Skip to content

Commit

Permalink
docs: [analytics-admin] replace "GA4" with "Google Analytics" or "GA"…
Browse files Browse the repository at this point in the history
… in all comments (#5989)

* 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

Source-Link: googleapis/googleapis@f20edbd

Source-Link: googleapis/googleapis-gen@ed0f0d6
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiZWQwZjBkNmRkZGM3MmQzMWIyOTg3ZjgwYmExM2Q3M2NiNjI4MGE3YyJ9

* 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: 720657164

Source-Link: googleapis/googleapis@89a0f8e

Source-Link: googleapis/googleapis-gen@ff322a9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiZmYzMjJhOTI5ZGVjNzZiNDBjMGJlYTNhZmY3MDc0MWExYzVkMTk1MCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Jan 29, 2025
1 parent e87d466 commit 6bf295b
Show file tree
Hide file tree
Showing 18 changed files with 431 additions and 159 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ option java_multiple_files = true;
option java_outer_classname = "AnalyticsAdminProto";
option java_package = "com.google.analytics.admin.v1alpha";

// 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) =
Expand All @@ -55,7 +55,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) {
Expand Down Expand Up @@ -108,7 +108,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: "/v1alpha/{name=properties/*}"
Expand All @@ -118,7 +118,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.
Expand All @@ -128,7 +127,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: "/v1alpha/properties"
Expand All @@ -147,7 +147,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: "/v1alpha/{name=properties/*}"
Expand Down Expand Up @@ -249,7 +249,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) = {
Expand Down Expand Up @@ -368,6 +368,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) = {
Expand Down Expand Up @@ -900,12 +903,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) = {
Expand Down Expand Up @@ -1580,9 +1588,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
Expand Down Expand Up @@ -2140,9 +2148,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ message AudienceEventTrigger {
LogCondition log_condition = 2 [(google.api.field_behavior) = REQUIRED];
}

// A resource message representing a GA4 Audience.
// A resource message representing an Audience.
message Audience {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/Audience"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ message ExpandedDataSetFilterExpressionList {
repeated ExpandedDataSetFilterExpression filter_expressions = 1;
}

// A resource message representing a GA4 ExpandedDataSet.
// A resource message representing an `ExpandedDataSet`.
message ExpandedDataSet {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/ExpandedDataSet"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,18 +314,18 @@ enum LinkProposalState {
OBSOLETE = 6;
}

// 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;
}

Expand Down Expand Up @@ -388,7 +388,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"
Expand Down Expand Up @@ -579,7 +579,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"
Expand Down Expand Up @@ -621,7 +621,7 @@ message GlobalSiteTag {
string snippet = 2 [(google.api.field_behavior) = IMMUTABLE];
}

// 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"
Expand Down Expand Up @@ -693,7 +693,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"
Expand All @@ -719,7 +719,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}
Expand Down Expand Up @@ -861,7 +861,7 @@ message ConversionValues {

// Event setting conditions to match an event.
message EventMapping {
// Required. Name of the GA4 event. It must always be set.
// Required. Name of the Google Analytics event. It must always be set.
// The max allowed display name length is 40 UTF-16 code units.
string event_name = 1 [(google.api.field_behavior) = REQUIRED];

Expand Down Expand Up @@ -1016,7 +1016,8 @@ message ChangeHistoryChange {
ChangeHistoryResource resource_after_change = 4;
}

// A link between a GA4 property and a Display & Video 360 advertiser.
// A link between a Google Analytics property and a Display & Video 360
// advertiser.
message DisplayVideo360AdvertiserLink {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink"
Expand All @@ -1042,23 +1043,23 @@ message DisplayVideo360AdvertiserLink {
google.protobuf.BoolValue ads_personalization_enabled = 4;

// Immutable. Enables the import of campaign data from Display & Video 360
// into the GA4 property. After link creation, this can only be updated from
// the Display & Video 360 product. If this field is not set on create, it
// will be defaulted to true.
// into the Google Analytics property. After link creation, this can only be
// updated from the Display & Video 360 product. If this field is not set on
// create, it will be defaulted to true.
google.protobuf.BoolValue campaign_data_sharing_enabled = 5
[(google.api.field_behavior) = IMMUTABLE];

// Immutable. Enables the import of cost data from Display & Video 360 into
// the GA4 property. This can only be enabled if campaign_data_sharing_enabled
// is enabled. After link creation, this can only be updated from the Display
// & Video 360 product. If this field is not set on create, it will be
// defaulted to true.
// the Google Analytics property. This can only be enabled if
// `campaign_data_sharing_enabled` is true. After link creation, this can
// only be updated from the Display & Video 360 product. If this field is not
// set on create, it will be defaulted to true.
google.protobuf.BoolValue cost_data_sharing_enabled = 6
[(google.api.field_behavior) = IMMUTABLE];
}

// A proposal for a link between a GA4 property and a Display & Video 360
// advertiser.
// A proposal for a link between a Google Analytics property and a Display &
// Video 360 advertiser.
//
// A proposal is converted to a DisplayVideo360AdvertiserLink once approved.
// Google Analytics admins approve inbound proposals while Display & Video 360
Expand Down Expand Up @@ -1113,7 +1114,7 @@ message DisplayVideo360AdvertiserLinkProposal {
[(google.api.field_behavior) = IMMUTABLE];
}

// A link between a GA4 property and a Search Ads 360 entity.
// A link between a Google Analytics property and a Search Ads 360 entity.
message SearchAds360Link {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/SearchAds360Link"
Expand All @@ -1131,17 +1132,17 @@ message SearchAds360Link {
string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE];

// Immutable. Enables the import of campaign data from Search Ads 360 into the
// GA4 property. After link creation, this can only be updated from the Search
// Ads 360 product.
// If this field is not set on create, it will be defaulted to true.
// Google Analytics property. After link creation, this can only be updated
// from the Search Ads 360 product. If this field is not set on create, it
// will be defaulted to true.
google.protobuf.BoolValue campaign_data_sharing_enabled = 3
[(google.api.field_behavior) = IMMUTABLE];

// Immutable. Enables the import of cost data from Search Ads 360 to the GA4
// property. This can only be enabled if campaign_data_sharing_enabled is
// enabled. After link creation, this can only be updated from
// the Search Ads 360 product.
// If this field is not set on create, it will be defaulted to true.
// Immutable. Enables the import of cost data from Search Ads 360 to the
// Google Analytics property. This can only be enabled if
// campaign_data_sharing_enabled is enabled. After link creation, this can
// only be updated from the Search Ads 360 product. If this field is not set
// on create, it will be defaulted to true.
google.protobuf.BoolValue cost_data_sharing_enabled = 4
[(google.api.field_behavior) = IMMUTABLE];

Expand Down Expand Up @@ -1628,24 +1629,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.
Expand Down Expand Up @@ -1806,7 +1812,7 @@ message AccessBinding {
repeated string roles = 3;
}

// A link between a GA4 Property and BigQuery project.
// A link between a Google Analytics property and BigQuery project.
message BigQueryLink {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/BigQueryLink"
Expand Down Expand Up @@ -1964,7 +1970,8 @@ message DataRedactionSettings {
repeated string query_parameter_keys = 4;
}

// A link between a GA4 Property and an AdSense for Content ad client.
// A link between a Google Analytics property and an AdSense for Content ad
// client.
message AdSenseLink {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/AdSenseLink"
Expand All @@ -1976,8 +1983,8 @@ message AdSenseLink {
// Example: properties/1234/adSenseLinks/6789
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Immutable. The AdSense ad client code that the GA4 property is linked to.
// Example format: "ca-pub-1234567890"
// Immutable. The AdSense ad client code that the Google Analytics property is
// linked to. Example format: "ca-pub-1234567890"
string ad_client_code = 2 [(google.api.field_behavior) = IMMUTABLE];
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ message SubpropertyEventFilterClause {
[(google.api.field_behavior) = REQUIRED];
}

// A resource message representing a GA4 Subproperty event filter.
// A resource message representing a Google Analytics subproperty event filter.
message SubpropertyEventFilter {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/SubpropertyEventFilter"
Expand Down
Loading

0 comments on commit 6bf295b

Please sign in to comment.