Skip to content

Commit f20edbd

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: replace "GA4" with "Google Analytics" or "GA" in all comments
feat: add `user_data_retention` field to `DataRetentionSettings` and mark as `REQUIRED` fix: mark `event_data_retention` field in `DataRetentionSettings` as `REQUIRED` PiperOrigin-RevId: 720655692
1 parent 0ce8062 commit f20edbd

6 files changed

Lines changed: 88 additions & 58 deletions

File tree

‎google/analytics/admin/v1alpha/BUILD.bazel‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@
99
# * extra_protoc_file_parameters
1010
# The complete list of preserved parameters can be found in the source code.
1111

12+
# buildifier: disable=load-on-top
13+
1214
# This is an API workspace, having public visibility by default makes perfect sense.
1315
package(default_visibility = ["//visibility:public"])
1416

1517
##############################################################################
1618
# Common
1719
##############################################################################
18-
load("@rules_proto//proto:defs.bzl", "proto_library")
20+
# buildifier: disable=same-origin-load
1921
load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
22+
load("@rules_proto//proto:defs.bzl", "proto_library")
2023

2124
proto_library(
2225
name = "admin_proto",
@@ -54,6 +57,7 @@ proto_library_with_info(
5457
##############################################################################
5558
# Java
5659
##############################################################################
60+
# buildifier: disable=same-origin-load
5761
load(
5862
"@com_google_googleapis_imports//:imports.bzl",
5963
"java_gapic_assembly_gradle_pkg",
@@ -116,6 +120,7 @@ java_gapic_assembly_gradle_pkg(
116120
##############################################################################
117121
# Go
118122
##############################################################################
123+
# buildifier: disable=same-origin-load
119124
load(
120125
"@com_google_googleapis_imports//:imports.bzl",
121126
"go_gapic_assembly_pkg",
@@ -164,6 +169,7 @@ go_gapic_assembly_pkg(
164169
##############################################################################
165170
# Python
166171
##############################################################################
172+
# buildifier: disable=same-origin-load
167173
load(
168174
"@com_google_googleapis_imports//:imports.bzl",
169175
"py_gapic_assembly_pkg",
@@ -204,6 +210,7 @@ py_gapic_assembly_pkg(
204210
##############################################################################
205211
# PHP
206212
##############################################################################
213+
# buildifier: disable=same-origin-load
207214
load(
208215
"@com_google_googleapis_imports//:imports.bzl",
209216
"php_gapic_assembly_pkg",
@@ -241,6 +248,7 @@ php_gapic_assembly_pkg(
241248
##############################################################################
242249
# Node.js
243250
##############################################################################
251+
# buildifier: disable=same-origin-load
244252
load(
245253
"@com_google_googleapis_imports//:imports.bzl",
246254
"nodejs_gapic_assembly_pkg",
@@ -271,6 +279,7 @@ nodejs_gapic_assembly_pkg(
271279
##############################################################################
272280
# Ruby
273281
##############################################################################
282+
# buildifier: disable=same-origin-load
274283
load(
275284
"@com_google_googleapis_imports//:imports.bzl",
276285
"ruby_cloud_gapic_library",
@@ -324,6 +333,7 @@ ruby_gapic_assembly_pkg(
324333
##############################################################################
325334
# C#
326335
##############################################################################
336+
# buildifier: disable=same-origin-load
327337
load(
328338
"@com_google_googleapis_imports//:imports.bzl",
329339
"csharp_gapic_assembly_pkg",
@@ -334,7 +344,6 @@ load(
334344

335345
csharp_proto_library(
336346
name = "admin_csharp_proto",
337-
extra_opts = [],
338347
deps = [":admin_proto"],
339348
)
340349

@@ -371,6 +380,7 @@ csharp_gapic_assembly_pkg(
371380
##############################################################################
372381
# C++
373382
##############################################################################
383+
# buildifier: disable=same-origin-load
374384
load(
375385
"@com_google_googleapis_imports//:imports.bzl",
376386
"cc_grpc_library",

‎google/analytics/admin/v1alpha/analytics_admin.proto‎

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ option java_multiple_files = true;
3636
option java_outer_classname = "AnalyticsAdminProto";
3737
option java_package = "com.google.analytics.admin.v1alpha";
3838

39-
// Service Interface for the Analytics Admin API (GA4).
39+
// Service Interface for the Google Analytics Admin API.
4040
service AnalyticsAdminService {
4141
option (google.api.default_host) = "analyticsadmin.googleapis.com";
4242
option (google.api.oauth_scopes) =
@@ -55,7 +55,7 @@ service AnalyticsAdminService {
5555

5656
// Returns all accounts accessible by the caller.
5757
//
58-
// Note that these accounts might not currently have GA4 properties.
58+
// Note that these accounts might not currently have GA properties.
5959
// Soft-deleted (ie: "trashed") accounts are excluded by default.
6060
// Returns an empty list if no relevant accounts are found.
6161
rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) {
@@ -108,7 +108,7 @@ service AnalyticsAdminService {
108108
};
109109
}
110110

111-
// Lookup for a single "GA4" Property.
111+
// Lookup for a single GA Property.
112112
rpc GetProperty(GetPropertyRequest) returns (Property) {
113113
option (google.api.http) = {
114114
get: "/v1alpha/{name=properties/*}"
@@ -118,7 +118,6 @@ service AnalyticsAdminService {
118118

119119
// Returns child Properties under the specified parent Account.
120120
//
121-
// Only "GA4" properties will be returned.
122121
// Properties will be excluded if the caller does not have access.
123122
// Soft-deleted (ie: "trashed") properties are excluded by default.
124123
// Returns an empty list if no relevant properties are found.
@@ -128,7 +127,8 @@ service AnalyticsAdminService {
128127
};
129128
}
130129

131-
// Creates an "GA4" property with the specified location and attributes.
130+
// Creates a Google Analytics property with the specified location and
131+
// attributes.
132132
rpc CreateProperty(CreatePropertyRequest) returns (Property) {
133133
option (google.api.http) = {
134134
post: "/v1alpha/properties"
@@ -147,7 +147,7 @@ service AnalyticsAdminService {
147147
// will be permanently purged.
148148
// https://support.google.com/analytics/answer/6154772
149149
//
150-
// Returns an error if the target is not found, or is not a GA4 Property.
150+
// Returns an error if the target is not found.
151151
rpc DeleteProperty(DeletePropertyRequest) returns (Property) {
152152
option (google.api.http) = {
153153
delete: "/v1alpha/{name=properties/*}"
@@ -249,7 +249,7 @@ service AnalyticsAdminService {
249249
option (google.api.method_signature) = "name";
250250
}
251251

252-
// Lookup for a single "GA4" MeasurementProtocolSecret.
252+
// Lookup for a single MeasurementProtocolSecret.
253253
rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest)
254254
returns (MeasurementProtocolSecret) {
255255
option (google.api.http) = {
@@ -368,6 +368,9 @@ service AnalyticsAdminService {
368368

369369
// Searches through all changes to an account or its children given the
370370
// specified set of filters.
371+
//
372+
// Only returns the subset of changes supported by the API. The UI may return
373+
// additional changes.
371374
rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest)
372375
returns (SearchChangeHistoryEventsResponse) {
373376
option (google.api.http) = {
@@ -900,12 +903,17 @@ service AnalyticsAdminService {
900903
// only be requested on Google Analytics 360 properties. This method is only
901904
// available to Administrators.
902905
//
903-
// These data access records include GA4 UI Reporting, GA4 UI Explorations,
904-
// GA4 Data API, and other products like Firebase & Admob that can retrieve
906+
// These data access records include GA UI Reporting, GA UI Explorations,
907+
// GA Data API, and other products like Firebase & Admob that can retrieve
905908
// data from Google Analytics through a linkage. These records don't include
906909
// property configuration changes like adding a stream or changing a
907910
// property's time zone. For configuration change history, see
908911
// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
912+
//
913+
// To give your feedback on this API, complete the [Google Analytics Access
914+
// Reports
915+
// feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform)
916+
// form.
909917
rpc RunAccessReport(RunAccessReportRequest)
910918
returns (RunAccessReportResponse) {
911919
option (google.api.http) = {
@@ -1580,9 +1588,9 @@ message RunAccessReportRequest {
15801588
// access for all properties under that account.
15811589
//
15821590
// To request at the property level, entity should be for example
1583-
// 'properties/123' if "123" is your GA4 property ID. To request at the
1584-
// account level, entity should be for example 'accounts/1234' if "1234" is
1585-
// your GA4 Account ID.
1591+
// 'properties/123' if "123" is your Google Analytics property ID. To request
1592+
// at the account level, entity should be for example 'accounts/1234' if
1593+
// "1234" is your Google Analytics Account ID.
15861594
string entity = 1;
15871595

15881596
// The dimensions requested and displayed in the response. Requests are
@@ -2140,9 +2148,14 @@ message SearchChangeHistoryEventsRequest {
21402148
[(google.api.field_behavior) = OPTIONAL];
21412149

21422150
// Optional. The maximum number of ChangeHistoryEvent items to return.
2143-
// The service may return fewer than this value, even if there are additional
2144-
// pages. If unspecified, at most 50 items will be returned.
2145-
// The maximum value is 200 (higher values will be coerced to the maximum).
2151+
// If unspecified, at most 50 items will be returned. The maximum value is 200
2152+
// (higher values will be coerced to the maximum).
2153+
//
2154+
// Note that the service may return a page with fewer items than this value
2155+
// specifies (potentially even zero), and that there still may be additional
2156+
// pages. If you want a particular number of items, you'll need to continue
2157+
// requesting additional pages using `page_token` until you get the needed
2158+
// number.
21462159
int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL];
21472160

21482161
// Optional. A page token, received from a previous

‎google/analytics/admin/v1alpha/audience.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ message AudienceEventTrigger {
361361
LogCondition log_condition = 2 [(google.api.field_behavior) = REQUIRED];
362362
}
363363

364-
// A resource message representing a GA4 Audience.
364+
// A resource message representing an Audience.
365365
message Audience {
366366
option (google.api.resource) = {
367367
type: "analyticsadmin.googleapis.com/Audience"

‎google/analytics/admin/v1alpha/expanded_data_set.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ message ExpandedDataSetFilterExpressionList {
107107
repeated ExpandedDataSetFilterExpression filter_expressions = 1;
108108
}
109109

110-
// A resource message representing a GA4 ExpandedDataSet.
110+
// A resource message representing an `ExpandedDataSet`.
111111
message ExpandedDataSet {
112112
option (google.api.resource) = {
113113
type: "analyticsadmin.googleapis.com/ExpandedDataSet"

0 commit comments

Comments
 (0)