feat: add UserProvidedDataSettings resource and GetUserProvidedDataSettings RPC to Google Analytics

Google APIs · copybara-github · commit fc968708d27f · 2026-04-14T09:54:31.000-07:00
chore: update resource name fields to use IDENTIFIER field behavior across Google Analytics resources
chore: add plural and singular names to google.api.resource definitions for Google Analytics resources
chore: mark page_size and page_token fields as OPTIONAL in Google Analytics list request messages
chore: update OAuth scopes for GetUserProvidedDataSettings and GetSubpropertySyncConfig in Google Analytics
docs: update documentation for GetReportingIdentitySettings to correctly describe it as returning reporting identity settings in Google Analytics
docs: update copyright year to 2026 in Google Analytics proto files

PiperOrigin-RevId: 899639582
diff --git a/google/analytics/admin/v1alpha/access_report.proto b/google/analytics/admin/v1alpha/access_report.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/analytics/admin/v1alpha/analytics_admin.proto b/google/analytics/admin/v1alpha/analytics_admin.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -1602,14 +1602,23 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "name";
   }
 
-  // Returns the singleton data retention settings for this property.
+  // Returns the reporting identity settings for this property.
   rpc GetReportingIdentitySettings(GetReportingIdentitySettingsRequest)
       returns (ReportingIdentitySettings) {
     option (google.api.http) = {
       get: "/v1alpha/{name=properties/*/reportingIdentitySettings}"
     };
     option (google.api.method_signature) = "name";
   }
+
+  // Looks up settings related to user-provided data for a property.
+  rpc GetUserProvidedDataSettings(GetUserProvidedDataSettingsRequest)
+      returns (UserProvidedDataSettings) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=properties/*/userProvidedDataSettings}"
+    };
+    option (google.api.method_signature) = "name";
+  }
 }
 
 // The request for a Data Access Record Report.
@@ -1750,17 +1759,17 @@ message GetAccountRequest {
 
 // Request message for ListAccounts RPC.
 message ListAccountsRequest {
-  // The maximum number of resources to return. The service may return
+  // Optional. The maximum number of resources to return. The service may return
   // fewer than this value, even if there are additional pages.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 1;
+  int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListAccounts` call.
+  // Optional. A page token, received from a previous `ListAccounts` call.
   // Provide this to retrieve the subsequent page.
   // When paginating, all other parameters provided to `ListAccounts` must
   // match the call that provided the page token.
-  string page_token = 2;
+  string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Whether to include soft-deleted (ie: "trashed") Accounts in the
   // results. Accounts can be inspected to determine whether they are deleted or
@@ -1854,17 +1863,17 @@ message ListPropertiesRequest {
   // ```
   string filter = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // The maximum number of resources to return. The service may return
+  // Optional. The maximum number of resources to return. The service may return
   // fewer than this value, even if there are additional pages.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListProperties` call.
+  // Optional. A page token, received from a previous `ListProperties` call.
   // Provide this to retrieve the subsequent page.
   // When paginating, all other parameters provided to `ListProperties` must
   // match the call that provided the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // Whether to include soft-deleted (ie: "trashed") Properties in the
   // results. Properties can be inspected to determine whether they are deleted
@@ -1958,17 +1967,17 @@ message ListFirebaseLinksRequest {
     }
   ];
 
-  // The maximum number of resources to return. The service may return
+  // Optional. The maximum number of resources to return. The service may return
   // fewer than this value, even if there are additional pages.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListFirebaseLinks` call.
+  // Optional. A page token, received from a previous `ListFirebaseLinks` call.
   // Provide this to retrieve the subsequent page.
   // When paginating, all other parameters provided to `ListFirebaseLinks` must
   // match the call that provided the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListFirebaseLinks RPC
@@ -2046,17 +2055,17 @@ message ListGoogleAdsLinksRequest {
     }
   ];
 
-  // The maximum number of resources to return.
+  // Optional. The maximum number of resources to return.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200 (higher values will be coerced to the maximum).
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListGoogleAdsLinks` call.
+  // Optional. A page token, received from a previous `ListGoogleAdsLinks` call.
   // Provide this to retrieve the subsequent page.
   //
   // When paginating, all other parameters provided to `ListGoogleAdsLinks` must
   // match the call that provided the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListGoogleAdsLinks RPC.
@@ -2085,17 +2094,17 @@ message GetDataSharingSettingsRequest {
 
 // Request message for ListAccountSummaries RPC.
 message ListAccountSummariesRequest {
-  // The maximum number of AccountSummary resources to return. The service may
-  // return fewer than this value, even if there are additional pages.
-  // If unspecified, at most 50 resources will be returned.
-  // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 1;
+  // Optional. The maximum number of AccountSummary resources to return. The
+  // service may return fewer than this value, even if there are additional
+  // pages. If unspecified, at most 50 resources will be returned. The maximum
+  // value is 200; (higher values will be coerced to the maximum)
+  int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListAccountSummaries` call.
-  // Provide this to retrieve the subsequent page.
-  // When paginating, all other parameters provided to `ListAccountSummaries`
-  // must match the call that provided the page token.
-  string page_token = 2;
+  // Optional. A page token, received from a previous `ListAccountSummaries`
+  // call. Provide this to retrieve the subsequent page. When paginating, all
+  // other parameters provided to `ListAccountSummaries` must match the call
+  // that provided the page token.
+  string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListAccountSummaries RPC.
@@ -2273,16 +2282,17 @@ message ListMeasurementProtocolSecretsRequest {
     }
   ];
 
-  // The maximum number of resources to return.
+  // Optional. The maximum number of resources to return.
   // If unspecified, at most 10 resources will be returned.
   // The maximum value is 10. Higher values will be coerced to the maximum.
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListMeasurementProtocolSecrets`
-  // call. Provide this to retrieve the subsequent page. When paginating, all
-  // other parameters provided to `ListMeasurementProtocolSecrets` must match
-  // the call that provided the page token.
-  string page_token = 3;
+  // Optional. A page token, received from a previous
+  // `ListMeasurementProtocolSecrets` call. Provide this to retrieve the
+  // subsequent page. When paginating, all other parameters provided to
+  // `ListMeasurementProtocolSecrets` must match the call that provided the page
+  // token.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListMeasurementProtocolSecret RPC
@@ -2362,18 +2372,18 @@ message ListSKAdNetworkConversionValueSchemasRequest {
     }
   ];
 
-  // The maximum number of resources to return. The service may return
+  // Optional. The maximum number of resources to return. The service may return
   // fewer than this value, even if there are additional pages.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous
+  // Optional. A page token, received from a previous
   // `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
   // subsequent page. When paginating, all other parameters provided to
   // `ListSKAdNetworkConversionValueSchema` must match the call that provided
   // the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListSKAdNetworkConversionValueSchemas RPC
@@ -2484,16 +2494,16 @@ message ListConversionEventsRequest {
     }
   ];
 
-  // The maximum number of resources to return.
+  // Optional. The maximum number of resources to return.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListConversionEvents` call.
-  // Provide this to retrieve the subsequent page.
-  // When paginating, all other parameters provided to `ListConversionEvents`
-  // must match the call that provided the page token.
-  string page_token = 3;
+  // Optional. A page token, received from a previous `ListConversionEvents`
+  // call. Provide this to retrieve the subsequent page. When paginating, all
+  // other parameters provided to `ListConversionEvents` must match the call
+  // that provided the page token.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListConversionEvents RPC.
@@ -2572,16 +2582,16 @@ message ListKeyEventsRequest {
     }
   ];
 
-  // The maximum number of resources to return.
+  // Optional. The maximum number of resources to return.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200; (higher values will be coerced to the maximum)
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListKeyEvents` call.
+  // Optional. A page token, received from a previous `ListKeyEvents` call.
   // Provide this to retrieve the subsequent page.
   // When paginating, all other parameters provided to `ListKeyEvents`
   // must match the call that provided the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListKeyEvents RPC.
@@ -2907,17 +2917,17 @@ message ListCustomDimensionsRequest {
     }
   ];
 
-  // The maximum number of resources to return.
+  // Optional. The maximum number of resources to return.
   // If unspecified, at most 50 resources will be returned.
   // The maximum value is 200 (higher values will be coerced to the maximum).
-  int32 page_size = 2;
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // A page token, received from a previous `ListCustomDimensions` call.
-  // Provide this to retrieve the subsequent page.
+  // Optional. A page token, received from a previous `ListCustomDimensions`
+  // call. Provide this to retrieve the subsequent page.
   //
   // When paginating, all other parameters provided to `ListCustomDimensions`
   // must match the call that provided the page token.
-  string page_token = 3;
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for ListCustomDimensions RPC.
@@ -4625,3 +4635,15 @@ message GetReportingIdentitySettingsRequest {
     }
   ];
 }
+
+// Request message for GetUserProvidedDataSettings RPC
+message GetUserProvidedDataSettingsRequest {
+  // Required. The name of the user provided data settings to retrieve.
+  // Format: properties/{property}/userProvidedDataSettings
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "analyticsadmin.googleapis.com/UserProvidedDataSettings"
+    }
+  ];
+}
diff --git a/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml b/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
@@ -212,6 +212,11 @@ authentication:
       canonical_scopes: |-
         https://www.googleapis.com/auth/analytics.edit,
         https://www.googleapis.com/auth/analytics.readonly
+  - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserProvidedDataSettings
+    oauth:
+      canonical_scopes: |-
+        https://www.googleapis.com/auth/analytics.edit,
+        https://www.googleapis.com/auth/analytics.readonly
   - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccessBindings
     oauth:
       canonical_scopes: |-
diff --git a/google/analytics/admin/v1alpha/audience.proto b/google/analytics/admin/v1alpha/audience.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/analytics/admin/v1alpha/channel_group.proto b/google/analytics/admin/v1alpha/channel_group.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/analytics/admin/v1alpha/event_create_and_edit.proto b/google/analytics/admin/v1alpha/event_create_and_edit.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/analytics/admin/v1alpha/expanded_data_set.proto b/google/analytics/admin/v1alpha/expanded_data_set.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/analytics/admin/v1alpha/resources.proto b/google/analytics/admin/v1alpha/resources.proto
diff --git a/google/analytics/admin/v1alpha/subproperty_event_filter.proto b/google/analytics/admin/v1alpha/subproperty_event_filter.proto

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2025 Google LLC`
	`1`	`+// Copyright 2026 Google LLC`
`2`	`2`	`//`
`3`	`3`	`// Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`// you may not use this file except in compliance with the License.`