docs: replace "GA4" with "Google Analytics" or "GA" in all comments

Google APIs · copybara-github · commit 89a0f8e22df3 · 2025-01-28T11:52:01.000-08:00
feat: add `user_data_retention` field to `DataRetentionSettings` and mark as `REQUIRED`
fix: mark `event_data_retention` field in `DataRetentionSettings` as `REQUIRED`

PiperOrigin-RevId: 720657164
diff --git a/google/analytics/admin/v1beta/BUILD.bazel b/google/analytics/admin/v1beta/BUILD.bazel
@@ -9,14 +9,17 @@
 #    * extra_protoc_file_parameters
 # The complete list of preserved parameters can be found in the source code.
 
+# buildifier: disable=load-on-top
+
 # This is an API workspace, having public visibility by default makes perfect sense.
 package(default_visibility = ["//visibility:public"])
 
 ##############################################################################
 # Common
 ##############################################################################
-load("@rules_proto//proto:defs.bzl", "proto_library")
+# buildifier: disable=same-origin-load
 load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+load("@rules_proto//proto:defs.bzl", "proto_library")
 
 proto_library(
     name = "admin_proto",
@@ -48,6 +51,7 @@ proto_library_with_info(
 ##############################################################################
 # Java
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "java_gapic_assembly_gradle_pkg",
@@ -110,6 +114,7 @@ java_gapic_assembly_gradle_pkg(
 ##############################################################################
 # Go
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "go_gapic_assembly_pkg",
@@ -157,6 +162,7 @@ go_gapic_assembly_pkg(
 ##############################################################################
 # Python
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "py_gapic_assembly_pkg",
@@ -196,6 +202,7 @@ py_gapic_assembly_pkg(
 ##############################################################################
 # PHP
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "php_gapic_assembly_pkg",
@@ -216,7 +223,9 @@ php_gapic_library(
     rest_numeric_enums = True,
     service_yaml = "analyticsadmin_v1beta.yaml",
     transport = "grpc+rest",
-    deps = [":admin_php_proto"],
+    deps = [
+        ":admin_php_proto",
+    ],
 )
 
 # Open Source Packages
@@ -231,6 +240,7 @@ php_gapic_assembly_pkg(
 ##############################################################################
 # Node.js
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "nodejs_gapic_assembly_pkg",
@@ -261,6 +271,7 @@ nodejs_gapic_assembly_pkg(
 ##############################################################################
 # Ruby
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "ruby_cloud_gapic_library",
@@ -307,6 +318,7 @@ ruby_gapic_assembly_pkg(
 ##############################################################################
 # C#
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "csharp_gapic_assembly_pkg",
@@ -317,6 +329,7 @@ load(
 
 csharp_proto_library(
     name = "admin_csharp_proto",
+    extra_opts = [],
     deps = [":admin_proto"],
 )
 
@@ -353,6 +366,7 @@ csharp_gapic_assembly_pkg(
 ##############################################################################
 # C++
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "cc_grpc_library",
diff --git a/google/analytics/admin/v1beta/analytics_admin.proto b/google/analytics/admin/v1beta/analytics_admin.proto
@@ -31,7 +31,7 @@ option java_multiple_files = true;
 option java_outer_classname = "AnalyticsAdminProto";
 option java_package = "com.google.analytics.admin.v1beta";
 
-// Service Interface for the Analytics Admin API (GA4).
+// Service Interface for the Google Analytics Admin API.
 service AnalyticsAdminService {
   option (google.api.default_host) = "analyticsadmin.googleapis.com";
   option (google.api.oauth_scopes) =
@@ -48,7 +48,7 @@ service AnalyticsAdminService {
 
   // Returns all accounts accessible by the caller.
   //
-  // Note that these accounts might not currently have GA4 properties.
+  // Note that these accounts might not currently have GA properties.
   // Soft-deleted (ie: "trashed") accounts are excluded by default.
   // Returns an empty list if no relevant accounts are found.
   rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) {
@@ -101,7 +101,7 @@ service AnalyticsAdminService {
     };
   }
 
-  // Lookup for a single "GA4" Property.
+  // Lookup for a single GA Property.
   rpc GetProperty(GetPropertyRequest) returns (Property) {
     option (google.api.http) = {
       get: "/v1beta/{name=properties/*}"
@@ -111,7 +111,6 @@ service AnalyticsAdminService {
 
   // Returns child Properties under the specified parent Account.
   //
-  // Only "GA4" properties will be returned.
   // Properties will be excluded if the caller does not have access.
   // Soft-deleted (ie: "trashed") properties are excluded by default.
   // Returns an empty list if no relevant properties are found.
@@ -121,7 +120,8 @@ service AnalyticsAdminService {
     };
   }
 
-  // Creates an "GA4" property with the specified location and attributes.
+  // Creates a Google Analytics property with the specified location and
+  // attributes.
   rpc CreateProperty(CreatePropertyRequest) returns (Property) {
     option (google.api.http) = {
       post: "/v1beta/properties"
@@ -140,7 +140,7 @@ service AnalyticsAdminService {
   // will be permanently purged.
   // https://support.google.com/analytics/answer/6154772
   //
-  // Returns an error if the target is not found, or is not a GA4 Property.
+  // Returns an error if the target is not found.
   rpc DeleteProperty(DeletePropertyRequest) returns (Property) {
     option (google.api.http) = {
       delete: "/v1beta/{name=properties/*}"
@@ -233,7 +233,7 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "name";
   }
 
-  // Lookup for a single "GA4" MeasurementProtocolSecret.
+  // Lookup for a single MeasurementProtocolSecret.
   rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest)
       returns (MeasurementProtocolSecret) {
     option (google.api.http) = {
@@ -297,6 +297,9 @@ service AnalyticsAdminService {
 
   // Searches through all changes to an account or its children given the
   // specified set of filters.
+  //
+  // Only returns the subset of changes supported by the API. The UI may return
+  // additional changes.
   rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest)
       returns (SearchChangeHistoryEventsResponse) {
     option (google.api.http) = {
@@ -571,12 +574,17 @@ service AnalyticsAdminService {
   // only be requested on Google Analytics 360 properties. This method is only
   // available to Administrators.
   //
-  // These data access records include GA4 UI Reporting, GA4 UI Explorations,
-  // GA4 Data API, and other products like Firebase & Admob that can retrieve
+  // These data access records include GA UI Reporting, GA UI Explorations,
+  // GA Data API, and other products like Firebase & Admob that can retrieve
   // data from Google Analytics through a linkage. These records don't include
   // property configuration changes like adding a stream or changing a
   // property's time zone. For configuration change history, see
   // [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
+  //
+  // To give your feedback on this API, complete the [Google Analytics Access
+  // Reports
+  // feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform)
+  // form.
   rpc RunAccessReport(RunAccessReportRequest)
       returns (RunAccessReportResponse) {
     option (google.api.http) = {
@@ -597,9 +605,9 @@ message RunAccessReportRequest {
   // access for all properties under that account.
   //
   // To request at the property level, entity should be for example
-  // 'properties/123' if "123" is your GA4 property ID. To request at the
-  // account level, entity should be for example 'accounts/1234' if "1234" is
-  // your GA4 Account ID.
+  // 'properties/123' if "123" is your Google Analytics property ID. To request
+  // at the account level, entity should be for example 'accounts/1234' if
+  // "1234" is your Google Analytics Account ID.
   string entity = 1;
 
   // The dimensions requested and displayed in the response. Requests are
@@ -1142,9 +1150,14 @@ message SearchChangeHistoryEventsRequest {
       [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The maximum number of ChangeHistoryEvent items to return.
-  // The service may return fewer than this value, even if there are additional
-  // pages. If unspecified, at most 50 items will be returned.
-  // The maximum value is 200 (higher values will be coerced to the maximum).
+  // If unspecified, at most 50 items will be returned. The maximum value is 200
+  // (higher values will be coerced to the maximum).
+  //
+  // Note that the service may return a page with fewer items than this value
+  // specifies (potentially even zero), and that there still may be additional
+  // pages. If you want a particular number of items, you'll need to continue
+  // requesting additional pages using `page_token` until you get the needed
+  // number.
   int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. A page token, received from a previous
diff --git a/google/analytics/admin/v1beta/resources.proto b/google/analytics/admin/v1beta/resources.proto
@@ -183,6 +183,12 @@ enum ChangeHistoryResourceType {
   // MeasurementProtocolSecret resource
   MEASUREMENT_PROTOCOL_SECRET = 10;
 
+  // CustomDimension resource
+  CUSTOM_DIMENSION = 11;
+
+  // CustomMetric resource
+  CUSTOM_METRIC = 12;
+
   // DataRetentionSettings resource
   DATA_RETENTION_SETTINGS = 13;
 
@@ -199,18 +205,18 @@ enum ChangeHistoryResourceType {
   ATTRIBUTION_SETTINGS = 20;
 }
 
-// Types of Property resources.
+// Types of `Property` resources.
 enum PropertyType {
   // Unknown or unspecified property type
   PROPERTY_TYPE_UNSPECIFIED = 0;
 
-  // Ordinary GA4 property
+  // Ordinary Google Analytics property
   PROPERTY_TYPE_ORDINARY = 1;
 
-  // GA4 subproperty
+  // Google Analytics subproperty
   PROPERTY_TYPE_SUBPROPERTY = 2;
 
-  // GA4 rollup property
+  // Google Analytics rollup property
   PROPERTY_TYPE_ROLLUP = 3;
 }
 
@@ -255,7 +261,7 @@ message Account {
   ];
 }
 
-// A resource message representing a Google Analytics GA4 property.
+// A resource message representing a Google Analytics property.
 message Property {
   option (google.api.resource) = {
     type: "analyticsadmin.googleapis.com/Property"
@@ -446,7 +452,7 @@ message DataStream {
       [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// A link between a GA4 property and a Firebase project.
+// A link between a Google Analytics property and a Firebase project.
 message FirebaseLink {
   option (google.api.resource) = {
     type: "analyticsadmin.googleapis.com/FirebaseLink"
@@ -470,7 +476,7 @@ message FirebaseLink {
       [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// A link between a GA4 property and a Google Ads account.
+// A link between a Google Analytics property and a Google Ads account.
 message GoogleAdsLink {
   option (google.api.resource) = {
     type: "analyticsadmin.googleapis.com/GoogleAdsLink"
@@ -542,7 +548,7 @@ message DataSharingSettings {
 }
 
 // A virtual resource representing an overview of an account and
-// all its child GA4 properties.
+// all its child Google Analytics properties.
 message AccountSummary {
   option (google.api.resource) = {
     type: "analyticsadmin.googleapis.com/AccountSummary"
@@ -568,7 +574,7 @@ message AccountSummary {
   repeated PropertySummary property_summaries = 4;
 }
 
-// A virtual resource representing metadata for a GA4 property.
+// A virtual resource representing metadata for a Google Analytics property.
 message PropertySummary {
   // Resource name of property referred to by this property summary
   // Format: properties/{property_id}
@@ -1024,24 +1030,29 @@ message DataRetentionSettings {
     FOURTEEN_MONTHS = 3;
 
     // The data retention time duration is 26 months.
-    // Available to 360 properties only.
+    // Available to 360 properties only. Available for event data only.
     TWENTY_SIX_MONTHS = 4;
 
     // The data retention time duration is 38 months.
-    // Available to 360 properties only.
+    // Available to 360 properties only. Available for event data only.
     THIRTY_EIGHT_MONTHS = 5;
 
     // The data retention time duration is 50 months.
-    // Available to 360 properties only.
+    // Available to 360 properties only. Available for event data only.
     FIFTY_MONTHS = 6;
   }
 
   // Output only. Resource name for this DataRetentionSetting resource.
   // Format: properties/{property}/dataRetentionSettings
   string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // The length of time that event-level data is retained.
-  RetentionDuration event_data_retention = 2;
+  // Required. The length of time that event-level data is retained.
+  RetentionDuration event_data_retention = 2
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The length of time that user-level data is retained.
+  RetentionDuration user_data_retention = 4
+      [(google.api.field_behavior) = REQUIRED];
 
   // If true, reset the retention period for the user identifier with every
   // event from that user.
