diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/analytics_admin.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/analytics_admin.proto index 474e34bc2e2..20a0d376ee4 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/analytics_admin.proto +++ b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/analytics_admin.proto @@ -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) = @@ -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) { @@ -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/*}" @@ -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. @@ -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" @@ -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/*}" @@ -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) = { @@ -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) = { @@ -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) = { @@ -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 @@ -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 diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/audience.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/audience.proto index 11abdf1141c..b5afbcac4c6 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/audience.proto +++ b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/audience.proto @@ -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" diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/expanded_data_set.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/expanded_data_set.proto index 839c0baab5e..932880d79b6 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/expanded_data_set.proto +++ b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/expanded_data_set.proto @@ -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" diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/resources.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/resources.proto index 8faeab1c645..bf1e105a118 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/resources.proto +++ b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/resources.proto @@ -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; } @@ -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" @@ -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" @@ -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" @@ -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" @@ -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} @@ -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]; @@ -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" @@ -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 @@ -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" @@ -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]; @@ -1628,15 +1629,15 @@ 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; } @@ -1644,8 +1645,13 @@ message DataRetentionSettings { // 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. @@ -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" @@ -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" @@ -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]; } diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/subproperty_event_filter.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/subproperty_event_filter.proto index 204bdc33a02..b613d1d9bcc 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/subproperty_event_filter.proto +++ b/packages/google-analytics-admin/protos/google/analytics/admin/v1alpha/subproperty_event_filter.proto @@ -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" diff --git a/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/analytics_admin.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/analytics_admin.proto index 84fb343415a..ede4efa54c7 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/analytics_admin.proto +++ b/packages/google-analytics-admin/protos/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/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/resources.proto b/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/resources.proto index 0c290c15b12..4b0b481d9fd 100644 --- a/packages/google-analytics-admin/protos/google/analytics/admin/v1beta/resources.proto +++ b/packages/google-analytics-admin/protos/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,15 +1030,15 @@ 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; } @@ -1040,8 +1046,13 @@ message DataRetentionSettings { // 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. diff --git a/packages/google-analytics-admin/protos/protos.d.ts b/packages/google-analytics-admin/protos/protos.d.ts index 3546a35a153..3088ccb6968 100644 --- a/packages/google-analytics-admin/protos/protos.d.ts +++ b/packages/google-analytics-admin/protos/protos.d.ts @@ -32883,6 +32883,9 @@ export namespace google { /** DataRetentionSettings eventDataRetention */ eventDataRetention?: (google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|null); + /** DataRetentionSettings userDataRetention */ + userDataRetention?: (google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|null); + /** DataRetentionSettings resetUserDataOnNewActivity */ resetUserDataOnNewActivity?: (boolean|null); } @@ -32902,6 +32905,9 @@ export namespace google { /** DataRetentionSettings eventDataRetention. */ public eventDataRetention: (google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration); + /** DataRetentionSettings userDataRetention. */ + public userDataRetention: (google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration); + /** DataRetentionSettings resetUserDataOnNewActivity. */ public resetUserDataOnNewActivity: boolean; @@ -45276,6 +45282,8 @@ export namespace google { GOOGLE_SIGNALS_SETTINGS = 8, CONVERSION_EVENT = 9, MEASUREMENT_PROTOCOL_SECRET = 10, + CUSTOM_DIMENSION = 11, + CUSTOM_METRIC = 12, DATA_RETENTION_SETTINGS = 13, DISPLAY_VIDEO_360_ADVERTISER_LINK = 14, DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15, @@ -47968,6 +47976,9 @@ export namespace google { /** DataRetentionSettings eventDataRetention */ eventDataRetention?: (google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|null); + /** DataRetentionSettings userDataRetention */ + userDataRetention?: (google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|null); + /** DataRetentionSettings resetUserDataOnNewActivity */ resetUserDataOnNewActivity?: (boolean|null); } @@ -47987,6 +47998,9 @@ export namespace google { /** DataRetentionSettings eventDataRetention. */ public eventDataRetention: (google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration); + /** DataRetentionSettings userDataRetention. */ + public userDataRetention: (google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration); + /** DataRetentionSettings resetUserDataOnNewActivity. */ public resetUserDataOnNewActivity: boolean; diff --git a/packages/google-analytics-admin/protos/protos.js b/packages/google-analytics-admin/protos/protos.js index 1bde455004f..a2aa560b2de 100644 --- a/packages/google-analytics-admin/protos/protos.js +++ b/packages/google-analytics-admin/protos/protos.js @@ -76080,6 +76080,7 @@ * @interface IDataRetentionSettings * @property {string|null} [name] DataRetentionSettings name * @property {google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|null} [eventDataRetention] DataRetentionSettings eventDataRetention + * @property {google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration|null} [userDataRetention] DataRetentionSettings userDataRetention * @property {boolean|null} [resetUserDataOnNewActivity] DataRetentionSettings resetUserDataOnNewActivity */ @@ -76114,6 +76115,14 @@ */ DataRetentionSettings.prototype.eventDataRetention = 0; + /** + * DataRetentionSettings userDataRetention. + * @member {google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration} userDataRetention + * @memberof google.analytics.admin.v1alpha.DataRetentionSettings + * @instance + */ + DataRetentionSettings.prototype.userDataRetention = 0; + /** * DataRetentionSettings resetUserDataOnNewActivity. * @member {boolean} resetUserDataOnNewActivity @@ -76152,6 +76161,8 @@ writer.uint32(/* id 2, wireType 0 =*/16).int32(message.eventDataRetention); if (message.resetUserDataOnNewActivity != null && Object.hasOwnProperty.call(message, "resetUserDataOnNewActivity")) writer.uint32(/* id 3, wireType 0 =*/24).bool(message.resetUserDataOnNewActivity); + if (message.userDataRetention != null && Object.hasOwnProperty.call(message, "userDataRetention")) + writer.uint32(/* id 4, wireType 0 =*/32).int32(message.userDataRetention); return writer; }; @@ -76194,6 +76205,10 @@ message.eventDataRetention = reader.int32(); break; } + case 4: { + message.userDataRetention = reader.int32(); + break; + } case 3: { message.resetUserDataOnNewActivity = reader.bool(); break; @@ -76248,6 +76263,18 @@ case 6: break; } + if (message.userDataRetention != null && message.hasOwnProperty("userDataRetention")) + switch (message.userDataRetention) { + default: + return "userDataRetention: enum value expected"; + case 0: + case 1: + case 3: + case 4: + case 5: + case 6: + break; + } if (message.resetUserDataOnNewActivity != null && message.hasOwnProperty("resetUserDataOnNewActivity")) if (typeof message.resetUserDataOnNewActivity !== "boolean") return "resetUserDataOnNewActivity: boolean expected"; @@ -76300,6 +76327,38 @@ message.eventDataRetention = 6; break; } + switch (object.userDataRetention) { + default: + if (typeof object.userDataRetention === "number") { + message.userDataRetention = object.userDataRetention; + break; + } + break; + case "RETENTION_DURATION_UNSPECIFIED": + case 0: + message.userDataRetention = 0; + break; + case "TWO_MONTHS": + case 1: + message.userDataRetention = 1; + break; + case "FOURTEEN_MONTHS": + case 3: + message.userDataRetention = 3; + break; + case "TWENTY_SIX_MONTHS": + case 4: + message.userDataRetention = 4; + break; + case "THIRTY_EIGHT_MONTHS": + case 5: + message.userDataRetention = 5; + break; + case "FIFTY_MONTHS": + case 6: + message.userDataRetention = 6; + break; + } if (object.resetUserDataOnNewActivity != null) message.resetUserDataOnNewActivity = Boolean(object.resetUserDataOnNewActivity); return message; @@ -76322,6 +76381,7 @@ object.name = ""; object.eventDataRetention = options.enums === String ? "RETENTION_DURATION_UNSPECIFIED" : 0; object.resetUserDataOnNewActivity = false; + object.userDataRetention = options.enums === String ? "RETENTION_DURATION_UNSPECIFIED" : 0; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -76329,6 +76389,8 @@ object.eventDataRetention = options.enums === String ? $root.google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration[message.eventDataRetention] === undefined ? message.eventDataRetention : $root.google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration[message.eventDataRetention] : message.eventDataRetention; if (message.resetUserDataOnNewActivity != null && message.hasOwnProperty("resetUserDataOnNewActivity")) object.resetUserDataOnNewActivity = message.resetUserDataOnNewActivity; + if (message.userDataRetention != null && message.hasOwnProperty("userDataRetention")) + object.userDataRetention = options.enums === String ? $root.google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration[message.userDataRetention] === undefined ? message.userDataRetention : $root.google.analytics.admin.v1alpha.DataRetentionSettings.RetentionDuration[message.userDataRetention] : message.userDataRetention; return object; }; @@ -95199,6 +95261,8 @@ case 8: case 9: case 10: + case 11: + case 12: case 13: case 14: case 15: @@ -95306,6 +95370,14 @@ case 10: message.resourceType[i] = 10; break; + case "CUSTOM_DIMENSION": + case 11: + message.resourceType[i] = 11; + break; + case "CUSTOM_METRIC": + case 12: + message.resourceType[i] = 12; + break; case "DATA_RETENTION_SETTINGS": case 13: message.resourceType[i] = 13; @@ -104520,6 +104592,8 @@ * @property {number} GOOGLE_SIGNALS_SETTINGS=8 GOOGLE_SIGNALS_SETTINGS value * @property {number} CONVERSION_EVENT=9 CONVERSION_EVENT value * @property {number} MEASUREMENT_PROTOCOL_SECRET=10 MEASUREMENT_PROTOCOL_SECRET value + * @property {number} CUSTOM_DIMENSION=11 CUSTOM_DIMENSION value + * @property {number} CUSTOM_METRIC=12 CUSTOM_METRIC value * @property {number} DATA_RETENTION_SETTINGS=13 DATA_RETENTION_SETTINGS value * @property {number} DISPLAY_VIDEO_360_ADVERTISER_LINK=14 DISPLAY_VIDEO_360_ADVERTISER_LINK value * @property {number} DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL=15 DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL value @@ -104536,6 +104610,8 @@ values[valuesById[8] = "GOOGLE_SIGNALS_SETTINGS"] = 8; values[valuesById[9] = "CONVERSION_EVENT"] = 9; values[valuesById[10] = "MEASUREMENT_PROTOCOL_SECRET"] = 10; + values[valuesById[11] = "CUSTOM_DIMENSION"] = 11; + values[valuesById[12] = "CUSTOM_METRIC"] = 12; values[valuesById[13] = "DATA_RETENTION_SETTINGS"] = 13; values[valuesById[14] = "DISPLAY_VIDEO_360_ADVERTISER_LINK"] = 14; values[valuesById[15] = "DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL"] = 15; @@ -111923,6 +111999,7 @@ * @interface IDataRetentionSettings * @property {string|null} [name] DataRetentionSettings name * @property {google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|null} [eventDataRetention] DataRetentionSettings eventDataRetention + * @property {google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|null} [userDataRetention] DataRetentionSettings userDataRetention * @property {boolean|null} [resetUserDataOnNewActivity] DataRetentionSettings resetUserDataOnNewActivity */ @@ -111957,6 +112034,14 @@ */ DataRetentionSettings.prototype.eventDataRetention = 0; + /** + * DataRetentionSettings userDataRetention. + * @member {google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration} userDataRetention + * @memberof google.analytics.admin.v1beta.DataRetentionSettings + * @instance + */ + DataRetentionSettings.prototype.userDataRetention = 0; + /** * DataRetentionSettings resetUserDataOnNewActivity. * @member {boolean} resetUserDataOnNewActivity @@ -111995,6 +112080,8 @@ writer.uint32(/* id 2, wireType 0 =*/16).int32(message.eventDataRetention); if (message.resetUserDataOnNewActivity != null && Object.hasOwnProperty.call(message, "resetUserDataOnNewActivity")) writer.uint32(/* id 3, wireType 0 =*/24).bool(message.resetUserDataOnNewActivity); + if (message.userDataRetention != null && Object.hasOwnProperty.call(message, "userDataRetention")) + writer.uint32(/* id 4, wireType 0 =*/32).int32(message.userDataRetention); return writer; }; @@ -112037,6 +112124,10 @@ message.eventDataRetention = reader.int32(); break; } + case 4: { + message.userDataRetention = reader.int32(); + break; + } case 3: { message.resetUserDataOnNewActivity = reader.bool(); break; @@ -112091,6 +112182,18 @@ case 6: break; } + if (message.userDataRetention != null && message.hasOwnProperty("userDataRetention")) + switch (message.userDataRetention) { + default: + return "userDataRetention: enum value expected"; + case 0: + case 1: + case 3: + case 4: + case 5: + case 6: + break; + } if (message.resetUserDataOnNewActivity != null && message.hasOwnProperty("resetUserDataOnNewActivity")) if (typeof message.resetUserDataOnNewActivity !== "boolean") return "resetUserDataOnNewActivity: boolean expected"; @@ -112143,6 +112246,38 @@ message.eventDataRetention = 6; break; } + switch (object.userDataRetention) { + default: + if (typeof object.userDataRetention === "number") { + message.userDataRetention = object.userDataRetention; + break; + } + break; + case "RETENTION_DURATION_UNSPECIFIED": + case 0: + message.userDataRetention = 0; + break; + case "TWO_MONTHS": + case 1: + message.userDataRetention = 1; + break; + case "FOURTEEN_MONTHS": + case 3: + message.userDataRetention = 3; + break; + case "TWENTY_SIX_MONTHS": + case 4: + message.userDataRetention = 4; + break; + case "THIRTY_EIGHT_MONTHS": + case 5: + message.userDataRetention = 5; + break; + case "FIFTY_MONTHS": + case 6: + message.userDataRetention = 6; + break; + } if (object.resetUserDataOnNewActivity != null) message.resetUserDataOnNewActivity = Boolean(object.resetUserDataOnNewActivity); return message; @@ -112165,6 +112300,7 @@ object.name = ""; object.eventDataRetention = options.enums === String ? "RETENTION_DURATION_UNSPECIFIED" : 0; object.resetUserDataOnNewActivity = false; + object.userDataRetention = options.enums === String ? "RETENTION_DURATION_UNSPECIFIED" : 0; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -112172,6 +112308,8 @@ object.eventDataRetention = options.enums === String ? $root.google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration[message.eventDataRetention] === undefined ? message.eventDataRetention : $root.google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration[message.eventDataRetention] : message.eventDataRetention; if (message.resetUserDataOnNewActivity != null && message.hasOwnProperty("resetUserDataOnNewActivity")) object.resetUserDataOnNewActivity = message.resetUserDataOnNewActivity; + if (message.userDataRetention != null && message.hasOwnProperty("userDataRetention")) + object.userDataRetention = options.enums === String ? $root.google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration[message.userDataRetention] === undefined ? message.userDataRetention : $root.google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration[message.userDataRetention] : message.userDataRetention; return object; }; diff --git a/packages/google-analytics-admin/protos/protos.json b/packages/google-analytics-admin/protos/protos.json index a527379e5ee..e0532343114 100644 --- a/packages/google-analytics-admin/protos/protos.json +++ b/packages/google-analytics-admin/protos/protos.json @@ -8756,7 +8756,17 @@ }, "eventDataRetention": { "type": "RetentionDuration", - "id": 2 + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "userDataRetention": { + "type": "RetentionDuration", + "id": 4, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } }, "resetUserDataOnNewActivity": { "type": "bool", @@ -11852,6 +11862,8 @@ "GOOGLE_SIGNALS_SETTINGS": 8, "CONVERSION_EVENT": 9, "MEASUREMENT_PROTOCOL_SECRET": 10, + "CUSTOM_DIMENSION": 11, + "CUSTOM_METRIC": 12, "DATA_RETENTION_SETTINGS": 13, "DISPLAY_VIDEO_360_ADVERTISER_LINK": 14, "DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL": 15, @@ -12797,7 +12809,17 @@ }, "eventDataRetention": { "type": "RetentionDuration", - "id": 2 + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "userDataRetention": { + "type": "RetentionDuration", + "id": 4, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } }, "resetUserDataOnNewActivity": { "type": "bool", diff --git a/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.run_access_report.js b/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.run_access_report.js index 18f227a0c0e..647ca7b03f8 100644 --- a/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.run_access_report.js +++ b/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.run_access_report.js @@ -33,9 +33,9 @@ function main() { * level. If requested at the account level, Data Access Reports include all * 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. */ // const entity = 'abc123' /** diff --git a/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.search_change_history_events.js b/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.search_change_history_events.js index d6153d0296e..cb1ca50ed40 100644 --- a/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.search_change_history_events.js +++ b/packages/google-analytics-admin/samples/generated/v1alpha/analytics_admin_service.search_change_history_events.js @@ -66,9 +66,13 @@ function main(account) { // const latestChangeTime = {} /** * 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. */ // const pageSize = 1234 /** diff --git a/packages/google-analytics-admin/samples/generated/v1alpha/snippet_metadata_google.analytics.admin.v1alpha.json b/packages/google-analytics-admin/samples/generated/v1alpha/snippet_metadata_google.analytics.admin.v1alpha.json index a2e7c84e29f..5af6de4d1c0 100644 --- a/packages/google-analytics-admin/samples/generated/v1alpha/snippet_metadata_google.analytics.admin.v1alpha.json +++ b/packages/google-analytics-admin/samples/generated/v1alpha/snippet_metadata_google.analytics.admin.v1alpha.json @@ -55,7 +55,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_ListAccounts_async", "title": "AnalyticsAdminService listAccounts Sample", "origin": "API_DEFINITION", - "description": " Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found.", + "description": " Returns all accounts accessible by the caller. 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.", "canonical": true, "file": "analytics_admin_service.list_accounts.js", "language": "JAVASCRIPT", @@ -275,7 +275,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_GetProperty_async", "title": "AnalyticsAdminService getProperty Sample", "origin": "API_DEFINITION", - "description": " Lookup for a single \"GA4\" Property.", + "description": " Lookup for a single GA Property.", "canonical": true, "file": "analytics_admin_service.get_property.js", "language": "JAVASCRIPT", @@ -315,7 +315,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_ListProperties_async", "title": "AnalyticsAdminService listProperties Sample", "origin": "API_DEFINITION", - "description": " 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.", + "description": " Returns child Properties under the specified parent Account. 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.", "canonical": true, "file": "analytics_admin_service.list_properties.js", "language": "JAVASCRIPT", @@ -367,7 +367,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_CreateProperty_async", "title": "AnalyticsAdminService createProperty Sample", "origin": "API_DEFINITION", - "description": " Creates an \"GA4\" property with the specified location and attributes.", + "description": " Creates a Google Analytics property with the specified location and attributes.", "canonical": true, "file": "analytics_admin_service.create_property.js", "language": "JAVASCRIPT", @@ -407,7 +407,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_DeleteProperty_async", "title": "AnalyticsAdminService deleteProperty Sample", "origin": "API_DEFINITION", - "description": " Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) 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.", + "description": " Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", "canonical": true, "file": "analytics_admin_service.delete_property.js", "language": "JAVASCRIPT", @@ -879,7 +879,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_GetMeasurementProtocolSecret_async", "title": "AnalyticsAdminService getMeasurementProtocolSecret Sample", "origin": "API_DEFINITION", - "description": " Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "description": " Lookup for a single MeasurementProtocolSecret.", "canonical": true, "file": "analytics_admin_service.get_measurement_protocol_secret.js", "language": "JAVASCRIPT", @@ -1355,14 +1355,14 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_SearchChangeHistoryEvents_async", "title": "AnalyticsAdminService searchChangeHistoryEvents Sample", "origin": "API_DEFINITION", - "description": " Searches through all changes to an account or its children given the specified set of filters.", + "description": " 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.", "canonical": true, "file": "analytics_admin_service.search_change_history_events.js", "language": "JAVASCRIPT", "segments": [ { "start": 25, - "end": 102, + "end": 106, "type": "FULL" } ], @@ -3659,7 +3659,7 @@ "regionTag": "analyticsadmin_v1alpha_generated_AnalyticsAdminService_RunAccessReport_async", "title": "AnalyticsAdminService runAccessReport Sample", "origin": "API_DEFINITION", - "description": " Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can 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 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).", + "description": " Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. 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.", "canonical": true, "file": "analytics_admin_service.run_access_report.js", "language": "JAVASCRIPT", diff --git a/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.run_access_report.js b/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.run_access_report.js index 080e108a1d5..8a6ceb3ed44 100644 --- a/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.run_access_report.js +++ b/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.run_access_report.js @@ -33,9 +33,9 @@ function main() { * level. If requested at the account level, Data Access Reports include all * 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. */ // const entity = 'abc123' /** diff --git a/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.search_change_history_events.js b/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.search_change_history_events.js index c58e2a16248..77736cae2f3 100644 --- a/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.search_change_history_events.js +++ b/packages/google-analytics-admin/samples/generated/v1beta/analytics_admin_service.search_change_history_events.js @@ -66,9 +66,13 @@ function main(account) { // const latestChangeTime = {} /** * 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. */ // const pageSize = 1234 /** diff --git a/packages/google-analytics-admin/samples/generated/v1beta/snippet_metadata_google.analytics.admin.v1beta.json b/packages/google-analytics-admin/samples/generated/v1beta/snippet_metadata_google.analytics.admin.v1beta.json index 489c68c2d8a..9e9d2409c05 100644 --- a/packages/google-analytics-admin/samples/generated/v1beta/snippet_metadata_google.analytics.admin.v1beta.json +++ b/packages/google-analytics-admin/samples/generated/v1beta/snippet_metadata_google.analytics.admin.v1beta.json @@ -55,7 +55,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_ListAccounts_async", "title": "AnalyticsAdminService listAccounts Sample", "origin": "API_DEFINITION", - "description": " Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found.", + "description": " Returns all accounts accessible by the caller. 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.", "canonical": true, "file": "analytics_admin_service.list_accounts.js", "language": "JAVASCRIPT", @@ -275,7 +275,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_GetProperty_async", "title": "AnalyticsAdminService getProperty Sample", "origin": "API_DEFINITION", - "description": " Lookup for a single \"GA4\" Property.", + "description": " Lookup for a single GA Property.", "canonical": true, "file": "analytics_admin_service.get_property.js", "language": "JAVASCRIPT", @@ -315,7 +315,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_ListProperties_async", "title": "AnalyticsAdminService listProperties Sample", "origin": "API_DEFINITION", - "description": " 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.", + "description": " Returns child Properties under the specified parent Account. 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.", "canonical": true, "file": "analytics_admin_service.list_properties.js", "language": "JAVASCRIPT", @@ -367,7 +367,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_CreateProperty_async", "title": "AnalyticsAdminService createProperty Sample", "origin": "API_DEFINITION", - "description": " Creates an \"GA4\" property with the specified location and attributes.", + "description": " Creates a Google Analytics property with the specified location and attributes.", "canonical": true, "file": "analytics_admin_service.create_property.js", "language": "JAVASCRIPT", @@ -407,7 +407,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_DeleteProperty_async", "title": "AnalyticsAdminService deleteProperty Sample", "origin": "API_DEFINITION", - "description": " Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) 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.", + "description": " Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", "canonical": true, "file": "analytics_admin_service.delete_property.js", "language": "JAVASCRIPT", @@ -839,7 +839,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_GetMeasurementProtocolSecret_async", "title": "AnalyticsAdminService getMeasurementProtocolSecret Sample", "origin": "API_DEFINITION", - "description": " Lookup for a single \"GA4\" MeasurementProtocolSecret.", + "description": " Lookup for a single MeasurementProtocolSecret.", "canonical": true, "file": "analytics_admin_service.get_measurement_protocol_secret.js", "language": "JAVASCRIPT", @@ -1099,14 +1099,14 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_SearchChangeHistoryEvents_async", "title": "AnalyticsAdminService searchChangeHistoryEvents Sample", "origin": "API_DEFINITION", - "description": " Searches through all changes to an account or its children given the specified set of filters.", + "description": " 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.", "canonical": true, "file": "analytics_admin_service.search_change_history_events.js", "language": "JAVASCRIPT", "segments": [ { "start": 25, - "end": 102, + "end": 106, "type": "FULL" } ], @@ -2335,7 +2335,7 @@ "regionTag": "analyticsadmin_v1beta_generated_AnalyticsAdminService_RunAccessReport_async", "title": "AnalyticsAdminService runAccessReport Sample", "origin": "API_DEFINITION", - "description": " Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can 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 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).", + "description": " Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. 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.", "canonical": true, "file": "analytics_admin_service.run_access_report.js", "language": "JAVASCRIPT", diff --git a/packages/google-analytics-admin/src/v1alpha/analytics_admin_service_client.ts b/packages/google-analytics-admin/src/v1alpha/analytics_admin_service_client.ts index 1fae31fe848..69e45c36a2f 100644 --- a/packages/google-analytics-admin/src/v1alpha/analytics_admin_service_client.ts +++ b/packages/google-analytics-admin/src/v1alpha/analytics_admin_service_client.ts @@ -39,7 +39,7 @@ import * as gapicConfig from './analytics_admin_service_client_config.json'; const version = require('../../../package.json').version; /** - * Service Interface for the Analytics Admin API (GA4). + * Service Interface for the Google Analytics Admin API. * @class * @memberof v1alpha */ @@ -1159,7 +1159,7 @@ export class AnalyticsAdminServiceClient { ); } /** - * Lookup for a single "GA4" Property. + * Lookup for a single GA Property. * * @param {Object} request * The request object that will be sent. @@ -1251,7 +1251,8 @@ export class AnalyticsAdminServiceClient { return this.innerApiCalls.getProperty(request, options, callback); } /** - * Creates an "GA4" property with the specified location and attributes. + * Creates a Google Analytics property with the specified location and + * attributes. * * @param {Object} request * The request object that will be sent. @@ -1348,7 +1349,7 @@ export class AnalyticsAdminServiceClient { * 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. * * @param {Object} request * The request object that will be sent. @@ -2237,7 +2238,7 @@ export class AnalyticsAdminServiceClient { ); } /** - * Lookup for a single "GA4" MeasurementProtocolSecret. + * Lookup for a single MeasurementProtocolSecret. * * @param {Object} request * The request object that will be sent. @@ -7473,13 +7474,18 @@ export class AnalyticsAdminServiceClient { * 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. + * * @param {Object} request * The request object that will be sent. * @param {string} request.entity @@ -7488,9 +7494,9 @@ export class AnalyticsAdminServiceClient { * 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. * @param {number[]} request.dimensions * The dimensions requested and displayed in the response. Requests are * allowed up to 9 dimensions. @@ -13195,7 +13201,7 @@ export class AnalyticsAdminServiceClient { /** * 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. * @@ -13583,7 +13589,6 @@ export class AnalyticsAdminServiceClient { /** * 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. @@ -14690,6 +14695,9 @@ export class AnalyticsAdminServiceClient { * 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. + * * @param {Object} request * The request object that will be sent. * @param {string} request.account @@ -14718,9 +14726,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent @@ -14848,9 +14861,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent @@ -14922,9 +14940,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent diff --git a/packages/google-analytics-admin/src/v1beta/analytics_admin_service_client.ts b/packages/google-analytics-admin/src/v1beta/analytics_admin_service_client.ts index 6718e8f7964..12aca859de9 100644 --- a/packages/google-analytics-admin/src/v1beta/analytics_admin_service_client.ts +++ b/packages/google-analytics-admin/src/v1beta/analytics_admin_service_client.ts @@ -39,7 +39,7 @@ import * as gapicConfig from './analytics_admin_service_client_config.json'; const version = require('../../../package.json').version; /** - * Service Interface for the Analytics Admin API (GA4). + * Service Interface for the Google Analytics Admin API. * @class * @memberof v1beta */ @@ -919,7 +919,7 @@ export class AnalyticsAdminServiceClient { ); } /** - * Lookup for a single "GA4" Property. + * Lookup for a single GA Property. * * @param {Object} request * The request object that will be sent. @@ -1011,7 +1011,8 @@ export class AnalyticsAdminServiceClient { return this.innerApiCalls.getProperty(request, options, callback); } /** - * Creates an "GA4" property with the specified location and attributes. + * Creates a Google Analytics property with the specified location and + * attributes. * * @param {Object} request * The request object that will be sent. @@ -1108,7 +1109,7 @@ export class AnalyticsAdminServiceClient { * 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. * * @param {Object} request * The request object that will be sent. @@ -1896,7 +1897,7 @@ export class AnalyticsAdminServiceClient { ); } /** - * Lookup for a single "GA4" MeasurementProtocolSecret. + * Lookup for a single MeasurementProtocolSecret. * * @param {Object} request * The request object that will be sent. @@ -4587,13 +4588,18 @@ export class AnalyticsAdminServiceClient { * 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. + * * @param {Object} request * The request object that will be sent. * @param {string} request.entity @@ -4602,9 +4608,9 @@ export class AnalyticsAdminServiceClient { * 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. * @param {number[]} request.dimensions * The dimensions requested and displayed in the response. Requests are * allowed up to 9 dimensions. @@ -4760,7 +4766,7 @@ export class AnalyticsAdminServiceClient { /** * 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. * @@ -5148,7 +5154,6 @@ export class AnalyticsAdminServiceClient { /** * 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. @@ -6032,6 +6037,9 @@ export class AnalyticsAdminServiceClient { * 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. + * * @param {Object} request * The request object that will be sent. * @param {string} request.account @@ -6060,9 +6068,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent @@ -6190,9 +6203,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent @@ -6264,9 +6282,14 @@ export class AnalyticsAdminServiceClient { * Optional. If set, only return changes made before this time (inclusive). * @param {number} [request.pageSize] * 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. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent