diff --git a/google/analytics/admin/v1alpha/BUILD.bazel b/google/analytics/admin/v1alpha/BUILD.bazel index fce7ab17..77a97766 100644 --- a/google/analytics/admin/v1alpha/BUILD.bazel +++ b/google/analytics/admin/v1alpha/BUILD.bazel @@ -71,6 +71,7 @@ java_gapic_library( name = "admin_java_gapic", srcs = [":admin_proto_with_info"], grpc_service_config = "admin_grpc_service_config.json", + package = "google.analytics.admin.v1alpha", test_deps = [ ":admin_java_grpc", ], @@ -82,7 +83,6 @@ java_gapic_library( java_gapic_test( name = "admin_java_gapic_test_suite", test_classes = [ - "com.google.analytics.admin.v1alpha.AnalyticsAdminServiceClientTest", ], runtime_deps = [":admin_java_gapic_test"], ) @@ -150,7 +150,6 @@ go_gapic_assembly_pkg( ############################################################################## # Python ############################################################################## - load( "@com_google_googleapis_imports//:imports.bzl", "py_gapic_assembly_pkg", diff --git a/google/analytics/admin/v1alpha/analytics_admin.proto b/google/analytics/admin/v1alpha/analytics_admin.proto index e9e986fa..c5a7308c 100644 --- a/google/analytics/admin/v1alpha/analytics_admin.proto +++ b/google/analytics/admin/v1alpha/analytics_admin.proto @@ -23,6 +23,7 @@ import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/protobuf/empty.proto"; import "google/protobuf/field_mask.proto"; +import "google/protobuf/timestamp.proto"; option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin"; option java_multiple_files = true; @@ -39,8 +40,6 @@ service AnalyticsAdminService { "https://www.googleapis.com/auth/analytics.readonly"; // Lookup for a single Account. - // Throws "Target not found" if no such account found, or if caller does not - // have permissions to access it. rpc GetAccount(GetAccountRequest) returns (Account) { option (google.api.http) = { get: "/v1alpha/{name=accounts/*}" @@ -102,9 +101,6 @@ service AnalyticsAdminService { } // Lookup for a single "GA4" Property. - // - // Throws "Target not found" if no such property found, if property is not - // of the type "GA4", or if caller does not have permissions to access it. rpc GetProperty(GetPropertyRequest) returns (Property) { option (google.api.http) = { get: "/v1alpha/{name=properties/*}" @@ -293,9 +289,6 @@ service AnalyticsAdminService { } // Lookup for a single WebDataStream - // - // Throws "Target not found" if no such web data stream found, or if the - // caller does not have permissions to access it. rpc GetWebDataStream(GetWebDataStreamRequest) returns (WebDataStream) { option (google.api.http) = { get: "/v1alpha/{name=properties/*/webDataStreams/*}" @@ -341,9 +334,6 @@ service AnalyticsAdminService { } // Lookup for a single IosAppDataStream - // - // Throws "Target not found" if no such iOS app data stream found, or if the - // caller does not have permissions to access it. rpc GetIosAppDataStream(GetIosAppDataStreamRequest) returns (IosAppDataStream) { option (google.api.http) = { get: "/v1alpha/{name=properties/*/iosAppDataStreams/*}" @@ -389,9 +379,6 @@ service AnalyticsAdminService { } // Lookup for a single AndroidAppDataStream - // - // Throws "Target not found" if no such android app data stream found, or if - // the caller does not have permissions to access it. rpc GetAndroidAppDataStream(GetAndroidAppDataStreamRequest) returns (AndroidAppDataStream) { option (google.api.http) = { get: "/v1alpha/{name=properties/*/androidAppDataStreams/*}" @@ -609,8 +596,10 @@ message UpdateAccountRequest { // The account's `name` field is used to identify the account. Account account = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for ProvisionAccountTicket RPC. @@ -694,8 +683,10 @@ message UpdatePropertyRequest { // updated. Property property = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for CreateProperty RPC. @@ -971,8 +962,10 @@ message UpdateWebDataStreamRequest { // The `name` field is used to identify the web stream to be updated. WebDataStream web_data_stream = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for CreateWebDataStream RPC. @@ -1056,8 +1049,10 @@ message UpdateIosAppDataStreamRequest { // The `name` field is used to identify the iOS app stream to be updated. IosAppDataStream ios_app_data_stream = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for CreateIosAppDataStream RPC. @@ -1141,8 +1136,10 @@ message UpdateAndroidAppDataStreamRequest { // The `name` field is used to identify the android app stream to be updated. AndroidAppDataStream android_app_data_stream = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for CreateAndroidAppDataStream RPC. @@ -1200,7 +1197,6 @@ message ListAndroidAppDataStreamsResponse { message GetEnhancedMeasurementSettingsRequest { // Required. The name of the settings to lookup. // Format: - // // properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings // Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" string name = 1 [ @@ -1217,8 +1213,10 @@ message UpdateEnhancedMeasurementSettingsRequest { // The `name` field is used to identify the settings to be updated. EnhancedMeasurementSettings enhanced_measurement_settings = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for CreateFirebaseLink RPC @@ -1241,8 +1239,10 @@ message UpdateFirebaseLinkRequest { // Required. The Firebase link to update. FirebaseLink firebase_link = 1 [(google.api.field_behavior) = REQUIRED]; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for DeleteFirebaseLink RPC @@ -1267,12 +1267,30 @@ message ListFirebaseLinksRequest { child_type: "analyticsadmin.googleapis.com/FirebaseLink" } ]; + + // The maximum number of resources to return. The service may return + // fewer than this value, even if there are additional pages. + // If unspecified, at most 50 resources will be returned. + // The maximum value is 200; (higher values will be coerced to the maximum) + int32 page_size = 2; + + // A page token, received from a previous `ListFirebaseLinks` call. + // Provide this to retrieve the subsequent page. + // When paginating, all other parameters provided to `ListProperties` must + // match the call that provided the page token. + string page_token = 3; } // Response message for ListFirebaseLinks RPC message ListFirebaseLinksResponse { // List of FirebaseLinks. This will have at most one value. repeated FirebaseLink firebase_links = 1; + + // A token, which can be sent as `page_token` to retrieve the next page. + // If this field is omitted, there are no subsequent pages. + // Currently, Google Analytics supports only one FirebaseLink per property, + // so this will never be populated. + string next_page_token = 2; } // Request message for GetGlobalSiteTag RPC. @@ -1308,8 +1326,10 @@ message UpdateGoogleAdsLinkRequest { // The GoogleAdsLink to update GoogleAdsLink google_ads_link = 1; - // The list of fields to be updated. Omitted fields will not be updated. - google.protobuf.FieldMask update_mask = 2; + // Required. The list of fields to be updated. Omitted fields will not be updated. + // To replace the entire entity, use one path with the string "*" to match + // all fields. + google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; } // Request message for DeleteGoogleAdsLink RPC. diff --git a/google/analytics/admin/v1alpha/resources.proto b/google/analytics/admin/v1alpha/resources.proto index 4830e0c3..41044dec 100644 --- a/google/analytics/admin/v1alpha/resources.proto +++ b/google/analytics/admin/v1alpha/resources.proto @@ -144,22 +144,16 @@ message Account { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this account was originally created. - google.protobuf.Timestamp create_time = 2 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when account payload fields were last updated. - google.protobuf.Timestamp update_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Human-readable display name for this account. string display_name = 4 [(google.api.field_behavior) = REQUIRED]; - // Country of business. Must be a non-deprecated code for a UN M.49 region. - // - // https: - // //unicode.org/cldr/charts/latest/supplem - // // ental/territory_containment_un_m_49.html - string country_code = 5; + // Country of business. Must be a Unicode CLDR region code. + string region_code = 5; // Output only. Indicates whether this Account is soft-deleted or not. Deleted // accounts are excluded from List results unless specifically requested. @@ -179,12 +173,10 @@ message Property { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the entity was originally created. - google.protobuf.Timestamp create_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when entity payload fields were last updated. - google.protobuf.Timestamp update_time = 4 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Resource name of this property's logical parent. // @@ -220,9 +212,8 @@ message Property { // Examples: "USD", "EUR", "JPY" string currency_code = 8; - // Output only. Indicates whether this Property is soft-deleted or not. - // Deleted properties are excluded from List results unless specifically - // requested. + // Output only. Indicates whether this Property is soft-deleted or not. Deleted properties + // are excluded from List results unless specifically requested. bool deleted = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -243,12 +234,10 @@ message AndroidAppDataStream { string firebase_app_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this stream was originally created. - google.protobuf.Timestamp create_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when stream payload fields were last updated. - google.protobuf.Timestamp update_time = 4 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. The package name for the app being measured. // Example: "com.example.myandroidapp" @@ -277,12 +266,10 @@ message IosAppDataStream { string firebase_app_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this stream was originally created. - google.protobuf.Timestamp create_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when stream payload fields were last updated. - google.protobuf.Timestamp update_time = 4 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Immutable. The Apple App Store Bundle ID for the app // Example: "com.example.myiosapp" @@ -318,12 +305,10 @@ message WebDataStream { string firebase_app_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this stream was originally created. - google.protobuf.Timestamp create_time = 4 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when stream payload fields were last updated. - google.protobuf.Timestamp update_time = 5 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. Domain name of the web app being measured, or empty. // Example: "http://www.google.com", "https://www.google.com" @@ -399,7 +384,6 @@ message EnhancedMeasurementSettings { // Output only. Resource name of this Data Stream. // Format: - // // properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings // Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -411,8 +395,8 @@ message EnhancedMeasurementSettings { // whether they are respected. bool stream_enabled = 2; - // Output only. If enabled, capture a page view event each time a page loads - // or the website changes the browser history state. + // Output only. If enabled, capture a page view event each time a page loads or the + // website changes the browser history state. bool page_views_enabled = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // If enabled, capture scroll events each time a visitor gets to the bottom of @@ -423,18 +407,10 @@ message EnhancedMeasurementSettings { // link that leads them away from your domain. bool outbound_clicks_enabled = 5; - // Capture events when your visitors view content on your site that has - // structured data (eg, articles, blog posts, product details screens, etc.). - bool content_views_enabled = 6; - // If enabled, capture a view search results event each time a visitor // performs a search on your site (based on a query parameter). bool site_search_enabled = 7; - // If enabled, capture a view search results event each time a visitor - // interacts with a form on your site. - bool form_interactions_enabled = 8; - // If enabled, capture video play, progress, and complete events as visitors // view embedded videos on your site. bool video_engagement_enabled = 9; @@ -443,35 +419,20 @@ message EnhancedMeasurementSettings { // a common document, compressed file, application, video, or audio extension. bool file_downloads_enabled = 10; - // If enabled, capture a click event each time a visitor clicks a link or - // element that has data attributes beginning with "data-ga". - bool data_tagged_element_clicks_enabled = 11; - - // If enabled, capture a page view event each time a page loads. - bool page_loads_enabled = 12; + // Output only. If enabled, capture a page view event each time a page loads. + bool page_loads_enabled = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // If enabled, capture a page view event each time the website changes the // browser history state. bool page_changes_enabled = 13; - // Capture events when your visitors view content on your site that has - // articles or blog posts. - bool articles_and_blogs_enabled = 14; - - // Capture events when your visitors view content on your site that has - // product details screens, etc. - bool products_and_ecommerce_enabled = 15; - // Required. URL query parameters to interpret as site search parameters. // Max length is 1024 characters. Must not be empty. string search_query_parameter = 16 [(google.api.field_behavior) = REQUIRED]; // Additional URL query parameters. // Max length is 1024 characters. - string url_query_parameter = 17; - - // Domains to exclude from measurement. Max length is 1024 characters. - string excluded_domains = 18; + string uri_query_parameter = 17; } // A link between an GA4 property and a Firebase project. @@ -484,9 +445,9 @@ message FirebaseLink { // Output only. Example format: properties/1234/firebaseLinks/5678 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. Firebase project resource name. When creating a FirebaseLink, - // you may provide this resource name using either a project number or project - // ID. Once this resource has been created, returned FirebaseLinks will always + // Immutable. Firebase project resource name. When creating a FirebaseLink, you may + // provide this resource name using either a project number or project ID. + // Once this resource has been created, returned FirebaseLinks will always // have a project_name that contains a project number. // // Format: 'projects/{project number}' @@ -494,8 +455,7 @@ message FirebaseLink { string project = 2 [(google.api.field_behavior) = IMMUTABLE]; // Output only. Time when this FirebaseLink was originally created. - google.protobuf.Timestamp create_time = 3 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Maximum user access to the GA4 property allowed to admins of // the linked Firebase project. @@ -510,12 +470,13 @@ message GlobalSiteTag { pattern: "properties/{property}/globalSiteTag" }; - // Immutable. JavaScript code snippet to be pasted as the first item into the - // head tag of every webpage to measure. - string snippet = 1 [(google.api.field_behavior) = IMMUTABLE]; + // Output only. Resource name for this GlobalSiteTag resource. + // Format: properties/{propertyId}/globalSiteTag + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // The resource name of this tag. - string name = 2; + // Immutable. JavaScript code snippet to be pasted as the first item into the head tag of + // every webpage to measure. + string snippet = 2 [(google.api.field_behavior) = IMMUTABLE]; } // A link between an GA4 property and a Google Ads account. @@ -525,15 +486,11 @@ message GoogleAdsLink { pattern: "properties/{property}/googleAdsLinks/{google_ads_link}" }; - // Output only. Format: - // properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} + // Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} // // Note: googleAdsLinkId is not the Google Ads customer ID. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. Format: properties/{propertyId} - string parent = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Google Ads customer ID. string customer_id = 3 [(google.api.field_behavior) = IMMUTABLE]; @@ -551,12 +508,10 @@ message GoogleAdsLink { string email_address = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this link was originally created. - google.protobuf.Timestamp create_time = 7 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when this link was last updated. - google.protobuf.Timestamp update_time = 8 - [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; } // A resource message representing data sharing settings of a Google Analytics @@ -609,8 +564,8 @@ message AccountSummary { // Format: accounts/{account_id} // Example: "accounts/1000" string account = 2 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - }]; + type: "analyticsadmin.googleapis.com/Account" + }]; // Display name for the account referred to in this account summary. string display_name = 3; @@ -625,8 +580,8 @@ message PropertySummary { // Format: properties/{property_id} // Example: "properties/1000" string property = 1 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - }]; + type: "analyticsadmin.googleapis.com/Property" + }]; // Display name for the property referred to in this account summary. string display_name = 2;