diff options
Diffstat (limited to 'third_party/googleapis/google/analytics')
26 files changed, 0 insertions, 12033 deletions
diff --git a/third_party/googleapis/google/analytics/admin/BUILD.bazel b/third_party/googleapis/google/analytics/admin/BUILD.bazel deleted file mode 100644 index 7d08fc5..0000000 --- a/third_party/googleapis/google/analytics/admin/BUILD.bazel +++ /dev/null @@ -1,39 +0,0 @@ -# This build file includes a target for the Ruby wrapper library for -# google-analytics-admin. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -# Export yaml configs. -exports_files(glob(["*.yaml"])) - -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", -) - -# Generates a Ruby wrapper client for analyticsadmin. -# Ruby wrapper clients are versionless, but are generated from source protos -# for a particular service version, v1alpha in this case. -ruby_cloud_gapic_library( - name = "analyticsadmin_ruby_wrapper", - srcs = ["//google/analytics/admin/v1alpha:admin_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-analytics-admin", - "ruby-cloud-env-prefix=ANALYTICS_ADMIN", - "ruby-cloud-wrapper-of=v1alpha:0.0", - "ruby-cloud-api-id=analyticsadmin.googleapis.com", - "ruby-cloud-api-shortname=analyticsadmin", - ], - ruby_cloud_description = "The Analytics Admin API allows for programmatic access to the Google Analytics App+Web configuration data. You can use the Google Analytics Admin API to manage accounts and App+Web properties.", - ruby_cloud_title = "Google Analytics Admin", -) - -# Open Source package. -ruby_gapic_assembly_pkg( - name = "google-analytics-admin-ruby", - deps = [ - ":analyticsadmin_ruby_wrapper", - ], -) diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel b/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel deleted file mode 100644 index 47c65d6..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/BUILD.bazel +++ /dev/null @@ -1,387 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "admin_proto", - srcs = [ - "access_report.proto", - "analytics_admin.proto", - "audience.proto", - "resources.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "//google/api:field_behavior_proto", - "//google/api:resource_proto", - "@com_google_protobuf//:duration_proto", - "@com_google_protobuf//:empty_proto", - "@com_google_protobuf//:field_mask_proto", - "@com_google_protobuf//:timestamp_proto", - "@com_google_protobuf//:wrappers_proto", - ], -) - -proto_library_with_info( - name = "admin_proto_with_info", - deps = [ - ":admin_proto", - "//google/cloud:common_resources_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "admin_java_proto", - deps = [":admin_proto"], -) - -java_grpc_library( - name = "admin_java_grpc", - srcs = [":admin_proto"], - deps = [":admin_java_proto"], -) - -java_gapic_library( - name = "admin_java_gapic", - srcs = [":admin_proto_with_info"], - gapic_yaml = "analyticsadmin_gapic.yaml", - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin_v1alpha.yaml", - test_deps = [ - ":admin_java_grpc", - ], - transport = "grpc+rest", - deps = [ - ":admin_java_proto", - "//google/api:api_java_proto", - ], -) - -java_gapic_test( - name = "admin_java_gapic_test_suite", - test_classes = [ - "com.google.analytics.admin.v1alpha.AnalyticsAdminServiceClientHttpJsonTest", - "com.google.analytics.admin.v1alpha.AnalyticsAdminServiceClientTest", - ], - runtime_deps = [":admin_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-analytics-admin-v1alpha-java", - include_samples = True, - transport = "grpc+rest", - deps = [ - ":admin_java_gapic", - ":admin_java_grpc", - ":admin_java_proto", - ":admin_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "admin_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha", - protos = [":admin_proto"], - deps = [ - "//google/api:annotations_go_proto", - ], -) - -go_gapic_library( - name = "admin_go_gapic", - srcs = [":admin_proto_with_info"], - grpc_service_config = "admin_grpc_service_config.json", - importpath = "google.golang.org/google/analytics/admin/v1alpha;admin", - metadata = True, - service_yaml = "analyticsadmin_v1alpha.yaml", - transport = "grpc+rest", - deps = [ - ":admin_go_proto", - "@io_bazel_rules_go//proto/wkt:duration_go_proto", - ], -) - -go_test( - name = "admin_go_gapic_test", - srcs = [":admin_go_gapic_srcjar_test"], - embed = [":admin_go_gapic"], - importpath = "google.golang.org/google/analytics/admin/v1alpha", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-analytics-admin-v1alpha-go", - deps = [ - ":admin_go_gapic", - ":admin_go_gapic_srcjar-metadata.srcjar", - ":admin_go_gapic_srcjar-test.srcjar", - ":admin_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "admin_py_gapic", - srcs = [":admin_proto"], - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin_v1alpha.yaml", - transport = "grpc+rest", - deps = [ - ], -) - -py_test( - name = "admin_py_gapic_test", - srcs = [ - "admin_py_gapic_pytest.py", - "admin_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":admin_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "google-analytics-admin-v1alpha-py", - deps = [ - ":admin_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "admin_php_proto", - deps = [":admin_proto"], -) - -php_grpc_library( - name = "admin_php_grpc", - srcs = [":admin_proto"], - deps = [":admin_php_proto"], -) - -php_gapic_library( - name = "admin_php_gapic", - srcs = [":admin_proto_with_info"], - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin_v1alpha.yaml", - deps = [ - ":admin_php_grpc", - ":admin_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-analytics-admin-v1alpha-php", - deps = [ - ":admin_php_gapic", - ":admin_php_grpc", - ":admin_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "admin_nodejs_gapic", - package_name = "@google-analytics/admin", - src = ":admin_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "admin_grpc_service_config.json", - package = "google.analytics.admin.v1alpha", - service_yaml = "analyticsadmin_v1alpha.yaml", - deps = [], -) - -nodejs_gapic_assembly_pkg( - name = "google-analytics-admin-v1alpha-nodejs", - deps = [ - ":admin_nodejs_gapic", - ":admin_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "admin_ruby_proto", - deps = [":admin_proto"], -) - -ruby_grpc_library( - name = "admin_ruby_grpc", - srcs = [":admin_proto"], - deps = [":admin_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "admin_ruby_gapic", - srcs = [":admin_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-api-id=analyticsadmin.googleapis.com", - "ruby-cloud-api-shortname=analyticsadmin", - "ruby-cloud-env-prefix=ANALYTICS_ADMIN", - "ruby-cloud-gem-name=google-analytics-admin-v1alpha", - ], - grpc_service_config = "admin_grpc_service_config.json", - ruby_cloud_description = "The Analytics Admin API allows for programmatic access to the Google Analytics App+Web configuration data. You can use the Google Analytics Admin API to manage accounts and App+Web properties.", - ruby_cloud_title = "Google Analytics Admin V1alpha", - service_yaml = "analyticsadmin_v1alpha.yaml", - deps = [ - ":admin_ruby_grpc", - ":admin_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-analytics-admin-v1alpha-ruby", - deps = [ - ":admin_ruby_gapic", - ":admin_ruby_grpc", - ":admin_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "admin_csharp_proto", - deps = [":admin_proto"], -) - -csharp_grpc_library( - name = "admin_csharp_grpc", - srcs = [":admin_proto"], - deps = [":admin_csharp_proto"], -) - -csharp_gapic_library( - name = "admin_csharp_gapic", - srcs = [":admin_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin_v1alpha.yaml", - deps = [ - ":admin_csharp_grpc", - ":admin_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-analytics-admin-v1alpha-csharp", - deps = [ - ":admin_csharp_gapic", - ":admin_csharp_grpc", - ":admin_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "admin_cc_proto", - deps = [":admin_proto"], -) - -cc_grpc_library( - name = "admin_cc_grpc", - srcs = [":admin_proto"], - grpc_only = True, - deps = [":admin_cc_proto"], -) diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto b/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto deleted file mode 100644 index ce6a8aa..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/access_report.proto +++ /dev/null @@ -1,328 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1alpha; - -option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin"; -option java_multiple_files = true; -option java_outer_classname = "AccessReportProto"; -option java_package = "com.google.analytics.admin.v1alpha"; - -// Dimensions are attributes of your data. For example, the dimension -// `userEmail` indicates the email of the user that accessed reporting data. -// Dimension values in report responses are strings. -message AccessDimension { - // The API name of the dimension. See [Data Access - // Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) - // for the list of dimensions supported in this API. - // - // Dimensions are referenced by name in `dimensionFilter` and `orderBys`. - string dimension_name = 1; -} - -// The quantitative measurements of a report. For example, the metric -// `accessCount` is the total number of data access records. -message AccessMetric { - // The API name of the metric. See [Data Access - // Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) - // for the list of metrics supported in this API. - // - // Metrics are referenced by name in `metricFilter` & `orderBys`. - string metric_name = 1; -} - -// A contiguous range of days: startDate, startDate + 1, ..., endDate. -message AccessDateRange { - // The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot - // be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also - // accepted, and in that case, the date is inferred based on the current time - // in the request's time zone. - string start_date = 1; - - // The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot - // be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is - // also accepted, and in that case, the date is inferred based on the current - // time in the request's time zone. - string end_date = 2; -} - -// Expresses dimension or metric filters. The fields in the same expression need -// to be either all dimensions or all metrics. -message AccessFilterExpression { - // Specify one type of filter expression for `FilterExpression`. - oneof one_expression { - // Each of the FilterExpressions in the and_group has an AND relationship. - AccessFilterExpressionList and_group = 1; - - // Each of the FilterExpressions in the or_group has an OR relationship. - AccessFilterExpressionList or_group = 2; - - // The FilterExpression is NOT of not_expression. - AccessFilterExpression not_expression = 3; - - // A primitive filter. In the same FilterExpression, all of the filter's - // field names need to be either all dimensions or all metrics. - AccessFilter access_filter = 4; - } -} - -// A list of filter expressions. -message AccessFilterExpressionList { - // A list of filter expressions. - repeated AccessFilterExpression expressions = 1; -} - -// An expression to filter dimension or metric values. -message AccessFilter { - // Specify one type of filter for `Filter`. - oneof one_filter { - // Strings related filter. - AccessStringFilter string_filter = 2; - - // A filter for in list values. - AccessInListFilter in_list_filter = 3; - - // A filter for numeric or date values. - AccessNumericFilter numeric_filter = 4; - - // A filter for two values. - AccessBetweenFilter between_filter = 5; - } - - // The dimension name or metric name. - string field_name = 1; -} - -// The filter for strings. -message AccessStringFilter { - // The match type of a string filter. - enum MatchType { - // Unspecified - MATCH_TYPE_UNSPECIFIED = 0; - - // Exact match of the string value. - EXACT = 1; - - // Begins with the string value. - BEGINS_WITH = 2; - - // Ends with the string value. - ENDS_WITH = 3; - - // Contains the string value. - CONTAINS = 4; - - // Full match for the regular expression with the string value. - FULL_REGEXP = 5; - - // Partial match for the regular expression with the string value. - PARTIAL_REGEXP = 6; - } - - // The match type for this filter. - MatchType match_type = 1; - - // The string value used for the matching. - string value = 2; - - // If true, the string value is case sensitive. - bool case_sensitive = 3; -} - -// The result needs to be in a list of string values. -message AccessInListFilter { - // The list of string values. Must be non-empty. - repeated string values = 1; - - // If true, the string value is case sensitive. - bool case_sensitive = 2; -} - -// Filters for numeric or date values. -message AccessNumericFilter { - // The operation applied to a numeric filter. - enum Operation { - // Unspecified. - OPERATION_UNSPECIFIED = 0; - - // Equal - EQUAL = 1; - - // Less than - LESS_THAN = 2; - - // Less than or equal - LESS_THAN_OR_EQUAL = 3; - - // Greater than - GREATER_THAN = 4; - - // Greater than or equal - GREATER_THAN_OR_EQUAL = 5; - } - - // The operation type for this filter. - Operation operation = 1; - - // A numeric value or a date value. - NumericValue value = 2; -} - -// To express that the result needs to be between two numbers (inclusive). -message AccessBetweenFilter { - // Begins with this number. - NumericValue from_value = 1; - - // Ends with this number. - NumericValue to_value = 2; -} - -// To represent a number. -message NumericValue { - // One of a numeric value - oneof one_value { - // Integer value - int64 int64_value = 1; - - // Double value - double double_value = 2; - } -} - -// Order bys define how rows will be sorted in the response. For example, -// ordering rows by descending access count is one ordering, and ordering rows -// by the country string is a different ordering. -message AccessOrderBy { - // Sorts by metric values. - message MetricOrderBy { - // A metric name in the request to order by. - string metric_name = 1; - } - - // Sorts by dimension values. - message DimensionOrderBy { - // Rule to order the string dimension values by. - enum OrderType { - // Unspecified. - ORDER_TYPE_UNSPECIFIED = 0; - - // Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < - // "b" < "z". - ALPHANUMERIC = 1; - - // Case insensitive alphanumeric sort by lower case Unicode code point. - // For example, "2" < "A" < "b" < "X" < "z". - CASE_INSENSITIVE_ALPHANUMERIC = 2; - - // Dimension values are converted to numbers before sorting. For example - // in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" < - // "25". Non-numeric dimension values all have equal ordering value below - // all numeric values. - NUMERIC = 3; - } - - // A dimension name in the request to order by. - string dimension_name = 1; - - // Controls the rule for dimension value ordering. - OrderType order_type = 2; - } - - // Specify one type of order by for `OrderBy`. - oneof one_order_by { - // Sorts results by a metric's values. - MetricOrderBy metric = 1; - - // Sorts results by a dimension's values. - DimensionOrderBy dimension = 2; - } - - // If true, sorts by descending order. If false or unspecified, sorts in - // ascending order. - bool desc = 3; -} - -// Describes a dimension column in the report. Dimensions requested in a report -// produce column entries within rows and DimensionHeaders. However, dimensions -// used exclusively within filters or expressions do not produce columns in a -// report; correspondingly, those dimensions do not produce headers. -message AccessDimensionHeader { - // The dimension's name; for example 'userEmail'. - string dimension_name = 1; -} - -// Describes a metric column in the report. Visible metrics requested in a -// report produce column entries within rows and MetricHeaders. However, -// metrics used exclusively within filters or expressions do not produce columns -// in a report; correspondingly, those metrics do not produce headers. -message AccessMetricHeader { - // The metric's name; for example 'accessCount'. - string metric_name = 1; -} - -// Access report data for each row. -message AccessRow { - // List of dimension values. These values are in the same order as specified - // in the request. - repeated AccessDimensionValue dimension_values = 1; - - // List of metric values. These values are in the same order as specified - // in the request. - repeated AccessMetricValue metric_values = 2; -} - -// The value of a dimension. -message AccessDimensionValue { - // The dimension value. For example, this value may be 'France' for the - // 'country' dimension. - string value = 1; -} - -// The value of a metric. -message AccessMetricValue { - // The measurement value. For example, this value may be '13'. - string value = 1; -} - -// Current state of all quotas for this Analytics property. If any quota for a -// property is exhausted, all requests to that property will return Resource -// Exhausted errors. -message AccessQuota { - // Properties can use 250,000 tokens per day. Most requests consume fewer than - // 10 tokens. - AccessQuotaStatus tokens_per_day = 1; - - // Properties can use 50,000 tokens per hour. An API request consumes a single - // number of tokens, and that number is deducted from both the hourly and - // daily quotas. - AccessQuotaStatus tokens_per_hour = 2; - - // Properties can use up to 50 concurrent requests. - AccessQuotaStatus concurrent_requests = 3; - - // Properties and cloud project pairs can have up to 50 server errors per - // hour. - AccessQuotaStatus server_errors_per_project_per_hour = 4; -} - -// Current state for a particular quota group. -message AccessQuotaStatus { - // Quota consumed by this request. - int32 consumed = 1; - - // Quota remaining after this request. - int32 remaining = 2; -} diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json b/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json deleted file mode 100644 index 7b40cde..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/admin_grpc_service_config.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "methodConfig": [ - { - "name": [{"service": "google.analytics.admin.v1alpha.AnalyticsAdminService"}], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "1s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": ["UNAVAILABLE", "UNKNOWN"] - } - } - ] -} diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto b/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto deleted file mode 100644 index 926f91b..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/analytics_admin.proto +++ /dev/null @@ -1,2333 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1alpha; - -import "google/analytics/admin/v1alpha/access_report.proto"; -import "google/analytics/admin/v1alpha/audience.proto"; -import "google/analytics/admin/v1alpha/resources.proto"; -import "google/api/annotations.proto"; -import "google/api/client.proto"; -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; -option java_outer_classname = "AnalyticsAdminProto"; -option java_package = "com.google.analytics.admin.v1alpha"; - -// Service Interface for the Analytics Admin API (GA4). -service AnalyticsAdminService { - option (google.api.default_host) = "analyticsadmin.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/analytics.edit," - "https://www.googleapis.com/auth/analytics.manage.users," - "https://www.googleapis.com/auth/analytics.manage.users.readonly," - "https://www.googleapis.com/auth/analytics.readonly"; - - // Lookup for a single Account. - rpc GetAccount(GetAccountRequest) returns (Account) { - option (google.api.http) = { - get: "/v1alpha/{name=accounts/*}" - }; - option (google.api.method_signature) = "name"; - } - - // 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. - rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) { - option (google.api.http) = { - get: "/v1alpha/accounts" - }; - } - - // Marks target Account as soft-deleted (ie: "trashed") and returns it. - // - // This API does not have a method to restore soft-deleted accounts. - // However, they can be restored using the Trash Can UI. - // - // If the accounts are not restored before the expiration time, the account - // and all child resources (eg: Properties, GoogleAdsLinks, Streams, - // UserLinks) will be permanently purged. - // https://support.google.com/analytics/answer/6154772 - // - // Returns an error if the target is not found. - rpc DeleteAccount(DeleteAccountRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=accounts/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates an account. - rpc UpdateAccount(UpdateAccountRequest) returns (Account) { - option (google.api.http) = { - patch: "/v1alpha/{account.name=accounts/*}" - body: "account" - }; - option (google.api.method_signature) = "account,update_mask"; - } - - // Requests a ticket for creating an account. - rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse) { - option (google.api.http) = { - post: "/v1alpha/accounts:provisionAccountTicket" - body: "*" - }; - } - - // Returns summaries of all accounts accessible by the caller. - rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) { - option (google.api.http) = { - get: "/v1alpha/accountSummaries" - }; - } - - // Lookup for a single "GA4" Property. - rpc GetProperty(GetPropertyRequest) returns (Property) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*}" - }; - option (google.api.method_signature) = "name"; - } - - // 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. - rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse) { - option (google.api.http) = { - get: "/v1alpha/properties" - }; - } - - // Creates an "GA4" property with the specified location and attributes. - rpc CreateProperty(CreatePropertyRequest) returns (Property) { - option (google.api.http) = { - post: "/v1alpha/properties" - body: "property" - }; - option (google.api.method_signature) = "property"; - } - - // 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, UserLinks) - // will be permanently purged. - // https://support.google.com/analytics/answer/6154772 - // - // Returns an error if the target is not found, or is not an GA4 Property. - rpc DeleteProperty(DeletePropertyRequest) returns (Property) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a property. - rpc UpdateProperty(UpdatePropertyRequest) returns (Property) { - option (google.api.http) = { - patch: "/v1alpha/{property.name=properties/*}" - body: "property" - }; - option (google.api.method_signature) = "property,update_mask"; - } - - // Gets information about a user's link to an account or property. - rpc GetUserLink(GetUserLinkRequest) returns (UserLink) { - option (google.api.http) = { - get: "/v1alpha/{name=accounts/*/userLinks/*}" - additional_bindings { - get: "/v1alpha/{name=properties/*/userLinks/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Gets information about multiple users' links to an account or property. - rpc BatchGetUserLinks(BatchGetUserLinksRequest) returns (BatchGetUserLinksResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=accounts/*}/userLinks:batchGet" - additional_bindings { - get: "/v1alpha/{parent=properties/*}/userLinks:batchGet" - } - }; - } - - // Lists all user links on an account or property. - rpc ListUserLinks(ListUserLinksRequest) returns (ListUserLinksResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=accounts/*}/userLinks" - additional_bindings { - get: "/v1alpha/{parent=properties/*}/userLinks" - } - }; - option (google.api.method_signature) = "parent"; - } - - // Lists all user links on an account or property, including implicit ones - // that come from effective permissions granted by groups or organization - // admin roles. - // - // If a returned user link does not have direct permissions, they cannot - // be removed from the account or property directly with the DeleteUserLink - // command. They have to be removed from the group/etc that gives them - // permissions, which is currently only usable/discoverable in the GA or GMP - // UIs. - rpc AuditUserLinks(AuditUserLinksRequest) returns (AuditUserLinksResponse) { - option (google.api.http) = { - post: "/v1alpha/{parent=accounts/*}/userLinks:audit" - body: "*" - additional_bindings { - post: "/v1alpha/{parent=properties/*}/userLinks:audit" - body: "*" - } - }; - } - - // Creates a user link on an account or property. - // - // If the user with the specified email already has permissions on the - // account or property, then the user's existing permissions will be unioned - // with the permissions specified in the new UserLink. - rpc CreateUserLink(CreateUserLinkRequest) returns (UserLink) { - option (google.api.http) = { - post: "/v1alpha/{parent=accounts/*}/userLinks" - body: "user_link" - additional_bindings { - post: "/v1alpha/{parent=properties/*}/userLinks" - body: "user_link" - } - }; - option (google.api.method_signature) = "parent,user_link"; - } - - // Creates information about multiple users' links to an account or property. - // - // This method is transactional. If any UserLink cannot be created, none of - // the UserLinks will be created. - rpc BatchCreateUserLinks(BatchCreateUserLinksRequest) returns (BatchCreateUserLinksResponse) { - option (google.api.http) = { - post: "/v1alpha/{parent=accounts/*}/userLinks:batchCreate" - body: "*" - additional_bindings { - post: "/v1alpha/{parent=properties/*}/userLinks:batchCreate" - body: "*" - } - }; - } - - // Updates a user link on an account or property. - rpc UpdateUserLink(UpdateUserLinkRequest) returns (UserLink) { - option (google.api.http) = { - patch: "/v1alpha/{user_link.name=accounts/*/userLinks/*}" - body: "user_link" - additional_bindings { - patch: "/v1alpha/{user_link.name=properties/*/userLinks/*}" - body: "user_link" - } - }; - option (google.api.method_signature) = "user_link"; - } - - // Updates information about multiple users' links to an account or property. - rpc BatchUpdateUserLinks(BatchUpdateUserLinksRequest) returns (BatchUpdateUserLinksResponse) { - option (google.api.http) = { - post: "/v1alpha/{parent=accounts/*}/userLinks:batchUpdate" - body: "*" - additional_bindings { - post: "/v1alpha/{parent=properties/*}/userLinks:batchUpdate" - body: "*" - } - }; - } - - // Deletes a user link on an account or property. - rpc DeleteUserLink(DeleteUserLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=accounts/*/userLinks/*}" - additional_bindings { - delete: "/v1alpha/{name=properties/*/userLinks/*}" - } - }; - option (google.api.method_signature) = "name"; - } - - // Deletes information about multiple users' links to an account or property. - rpc BatchDeleteUserLinks(BatchDeleteUserLinksRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1alpha/{parent=accounts/*}/userLinks:batchDelete" - body: "*" - additional_bindings { - post: "/v1alpha/{parent=properties/*}/userLinks:batchDelete" - body: "*" - } - }; - } - - // Creates a FirebaseLink. - // - // Properties can have at most one FirebaseLink. - rpc CreateFirebaseLink(CreateFirebaseLinkRequest) returns (FirebaseLink) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/firebaseLinks" - body: "firebase_link" - }; - option (google.api.method_signature) = "parent,firebase_link"; - } - - // Deletes a FirebaseLink on a property - rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/firebaseLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists FirebaseLinks on a property. - // Properties can have at most one FirebaseLink. - rpc ListFirebaseLinks(ListFirebaseLinksRequest) returns (ListFirebaseLinksResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/firebaseLinks" - }; - option (google.api.method_signature) = "parent"; - } - - // Returns the Site Tag for the specified web stream. - // Site Tags are immutable singletons. - rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a GoogleAdsLink. - rpc CreateGoogleAdsLink(CreateGoogleAdsLinkRequest) returns (GoogleAdsLink) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/googleAdsLinks" - body: "google_ads_link" - }; - option (google.api.method_signature) = "parent,google_ads_link"; - } - - // Updates a GoogleAdsLink on a property - rpc UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest) returns (GoogleAdsLink) { - option (google.api.http) = { - patch: "/v1alpha/{google_ads_link.name=properties/*/googleAdsLinks/*}" - body: "google_ads_link" - }; - option (google.api.method_signature) = "google_ads_link,update_mask"; - } - - // Deletes a GoogleAdsLink on a property - rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/googleAdsLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists GoogleAdsLinks on a property. - rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest) returns (ListGoogleAdsLinksResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/googleAdsLinks" - }; - option (google.api.method_signature) = "parent"; - } - - // Get data sharing settings on an account. - // Data sharing settings are singletons. - rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings) { - option (google.api.http) = { - get: "/v1alpha/{name=accounts/*/dataSharingSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single "GA4" MeasurementProtocolSecret. - rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns child MeasurementProtocolSecrets under the specified parent - // Property. - rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a measurement protocol secret. - rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" - body: "measurement_protocol_secret" - }; - option (google.api.method_signature) = "parent,measurement_protocol_secret"; - } - - // Deletes target MeasurementProtocolSecret. - rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a measurement protocol secret. - rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - patch: "/v1alpha/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - body: "measurement_protocol_secret" - }; - option (google.api.method_signature) = "measurement_protocol_secret,update_mask"; - } - - // Acknowledges the terms of user data collection for the specified property. - // - // This acknowledgement must be completed (either in the Google Analytics UI - // or via this API) before MeasurementProtocolSecret resources may be created. - rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse) { - option (google.api.http) = { - post: "/v1alpha/{property=properties/*}:acknowledgeUserDataCollection" - body: "*" - }; - } - - // Searches through all changes to an account or its children given the - // specified set of filters. - rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse) { - option (google.api.http) = { - post: "/v1alpha/{account=accounts/*}:searchChangeHistoryEvents" - body: "*" - }; - } - - // Lookup for Google Signals settings for a property. - rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/googleSignalsSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates Google Signals settings for a property. - rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings) { - option (google.api.http) = { - patch: "/v1alpha/{google_signals_settings.name=properties/*/googleSignalsSettings}" - body: "google_signals_settings" - }; - option (google.api.method_signature) = "google_signals_settings,update_mask"; - } - - // Creates a conversion event with the specified attributes. - rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/conversionEvents" - body: "conversion_event" - }; - option (google.api.method_signature) = "parent,conversion_event"; - } - - // Retrieve a single conversion event. - rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/conversionEvents/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes a conversion event in a property. - rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/conversionEvents/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns a list of conversion events in the specified parent property. - // - // Returns an empty list if no conversion events are found. - rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/conversionEvents" - }; - option (google.api.method_signature) = "parent"; - } - - // Look up a single DisplayVideo360AdvertiserLink - rpc GetDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists all DisplayVideo360AdvertiserLinks on a property. - rpc ListDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest) returns (ListDisplayVideo360AdvertiserLinksResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a DisplayVideo360AdvertiserLink. - // This can only be utilized by users who have proper authorization both on - // the Google Analytics property and on the Display & Video 360 advertiser. - // Users who do not have access to the Display & Video 360 advertiser should - // instead seek to create a DisplayVideo360LinkProposal. - rpc CreateDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinks" - body: "display_video_360_advertiser_link" - }; - option (google.api.method_signature) = "parent,display_video_360_advertiser_link"; - } - - // Deletes a DisplayVideo360AdvertiserLink on a property. - rpc DeleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a DisplayVideo360AdvertiserLink on a property. - rpc UpdateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest) returns (DisplayVideo360AdvertiserLink) { - option (google.api.http) = { - patch: "/v1alpha/{display_video_360_advertiser_link.name=properties/*/displayVideo360AdvertiserLinks/*}" - body: "display_video_360_advertiser_link" - }; - option (google.api.method_signature) = "display_video_360_advertiser_link,update_mask"; - } - - // Lookup for a single DisplayVideo360AdvertiserLinkProposal. - rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists DisplayVideo360AdvertiserLinkProposals on a property. - rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a DisplayVideo360AdvertiserLinkProposal. - rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals" - body: "display_video_360_advertiser_link_proposal" - }; - option (google.api.method_signature) = "parent,display_video_360_advertiser_link_proposal"; - } - - // Deletes a DisplayVideo360AdvertiserLinkProposal on a property. - // This can only be used on cancelled proposals. - rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Approves a DisplayVideo360AdvertiserLinkProposal. - // The DisplayVideo360AdvertiserLinkProposal will be deleted and a new - // DisplayVideo360AdvertiserLink will be created. - rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse) { - option (google.api.http) = { - post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve" - body: "*" - }; - } - - // Cancels a DisplayVideo360AdvertiserLinkProposal. - // Cancelling can mean either: - // - Declining a proposal initiated from Display & Video 360 - // - Withdrawing a proposal initiated from Google Analytics - // After being cancelled, a proposal will eventually be deleted automatically. - rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal) { - option (google.api.http) = { - post: "/v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel" - body: "*" - }; - } - - // Creates a CustomDimension. - rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/customDimensions" - body: "custom_dimension" - }; - option (google.api.method_signature) = "parent,custom_dimension"; - } - - // Updates a CustomDimension on a property. - rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - patch: "/v1alpha/{custom_dimension.name=properties/*/customDimensions/*}" - body: "custom_dimension" - }; - option (google.api.method_signature) = "custom_dimension,update_mask"; - } - - // Lists CustomDimensions on a property. - rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/customDimensions" - }; - option (google.api.method_signature) = "parent"; - } - - // Archives a CustomDimension on a property. - rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1alpha/{name=properties/*/customDimensions/*}:archive" - body: "*" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single CustomDimension. - rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/customDimensions/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a CustomMetric. - rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/customMetrics" - body: "custom_metric" - }; - option (google.api.method_signature) = "parent,custom_metric"; - } - - // Updates a CustomMetric on a property. - rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - patch: "/v1alpha/{custom_metric.name=properties/*/customMetrics/*}" - body: "custom_metric" - }; - option (google.api.method_signature) = "custom_metric,update_mask"; - } - - // Lists CustomMetrics on a property. - rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/customMetrics" - }; - option (google.api.method_signature) = "parent"; - } - - // Archives a CustomMetric on a property. - rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1alpha/{name=properties/*/customMetrics/*}:archive" - body: "*" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single CustomMetric. - rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/customMetrics/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns the singleton data retention settings for this property. - rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/dataRetentionSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates the singleton data retention settings for this property. - rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings) { - option (google.api.http) = { - patch: "/v1alpha/{data_retention_settings.name=properties/*/dataRetentionSettings}" - body: "data_retention_settings" - }; - option (google.api.method_signature) = "data_retention_settings,update_mask"; - } - - // Creates a DataStream. - rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/dataStreams" - body: "data_stream" - }; - option (google.api.method_signature) = "parent,data_stream"; - } - - // Deletes a DataStream on a property. - rpc DeleteDataStream(DeleteDataStreamRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1alpha/{name=properties/*/dataStreams/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a DataStream on a property. - rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - patch: "/v1alpha/{data_stream.name=properties/*/dataStreams/*}" - body: "data_stream" - }; - option (google.api.method_signature) = "data_stream,update_mask"; - } - - // Lists DataStreams on a property. - rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/dataStreams" - }; - option (google.api.method_signature) = "parent"; - } - - // Lookup for a single DataStream. - rpc GetDataStream(GetDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/dataStreams/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single Audience. - // Audiences created before 2020 may not be supported. - rpc GetAudience(GetAudienceRequest) returns (Audience) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/audiences/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists Audiences on a property. - // Audiences created before 2020 may not be supported. - rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse) { - option (google.api.http) = { - get: "/v1alpha/{parent=properties/*}/audiences" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates an Audience. - rpc CreateAudience(CreateAudienceRequest) returns (Audience) { - option (google.api.http) = { - post: "/v1alpha/{parent=properties/*}/audiences" - body: "audience" - }; - option (google.api.method_signature) = "parent,audience"; - } - - // Updates an Audience on a property. - rpc UpdateAudience(UpdateAudienceRequest) returns (Audience) { - option (google.api.http) = { - patch: "/v1alpha/{audience.name=properties/*/audiences/*}" - body: "audience" - }; - option (google.api.method_signature) = "audience,update_mask"; - } - - // Archives an Audience on a property. - rpc ArchiveAudience(ArchiveAudienceRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1alpha/{name=properties/*/audiences/*}:archive" - body: "*" - }; - } - - // Lookup for a AttributionSettings singleton. - rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings) { - option (google.api.http) = { - get: "/v1alpha/{name=properties/*/attributionSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates attribution settings on a property. - rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings) { - option (google.api.http) = { - patch: "/v1alpha/{attribution_settings.name=properties/*/attributionSettings}" - body: "attribution_settings" - }; - option (google.api.method_signature) = "attribution_settings,update_mask"; - } - - // 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. The property must be - // in Google Analytics 360. 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). - rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse) { - option (google.api.http) = { - post: "/v1alpha/{entity=properties/*}:runAccessReport" - body: "*" - }; - } -} - -// The request for a Data Access Record Report. -message RunAccessReportRequest { - // The Data Access Report is requested for this property. - // For example if "123" is your GA4 property ID, then entity should be - // "properties/123". - string entity = 1; - - // The dimensions requested and displayed in the response. Requests are - // allowed up to 9 dimensions. - repeated AccessDimension dimensions = 2; - - // The metrics requested and displayed in the response. Requests are allowed - // up to 10 metrics. - repeated AccessMetric metrics = 3; - - // Date ranges of access records to read. If multiple date ranges are - // requested, each response row will contain a zero based date range index. If - // two date ranges overlap, the access records for the overlapping days is - // included in the response rows for both date ranges. Requests are allowed up - // to 2 date ranges. - repeated AccessDateRange date_ranges = 4; - - // Dimension filters allow you to restrict report response to specific - // dimension values which match the filter. For example, filtering on access - // records of a single user. To learn more, see [Fundamentals of Dimension - // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) - // for examples. Metrics cannot be used in this filter. - AccessFilterExpression dimension_filter = 5; - - // Metric filters allow you to restrict report response to specific metric - // values which match the filter. Metric filters are applied after aggregating - // the report's rows, similar to SQL having-clause. Dimensions cannot be used - // in this filter. - AccessFilterExpression metric_filter = 6; - - // The row count of the start row. The first row is counted as row 0. If - // offset is unspecified, it is treated as 0. If offset is zero, then this - // method will return the first page of results with `limit` entries. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int64 offset = 7; - - // The number of rows to return. If unspecified, 10,000 rows are returned. The - // API returns a maximum of 100,000 rows per request, no matter how many you - // ask for. `limit` must be positive. - // - // The API may return fewer rows than the requested `limit`, if there aren't - // as many remaining rows as the `limit`. For instance, there are fewer than - // 300 possible values for the dimension `country`, so when reporting on only - // `country`, you can't get more than 300 rows, even if you set `limit` to a - // higher value. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int64 limit = 8; - - // This request's time zone if specified. If unspecified, the property's time - // zone is used. The request's time zone is used to interpret the start & end - // dates of the report. - // - // Formatted as strings from the IANA Time Zone database - // (https://www.iana.org/time-zones); for example "America/New_York" or - // "Asia/Tokyo". - string time_zone = 9; - - // Specifies how rows are ordered in the response. - repeated AccessOrderBy order_bys = 10; - - // Toggles whether to return the current state of this Analytics Property's - // quota. Quota is returned in [AccessQuota](#AccessQuota). - bool return_entity_quota = 11; -} - -// The customized Data Access Record Report response. -message RunAccessReportResponse { - // The header for a column in the report that corresponds to a specific - // dimension. The number of DimensionHeaders and ordering of DimensionHeaders - // matches the dimensions present in rows. - repeated AccessDimensionHeader dimension_headers = 1; - - // The header for a column in the report that corresponds to a specific - // metric. The number of MetricHeaders and ordering of MetricHeaders matches - // the metrics present in rows. - repeated AccessMetricHeader metric_headers = 2; - - // Rows of dimension value combinations and metric values in the report. - repeated AccessRow rows = 3; - - // The total number of rows in the query result. `rowCount` is independent of - // the number of rows returned in the response, the `limit` request - // parameter, and the `offset` request parameter. For example if a query - // returns 175 rows and includes `limit` of 50 in the API request, the - // response will contain `rowCount` of 175 but only 50 rows. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int32 row_count = 4; - - // The quota state for this Analytics property including this request. - AccessQuota quota = 5; -} - -// Request message for GetAccount RPC. -message GetAccountRequest { - // Required. The name of the account to lookup. - // Format: accounts/{account} - // Example: "accounts/100" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// Request message for ListAccounts RPC. -message ListAccountsRequest { - // 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 = 1; - - // A page token, received from a previous `ListAccounts` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListAccounts` must - // match the call that provided the page token. - string page_token = 2; - - // Whether to include soft-deleted (ie: "trashed") Accounts in the - // results. Accounts can be inspected to determine whether they are deleted or - // not. - bool show_deleted = 3; -} - -// Request message for ListAccounts RPC. -message ListAccountsResponse { - // Results that were accessible to the caller. - repeated Account accounts = 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. - string next_page_token = 2; -} - -// Request message for DeleteAccount RPC. -message DeleteAccountRequest { - // Required. The name of the Account to soft-delete. - // Format: accounts/{account} - // Example: "accounts/100" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// Request message for UpdateAccount RPC. -message UpdateAccountRequest { - // Required. The account to update. - // The account's `name` field is used to identify the account. - Account account = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message ProvisionAccountTicketRequest { - // The account to create. - Account account = 1; - - // Redirect URI where the user will be sent after accepting Terms of Service. - // Must be configured in Developers Console as a Redirect URI - string redirect_uri = 2; -} - -// Response message for ProvisionAccountTicket RPC. -message ProvisionAccountTicketResponse { - // The param to be passed in the ToS link. - string account_ticket_id = 1; -} - -// Request message for GetProperty RPC. -message GetPropertyRequest { - // Required. The name of the property to lookup. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; -} - -// Request message for ListProperties RPC. -message ListPropertiesRequest { - // Required. An expression for filtering the results of the request. - // Fields eligible for filtering are: - // `parent:`(The resource name of the parent account/property) or - // `ancestor:`(The resource name of the parent account) or - // `firebase_project:`(The id or number of the linked firebase project). - // Some examples of filters: - // - // ``` - // | Filter | Description | - // |-----------------------------|-------------------------------------------| - // | parent:accounts/123 | The account with account id: 123. | - // | parent:properties/123 | The property with property id: 123. | - // | ancestor:accounts/123 | The account with account id: 123. | - // | firebase_project:project-id | The firebase project with id: project-id. | - // | firebase_project:123 | The firebase project with number: 123. | - // ``` - string filter = 1 [(google.api.field_behavior) = REQUIRED]; - - // 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 `ListProperties` 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; - - // Whether to include soft-deleted (ie: "trashed") Properties in the - // results. Properties can be inspected to determine whether they are deleted - // or not. - bool show_deleted = 4; -} - -// Response message for ListProperties RPC. -message ListPropertiesResponse { - // Results that matched the filter criteria and were accessible to the caller. - repeated Property properties = 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. - string next_page_token = 2; -} - -// Request message for UpdateProperty RPC. -message UpdatePropertyRequest { - // Required. The property to update. - // The property's `name` field is used to identify the property to be - // updated. - Property property = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message CreatePropertyRequest { - // Required. The property to create. - // Note: the supplied property must specify its parent. - Property property = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteProperty RPC. -message DeletePropertyRequest { - // Required. The name of the Property to soft-delete. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; -} - -// Request message for GetUserLink RPC. -message GetUserLinkRequest { - // Required. Example format: accounts/1234/userLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/UserLink" - } - ]; -} - -// Request message for BatchGetUserLinks RPC. -message BatchGetUserLinksRequest { - // Required. The account or property that all user links in the request are - // for. The parent of all provided values for the 'names' field must match - // this field. - // Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // Required. The names of the user links to retrieve. - // A maximum of 1000 user links can be retrieved in a batch. - // Format: accounts/{accountId}/userLinks/{userLinkId} - repeated string names = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/UserLink" - } - ]; -} - -// Response message for BatchGetUserLinks RPC. -message BatchGetUserLinksResponse { - // The requested user links. - repeated UserLink user_links = 1; -} - -// Request message for ListUserLinks RPC. -message ListUserLinksRequest { - // Required. Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // The maximum number of user links to return. - // The service may return fewer than this value. - // If unspecified, at most 200 user links will be returned. - // The maximum value is 500; values above 500 will be coerced to 500. - int32 page_size = 2; - - // A page token, received from a previous `ListUserLinks` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListUserLinks` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListUserLinks RPC. -message ListUserLinksResponse { - // List of UserLinks. These will be ordered stably, but in an arbitrary order. - repeated UserLink user_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. - string next_page_token = 2; -} - -// Request message for AuditUserLinks RPC. -message AuditUserLinksRequest { - // Required. Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // The maximum number of user links to return. - // The service may return fewer than this value. - // If unspecified, at most 1000 user links will be returned. - // The maximum value is 5000; values above 5000 will be coerced to 5000. - int32 page_size = 2; - - // A page token, received from a previous `AuditUserLinks` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `AuditUserLinks` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for AuditUserLinks RPC. -message AuditUserLinksResponse { - // List of AuditUserLinks. These will be ordered stably, but in an arbitrary - // order. - repeated AuditUserLink user_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. - string next_page_token = 2; -} - -// Request message for CreateUserLink RPC. -// -// Users can have multiple email addresses associated with their Google -// account, and one of these email addresses is the "primary" email address. -// Any of the email addresses associated with a Google account may be used -// for a new UserLink, but the returned UserLink will always contain the -// "primary" email address. As a result, the input and output email address -// for this request may differ. -message CreateUserLinkRequest { - // Required. Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // Optional. If set, then email the new user notifying them that they've been granted - // permissions to the resource. - bool notify_new_user = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The user link to create. - UserLink user_link = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for BatchCreateUserLinks RPC. -message BatchCreateUserLinksRequest { - // Required. The account or property that all user links in the request are for. - // This field is required. The parent field in the CreateUserLinkRequest - // messages must either be empty or match this field. - // Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // Optional. If set, then email the new users notifying them that they've been granted - // permissions to the resource. Regardless of whether this is set or not, - // notify_new_user field inside each individual request is ignored. - bool notify_new_users = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The requests specifying the user links to create. - // A maximum of 1000 user links can be created in a batch. - repeated CreateUserLinkRequest requests = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// Response message for BatchCreateUserLinks RPC. -message BatchCreateUserLinksResponse { - // The user links created. - repeated UserLink user_links = 1; -} - -// Request message for UpdateUserLink RPC. -message UpdateUserLinkRequest { - // Required. The user link to update. - UserLink user_link = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for BatchUpdateUserLinks RPC. -message BatchUpdateUserLinksRequest { - // Required. The account or property that all user links in the request are - // for. The parent field in the UpdateUserLinkRequest messages must either be - // empty or match this field. - // Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // Required. The requests specifying the user links to update. - // A maximum of 1000 user links can be updated in a batch. - repeated UpdateUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Response message for BatchUpdateUserLinks RPC. -message BatchUpdateUserLinksResponse { - // The user links updated. - repeated UserLink user_links = 1; -} - -// Request message for DeleteUserLink RPC. -message DeleteUserLinkRequest { - // Required. Example format: accounts/1234/userLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/UserLink" - } - ]; -} - -// Request message for BatchDeleteUserLinks RPC. -message BatchDeleteUserLinksRequest { - // Required. The account or property that all user links in the request are - // for. The parent of all values for user link names to delete must match this - // field. - // Example format: accounts/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/UserLink" - } - ]; - - // Required. The requests specifying the user links to update. - // A maximum of 1000 user links can be updated in a batch. - repeated DeleteUserLinkRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for CreateFirebaseLink RPC -message CreateFirebaseLinkRequest { - // Required. Format: properties/{property_id} - // Example: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/FirebaseLink" - } - ]; - - // Required. The Firebase link to create. - FirebaseLink firebase_link = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteFirebaseLink RPC -message DeleteFirebaseLinkRequest { - // Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} - // Example: properties/1234/firebaseLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/FirebaseLink" - } - ]; -} - -// Request message for ListFirebaseLinks RPC -message ListFirebaseLinksRequest { - // Required. Format: properties/{property_id} - // Example: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - 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. -message GetGlobalSiteTagRequest { - // Required. The name of the site tag to lookup. - // Note that site tags are singletons and do not have unique IDs. - // Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag - // Example: "properties/123/dataStreams/456/globalSiteTag" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/GlobalSiteTag" - } - ]; -} - -// Request message for CreateGoogleAdsLink RPC -message CreateGoogleAdsLinkRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; - - // Required. The GoogleAdsLink to create. - GoogleAdsLink google_ads_link = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateGoogleAdsLink RPC -message UpdateGoogleAdsLinkRequest { - // The GoogleAdsLink to update - GoogleAdsLink google_ads_link = 1; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message DeleteGoogleAdsLinkRequest { - // Required. Example format: properties/1234/googleAdsLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; -} - -// Request message for ListGoogleAdsLinks RPC. -message ListGoogleAdsLinksRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; - - // The maximum number of resources to return. - // 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 `ListGoogleAdsLinks` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListGoogleAdsLinks` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListGoogleAdsLinks RPC. -message ListGoogleAdsLinksResponse { - // List of GoogleAdsLinks. - repeated GoogleAdsLink google_ads_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. - string next_page_token = 2; -} - -// Request message for GetDataSharingSettings RPC. -message GetDataSharingSettingsRequest { - // Required. The name of the settings to lookup. - // Format: accounts/{account}/dataSharingSettings - // Example: "accounts/1000/dataSharingSettings" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataSharingSettings" - } - ]; -} - -// Request message for ListAccountSummaries RPC. -message ListAccountSummariesRequest { - // The maximum number of AccountSummary 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 = 1; - - // A page token, received from a previous `ListAccountSummaries` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListAccountSummaries` - // must match the call that provided the page token. - string page_token = 2; -} - -// Response message for ListAccountSummaries RPC. -message ListAccountSummariesResponse { - // Account summaries of all accounts the caller has access to. - repeated AccountSummary account_summaries = 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. - string next_page_token = 2; -} - -// Request message for AcknowledgeUserDataCollection RPC. -message AcknowledgeUserDataCollectionRequest { - // Required. The property for which to acknowledge user data collection. - string property = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; - - // Required. An acknowledgement that the caller of this method understands the terms - // of user data collection. - // - // This field must contain the exact value: - // "I acknowledge that I have the necessary privacy disclosures and rights - // from my end users for the collection and processing of their data, - // including the association of such data with the visitation information - // Google Analytics collects from my site and/or app property." - string acknowledgement = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Response message for AcknowledgeUserDataCollection RPC. -message AcknowledgeUserDataCollectionResponse { - -} - -// Request message for SearchChangeHistoryEvents RPC. -message SearchChangeHistoryEventsRequest { - // Required. The account resource for which to return change history resources. - string account = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; - - // Optional. Resource name for a child property. If set, only return changes - // made to this property or its child resources. - string property = 2 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; - - // Optional. If set, only return changes if they are for a resource that matches at - // least one of these types. - repeated ChangeHistoryResourceType resource_type = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes that match one or more of these types of - // actions. - repeated ActionType action = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes if they are made by a user in this list. - repeated string actor_email = 5 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes made after this time (inclusive). - google.protobuf.Timestamp earliest_change_time = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes made before this time (inclusive). - google.protobuf.Timestamp latest_change_time = 7 [(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). - int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. - // Provide this to retrieve the subsequent page. When paginating, all other - // parameters provided to `SearchChangeHistoryEvents` must match the call that - // provided the page token. - string page_token = 9 [(google.api.field_behavior) = OPTIONAL]; -} - -// Response message for SearchAccounts RPC. -message SearchChangeHistoryEventsResponse { - // Results that were accessible to the caller. - repeated ChangeHistoryEvent change_history_events = 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. - string next_page_token = 2; -} - -// Request message for GetMeasurementProtocolSecret RPC. -message GetMeasurementProtocolSecretRequest { - // Required. The name of the measurement protocol secret to lookup. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; -} - -// Request message for CreateMeasurementProtocolSecret RPC -message CreateMeasurementProtocolSecretRequest { - // Required. The parent resource where this secret will be created. - // Format: properties/{property}/dataStreams/{dataStream} - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; - - // Required. The measurement protocol secret to create. - MeasurementProtocolSecret measurement_protocol_secret = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteMeasurementProtocolSecret RPC -message DeleteMeasurementProtocolSecretRequest { - // Required. The name of the MeasurementProtocolSecret to delete. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; -} - -// Request message for UpdateMeasurementProtocolSecret RPC -message UpdateMeasurementProtocolSecretRequest { - // Required. The measurement protocol secret to update. - MeasurementProtocolSecret measurement_protocol_secret = 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; -} - -// Request message for ListMeasurementProtocolSecret RPC -message ListMeasurementProtocolSecretsRequest { - // Required. The resource name of the parent stream. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; - - // The maximum number of resources to return. - // If unspecified, at most 10 resources will be returned. - // The maximum value is 10. Higher values will be coerced to the maximum. - int32 page_size = 2; - - // A page token, received from a previous `ListMeasurementProtocolSecrets` - // call. Provide this to retrieve the subsequent page. When paginating, all - // other parameters provided to `ListMeasurementProtocolSecrets` must match - // the call that provided the page token. - string page_token = 3; -} - -// Response message for ListMeasurementProtocolSecret RPC -message ListMeasurementProtocolSecretsResponse { - // A list of secrets for the parent stream specified in the request. - repeated MeasurementProtocolSecret measurement_protocol_secrets = 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. - string next_page_token = 2; -} - -// Request message for GetGoogleSignalsSettings RPC -message GetGoogleSignalsSettingsRequest { - // Required. The name of the google signals settings to retrieve. - // Format: properties/{property}/googleSignalsSettings - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/GoogleSignalsSettings" - } - ]; -} - -// Request message for UpdateGoogleSignalsSettings RPC -message UpdateGoogleSignalsSettingsRequest { - // Required. The settings to update. - // The `name` field is used to identify the settings to be updated. - GoogleSignalsSettings google_signals_settings = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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 CreateConversionEvent RPC -message CreateConversionEventRequest { - // Required. The conversion event to create. - ConversionEvent conversion_event = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The resource name of the parent property where this conversion event will - // be created. Format: properties/123 - string parent = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for GetConversionEvent RPC -message GetConversionEventRequest { - // Required. The resource name of the conversion event to retrieve. - // Format: properties/{property}/conversionEvents/{conversion_event} - // Example: "properties/123/conversionEvents/456" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for DeleteConversionEvent RPC -message DeleteConversionEventRequest { - // Required. The resource name of the conversion event to delete. - // Format: properties/{property}/conversionEvents/{conversion_event} - // Example: "properties/123/conversionEvents/456" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for ListConversionEvents RPC -message ListConversionEventsRequest { - // Required. The resource name of the parent property. - // Example: 'properties/123' - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; - - // The maximum number of resources to return. - // 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 `ListConversionEvents` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListConversionEvents` - // must match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListConversionEvents RPC. -message ListConversionEventsResponse { - // The requested conversion events - repeated ConversionEvent conversion_events = 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. - string next_page_token = 2; -} - -// Request message for GetDisplayVideo360AdvertiserLink RPC. -message GetDisplayVideo360AdvertiserLinkRequest { - // Required. The name of the DisplayVideo360AdvertiserLink to get. - // Example format: properties/1234/displayVideo360AdvertiserLink/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink" - } - ]; -} - -// Request message for ListDisplayVideo360AdvertiserLinks RPC. -message ListDisplayVideo360AdvertiserLinksRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink" - } - ]; - - // The maximum number of resources to return. - // 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 `ListDisplayVideo360AdvertiserLinks` - // call. Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to - // `ListDisplayVideo360AdvertiserLinks` must match the call that provided the - // page token. - string page_token = 3; -} - -// Response message for ListDisplayVideo360AdvertiserLinks RPC. -message ListDisplayVideo360AdvertiserLinksResponse { - // List of DisplayVideo360AdvertiserLinks. - repeated DisplayVideo360AdvertiserLink display_video_360_advertiser_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. - string next_page_token = 2; -} - -// Request message for CreateDisplayVideo360AdvertiserLink RPC. -message CreateDisplayVideo360AdvertiserLinkRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink" - } - ]; - - // Required. The DisplayVideo360AdvertiserLink to create. - DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteDisplayVideo360AdvertiserLink RPC. -message DeleteDisplayVideo360AdvertiserLinkRequest { - // Required. The name of the DisplayVideo360AdvertiserLink to delete. - // Example format: properties/1234/displayVideo360AdvertiserLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink" - } - ]; -} - -// Request message for UpdateDisplayVideo360AdvertiserLink RPC. -message UpdateDisplayVideo360AdvertiserLinkRequest { - // The DisplayVideo360AdvertiserLink to update - DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 1; - - // 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 GetDisplayVideo360AdvertiserLinkProposal RPC. -message GetDisplayVideo360AdvertiserLinkProposalRequest { - // Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. - // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; -} - -// Request message for ListDisplayVideo360AdvertiserLinkProposals RPC. -message ListDisplayVideo360AdvertiserLinkProposalsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; - - // The maximum number of resources to return. - // 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 - // `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve - // the subsequent page. - // - // When paginating, all other parameters provided to - // `ListDisplayVideo360AdvertiserLinkProposals` must match the call that - // provided the page token. - string page_token = 3; -} - -// Response message for ListDisplayVideo360AdvertiserLinkProposals RPC. -message ListDisplayVideo360AdvertiserLinkProposalsResponse { - // List of DisplayVideo360AdvertiserLinkProposals. - repeated DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposals = 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. - string next_page_token = 2; -} - -// Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC. -message CreateDisplayVideo360AdvertiserLinkProposalRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; - - // Required. The DisplayVideo360AdvertiserLinkProposal to create. - DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC. -message DeleteDisplayVideo360AdvertiserLinkProposalRequest { - // Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. - // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; -} - -// Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. -message ApproveDisplayVideo360AdvertiserLinkProposalRequest { - // Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. - // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; -} - -// Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. -message ApproveDisplayVideo360AdvertiserLinkProposalResponse { - // The DisplayVideo360AdvertiserLink created as a result of approving the - // proposal. - DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 1; -} - -// Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC. -message CancelDisplayVideo360AdvertiserLinkProposalRequest { - // Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. - // Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - } - ]; -} - -// Request message for CreateCustomDimension RPC. -message CreateCustomDimensionRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; - - // Required. The CustomDimension to create. - CustomDimension custom_dimension = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateCustomDimension RPC. -message UpdateCustomDimensionRequest { - // The CustomDimension to update - CustomDimension custom_dimension = 1; - - // 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 ListCustomDimensions RPC. -message ListCustomDimensionsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; - - // The maximum number of resources to return. - // 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 `ListCustomDimensions` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListCustomDimensions` - // must match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListCustomDimensions RPC. -message ListCustomDimensionsResponse { - // List of CustomDimensions. - repeated CustomDimension custom_dimensions = 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. - string next_page_token = 2; -} - -// Request message for ArchiveCustomDimension RPC. -message ArchiveCustomDimensionRequest { - // Required. The name of the CustomDimension to archive. - // Example format: properties/1234/customDimensions/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; -} - -// Request message for GetCustomDimension RPC. -message GetCustomDimensionRequest { - // Required. The name of the CustomDimension to get. - // Example format: properties/1234/customDimensions/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; -} - -// Request message for CreateCustomMetric RPC. -message CreateCustomMetricRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; - - // Required. The CustomMetric to create. - CustomMetric custom_metric = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateCustomMetric RPC. -message UpdateCustomMetricRequest { - // The CustomMetric to update - CustomMetric custom_metric = 1; - - // 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 ListCustomMetrics RPC. -message ListCustomMetricsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; - - // The maximum number of resources to return. - // 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 `ListCustomMetrics` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListCustomMetrics` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListCustomMetrics RPC. -message ListCustomMetricsResponse { - // List of CustomMetrics. - repeated CustomMetric custom_metrics = 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. - string next_page_token = 2; -} - -// Request message for ArchiveCustomMetric RPC. -message ArchiveCustomMetricRequest { - // Required. The name of the CustomMetric to archive. - // Example format: properties/1234/customMetrics/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; -} - -// Request message for GetCustomMetric RPC. -message GetCustomMetricRequest { - // Required. The name of the CustomMetric to get. - // Example format: properties/1234/customMetrics/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; -} - -// Request message for GetDataRetentionSettings RPC. -message GetDataRetentionSettingsRequest { - // Required. The name of the settings to lookup. - // Format: - // properties/{property}/dataRetentionSettings - // Example: "properties/1000/dataRetentionSettings" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataRetentionSettings" - } - ]; -} - -// Request message for UpdateDataRetentionSettings RPC. -message UpdateDataRetentionSettingsRequest { - // Required. The settings to update. - // The `name` field is used to identify the settings to be updated. - DataRetentionSettings data_retention_settings = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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 CreateDataStream RPC. -message CreateDataStreamRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DataStream" - } - ]; - - // Required. The DataStream to create. - DataStream data_stream = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteDataStream RPC. -message DeleteDataStreamRequest { - // Required. The name of the DataStream to delete. - // Example format: properties/1234/dataStreams/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataStream" - } - ]; -} - -// Request message for UpdateDataStream RPC. -message UpdateDataStreamRequest { - // The DataStream to update - DataStream data_stream = 1; - - // 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 ListDataStreams RPC. -message ListDataStreamsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DataStream" - } - ]; - - // The maximum number of resources to return. - // 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 `ListDataStreams` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListDataStreams` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListDataStreams RPC. -message ListDataStreamsResponse { - // List of DataStreams. - repeated DataStream data_streams = 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. - string next_page_token = 2; -} - -// Request message for GetDataStream RPC. -message GetDataStreamRequest { - // Required. The name of the DataStream to get. - // Example format: properties/1234/dataStreams/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataStream" - } - ]; -} - -// Request message for GetAudience RPC. -message GetAudienceRequest { - // Required. The name of the Audience to get. - // Example format: properties/1234/audiences/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Audience" - } - ]; -} - -// Request message for ListAudiences RPC. -message ListAudiencesRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/Audience" - } - ]; - - // The maximum number of resources to return. - // 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 `ListAudiences` call. Provide this - // to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListAudiences` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListAudiences RPC. -message ListAudiencesResponse { - // List of Audiences. - repeated Audience audiences = 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. - string next_page_token = 2; -} - -// Request message for CreateAudience RPC. -message CreateAudienceRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/Audience" - } - ]; - - // Required. The audience to create. - Audience audience = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateAudience RPC. -message UpdateAudienceRequest { - // Required. The audience to update. - // The audience's `name` field is used to identify the audience to be updated. - Audience audience = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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 ArchiveAudience RPC. -message ArchiveAudienceRequest { - // Required. Example format: properties/1234/audiences/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/Audience" - } - ]; -} - -// Request message for GetAttributionSettings RPC. -message GetAttributionSettingsRequest { - // Required. The name of the attribution settings to retrieve. - // Format: properties/{property}/attributionSettings - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/AttributionSettings" - } - ]; -} - -// Request message for UpdateAttributionSettings RPC -message UpdateAttributionSettingsRequest { - // Required. The attribution settings to update. - // The `name` field is used to identify the settings to be updated. - AttributionSettings attribution_settings = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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]; -} diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin.yaml b/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin.yaml deleted file mode 100644 index d74aa8b..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin.yaml +++ /dev/null @@ -1,198 +0,0 @@ -type: google.api.Service -config_version: 3 -name: analyticsadmin.googleapis.com -title: Google Analytics Admin API - -apis: -- name: google.analytics.admin.v1alpha.AnalyticsAdminService - -authentication: - rules: - - selector: 'google.analytics.admin.v1alpha.AnalyticsAdminService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.AuditUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAttributionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAudience - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomDimension - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomMetric - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataRetentionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataSharingSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataStream - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGoogleSignalsSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetMeasurementProtocolSecret - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetProperty - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccounts - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAudiences - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomDimensions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomMetrics - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDataStreams - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinkProposals - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListGoogleAdsLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListMeasurementProtocolSecrets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListProperties - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_gapic.yaml b/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_gapic.yaml deleted file mode 100644 index 0bcb880..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_gapic.yaml +++ /dev/null @@ -1,2 +0,0 @@ -type: com.google.api.codegen.ConfigProto -config_schema_version: 2.0.0 diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml b/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml deleted file mode 100644 index e268411..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml +++ /dev/null @@ -1,203 +0,0 @@ -type: google.api.Service -config_version: 3 -name: analyticsadmin.googleapis.com -title: Google Analytics Admin API - -apis: -- name: google.analytics.admin.v1alpha.AnalyticsAdminService - -authentication: - rules: - - selector: 'google.analytics.admin.v1alpha.AnalyticsAdminService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.AuditUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchCreateUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchDeleteUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchGetUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.BatchUpdateUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.CreateUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.DeleteUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccount - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAttributionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAudience - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetConversionEvent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomDimension - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetCustomMetric - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataRetentionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataSharingSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataStream - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDisplayVideo360AdvertiserLinkProposal - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGoogleSignalsSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetMeasurementProtocolSecret - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetProperty - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccountSummaries - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccounts - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAudiences - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomDimensions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListCustomMetrics - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDataStreams - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinkProposals - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListDisplayVideo360AdvertiserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListGoogleAdsLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListMeasurementProtocolSecrets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListProperties - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListUserLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users, - https://www.googleapis.com/auth/analytics.manage.users.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.RunAccessReport - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1alpha.AnalyticsAdminService.UpdateUserLink - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.manage.users diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto b/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto deleted file mode 100644 index e12943e..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/audience.proto +++ /dev/null @@ -1,419 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1alpha; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/duration.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin"; -option java_multiple_files = true; -option java_outer_classname = "AudienceProto"; -option java_package = "com.google.analytics.admin.v1alpha"; - -// Specifies how to evaluate users for joining an Audience. -enum AudienceFilterScope { - // Scope is not specified. - AUDIENCE_FILTER_SCOPE_UNSPECIFIED = 0; - - // User joins the Audience if the filter condition is met within one - // event. - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT = 1; - - // User joins the Audience if the filter condition is met within one - // session. - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION = 2; - - // User joins the Audience if the filter condition is met by any event - // across any session. - AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS = 3; -} - -// A specific filter for a single dimension or metric. -message AudienceDimensionOrMetricFilter { - // A filter for a string-type dimension that matches a particular pattern. - message StringFilter { - // The match type for the string filter. - enum MatchType { - // Unspecified - MATCH_TYPE_UNSPECIFIED = 0; - - // Exact match of the string value. - EXACT = 1; - - // Begins with the string value. - BEGINS_WITH = 2; - - // Ends with the string value. - ENDS_WITH = 3; - - // Contains the string value. - CONTAINS = 4; - - // Full regular expression matches with the string value. - FULL_REGEXP = 5; - - // Partial regular expression matches with the string value. - PARTIAL_REGEXP = 6; - } - - // Required. The match type for the string filter. - MatchType match_type = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The string value to be matched against. - string value = 2 [(google.api.field_behavior) = REQUIRED]; - - // Optional. If true, the match is case-sensitive. If false, the match is - // case-insensitive. - bool case_sensitive = 3 [(google.api.field_behavior) = OPTIONAL]; - } - - // A filter for a string dimension that matches a particular list of options. - message InListFilter { - // Required. The list of possible string values to match against. Must be non-empty. - repeated string values = 1 [(google.api.field_behavior) = REQUIRED]; - - // Optional. If true, the match is case-sensitive. If false, the match is - // case-insensitive. - bool case_sensitive = 2 [(google.api.field_behavior) = OPTIONAL]; - } - - // To represent a number. - message NumericValue { - // One of a numeric value. - oneof one_value { - // Integer value. - int64 int64_value = 1; - - // Double value. - double double_value = 2; - } - } - - // A filter for numeric or date values on a dimension or metric. - message NumericFilter { - // The operation applied to a numeric filter. - enum Operation { - // Unspecified. - OPERATION_UNSPECIFIED = 0; - - // Equal. - EQUAL = 1; - - // Less than. - LESS_THAN = 2; - - // Less than or equal. - LESS_THAN_OR_EQUAL = 3; - - // Greater than. - GREATER_THAN = 4; - - // Greater than or equal. - GREATER_THAN_OR_EQUAL = 5; - } - - // Required. The operation applied to a numeric filter. - Operation operation = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The numeric or date value to match against. - NumericValue value = 2 [(google.api.field_behavior) = REQUIRED]; - } - - // A filter for numeric or date values between certain values on a dimension - // or metric. - message BetweenFilter { - // Required. Begins with this number, inclusive. - NumericValue from_value = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. Ends with this number, inclusive. - NumericValue to_value = 2 [(google.api.field_behavior) = REQUIRED]; - } - - // One of the above filters. - oneof one_filter { - // A filter for a string-type dimension that matches a particular pattern. - StringFilter string_filter = 2; - - // A filter for a string dimension that matches a particular list of - // options. - InListFilter in_list_filter = 3; - - // A filter for numeric or date values on a dimension or metric. - NumericFilter numeric_filter = 4; - - // A filter for numeric or date values between certain values on a dimension - // or metric. - BetweenFilter between_filter = 5; - } - - // Required. Immutable. The dimension name or metric name to filter. - string field_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. Indicates whether this filter needs dynamic evaluation or not. If set to - // true, users join the Audience if they ever met the condition (static - // evaluation). If unset or set to false, user evaluation for an Audience is - // dynamic; users are added to an Audience when they meet the conditions and - // then removed when they no longer meet them. - // - // This can only be set when Audience scope is ACROSS_ALL_SESSIONS. - bool at_any_point_in_time = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, specifies the time window for which to evaluate data in number of - // days. If not set, then audience data is evaluated against lifetime data - // (i.e., infinite time window). - // - // For example, if set to 1 day, only the current day's data is evaluated. The - // reference point is the current day when at_any_point_in_time is unset or - // false. - // - // It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be - // greater than 60 days. - int32 in_any_n_day_period = 7 [(google.api.field_behavior) = OPTIONAL]; -} - -// A filter that matches events of a single event name. If an event parameter -// is specified, only the subset of events that match both the single event name -// and the parameter filter expressions match this event filter. -message AudienceEventFilter { - // Required. Immutable. The name of the event to match against. - string event_name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. If specified, this filter matches events that match both the single - // event name and the parameter filter expressions. AudienceEventFilter - // inside the parameter filter expression cannot be set (i.e., nested - // event filters are not supported). This should be a single and_group of - // dimension_or_metric_filter or not_expression; ANDs of ORs are not - // supported. Also, if it includes a filter for "eventCount", only that one - // will be considered; all the other filters will be ignored. - AudienceFilterExpression event_parameter_filter_expression = 2 [(google.api.field_behavior) = OPTIONAL]; -} - -// A logical expression of Audience dimension, metric, or event filters. -message AudienceFilterExpression { - // The expression applied to a filter. - oneof expr { - // A list of expressions to be AND’ed together. It can only contain - // AudienceFilterExpressions with or_group. This must be set for the top - // level AudienceFilterExpression. - AudienceFilterExpressionList and_group = 1; - - // A list of expressions to OR’ed together. It cannot contain - // AudienceFilterExpressions with and_group or or_group. - AudienceFilterExpressionList or_group = 2; - - // A filter expression to be NOT'ed (i.e., inverted, complemented). It - // can only include a dimension_or_metric_filter. This cannot be set on the - // top level AudienceFilterExpression. - AudienceFilterExpression not_expression = 3; - - // A filter on a single dimension or metric. This cannot be set on the top - // level AudienceFilterExpression. - AudienceDimensionOrMetricFilter dimension_or_metric_filter = 4; - - // Creates a filter that matches a specific event. This cannot be set on the - // top level AudienceFilterExpression. - AudienceEventFilter event_filter = 5; - } -} - -// A list of Audience filter expressions. -message AudienceFilterExpressionList { - // A list of Audience filter expressions. - repeated AudienceFilterExpression filter_expressions = 1; -} - -// Defines a simple filter that a user must satisfy to be a member of the -// Audience. -message AudienceSimpleFilter { - // Required. Immutable. Specifies the scope for this filter. - AudienceFilterScope scope = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Required. Immutable. A logical expression of Audience dimension, metric, or event filters. - AudienceFilterExpression filter_expression = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; -} - -// Defines filters that must occur in a specific order for the user to be a -// member of the Audience. -message AudienceSequenceFilter { - // A condition that must occur in the specified step order for this user - // to match the sequence. - message AudienceSequenceStep { - // Required. Immutable. Specifies the scope for this step. - AudienceFilterScope scope = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. If true, the event satisfying this step must be the very next event - // after the event satisfying the last step. If unset or false, this - // step indirectly follows the prior step; for example, there may be - // events between the prior step and this step. It is ignored for the - // first step. - bool immediately_follows = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. When set, this step must be satisfied within the constraint_duration of - // the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not - // set, there is no duration requirement (the duration is effectively - // unlimited). It is ignored for the first step. - google.protobuf.Duration constraint_duration = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Required. Immutable. A logical expression of Audience dimension, metric, or event filters in - // each step. - AudienceFilterExpression filter_expression = 4 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - } - - // Required. Immutable. Specifies the scope for this filter. - AudienceFilterScope scope = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. Defines the time period in which the whole sequence must occur. - google.protobuf.Duration sequence_maximum_duration = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Required. An ordered sequence of steps. A user must complete each step in order to - // join the sequence filter. - repeated AudienceSequenceStep sequence_steps = 3 [(google.api.field_behavior) = REQUIRED]; -} - -// A clause for defining either a simple or sequence filter. A filter can be -// inclusive (i.e., users satisfying the filter clause are included in the -// Audience) or exclusive (i.e., users satisfying the filter clause are -// excluded from the Audience). -message AudienceFilterClause { - // Specifies whether this is an include or exclude filter clause. - enum AudienceClauseType { - // Unspecified clause type. - AUDIENCE_CLAUSE_TYPE_UNSPECIFIED = 0; - - // Users will be included in the Audience if the filter clause is met. - INCLUDE = 1; - - // Users will be excluded from the Audience if the filter clause is met. - EXCLUDE = 2; - } - - oneof filter { - // A simple filter that a user must satisfy to be a member of the Audience. - AudienceSimpleFilter simple_filter = 2; - - // Filters that must occur in a specific order for the user to be a member - // of the Audience. - AudienceSequenceFilter sequence_filter = 3; - } - - // Required. Specifies whether this is an include or exclude filter clause. - AudienceClauseType clause_type = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Specifies an event to log when a user joins the Audience. -message AudienceEventTrigger { - // Determines when to log the event. - enum LogCondition { - // Log condition is not specified. - LOG_CONDITION_UNSPECIFIED = 0; - - // The event should be logged only when a user is joined. - AUDIENCE_JOINED = 1; - - // The event should be logged whenever the Audience condition is met, even - // if the user is already a member of the Audience. - AUDIENCE_MEMBERSHIP_RENEWED = 2; - } - - // Required. The event name that will be logged. - string event_name = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. When to log the event. - LogCondition log_condition = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// A resource message representing a GA4 Audience. -message Audience { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/Audience" - pattern: "properties/{property}/audiences/{audience}" - }; - - // Specifies how long an exclusion lasts for users that meet the exclusion - // filter. - enum AudienceExclusionDurationMode { - // Not specified. - AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED = 0; - - // Exclude users from the Audience during periods when they meet the - // filter clause. - EXCLUDE_TEMPORARILY = 1; - - // Exclude users from the Audience if they've ever met the filter clause. - EXCLUDE_PERMANENTLY = 2; - } - - // Output only. The resource name for this Audience resource. - // Format: properties/{propertyId}/audiences/{audienceId} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. The display name of the Audience. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The description of the Audience. - string description = 3 [(google.api.field_behavior) = REQUIRED]; - - // Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more - // than 540 days. - int32 membership_duration_days = 4 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Output only. It is automatically set by GA to false if this is an NPA Audience and is - // excluded from ads personalization. - bool ads_personalization_enabled = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Optional. Specifies an event to log when a user joins the Audience. If not set, no - // event is logged when a user joins the Audience. - AudienceEventTrigger event_trigger = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Immutable. Specifies how long an exclusion lasts for users that meet the exclusion - // filter. It is applied to all EXCLUDE filter clauses and is ignored when - // there is no EXCLUDE filter clause in the Audience. - AudienceExclusionDurationMode exclusion_duration_mode = 7 [(google.api.field_behavior) = IMMUTABLE]; - - // Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed - // together. - repeated AudienceFilterClause filter_clauses = 8 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = UNORDERED_LIST - ]; -} diff --git a/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto b/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto deleted file mode 100644 index 337c7fe..0000000 --- a/third_party/googleapis/google/analytics/admin/v1alpha/resources.proto +++ /dev/null @@ -1,1300 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1alpha; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/timestamp.proto"; -import "google/protobuf/wrappers.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin"; -option java_multiple_files = true; -option java_outer_classname = "ResourcesProto"; -option java_package = "com.google.analytics.admin.v1alpha"; - -// The category selected for this property, used for industry benchmarking. -enum IndustryCategory { - // Industry category unspecified - INDUSTRY_CATEGORY_UNSPECIFIED = 0; - - // Automotive - AUTOMOTIVE = 1; - - // Business and industrial markets - BUSINESS_AND_INDUSTRIAL_MARKETS = 2; - - // Finance - FINANCE = 3; - - // Healthcare - HEALTHCARE = 4; - - // Technology - TECHNOLOGY = 5; - - // Travel - TRAVEL = 6; - - // Other - OTHER = 7; - - // Arts and entertainment - ARTS_AND_ENTERTAINMENT = 8; - - // Beauty and fitness - BEAUTY_AND_FITNESS = 9; - - // Books and literature - BOOKS_AND_LITERATURE = 10; - - // Food and drink - FOOD_AND_DRINK = 11; - - // Games - GAMES = 12; - - // Hobbies and leisure - HOBBIES_AND_LEISURE = 13; - - // Home and garden - HOME_AND_GARDEN = 14; - - // Internet and telecom - INTERNET_AND_TELECOM = 15; - - // Law and government - LAW_AND_GOVERNMENT = 16; - - // News - NEWS = 17; - - // Online communities - ONLINE_COMMUNITIES = 18; - - // People and society - PEOPLE_AND_SOCIETY = 19; - - // Pets and animals - PETS_AND_ANIMALS = 20; - - // Real estate - REAL_ESTATE = 21; - - // Reference - REFERENCE = 22; - - // Science - SCIENCE = 23; - - // Sports - SPORTS = 24; - - // Jobs and education - JOBS_AND_EDUCATION = 25; - - // Shopping - SHOPPING = 26; -} - -// Various levels of service for Google Analytics. -enum ServiceLevel { - // Service level not specified or invalid. - SERVICE_LEVEL_UNSPECIFIED = 0; - - // The standard version of Google Analytics. - GOOGLE_ANALYTICS_STANDARD = 1; - - // The paid, premium version of Google Analytics. - GOOGLE_ANALYTICS_360 = 2; -} - -// Different kinds of actors that can make changes to Google Analytics -// resources. -enum ActorType { - // Unknown or unspecified actor type. - ACTOR_TYPE_UNSPECIFIED = 0; - - // Changes made by the user specified in actor_email. - USER = 1; - - // Changes made by the Google Analytics system. - SYSTEM = 2; - - // Changes made by Google Analytics support team staff. - SUPPORT = 3; -} - -// Types of actions that may change a resource. -enum ActionType { - // Action type unknown or not specified. - ACTION_TYPE_UNSPECIFIED = 0; - - // Resource was created in this change. - CREATED = 1; - - // Resource was updated in this change. - UPDATED = 2; - - // Resource was deleted in this change. - DELETED = 3; -} - -// Types of resources whose changes may be returned from change history. -enum ChangeHistoryResourceType { - // Resource type unknown or not specified. - CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0; - - // Account resource - ACCOUNT = 1; - - // Property resource - PROPERTY = 2; - - // FirebaseLink resource - FIREBASE_LINK = 6; - - // GoogleAdsLink resource - GOOGLE_ADS_LINK = 7; - - // GoogleSignalsSettings resource - GOOGLE_SIGNALS_SETTINGS = 8; - - // ConversionEvent resource - CONVERSION_EVENT = 9; - - // MeasurementProtocolSecret resource - MEASUREMENT_PROTOCOL_SECRET = 10; - - // CustomDimension resource - CUSTOM_DIMENSION = 11; - - // CustomMetric resource - CUSTOM_METRIC = 12; - - // DataRetentionSettings resource - DATA_RETENTION_SETTINGS = 13; - - // DisplayVideo360AdvertiserLink resource - DISPLAY_VIDEO_360_ADVERTISER_LINK = 14; - - // DisplayVideo360AdvertiserLinkProposal resource - DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15; - - // SearchAds360Link resource - SEARCH_ADS_360_LINK = 16; - - // DataStream resource - DATA_STREAM = 18; - - // AttributionSettings resource - ATTRIBUTION_SETTINGS = 20; -} - -// Status of the Google Signals settings (i.e., whether this feature has been -// enabled for the property). -enum GoogleSignalsState { - // Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to - // represent that the user has not made an explicit choice. - GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0; - - // Google Signals is enabled. - GOOGLE_SIGNALS_ENABLED = 1; - - // Google Signals is disabled. - GOOGLE_SIGNALS_DISABLED = 2; -} - -// Consent field of the Google Signals settings (i.e., whether the user has -// consented to the Google Signals terms of service.) -enum GoogleSignalsConsent { - // Google Signals consent value defaults to - // GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as - // GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED. - GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0; - - // Terms of service have been accepted - GOOGLE_SIGNALS_CONSENT_CONSENTED = 2; - - // Terms of service have not been accepted - GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1; -} - -// An indication of which product the user initiated a link proposal from. -enum LinkProposalInitiatingProduct { - // Unspecified product. - LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED = 0; - - // This proposal was created by a user from Google Analytics. - GOOGLE_ANALYTICS = 1; - - // This proposal was created by a user from a linked product (not Google - // Analytics). - LINKED_PRODUCT = 2; -} - -// The state of a link proposal resource. -enum LinkProposalState { - // Unspecified state - LINK_PROPOSAL_STATE_UNSPECIFIED = 0; - - // This proposal is awaiting review from a Google Analytics user. This - // proposal will automatically expire after some time. - AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS = 1; - - // This proposal is awaiting review from a user of a linked product. This - // proposal will automatically expire after some time. - AWAITING_REVIEW_FROM_LINKED_PRODUCT = 2; - - // This proposal has been withdrawn by an admin on the initiating product. - // This proposal will be automatically deleted after some time. - WITHDRAWN = 3; - - // This proposal has been declined by an admin on the receiving product. This - // proposal will be automatically deleted after some time. - DECLINED = 4; - - // This proposal expired due to lack of response from an admin on the - // receiving product. This proposal will be automatically deleted after some - // time. - EXPIRED = 5; - - // This proposal has become obsolete because a link was directly created to - // the same external product resource that this proposal specifies. This - // proposal will be automatically deleted after some time. - OBSOLETE = 6; -} - -// Types of Property resources. -enum PropertyType { - // Unknown or unspecified property type - PROPERTY_TYPE_UNSPECIFIED = 0; - - // Ordinary GA4 property - PROPERTY_TYPE_ORDINARY = 1; - - // GA4 subproperty - PROPERTY_TYPE_SUBPROPERTY = 2; - - // GA4 rollup property - PROPERTY_TYPE_ROLLUP = 3; -} - -// A resource message representing a Google Analytics account. -message Account { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/Account" - pattern: "accounts/{account}" - }; - - // Output only. Resource name of this account. - // Format: accounts/{account} - // Example: "accounts/100" - 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]; - - // Output only. Time when account payload fields were last updated. - 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 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. - bool deleted = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A resource message representing a Google Analytics GA4 property. -message Property { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/Property" - pattern: "properties/{property}" - }; - - // Output only. Resource name of this property. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The property type for this Property resource. When creating a property, if - // the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be - // implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created - // via Google Analytics Admin API. - PropertyType property_type = 14 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. Time when the entity was originally created. - 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]; - - // Immutable. Resource name of this property's logical parent. - // - // Note: The Property-Moving UI can be used to change the parent. - // Format: accounts/{account}, properties/{property} - // Example: "accounts/100", "properties/101" - string parent = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Required. Human-readable display name for this property. - // - // The max allowed display name length is 100 UTF-16 code units. - string display_name = 5 [(google.api.field_behavior) = REQUIRED]; - - // Industry associated with this property - // Example: AUTOMOTIVE, FOOD_AND_DRINK - IndustryCategory industry_category = 6; - - // Required. Reporting Time Zone, used as the day boundary for reports, regardless of - // where the data originates. If the time zone honors DST, Analytics will - // automatically adjust for the changes. - // - // NOTE: Changing the time zone only affects data going forward, and is not - // applied retroactively. - // - // Format: https://www.iana.org/time-zones - // Example: "America/Los_Angeles" - string time_zone = 7 [(google.api.field_behavior) = REQUIRED]; - - // The currency type used in reports involving monetary values. - // - // - // Format: https://en.wikipedia.org/wiki/ISO_4217 - // Examples: "USD", "EUR", "JPY" - string currency_code = 8; - - // Output only. The Google Analytics service level that applies to this property. - ServiceLevel service_level = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, the time at which this property was trashed. If not set, then this - // property is not currently in the trash can. - google.protobuf.Timestamp delete_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, the time at which this trashed property will be permanently - // deleted. If not set, then this property is not currently in the trash can - // and is not slated to be deleted. - google.protobuf.Timestamp expire_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The resource name of the parent account - // Format: accounts/{account_id} - // Example: "accounts/123" - string account = 13 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// A resource message representing a data stream. -message DataStream { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataStream" - pattern: "properties/{property}/dataStreams/{data_stream}" - }; - - // Data specific to web streams. - message WebStreamData { - // Output only. Analytics "Measurement ID", without the "G-" prefix. - // Example: "G-1A2BCD345E" would just be "1A2BCD345E" - string measurement_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. ID of the corresponding web app in Firebase, if any. - // This ID can change if the web app is deleted and recreated. - string firebase_app_id = 2 [(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" - string default_uri = 3 [(google.api.field_behavior) = IMMUTABLE]; - } - - // Data specific to Android app streams. - message AndroidAppStreamData { - // Output only. ID of the corresponding Android app in Firebase, if any. - // This ID can change if the Android app is deleted and recreated. - string firebase_app_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The package name for the app being measured. - // Example: "com.example.myandroidapp" - string package_name = 2 [(google.api.field_behavior) = IMMUTABLE]; - } - - // Data specific to iOS app streams. - message IosAppStreamData { - // Output only. ID of the corresponding iOS app in Firebase, if any. - // This ID can change if the iOS app is deleted and recreated. - string firebase_app_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. The Apple App Store Bundle ID for the app - // Example: "com.example.myiosapp" - string bundle_id = 2 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.field_behavior) = REQUIRED - ]; - } - - // The type of the data stream. - enum DataStreamType { - // Type unknown or not specified. - DATA_STREAM_TYPE_UNSPECIFIED = 0; - - // Web data stream. - WEB_DATA_STREAM = 1; - - // Android app data stream. - ANDROID_APP_DATA_STREAM = 2; - - // iOS app data stream. - IOS_APP_DATA_STREAM = 3; - } - - // Data for specific data stream types. The message that will be - // set corresponds to the type of this stream. - oneof stream_data { - // Data specific to web streams. Must be populated if type is - // WEB_DATA_STREAM. - WebStreamData web_stream_data = 6; - - // Data specific to Android app streams. Must be populated if type is - // ANDROID_APP_DATA_STREAM. - AndroidAppStreamData android_app_stream_data = 7; - - // Data specific to iOS app streams. Must be populated if type is - // IOS_APP_DATA_STREAM. - IosAppStreamData ios_app_stream_data = 8; - } - - // Output only. Resource name of this Data Stream. - // Format: properties/{property_id}/dataStreams/{stream_id} - // Example: "properties/1000/dataStreams/2000" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. The type of this DataStream resource. - DataStreamType type = 2 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.field_behavior) = REQUIRED - ]; - - // Human-readable display name for the Data Stream. - // - // Required for web data streams. - // - // The max allowed display name length is 255 UTF-16 code units. - string display_name = 3; - - // Output only. Time when this stream was originally created. - 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]; -} - -// A resource message representing a user's permissions on an Account or -// Property resource. -message UserLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/UserLink" - pattern: "accounts/{account}/userLinks/{user_link}" - pattern: "properties/{property}/userLinks/{user_link}" - }; - - // Output only. Example format: properties/1234/userLinks/5678 - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. Email address of the user to link - string email_address = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Roles directly assigned to this user for this account or property. - // - // Valid values: - // predefinedRoles/viewer - // predefinedRoles/analyst - // predefinedRoles/editor - // predefinedRoles/admin - // predefinedRoles/no-cost-data - // predefinedRoles/no-revenue-data - // - // Excludes roles that are inherited from a higher-level entity, group, - // or organization admin role. - // - // A UserLink that is updated to have an empty list of direct_roles will be - // deleted. - repeated string direct_roles = 3; -} - -// Read-only resource used to summarize a principal's effective roles. -message AuditUserLink { - // Example format: properties/1234/userLinks/5678 - string name = 1; - - // Email address of the linked user - string email_address = 2; - - // Roles directly assigned to this user for this entity. - // - // Format: predefinedRoles/viewer - // - // Excludes roles that are inherited from an account (if this is for a - // property), group, or organization admin role. - repeated string direct_roles = 3; - - // Union of all permissions a user has at this account or property (includes - // direct permissions, group-inherited permissions, etc.). - // - // Format: predefinedRoles/viewer - repeated string effective_roles = 4; -} - -// A link between a GA4 property and a Firebase project. -message FirebaseLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/FirebaseLink" - pattern: "properties/{property}/firebaseLinks/{firebase_link}" - }; - - // 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 - // have a project_name that contains a project number. - // - // Format: 'projects/{project number}' - // Example: 'projects/1234' - 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]; -} - -// Read-only resource with the tag for sending data from a website to a -// DataStream. Only present for web DataStream resources. -message GlobalSiteTag { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/GlobalSiteTag" - pattern: "properties/{property}/dataStreams/{data_stream}/globalSiteTag" - }; - - // Output only. Resource name for this GlobalSiteTag resource. - // Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag - // Example: "properties/123/dataStreams/456/globalSiteTag" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // 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 a GA4 property and a Google Ads account. -message GoogleAdsLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/GoogleAdsLink" - pattern: "properties/{property}/googleAdsLinks/{google_ads_link}" - }; - - // 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. Google Ads customer ID. - string customer_id = 3 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. If true, this link is for a Google Ads manager account. - bool can_manage_clients = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Enable personalized advertising features with this integration. - // Automatically publish my Google Analytics audience lists and Google - // Analytics remarketing events/parameters to the linked Google Ads account. - // If this field is not set on create/update, it will be defaulted to true. - google.protobuf.BoolValue ads_personalization_enabled = 5; - - // Output only. Time when this link was originally created. - 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]; - - // Output only. Email address of the user that created the link. - // An empty string will be returned if the email address can't be retrieved. - string creator_email_address = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A resource message representing data sharing settings of a Google Analytics -// account. -message DataSharingSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataSharingSettings" - pattern: "accounts/{account}/dataSharingSettings" - }; - - // Output only. Resource name. - // Format: accounts/{account}/dataSharingSettings - // Example: "accounts/1000/dataSharingSettings" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Allows Google support to access the data in order to help troubleshoot - // issues. - bool sharing_with_google_support_enabled = 2; - - // Allows Google sales teams that are assigned to the customer to access the - // data in order to suggest configuration changes to improve results. - // Sales team restrictions still apply when enabled. - bool sharing_with_google_assigned_sales_enabled = 3; - - // Allows any of Google sales to access the data in order to suggest - // configuration changes to improve results. - bool sharing_with_google_any_sales_enabled = 4; - - // Allows Google to use the data to improve other Google products or services. - bool sharing_with_google_products_enabled = 5; - - // Allows Google to share the data anonymously in aggregate form with others. - bool sharing_with_others_enabled = 6; -} - -// A virtual resource representing an overview of an account and -// all its child GA4 properties. -message AccountSummary { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/AccountSummary" - pattern: "accountSummaries/{account_summary}" - }; - - // Resource name for this account summary. - // Format: accountSummaries/{account_id} - // Example: "accountSummaries/1000" - string name = 1; - - // Resource name of account referred to by this account summary - // Format: accounts/{account_id} - // Example: "accounts/1000" - string account = 2 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - }]; - - // Display name for the account referred to in this account summary. - string display_name = 3; - - // List of summaries for child accounts of this account. - repeated PropertySummary property_summaries = 4; -} - -// A virtual resource representing metadata for a GA4 property. -message PropertySummary { - // Resource name of property referred to by this property summary - // Format: properties/{property_id} - // Example: "properties/1000" - string property = 1 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - }]; - - // Display name for the property referred to in this property summary. - string display_name = 2; - - // The property's property type. - PropertyType property_type = 3; - - // Resource name of this property's logical parent. - // - // Note: The Property-Moving UI can be used to change the parent. - // Format: accounts/{account}, properties/{property} - // Example: "accounts/100", "properties/200" - string parent = 4; -} - -// A secret value used for sending hits to Measurement Protocol. -message MeasurementProtocolSecret { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - pattern: "properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}" - }; - - // Output only. Resource name of this secret. This secret may be a child of any type of - // stream. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Human-readable display name for this secret. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Output only. The measurement protocol secret value. Pass this value to the api_secret - // field of the Measurement Protocol API when sending hits to this - // secret's parent property. - string secret_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A set of changes within a Google Analytics account or its child properties -// that resulted from the same cause. Common causes would be updates made in the -// Google Analytics UI, changes from customer support, or automatic Google -// Analytics system changes. -message ChangeHistoryEvent { - // ID of this change history event. This ID is unique across Google Analytics. - string id = 1; - - // Time when change was made. - google.protobuf.Timestamp change_time = 2; - - // The type of actor that made this change. - ActorType actor_type = 3; - - // Email address of the Google account that made the change. This will be a - // valid email address if the actor field is set to USER, and empty otherwise. - // Google accounts that have been deleted will cause an error. - string user_actor_email = 4; - - // If true, then the list of changes returned was filtered, and does not - // represent all changes that occurred in this event. - bool changes_filtered = 5; - - // A list of changes made in this change history event that fit the filters - // specified in SearchChangeHistoryEventsRequest. - repeated ChangeHistoryChange changes = 6; -} - -// A description of a change to a single Google Analytics resource. -message ChangeHistoryChange { - // A snapshot of a resource as before or after the result of a change in - // change history. - message ChangeHistoryResource { - oneof resource { - // A snapshot of an Account resource in change history. - Account account = 1; - - // A snapshot of a Property resource in change history. - Property property = 2; - - // A snapshot of a FirebaseLink resource in change history. - FirebaseLink firebase_link = 6; - - // A snapshot of a GoogleAdsLink resource in change history. - GoogleAdsLink google_ads_link = 7; - - // A snapshot of a GoogleSignalsSettings resource in change history. - GoogleSignalsSettings google_signals_settings = 8; - - // A snapshot of a DisplayVideo360AdvertiserLink resource in change - // history. - DisplayVideo360AdvertiserLink display_video_360_advertiser_link = 9; - - // A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in - // change history. - DisplayVideo360AdvertiserLinkProposal display_video_360_advertiser_link_proposal = 10; - - // A snapshot of a ConversionEvent resource in change history. - ConversionEvent conversion_event = 11; - - // A snapshot of a MeasurementProtocolSecret resource in change history. - MeasurementProtocolSecret measurement_protocol_secret = 12; - - // A snapshot of a CustomDimension resource in change history. - CustomDimension custom_dimension = 13; - - // A snapshot of a CustomMetric resource in change history. - CustomMetric custom_metric = 14; - - // A snapshot of a data retention settings resource in change history. - DataRetentionSettings data_retention_settings = 15; - - // A snapshot of a DataStream resource in change history. - DataStream data_stream = 18; - - // A snapshot of AttributionSettings resource in change history. - AttributionSettings attribution_settings = 20; - } - } - - // Resource name of the resource whose changes are described by this entry. - string resource = 1; - - // The type of action that changed this resource. - ActionType action = 2; - - // Resource contents from before the change was made. If this resource was - // created in this change, this field will be missing. - ChangeHistoryResource resource_before_change = 3; - - // Resource contents from after the change was made. If this resource was - // deleted in this change, this field will be missing. - ChangeHistoryResource resource_after_change = 4; -} - -// A link between a GA4 property and a Display & Video 360 advertiser. -message DisplayVideo360AdvertiserLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLink" - pattern: "properties/{property}/displayVideo360AdvertiserLinks/{display_video_360_advertiser_link}" - }; - - // Output only. The resource name for this DisplayVideo360AdvertiserLink resource. - // Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} - // - // Note: linkId is not the Display & Video 360 Advertiser ID - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The Display & Video 360 Advertiser's advertiser ID. - string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. The display name of the Display & Video 360 Advertiser. - string advertiser_display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Enables personalized advertising features with this integration. - // If this field is not set on create/update, it will be defaulted to true. - 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. - 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. - 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 is converted to a DisplayVideo360AdvertiserLink once approved. -// Google Analytics admins approve inbound proposals while Display & Video 360 -// admins approve outbound proposals. -message DisplayVideo360AdvertiserLinkProposal { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DisplayVideo360AdvertiserLinkProposal" - pattern: "properties/{property}/displayVideo360AdvertiserLinkProposals/{display_video_360_advertiser_link_proposal}" - }; - - // Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. - // Format: - // properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} - // - // Note: proposalId is not the Display & Video 360 Advertiser ID - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The Display & Video 360 Advertiser's advertiser ID. - string advertiser_id = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. The status information for this link proposal. - LinkProposalStatusDetails link_proposal_status_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The display name of the Display & Video Advertiser. - // Only populated for proposals that originated from Display & Video 360. - string advertiser_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Input only. On a proposal being sent to Display & Video 360, this field must be set to - // the email address of an admin on the target advertiser. This is used to - // verify that the Google Analytics admin is aware of at least one admin on - // the Display & Video 360 Advertiser. This does not restrict approval of the - // proposal to a single user. Any admin on the Display & Video 360 Advertiser - // may approve the proposal. - string validation_email = 5 [(google.api.field_behavior) = INPUT_ONLY]; - - // Immutable. Enables personalized advertising features with this integration. - // If this field is not set on create, it will be defaulted to true. - google.protobuf.BoolValue ads_personalization_enabled = 6 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Enables the import of campaign data from Display & Video 360. - // If this field is not set on create, it will be defaulted to true. - google.protobuf.BoolValue campaign_data_sharing_enabled = 7 [(google.api.field_behavior) = IMMUTABLE]; - - // Immutable. Enables the import of cost data from Display & Video 360. - // This can only be enabled if campaign_data_sharing_enabled is enabled. - // If this field is not set on create, it will be defaulted to true. - google.protobuf.BoolValue cost_data_sharing_enabled = 8 [(google.api.field_behavior) = IMMUTABLE]; -} - -// Status information for a link proposal. -message LinkProposalStatusDetails { - // Output only. The source of this proposal. - LinkProposalInitiatingProduct link_proposal_initiating_product = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The email address of the user that proposed this linkage. - string requestor_email = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The state of this proposal. - LinkProposalState link_proposal_state = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A conversion event in a Google Analytics property. -message ConversionEvent { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - pattern: "properties/{property}/conversionEvents/{conversion_event}" - }; - - // Output only. Resource name of this conversion event. - // Format: properties/{property}/conversionEvents/{conversion_event} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The event name for this conversion event. - // Examples: 'click', 'purchase' - string event_name = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. Time when this conversion event was created in the property. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, this event can currently be deleted via DeleteConversionEvent. - bool deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set to true, this conversion event refers to a custom event. If set to - // false, this conversion event refers to a default event in GA. Default - // events typically have special meaning in GA. Default events are usually - // created for you by the GA system, but in some cases can be created by - // property admins. Custom events count towards the maximum number of - // custom conversion events that may be created per property. - bool custom = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Settings values for Google Signals. This is a singleton resource. -message GoogleSignalsSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/GoogleSignalsSettings" - pattern: "properties/{property}/googleSignalsSettings" - }; - - // Output only. Resource name of this setting. - // Format: properties/{property_id}/googleSignalsSettings - // Example: "properties/1000/googleSignalsSettings" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Status of this setting. - GoogleSignalsState state = 3; - - // Output only. Terms of Service acceptance. - GoogleSignalsConsent consent = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A definition for a CustomDimension. -message CustomDimension { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - pattern: "properties/{property}/customDimensions/{custom_dimension}" - }; - - // Valid values for the scope of this dimension. - enum DimensionScope { - // Scope unknown or not specified. - DIMENSION_SCOPE_UNSPECIFIED = 0; - - // Dimension scoped to an event. - EVENT = 1; - - // Dimension scoped to a user. - USER = 2; - } - - // Output only. Resource name for this CustomDimension resource. - // Format: properties/{property}/customDimensions/{customDimension} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. Tagging parameter name for this custom dimension. - // - // If this is a user-scoped dimension, then this is the user property name. - // If this is an event-scoped dimension, then this is the event parameter - // name. - // - // May only contain alphanumeric and underscore characters, starting with a - // letter. Max length of 24 characters for user-scoped dimensions, 40 - // characters for event-scoped dimensions. - string parameter_name = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Required. Display name for this custom dimension as shown in the Analytics UI. - // Max length of 82 characters, alphanumeric plus space and underscore - // starting with a letter. Legacy system-generated display names may contain - // square brackets, but updates to this field will never permit square - // brackets. - string display_name = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Description for this custom dimension. Max length of 150 characters. - string description = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Required. Immutable. The scope of this dimension. - DimensionScope scope = 5 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. If set to true, sets this dimension as NPA and excludes it from ads - // personalization. - // - // This is currently only supported by user-scoped custom dimensions. - bool disallow_ads_personalization = 6 [(google.api.field_behavior) = OPTIONAL]; -} - -// A definition for a custom metric. -message CustomMetric { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - pattern: "properties/{property}/customMetrics/{custom_metric}" - }; - - // Possible types of representing the custom metric's value. - // - // Currency representation may change in the future, requiring a breaking API - // change. - enum MeasurementUnit { - // MeasurementUnit unspecified or missing. - MEASUREMENT_UNIT_UNSPECIFIED = 0; - - // This metric uses default units. - STANDARD = 1; - - // This metric measures a currency. - CURRENCY = 2; - - // This metric measures feet. - FEET = 3; - - // This metric measures meters. - METERS = 4; - - // This metric measures kilometers. - KILOMETERS = 5; - - // This metric measures miles. - MILES = 6; - - // This metric measures milliseconds. - MILLISECONDS = 7; - - // This metric measures seconds. - SECONDS = 8; - - // This metric measures minutes. - MINUTES = 9; - - // This metric measures hours. - HOURS = 10; - } - - // The scope of this metric. - enum MetricScope { - // Scope unknown or not specified. - METRIC_SCOPE_UNSPECIFIED = 0; - - // Metric scoped to an event. - EVENT = 1; - } - - // Labels that mark the data in this custom metric as data that should be - // restricted to specific users. - enum RestrictedMetricType { - // Type unknown or unspecified. - RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0; - - // Metric reports cost data. - COST_DATA = 1; - - // Metric reports revenue data. - REVENUE_DATA = 2; - } - - // Output only. Resource name for this CustomMetric resource. - // Format: properties/{property}/customMetrics/{customMetric} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. Tagging name for this custom metric. - // - // If this is an event-scoped metric, then this is the event parameter - // name. - // - // May only contain alphanumeric and underscore charactes, starting with a - // letter. Max length of 40 characters for event-scoped metrics. - string parameter_name = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Required. Display name for this custom metric as shown in the Analytics UI. - // Max length of 82 characters, alphanumeric plus space and underscore - // starting with a letter. Legacy system-generated display names may contain - // square brackets, but updates to this field will never permit square - // brackets. - string display_name = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Description for this custom dimension. - // Max length of 150 characters. - string description = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The type for the custom metric's value. - MeasurementUnit measurement_unit = 5 [(google.api.field_behavior) = REQUIRED]; - - // Required. Immutable. The scope of this custom metric. - MetricScope scope = 6 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. Types of restricted data that this metric may contain. Required for metrics - // with CURRENCY measurement unit. Must be empty for metrics with a - // non-CURRENCY measurement unit. - repeated RestrictedMetricType restricted_metric_type = 8 [(google.api.field_behavior) = OPTIONAL]; -} - -// Settings values for data retention. This is a singleton resource. -message DataRetentionSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataRetentionSettings" - pattern: "properties/{property}/dataRetentionSettings" - }; - - // Valid values for the data retention duration. - enum RetentionDuration { - // Data retention time duration is not specified. - RETENTION_DURATION_UNSPECIFIED = 0; - - // The data retention time duration is 2 months. - TWO_MONTHS = 1; - - // The data retention time duration is 14 months. - FOURTEEN_MONTHS = 3; - - // The data retention time duration is 26 months. - // Available to 360 properties only. - TWENTY_SIX_MONTHS = 4; - - // The data retention time duration is 38 months. - // Available to 360 properties only. - THIRTY_EIGHT_MONTHS = 5; - - // The data retention time duration is 50 months. - // Available to 360 properties only. - FIFTY_MONTHS = 6; - } - - // Output only. Resource name for this DataRetentionSetting resource. - // Format: properties/{property}/dataRetentionSettings - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The length of time that event-level data is retained. - RetentionDuration event_data_retention = 2; - - // If true, reset the retention period for the user identifier with every - // event from that user. - bool reset_user_data_on_new_activity = 3; -} - -// The attribution settings used for a given property. This is a singleton -// resource. -message AttributionSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/AttributionSettings" - pattern: "properties/{property}/attributionSettings" - }; - - // How far back in time events should be considered for inclusion in a - // converting path which leads to the first install of an app or the first - // visit to a site. - enum AcquisitionConversionEventLookbackWindow { - // Lookback window size unspecified. - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0; - - // 7-day lookback window. - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS = 1; - - // 30-day lookback window. - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 2; - } - - // How far back in time events should be considered for inclusion in a - // converting path for all conversions other than first app install/first site - // visit. - enum OtherConversionEventLookbackWindow { - // Lookback window size unspecified. - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED = 0; - - // 30-day lookback window. - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS = 1; - - // 60-day lookback window. - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS = 2; - - // 90-day lookback window. - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS = 3; - } - - // The reporting attribution model used to calculate conversion credit in this - // property's reports. - enum ReportingAttributionModel { - // Reporting attribution model unspecified. - REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED = 0; - - // Data-driven attribution distributes credit for the conversion based on - // data for each conversion event. Each Data-driven model is specific to - // each advertiser and each conversion event. - CROSS_CHANNEL_DATA_DRIVEN = 1; - - // Ignores direct traffic and attributes 100% of the conversion value to the - // last channel that the customer clicked through (or engaged view through - // for YouTube) before converting. - CROSS_CHANNEL_LAST_CLICK = 2; - - // Gives all credit for the conversion to the first channel that a customer - // clicked (or engaged view through for YouTube) before converting. - CROSS_CHANNEL_FIRST_CLICK = 3; - - // Distributes the credit for the conversion equally across all the channels - // a customer clicked (or engaged view through for YouTube) before - // converting. - CROSS_CHANNEL_LINEAR = 4; - - // Attributes 40% credit to the first and last interaction, and the - // remaining 20% credit is distributed evenly to the middle interactions. - CROSS_CHANNEL_POSITION_BASED = 5; - - // Gives more credit to the touchpoints that happened closer in time to - // the conversion. - CROSS_CHANNEL_TIME_DECAY = 6; - - // Attributes 100% of the conversion value to the last Google Ads channel - // that the customer clicked through before converting. - ADS_PREFERRED_LAST_CLICK = 7; - } - - // Output only. Resource name of this attribution settings resource. - // Format: properties/{property_id}/attributionSettings - // Example: "properties/1000/attributionSettings" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. The lookback window configuration for acquisition conversion events. - // The default window size is 30 days. - AcquisitionConversionEventLookbackWindow acquisition_conversion_event_lookback_window = 2 [(google.api.field_behavior) = REQUIRED]; - - // Required. The lookback window for all other, non-acquisition conversion events. - // The default window size is 90 days. - OtherConversionEventLookbackWindow other_conversion_event_lookback_window = 3 [(google.api.field_behavior) = REQUIRED]; - - // Required. The reporting attribution model used to calculate conversion credit in this - // property's reports. - // - // Changing the attribution model will apply to both historical and future - // data. These changes will be reflected in reports with conversion and - // revenue data. User and session data will be unaffected. - ReportingAttributionModel reporting_attribution_model = 4 [(google.api.field_behavior) = REQUIRED]; -} diff --git a/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel b/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel deleted file mode 100644 index 3184ca8..0000000 --- a/third_party/googleapis/google/analytics/admin/v1beta/BUILD.bazel +++ /dev/null @@ -1,376 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "admin_proto", - srcs = [ - "analytics_admin.proto", - "resources.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "//google/api:field_behavior_proto", - "//google/api:resource_proto", - "@com_google_protobuf//:empty_proto", - "@com_google_protobuf//:field_mask_proto", - "@com_google_protobuf//:timestamp_proto", - "@com_google_protobuf//:wrappers_proto", - ], -) - -proto_library_with_info( - name = "admin_proto_with_info", - deps = [ - ":admin_proto", - "//google/cloud:common_resources_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "admin_java_proto", - deps = [":admin_proto"], -) - -java_grpc_library( - name = "admin_java_grpc", - srcs = [":admin_proto"], - deps = [":admin_java_proto"], -) - -java_gapic_library( - name = "admin_java_gapic", - srcs = [":admin_proto_with_info"], - gapic_yaml = None, - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin.yaml", - test_deps = [ - ":admin_java_grpc", - ], - transport = "grpc+rest", - deps = [ - ":admin_java_proto", - "//google/api:api_java_proto", - ], -) - -java_gapic_test( - name = "admin_java_gapic_test_suite", - test_classes = [ - "com.google.analytics.admin.v1beta.AnalyticsAdminServiceClientHttpJsonTest", - "com.google.analytics.admin.v1beta.AnalyticsAdminServiceClientTest", - ], - runtime_deps = [":admin_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-cloud-analytics-admin-v1beta-java", - include_samples = True, - transport = "grpc+rest", - deps = [ - ":admin_java_gapic", - ":admin_java_grpc", - ":admin_java_proto", - ":admin_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "admin_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/analytics/admin/v1beta", - protos = [":admin_proto"], - deps = [ - "//google/api:annotations_go_proto", - ], -) - -go_gapic_library( - name = "admin_go_gapic", - srcs = [":admin_proto_with_info"], - grpc_service_config = "admin_grpc_service_config.json", - importpath = "google.golang.org/google/analytics/admin/v1beta;admin", - metadata = True, - service_yaml = "analyticsadmin.yaml", - transport = "grpc+rest", - deps = [ - ":admin_go_proto", - ], -) - -go_test( - name = "admin_go_gapic_test", - srcs = [":admin_go_gapic_srcjar_test"], - embed = [":admin_go_gapic"], - importpath = "google.golang.org/google/analytics/admin/v1beta", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-cloud-analytics-admin-v1beta-go", - deps = [ - ":admin_go_gapic", - ":admin_go_gapic_srcjar-metadata.srcjar", - ":admin_go_gapic_srcjar-test.srcjar", - ":admin_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "admin_py_gapic", - srcs = [":admin_proto"], - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin.yaml", - transport = "grpc+rest", -) - -py_test( - name = "admin_py_gapic_test", - srcs = [ - "admin_py_gapic_pytest.py", - "admin_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":admin_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "analytics-admin-v1beta-py", - deps = [ - ":admin_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "admin_php_proto", - deps = [":admin_proto"], -) - -php_grpc_library( - name = "admin_php_grpc", - srcs = [":admin_proto"], - deps = [":admin_php_proto"], -) - -php_gapic_library( - name = "admin_php_gapic", - srcs = [":admin_proto_with_info"], - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin.yaml", - deps = [ - ":admin_php_grpc", - ":admin_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-cloud-analytics-admin-v1beta-php", - deps = [ - ":admin_php_gapic", - ":admin_php_grpc", - ":admin_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "admin_nodejs_gapic", - package_name = "@google-cloud/admin", - src = ":admin_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "admin_grpc_service_config.json", - package = "google.analytics.admin.v1beta", - service_yaml = "analyticsadmin.yaml", - deps = [], -) - -nodejs_gapic_assembly_pkg( - name = "analytics-admin-v1beta-nodejs", - deps = [ - ":admin_nodejs_gapic", - ":admin_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "admin_ruby_proto", - deps = [":admin_proto"], -) - -ruby_grpc_library( - name = "admin_ruby_grpc", - srcs = [":admin_proto"], - deps = [":admin_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "admin_ruby_gapic", - srcs = [":admin_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-analytics-admin-v1beta", - ], - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin.yaml", - deps = [ - ":admin_ruby_grpc", - ":admin_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-cloud-analytics-admin-v1beta-ruby", - deps = [ - ":admin_ruby_gapic", - ":admin_ruby_grpc", - ":admin_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "admin_csharp_proto", - deps = [":admin_proto"], -) - -csharp_grpc_library( - name = "admin_csharp_grpc", - srcs = [":admin_proto"], - deps = [":admin_csharp_proto"], -) - -csharp_gapic_library( - name = "admin_csharp_gapic", - srcs = [":admin_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "admin_grpc_service_config.json", - service_yaml = "analyticsadmin.yaml", - deps = [ - ":admin_csharp_grpc", - ":admin_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-cloud-analytics-admin-v1beta-csharp", - deps = [ - ":admin_csharp_gapic", - ":admin_csharp_grpc", - ":admin_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "admin_cc_proto", - deps = [":admin_proto"], -) - -cc_grpc_library( - name = "admin_cc_grpc", - srcs = [":admin_proto"], - grpc_only = True, - deps = [":admin_cc_proto"], -) diff --git a/third_party/googleapis/google/analytics/admin/v1beta/admin_grpc_service_config.json b/third_party/googleapis/google/analytics/admin/v1beta/admin_grpc_service_config.json deleted file mode 100644 index e78bde2..0000000 --- a/third_party/googleapis/google/analytics/admin/v1beta/admin_grpc_service_config.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "methodConfig": [ - { - "name": [{"service": "google.analytics.admin.v1beta.AnalyticsAdminService"}], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "1s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": ["UNAVAILABLE", "UNKNOWN"] - } - }, - { - "name": [ - { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetAccount" - }, - { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListAccounts" - }, - { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteAccount" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateAccount" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ProvisionAccountTicket" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetProperty" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListProperties" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteProperty" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateProperty" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateProperty" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetUserLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "BatchGetUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "AuditUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateUserLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "BatchCreateUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateUserLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "BatchUpdateUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteUserLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "BatchDeleteUserLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetWebDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateWebDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateWebDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListWebDataStreams" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetIosAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteIosAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateIosAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateIosAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListIosAppDataStreams" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetAndroidAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteAndroidAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateAndroidAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateAndroidAppDataStream" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListAndroidAppDataStreams" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetEnhancedMeasurementSettings" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateEnhancedMeasurementSettings" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateFirebaseLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateFirebaseLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteFirebaseLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListFirebaseLinks" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "GetGlobalSiteTag" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "CreateGoogleAdsLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "UpdateGoogleAdsLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "DeleteGoogleAdsLink" - }, { - "service": "google.analytics.admin.v1beta.AnalyticsAdminService", - "method": "ListGoogleAdsLinks" - } - ], - "timeout": "60s" - } - ] -} diff --git a/third_party/googleapis/google/analytics/admin/v1beta/analytics_admin.proto b/third_party/googleapis/google/analytics/admin/v1beta/analytics_admin.proto deleted file mode 100644 index 7e80f73..0000000 --- a/third_party/googleapis/google/analytics/admin/v1beta/analytics_admin.proto +++ /dev/null @@ -1,1333 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1beta; - -import "google/analytics/admin/v1beta/resources.proto"; -import "google/api/annotations.proto"; -import "google/api/client.proto"; -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/v1beta;admin"; -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 AnalyticsAdminService { - option (google.api.default_host) = "analyticsadmin.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/analytics.edit," - "https://www.googleapis.com/auth/analytics.readonly"; - - // Lookup for a single Account. - rpc GetAccount(GetAccountRequest) returns (Account) { - option (google.api.http) = { - get: "/v1beta/{name=accounts/*}" - }; - option (google.api.method_signature) = "name"; - } - - // 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. - rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse) { - option (google.api.http) = { - get: "/v1beta/accounts" - }; - } - - // Marks target Account as soft-deleted (ie: "trashed") and returns it. - // - // This API does not have a method to restore soft-deleted accounts. - // However, they can be restored using the Trash Can UI. - // - // If the accounts are not restored before the expiration time, the account - // and all child resources (eg: Properties, GoogleAdsLinks, Streams, - // UserLinks) will be permanently purged. - // https://support.google.com/analytics/answer/6154772 - // - // Returns an error if the target is not found. - rpc DeleteAccount(DeleteAccountRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=accounts/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates an account. - rpc UpdateAccount(UpdateAccountRequest) returns (Account) { - option (google.api.http) = { - patch: "/v1beta/{account.name=accounts/*}" - body: "account" - }; - option (google.api.method_signature) = "account,update_mask"; - } - - // Requests a ticket for creating an account. - rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse) { - option (google.api.http) = { - post: "/v1beta/accounts:provisionAccountTicket" - body: "*" - }; - } - - // Returns summaries of all accounts accessible by the caller. - rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse) { - option (google.api.http) = { - get: "/v1beta/accountSummaries" - }; - } - - // Lookup for a single "GA4" Property. - rpc GetProperty(GetPropertyRequest) returns (Property) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*}" - }; - option (google.api.method_signature) = "name"; - } - - // 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. - rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse) { - option (google.api.http) = { - get: "/v1beta/properties" - }; - } - - // Creates an "GA4" property with the specified location and attributes. - rpc CreateProperty(CreatePropertyRequest) returns (Property) { - option (google.api.http) = { - post: "/v1beta/properties" - body: "property" - }; - option (google.api.method_signature) = "property"; - } - - // 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, UserLinks) - // will be permanently purged. - // https://support.google.com/analytics/answer/6154772 - // - // Returns an error if the target is not found, or is not an GA4 Property. - rpc DeleteProperty(DeletePropertyRequest) returns (Property) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a property. - rpc UpdateProperty(UpdatePropertyRequest) returns (Property) { - option (google.api.http) = { - patch: "/v1beta/{property.name=properties/*}" - body: "property" - }; - option (google.api.method_signature) = "property,update_mask"; - } - - // Creates a FirebaseLink. - // - // Properties can have at most one FirebaseLink. - rpc CreateFirebaseLink(CreateFirebaseLinkRequest) returns (FirebaseLink) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/firebaseLinks" - body: "firebase_link" - }; - option (google.api.method_signature) = "parent,firebase_link"; - } - - // Deletes a FirebaseLink on a property - rpc DeleteFirebaseLink(DeleteFirebaseLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*/firebaseLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists FirebaseLinks on a property. - // Properties can have at most one FirebaseLink. - rpc ListFirebaseLinks(ListFirebaseLinksRequest) returns (ListFirebaseLinksResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/firebaseLinks" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a GoogleAdsLink. - rpc CreateGoogleAdsLink(CreateGoogleAdsLinkRequest) returns (GoogleAdsLink) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/googleAdsLinks" - body: "google_ads_link" - }; - option (google.api.method_signature) = "parent,google_ads_link"; - } - - // Updates a GoogleAdsLink on a property - rpc UpdateGoogleAdsLink(UpdateGoogleAdsLinkRequest) returns (GoogleAdsLink) { - option (google.api.http) = { - patch: "/v1beta/{google_ads_link.name=properties/*/googleAdsLinks/*}" - body: "google_ads_link" - }; - option (google.api.method_signature) = "google_ads_link,update_mask"; - } - - // Deletes a GoogleAdsLink on a property - rpc DeleteGoogleAdsLink(DeleteGoogleAdsLinkRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*/googleAdsLinks/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Lists GoogleAdsLinks on a property. - rpc ListGoogleAdsLinks(ListGoogleAdsLinksRequest) returns (ListGoogleAdsLinksResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/googleAdsLinks" - }; - option (google.api.method_signature) = "parent"; - } - - // Get data sharing settings on an account. - // Data sharing settings are singletons. - rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings) { - option (google.api.http) = { - get: "/v1beta/{name=accounts/*/dataSharingSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single "GA4" MeasurementProtocolSecret. - rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns child MeasurementProtocolSecrets under the specified parent - // Property. - rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a measurement protocol secret. - rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets" - body: "measurement_protocol_secret" - }; - option (google.api.method_signature) = "parent,measurement_protocol_secret"; - } - - // Deletes target MeasurementProtocolSecret. - rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a measurement protocol secret. - rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret) { - option (google.api.http) = { - patch: "/v1beta/{measurement_protocol_secret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}" - body: "measurement_protocol_secret" - }; - option (google.api.method_signature) = "measurement_protocol_secret,update_mask"; - } - - // Acknowledges the terms of user data collection for the specified property. - // - // This acknowledgement must be completed (either in the Google Analytics UI - // or via this API) before MeasurementProtocolSecret resources may be created. - rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:acknowledgeUserDataCollection" - body: "*" - }; - } - - // Searches through all changes to an account or its children given the - // specified set of filters. - rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse) { - option (google.api.http) = { - post: "/v1beta/{account=accounts/*}:searchChangeHistoryEvents" - body: "*" - }; - } - - // Creates a conversion event with the specified attributes. - rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/conversionEvents" - body: "conversion_event" - }; - option (google.api.method_signature) = "parent,conversion_event"; - } - - // Retrieve a single conversion event. - rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/conversionEvents/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Deletes a conversion event in a property. - rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*/conversionEvents/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns a list of conversion events in the specified parent property. - // - // Returns an empty list if no conversion events are found. - rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/conversionEvents" - }; - option (google.api.method_signature) = "parent"; - } - - // Creates a CustomDimension. - rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/customDimensions" - body: "custom_dimension" - }; - option (google.api.method_signature) = "parent,custom_dimension"; - } - - // Updates a CustomDimension on a property. - rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - patch: "/v1beta/{custom_dimension.name=properties/*/customDimensions/*}" - body: "custom_dimension" - }; - option (google.api.method_signature) = "custom_dimension,update_mask"; - } - - // Lists CustomDimensions on a property. - rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/customDimensions" - }; - option (google.api.method_signature) = "parent"; - } - - // Archives a CustomDimension on a property. - rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1beta/{name=properties/*/customDimensions/*}:archive" - body: "*" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single CustomDimension. - rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/customDimensions/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Creates a CustomMetric. - rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/customMetrics" - body: "custom_metric" - }; - option (google.api.method_signature) = "parent,custom_metric"; - } - - // Updates a CustomMetric on a property. - rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - patch: "/v1beta/{custom_metric.name=properties/*/customMetrics/*}" - body: "custom_metric" - }; - option (google.api.method_signature) = "custom_metric,update_mask"; - } - - // Lists CustomMetrics on a property. - rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/customMetrics" - }; - option (google.api.method_signature) = "parent"; - } - - // Archives a CustomMetric on a property. - rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - post: "/v1beta/{name=properties/*/customMetrics/*}:archive" - body: "*" - }; - option (google.api.method_signature) = "name"; - } - - // Lookup for a single CustomMetric. - rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/customMetrics/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns the singleton data retention settings for this property. - rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/dataRetentionSettings}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates the singleton data retention settings for this property. - rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings) { - option (google.api.http) = { - patch: "/v1beta/{data_retention_settings.name=properties/*/dataRetentionSettings}" - body: "data_retention_settings" - }; - option (google.api.method_signature) = "data_retention_settings,update_mask"; - } - - // Creates a DataStream. - rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - post: "/v1beta/{parent=properties/*}/dataStreams" - body: "data_stream" - }; - option (google.api.method_signature) = "parent,data_stream"; - } - - // Deletes a DataStream on a property. - rpc DeleteDataStream(DeleteDataStreamRequest) returns (google.protobuf.Empty) { - option (google.api.http) = { - delete: "/v1beta/{name=properties/*/dataStreams/*}" - }; - option (google.api.method_signature) = "name"; - } - - // Updates a DataStream on a property. - rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - patch: "/v1beta/{data_stream.name=properties/*/dataStreams/*}" - body: "data_stream" - }; - option (google.api.method_signature) = "data_stream,update_mask"; - } - - // Lists DataStreams on a property. - rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse) { - option (google.api.http) = { - get: "/v1beta/{parent=properties/*}/dataStreams" - }; - option (google.api.method_signature) = "parent"; - } - - // Lookup for a single DataStream. - rpc GetDataStream(GetDataStreamRequest) returns (DataStream) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/dataStreams/*}" - }; - option (google.api.method_signature) = "name"; - } -} - -// Request message for GetAccount RPC. -message GetAccountRequest { - // Required. The name of the account to lookup. - // Format: accounts/{account} - // Example: "accounts/100" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// Request message for ListAccounts RPC. -message ListAccountsRequest { - // 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 = 1; - - // A page token, received from a previous `ListAccounts` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListAccounts` must - // match the call that provided the page token. - string page_token = 2; - - // Whether to include soft-deleted (ie: "trashed") Accounts in the - // results. Accounts can be inspected to determine whether they are deleted or - // not. - bool show_deleted = 3; -} - -// Request message for ListAccounts RPC. -message ListAccountsResponse { - // Results that were accessible to the caller. - repeated Account accounts = 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. - string next_page_token = 2; -} - -// Request message for DeleteAccount RPC. -message DeleteAccountRequest { - // Required. The name of the Account to soft-delete. - // Format: accounts/{account} - // Example: "accounts/100" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// Request message for UpdateAccount RPC. -message UpdateAccountRequest { - // Required. The account to update. - // The account's `name` field is used to identify the account. - Account account = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message ProvisionAccountTicketRequest { - // The account to create. - Account account = 1; - - // Redirect URI where the user will be sent after accepting Terms of Service. - // Must be configured in Developers Console as a Redirect URI - string redirect_uri = 2; -} - -// Response message for ProvisionAccountTicket RPC. -message ProvisionAccountTicketResponse { - // The param to be passed in the ToS link. - string account_ticket_id = 1; -} - -// Request message for GetProperty RPC. -message GetPropertyRequest { - // Required. The name of the property to lookup. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; -} - -// Request message for ListProperties RPC. -message ListPropertiesRequest { - // Required. An expression for filtering the results of the request. - // Fields eligible for filtering are: - // `parent:`(The resource name of the parent account/property) or - // `ancestor:`(The resource name of the parent account) or - // `firebase_project:`(The id or number of the linked firebase project). - // Some examples of filters: - // - // ``` - // | Filter | Description | - // |-----------------------------|-------------------------------------------| - // | parent:accounts/123 | The account with account id: 123. | - // | parent:properties/123 | The property with property id: 123. | - // | ancestor:accounts/123 | The account with account id: 123. | - // | firebase_project:project-id | The firebase project with id: project-id. | - // | firebase_project:123 | The firebase project with number: 123. | - // ``` - string filter = 1 [(google.api.field_behavior) = REQUIRED]; - - // 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 `ListProperties` 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; - - // Whether to include soft-deleted (ie: "trashed") Properties in the - // results. Properties can be inspected to determine whether they are deleted - // or not. - bool show_deleted = 4; -} - -// Response message for ListProperties RPC. -message ListPropertiesResponse { - // Results that matched the filter criteria and were accessible to the caller. - repeated Property properties = 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. - string next_page_token = 2; -} - -// Request message for UpdateProperty RPC. -message UpdatePropertyRequest { - // Required. The property to update. - // The property's `name` field is used to identify the property to be - // updated. - Property property = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message CreatePropertyRequest { - // Required. The property to create. - // Note: the supplied property must specify its parent. - Property property = 1 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteProperty RPC. -message DeletePropertyRequest { - // Required. The name of the Property to soft-delete. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; -} - -// Request message for CreateFirebaseLink RPC -message CreateFirebaseLinkRequest { - // Required. Format: properties/{property_id} - // Example: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/FirebaseLink" - } - ]; - - // Required. The Firebase link to create. - FirebaseLink firebase_link = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteFirebaseLink RPC -message DeleteFirebaseLinkRequest { - // Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} - // Example: properties/1234/firebaseLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/FirebaseLink" - } - ]; -} - -// Request message for ListFirebaseLinks RPC -message ListFirebaseLinksRequest { - // Required. Format: properties/{property_id} - // Example: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - 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 CreateGoogleAdsLink RPC -message CreateGoogleAdsLinkRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; - - // Required. The GoogleAdsLink to create. - GoogleAdsLink google_ads_link = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateGoogleAdsLink RPC -message UpdateGoogleAdsLinkRequest { - // The GoogleAdsLink to update - GoogleAdsLink google_ads_link = 1; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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. -message DeleteGoogleAdsLinkRequest { - // Required. Example format: properties/1234/googleAdsLinks/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; -} - -// Request message for ListGoogleAdsLinks RPC. -message ListGoogleAdsLinksRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/GoogleAdsLink" - } - ]; - - // The maximum number of resources to return. - // 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 `ListGoogleAdsLinks` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListGoogleAdsLinks` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListGoogleAdsLinks RPC. -message ListGoogleAdsLinksResponse { - // List of GoogleAdsLinks. - repeated GoogleAdsLink google_ads_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. - string next_page_token = 2; -} - -// Request message for GetDataSharingSettings RPC. -message GetDataSharingSettingsRequest { - // Required. The name of the settings to lookup. - // Format: accounts/{account}/dataSharingSettings - // Example: "accounts/1000/dataSharingSettings" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataSharingSettings" - } - ]; -} - -// Request message for ListAccountSummaries RPC. -message ListAccountSummariesRequest { - // The maximum number of AccountSummary 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 = 1; - - // A page token, received from a previous `ListAccountSummaries` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListAccountSummaries` - // must match the call that provided the page token. - string page_token = 2; -} - -// Response message for ListAccountSummaries RPC. -message ListAccountSummariesResponse { - // Account summaries of all accounts the caller has access to. - repeated AccountSummary account_summaries = 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. - string next_page_token = 2; -} - -// Request message for AcknowledgeUserDataCollection RPC. -message AcknowledgeUserDataCollectionRequest { - // Required. The property for which to acknowledge user data collection. - string property = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; - - // Required. An acknowledgement that the caller of this method understands the terms - // of user data collection. - // - // This field must contain the exact value: - // "I acknowledge that I have the necessary privacy disclosures and rights - // from my end users for the collection and processing of their data, - // including the association of such data with the visitation information - // Google Analytics collects from my site and/or app property." - string acknowledgement = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Response message for AcknowledgeUserDataCollection RPC. -message AcknowledgeUserDataCollectionResponse { - -} - -// Request message for SearchChangeHistoryEvents RPC. -message SearchChangeHistoryEventsRequest { - // Required. The account resource for which to return change history resources. - string account = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; - - // Optional. Resource name for a child property. If set, only return changes - // made to this property or its child resources. - string property = 2 [ - (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - } - ]; - - // Optional. If set, only return changes if they are for a resource that matches at - // least one of these types. - repeated ChangeHistoryResourceType resource_type = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes that match one or more of these types of - // actions. - repeated ActionType action = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes if they are made by a user in this list. - repeated string actor_email = 5 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes made after this time (inclusive). - google.protobuf.Timestamp earliest_change_time = 6 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If set, only return changes made before this time (inclusive). - google.protobuf.Timestamp latest_change_time = 7 [(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). - int32 page_size = 8 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. - // Provide this to retrieve the subsequent page. When paginating, all other - // parameters provided to `SearchChangeHistoryEvents` must match the call that - // provided the page token. - string page_token = 9 [(google.api.field_behavior) = OPTIONAL]; -} - -// Response message for SearchAccounts RPC. -message SearchChangeHistoryEventsResponse { - // Results that were accessible to the caller. - repeated ChangeHistoryEvent change_history_events = 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. - string next_page_token = 2; -} - -// Request message for GetMeasurementProtocolSecret RPC. -message GetMeasurementProtocolSecretRequest { - // Required. The name of the measurement protocol secret to lookup. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; -} - -// Request message for CreateMeasurementProtocolSecret RPC -message CreateMeasurementProtocolSecretRequest { - // Required. The parent resource where this secret will be created. - // Format: properties/{property}/dataStreams/{dataStream} - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; - - // Required. The measurement protocol secret to create. - MeasurementProtocolSecret measurement_protocol_secret = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteMeasurementProtocolSecret RPC -message DeleteMeasurementProtocolSecretRequest { - // Required. The name of the MeasurementProtocolSecret to delete. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; -} - -// Request message for UpdateMeasurementProtocolSecret RPC -message UpdateMeasurementProtocolSecretRequest { - // Required. The measurement protocol secret to update. - MeasurementProtocolSecret measurement_protocol_secret = 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; -} - -// Request message for ListMeasurementProtocolSecret RPC -message ListMeasurementProtocolSecretsRequest { - // Required. The resource name of the parent stream. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - } - ]; - - // The maximum number of resources to return. - // If unspecified, at most 10 resources will be returned. - // The maximum value is 10. Higher values will be coerced to the maximum. - int32 page_size = 2; - - // A page token, received from a previous `ListMeasurementProtocolSecrets` - // call. Provide this to retrieve the subsequent page. When paginating, all - // other parameters provided to `ListMeasurementProtocolSecrets` must match - // the call that provided the page token. - string page_token = 3; -} - -// Response message for ListMeasurementProtocolSecret RPC -message ListMeasurementProtocolSecretsResponse { - // A list of secrets for the parent stream specified in the request. - repeated MeasurementProtocolSecret measurement_protocol_secrets = 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. - string next_page_token = 2; -} - -// Request message for CreateConversionEvent RPC -message CreateConversionEventRequest { - // Required. The conversion event to create. - ConversionEvent conversion_event = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The resource name of the parent property where this conversion event will - // be created. Format: properties/123 - string parent = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for GetConversionEvent RPC -message GetConversionEventRequest { - // Required. The resource name of the conversion event to retrieve. - // Format: properties/{property}/conversionEvents/{conversion_event} - // Example: "properties/123/conversionEvents/456" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for DeleteConversionEvent RPC -message DeleteConversionEventRequest { - // Required. The resource name of the conversion event to delete. - // Format: properties/{property}/conversionEvents/{conversion_event} - // Example: "properties/123/conversionEvents/456" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; -} - -// Request message for ListConversionEvents RPC -message ListConversionEventsRequest { - // Required. The resource name of the parent property. - // Example: 'properties/123' - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/ConversionEvent" - } - ]; - - // The maximum number of resources to return. - // 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 `ListConversionEvents` call. - // Provide this to retrieve the subsequent page. - // When paginating, all other parameters provided to `ListConversionEvents` - // must match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListConversionEvents RPC. -message ListConversionEventsResponse { - // The requested conversion events - repeated ConversionEvent conversion_events = 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. - string next_page_token = 2; -} - -// Request message for CreateCustomDimension RPC. -message CreateCustomDimensionRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; - - // Required. The CustomDimension to create. - CustomDimension custom_dimension = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateCustomDimension RPC. -message UpdateCustomDimensionRequest { - // The CustomDimension to update - CustomDimension custom_dimension = 1; - - // 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 ListCustomDimensions RPC. -message ListCustomDimensionsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; - - // The maximum number of resources to return. - // 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 `ListCustomDimensions` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListCustomDimensions` - // must match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListCustomDimensions RPC. -message ListCustomDimensionsResponse { - // List of CustomDimensions. - repeated CustomDimension custom_dimensions = 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. - string next_page_token = 2; -} - -// Request message for ArchiveCustomDimension RPC. -message ArchiveCustomDimensionRequest { - // Required. The name of the CustomDimension to archive. - // Example format: properties/1234/customDimensions/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; -} - -// Request message for GetCustomDimension RPC. -message GetCustomDimensionRequest { - // Required. The name of the CustomDimension to get. - // Example format: properties/1234/customDimensions/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - } - ]; -} - -// Request message for CreateCustomMetric RPC. -message CreateCustomMetricRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; - - // Required. The CustomMetric to create. - CustomMetric custom_metric = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for UpdateCustomMetric RPC. -message UpdateCustomMetricRequest { - // The CustomMetric to update - CustomMetric custom_metric = 1; - - // 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 ListCustomMetrics RPC. -message ListCustomMetricsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; - - // The maximum number of resources to return. - // 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 `ListCustomMetrics` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListCustomMetrics` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListCustomMetrics RPC. -message ListCustomMetricsResponse { - // List of CustomMetrics. - repeated CustomMetric custom_metrics = 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. - string next_page_token = 2; -} - -// Request message for ArchiveCustomMetric RPC. -message ArchiveCustomMetricRequest { - // Required. The name of the CustomMetric to archive. - // Example format: properties/1234/customMetrics/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; -} - -// Request message for GetCustomMetric RPC. -message GetCustomMetricRequest { - // Required. The name of the CustomMetric to get. - // Example format: properties/1234/customMetrics/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - } - ]; -} - -// Request message for GetDataRetentionSettings RPC. -message GetDataRetentionSettingsRequest { - // Required. The name of the settings to lookup. - // Format: - // properties/{property}/dataRetentionSettings - // Example: "properties/1000/dataRetentionSettings" - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataRetentionSettings" - } - ]; -} - -// Request message for UpdateDataRetentionSettings RPC. -message UpdateDataRetentionSettingsRequest { - // Required. The settings to update. - // The `name` field is used to identify the settings to be updated. - DataRetentionSettings data_retention_settings = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The list of fields to be updated. Field names must be in snake case - // (e.g., "field_to_update"). 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 CreateDataStream RPC. -message CreateDataStreamRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DataStream" - } - ]; - - // Required. The DataStream to create. - DataStream data_stream = 2 [(google.api.field_behavior) = REQUIRED]; -} - -// Request message for DeleteDataStream RPC. -message DeleteDataStreamRequest { - // Required. The name of the DataStream to delete. - // Example format: properties/1234/dataStreams/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataStream" - } - ]; -} - -// Request message for UpdateDataStream RPC. -message UpdateDataStreamRequest { - // The DataStream to update - DataStream data_stream = 1; - - // 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 ListDataStreams RPC. -message ListDataStreamsRequest { - // Required. Example format: properties/1234 - string parent = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - child_type: "analyticsadmin.googleapis.com/DataStream" - } - ]; - - // The maximum number of resources to return. - // 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 `ListDataStreams` call. - // Provide this to retrieve the subsequent page. - // - // When paginating, all other parameters provided to `ListDataStreams` must - // match the call that provided the page token. - string page_token = 3; -} - -// Response message for ListDataStreams RPC. -message ListDataStreamsResponse { - // List of DataStreams. - repeated DataStream data_streams = 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. - string next_page_token = 2; -} - -// Request message for GetDataStream RPC. -message GetDataStreamRequest { - // Required. The name of the DataStream to get. - // Example format: properties/1234/dataStreams/5678 - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/DataStream" - } - ]; -} diff --git a/third_party/googleapis/google/analytics/admin/v1beta/analyticsadmin.yaml b/third_party/googleapis/google/analytics/admin/v1beta/analyticsadmin.yaml deleted file mode 100644 index bffe682..0000000 --- a/third_party/googleapis/google/analytics/admin/v1beta/analyticsadmin.yaml +++ /dev/null @@ -1,109 +0,0 @@ -type: google.api.Service -config_version: 3 -name: analyticsadmin.googleapis.com -title: Google Analytics Admin API - -apis: -- name: google.analytics.admin.v1beta.AnalyticsAdminService - -authentication: - rules: - - selector: 'google.analytics.admin.v1beta.AnalyticsAdminService.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetAccount - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetConversionEvent - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomDimension - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetCustomMetric - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataRetentionSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataSharingSettings - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetDataStream - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetMeasurementProtocolSecret - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.GetProperty - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListAccountSummaries - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListAccounts - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListConversionEvents - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomDimensions - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListCustomMetrics - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListDataStreams - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListFirebaseLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListGoogleAdsLinks - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListMeasurementProtocolSecrets - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly - - selector: google.analytics.admin.v1beta.AnalyticsAdminService.ListProperties - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics.edit, - https://www.googleapis.com/auth/analytics.readonly diff --git a/third_party/googleapis/google/analytics/admin/v1beta/resources.proto b/third_party/googleapis/google/analytics/admin/v1beta/resources.proto deleted file mode 100644 index 2a70103..0000000 --- a/third_party/googleapis/google/analytics/admin/v1beta/resources.proto +++ /dev/null @@ -1,905 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.admin.v1beta; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/protobuf/timestamp.proto"; -import "google/protobuf/wrappers.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1beta;admin"; -option java_multiple_files = true; -option java_outer_classname = "ResourcesProto"; -option java_package = "com.google.analytics.admin.v1beta"; - -// The category selected for this property, used for industry benchmarking. -enum IndustryCategory { - // Industry category unspecified - INDUSTRY_CATEGORY_UNSPECIFIED = 0; - - // Automotive - AUTOMOTIVE = 1; - - // Business and industrial markets - BUSINESS_AND_INDUSTRIAL_MARKETS = 2; - - // Finance - FINANCE = 3; - - // Healthcare - HEALTHCARE = 4; - - // Technology - TECHNOLOGY = 5; - - // Travel - TRAVEL = 6; - - // Other - OTHER = 7; - - // Arts and entertainment - ARTS_AND_ENTERTAINMENT = 8; - - // Beauty and fitness - BEAUTY_AND_FITNESS = 9; - - // Books and literature - BOOKS_AND_LITERATURE = 10; - - // Food and drink - FOOD_AND_DRINK = 11; - - // Games - GAMES = 12; - - // Hobbies and leisure - HOBBIES_AND_LEISURE = 13; - - // Home and garden - HOME_AND_GARDEN = 14; - - // Internet and telecom - INTERNET_AND_TELECOM = 15; - - // Law and government - LAW_AND_GOVERNMENT = 16; - - // News - NEWS = 17; - - // Online communities - ONLINE_COMMUNITIES = 18; - - // People and society - PEOPLE_AND_SOCIETY = 19; - - // Pets and animals - PETS_AND_ANIMALS = 20; - - // Real estate - REAL_ESTATE = 21; - - // Reference - REFERENCE = 22; - - // Science - SCIENCE = 23; - - // Sports - SPORTS = 24; - - // Jobs and education - JOBS_AND_EDUCATION = 25; - - // Shopping - SHOPPING = 26; -} - -// Various levels of service for Google Analytics. -enum ServiceLevel { - // Service level not specified or invalid. - SERVICE_LEVEL_UNSPECIFIED = 0; - - // The standard version of Google Analytics. - GOOGLE_ANALYTICS_STANDARD = 1; - - // The paid, premium version of Google Analytics. - GOOGLE_ANALYTICS_360 = 2; -} - -// Different kinds of actors that can make changes to Google Analytics -// resources. -enum ActorType { - // Unknown or unspecified actor type. - ACTOR_TYPE_UNSPECIFIED = 0; - - // Changes made by the user specified in actor_email. - USER = 1; - - // Changes made by the Google Analytics system. - SYSTEM = 2; - - // Changes made by Google Analytics support team staff. - SUPPORT = 3; -} - -// Types of actions that may change a resource. -enum ActionType { - // Action type unknown or not specified. - ACTION_TYPE_UNSPECIFIED = 0; - - // Resource was created in this change. - CREATED = 1; - - // Resource was updated in this change. - UPDATED = 2; - - // Resource was deleted in this change. - DELETED = 3; -} - -// Types of resources whose changes may be returned from change history. -enum ChangeHistoryResourceType { - // Resource type unknown or not specified. - CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0; - - // Account resource - ACCOUNT = 1; - - // Property resource - PROPERTY = 2; - - // FirebaseLink resource - FIREBASE_LINK = 6; - - // GoogleAdsLink resource - GOOGLE_ADS_LINK = 7; - - // GoogleSignalsSettings resource - GOOGLE_SIGNALS_SETTINGS = 8; - - // ConversionEvent resource - CONVERSION_EVENT = 9; - - // MeasurementProtocolSecret resource - MEASUREMENT_PROTOCOL_SECRET = 10; - - // DataRetentionSettings resource - DATA_RETENTION_SETTINGS = 13; - - // DisplayVideo360AdvertiserLink resource - DISPLAY_VIDEO_360_ADVERTISER_LINK = 14; - - // DisplayVideo360AdvertiserLinkProposal resource - DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15; - - // DataStream resource - DATA_STREAM = 18; - - // AttributionSettings resource - ATTRIBUTION_SETTINGS = 20; -} - -// Types of Property resources. -enum PropertyType { - // Unknown or unspecified property type - PROPERTY_TYPE_UNSPECIFIED = 0; - - // Ordinary GA4 property - PROPERTY_TYPE_ORDINARY = 1; - - // GA4 subproperty - PROPERTY_TYPE_SUBPROPERTY = 2; - - // GA4 rollup property - PROPERTY_TYPE_ROLLUP = 3; -} - -// A resource message representing a Google Analytics account. -message Account { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/Account" - pattern: "accounts/{account}" - }; - - // Output only. Resource name of this account. - // Format: accounts/{account} - // Example: "accounts/100" - 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]; - - // Output only. Time when account payload fields were last updated. - 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 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. - bool deleted = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A resource message representing a Google Analytics GA4 property. -message Property { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/Property" - pattern: "properties/{property}" - }; - - // Output only. Resource name of this property. - // Format: properties/{property_id} - // Example: "properties/1000" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The property type for this Property resource. When creating a property, if - // the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be - // implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created - // via Google Analytics Admin API. - PropertyType property_type = 14 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. Time when the entity was originally created. - 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]; - - // Immutable. Resource name of this property's logical parent. - // - // Note: The Property-Moving UI can be used to change the parent. - // Format: accounts/{account}, properties/{property} - // Example: "accounts/100", "properties/101" - string parent = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Required. Human-readable display name for this property. - // - // The max allowed display name length is 100 UTF-16 code units. - string display_name = 5 [(google.api.field_behavior) = REQUIRED]; - - // Industry associated with this property - // Example: AUTOMOTIVE, FOOD_AND_DRINK - IndustryCategory industry_category = 6; - - // Required. Reporting Time Zone, used as the day boundary for reports, regardless of - // where the data originates. If the time zone honors DST, Analytics will - // automatically adjust for the changes. - // - // NOTE: Changing the time zone only affects data going forward, and is not - // applied retroactively. - // - // Format: https://www.iana.org/time-zones - // Example: "America/Los_Angeles" - string time_zone = 7 [(google.api.field_behavior) = REQUIRED]; - - // The currency type used in reports involving monetary values. - // - // - // Format: https://en.wikipedia.org/wiki/ISO_4217 - // Examples: "USD", "EUR", "JPY" - string currency_code = 8; - - // Output only. The Google Analytics service level that applies to this property. - ServiceLevel service_level = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, the time at which this property was trashed. If not set, then this - // property is not currently in the trash can. - google.protobuf.Timestamp delete_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, the time at which this trashed property will be permanently - // deleted. If not set, then this property is not currently in the trash can - // and is not slated to be deleted. - google.protobuf.Timestamp expire_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The resource name of the parent account - // Format: accounts/{account_id} - // Example: "accounts/123" - string account = 13 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - } - ]; -} - -// A resource message representing a data stream. -message DataStream { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataStream" - pattern: "properties/{property}/dataStreams/{data_stream}" - }; - - // Data specific to web streams. - message WebStreamData { - // Output only. Analytics "Measurement ID", without the "G-" prefix. - // Example: "G-1A2BCD345E" would just be "1A2BCD345E" - string measurement_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. ID of the corresponding web app in Firebase, if any. - // This ID can change if the web app is deleted and recreated. - string firebase_app_id = 2 [(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" - string default_uri = 3 [(google.api.field_behavior) = IMMUTABLE]; - } - - // Data specific to Android app streams. - message AndroidAppStreamData { - // Output only. ID of the corresponding Android app in Firebase, if any. - // This ID can change if the Android app is deleted and recreated. - string firebase_app_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The package name for the app being measured. - // Example: "com.example.myandroidapp" - string package_name = 2 [(google.api.field_behavior) = IMMUTABLE]; - } - - // Data specific to iOS app streams. - message IosAppStreamData { - // Output only. ID of the corresponding iOS app in Firebase, if any. - // This ID can change if the iOS app is deleted and recreated. - string firebase_app_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. The Apple App Store Bundle ID for the app - // Example: "com.example.myiosapp" - string bundle_id = 2 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.field_behavior) = REQUIRED - ]; - } - - // The type of the data stream. - enum DataStreamType { - // Type unknown or not specified. - DATA_STREAM_TYPE_UNSPECIFIED = 0; - - // Web data stream. - WEB_DATA_STREAM = 1; - - // Android app data stream. - ANDROID_APP_DATA_STREAM = 2; - - // iOS app data stream. - IOS_APP_DATA_STREAM = 3; - } - - // Data for specific data stream types. The message that will be - // set corresponds to the type of this stream. - oneof stream_data { - // Data specific to web streams. Must be populated if type is - // WEB_DATA_STREAM. - WebStreamData web_stream_data = 6; - - // Data specific to Android app streams. Must be populated if type is - // ANDROID_APP_DATA_STREAM. - AndroidAppStreamData android_app_stream_data = 7; - - // Data specific to iOS app streams. Must be populated if type is - // IOS_APP_DATA_STREAM. - IosAppStreamData ios_app_stream_data = 8; - } - - // Output only. Resource name of this Data Stream. - // Format: properties/{property_id}/dataStreams/{stream_id} - // Example: "properties/1000/dataStreams/2000" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. The type of this DataStream resource. - DataStreamType type = 2 [ - (google.api.field_behavior) = IMMUTABLE, - (google.api.field_behavior) = REQUIRED - ]; - - // Human-readable display name for the Data Stream. - // - // Required for web data streams. - // - // The max allowed display name length is 255 UTF-16 code units. - string display_name = 3; - - // Output only. Time when this stream was originally created. - 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]; -} - -// A link between a GA4 property and a Firebase project. -message FirebaseLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/FirebaseLink" - pattern: "properties/{property}/firebaseLinks/{firebase_link}" - }; - - // 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 - // have a project_name that contains a project number. - // - // Format: 'projects/{project number}' - // Example: 'projects/1234' - 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]; -} - -// A link between a GA4 property and a Google Ads account. -message GoogleAdsLink { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/GoogleAdsLink" - pattern: "properties/{property}/googleAdsLinks/{google_ads_link}" - }; - - // 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. Google Ads customer ID. - string customer_id = 3 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. If true, this link is for a Google Ads manager account. - bool can_manage_clients = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Enable personalized advertising features with this integration. - // Automatically publish my Google Analytics audience lists and Google - // Analytics remarketing events/parameters to the linked Google Ads account. - // If this field is not set on create/update, it will be defaulted to true. - google.protobuf.BoolValue ads_personalization_enabled = 5; - - // Output only. Time when this link was originally created. - 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]; - - // Output only. Email address of the user that created the link. - // An empty string will be returned if the email address can't be retrieved. - string creator_email_address = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A resource message representing data sharing settings of a Google Analytics -// account. -message DataSharingSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataSharingSettings" - pattern: "accounts/{account}/dataSharingSettings" - }; - - // Output only. Resource name. - // Format: accounts/{account}/dataSharingSettings - // Example: "accounts/1000/dataSharingSettings" - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Allows Google support to access the data in order to help troubleshoot - // issues. - bool sharing_with_google_support_enabled = 2; - - // Allows Google sales teams that are assigned to the customer to access the - // data in order to suggest configuration changes to improve results. - // Sales team restrictions still apply when enabled. - bool sharing_with_google_assigned_sales_enabled = 3; - - // Allows any of Google sales to access the data in order to suggest - // configuration changes to improve results. - bool sharing_with_google_any_sales_enabled = 4; - - // Allows Google to use the data to improve other Google products or services. - bool sharing_with_google_products_enabled = 5; - - // Allows Google to share the data anonymously in aggregate form with others. - bool sharing_with_others_enabled = 6; -} - -// A virtual resource representing an overview of an account and -// all its child GA4 properties. -message AccountSummary { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/AccountSummary" - pattern: "accountSummaries/{account_summary}" - }; - - // Resource name for this account summary. - // Format: accountSummaries/{account_id} - // Example: "accountSummaries/1000" - string name = 1; - - // Resource name of account referred to by this account summary - // Format: accounts/{account_id} - // Example: "accounts/1000" - string account = 2 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Account" - }]; - - // Display name for the account referred to in this account summary. - string display_name = 3; - - // List of summaries for child accounts of this account. - repeated PropertySummary property_summaries = 4; -} - -// A virtual resource representing metadata for a GA4 property. -message PropertySummary { - // Resource name of property referred to by this property summary - // Format: properties/{property_id} - // Example: "properties/1000" - string property = 1 [(google.api.resource_reference) = { - type: "analyticsadmin.googleapis.com/Property" - }]; - - // Display name for the property referred to in this property summary. - string display_name = 2; - - // The property's property type. - PropertyType property_type = 3; - - // Resource name of this property's logical parent. - // - // Note: The Property-Moving UI can be used to change the parent. - // Format: accounts/{account}, properties/{property} - // Example: "accounts/100", "properties/200" - string parent = 4; -} - -// A secret value used for sending hits to Measurement Protocol. -message MeasurementProtocolSecret { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/MeasurementProtocolSecret" - pattern: "properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}" - }; - - // Output only. Resource name of this secret. This secret may be a child of any type of - // stream. - // Format: - // properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Human-readable display name for this secret. - string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - - // Output only. The measurement protocol secret value. Pass this value to the api_secret - // field of the Measurement Protocol API when sending hits to this - // secret's parent property. - string secret_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A set of changes within a Google Analytics account or its child properties -// that resulted from the same cause. Common causes would be updates made in the -// Google Analytics UI, changes from customer support, or automatic Google -// Analytics system changes. -message ChangeHistoryEvent { - // ID of this change history event. This ID is unique across Google Analytics. - string id = 1; - - // Time when change was made. - google.protobuf.Timestamp change_time = 2; - - // The type of actor that made this change. - ActorType actor_type = 3; - - // Email address of the Google account that made the change. This will be a - // valid email address if the actor field is set to USER, and empty otherwise. - // Google accounts that have been deleted will cause an error. - string user_actor_email = 4; - - // If true, then the list of changes returned was filtered, and does not - // represent all changes that occurred in this event. - bool changes_filtered = 5; - - // A list of changes made in this change history event that fit the filters - // specified in SearchChangeHistoryEventsRequest. - repeated ChangeHistoryChange changes = 6; -} - -// A description of a change to a single Google Analytics resource. -message ChangeHistoryChange { - // A snapshot of a resource as before or after the result of a change in - // change history. - message ChangeHistoryResource { - oneof resource { - // A snapshot of an Account resource in change history. - Account account = 1; - - // A snapshot of a Property resource in change history. - Property property = 2; - - // A snapshot of a FirebaseLink resource in change history. - FirebaseLink firebase_link = 6; - - // A snapshot of a GoogleAdsLink resource in change history. - GoogleAdsLink google_ads_link = 7; - - // A snapshot of a ConversionEvent resource in change history. - ConversionEvent conversion_event = 11; - - // A snapshot of a MeasurementProtocolSecret resource in change history. - MeasurementProtocolSecret measurement_protocol_secret = 12; - - // A snapshot of a data retention settings resource in change history. - DataRetentionSettings data_retention_settings = 15; - - // A snapshot of a DataStream resource in change history. - DataStream data_stream = 18; - } - } - - // Resource name of the resource whose changes are described by this entry. - string resource = 1; - - // The type of action that changed this resource. - ActionType action = 2; - - // Resource contents from before the change was made. If this resource was - // created in this change, this field will be missing. - ChangeHistoryResource resource_before_change = 3; - - // Resource contents from after the change was made. If this resource was - // deleted in this change, this field will be missing. - ChangeHistoryResource resource_after_change = 4; -} - -// A conversion event in a Google Analytics property. -message ConversionEvent { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/ConversionEvent" - pattern: "properties/{property}/conversionEvents/{conversion_event}" - }; - - // Output only. Resource name of this conversion event. - // Format: properties/{property}/conversionEvents/{conversion_event} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Immutable. The event name for this conversion event. - // Examples: 'click', 'purchase' - string event_name = 2 [(google.api.field_behavior) = IMMUTABLE]; - - // Output only. Time when this conversion event was created in the property. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set, this event can currently be deleted via DeleteConversionEvent. - bool deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. If set to true, this conversion event refers to a custom event. If set to - // false, this conversion event refers to a default event in GA. Default - // events typically have special meaning in GA. Default events are usually - // created for you by the GA system, but in some cases can be created by - // property admins. Custom events count towards the maximum number of - // custom conversion events that may be created per property. - bool custom = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// A definition for a CustomDimension. -message CustomDimension { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/CustomDimension" - pattern: "properties/{property}/customDimensions/{custom_dimension}" - }; - - // Valid values for the scope of this dimension. - enum DimensionScope { - // Scope unknown or not specified. - DIMENSION_SCOPE_UNSPECIFIED = 0; - - // Dimension scoped to an event. - EVENT = 1; - - // Dimension scoped to a user. - USER = 2; - } - - // Output only. Resource name for this CustomDimension resource. - // Format: properties/{property}/customDimensions/{customDimension} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. Tagging parameter name for this custom dimension. - // - // If this is a user-scoped dimension, then this is the user property name. - // If this is an event-scoped dimension, then this is the event parameter - // name. - // - // May only contain alphanumeric and underscore characters, starting with a - // letter. Max length of 24 characters for user-scoped dimensions, 40 - // characters for event-scoped dimensions. - string parameter_name = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Required. Display name for this custom dimension as shown in the Analytics UI. - // Max length of 82 characters, alphanumeric plus space and underscore - // starting with a letter. Legacy system-generated display names may contain - // square brackets, but updates to this field will never permit square - // brackets. - string display_name = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Description for this custom dimension. Max length of 150 characters. - string description = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Required. Immutable. The scope of this dimension. - DimensionScope scope = 5 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. If set to true, sets this dimension as NPA and excludes it from ads - // personalization. - // - // This is currently only supported by user-scoped custom dimensions. - bool disallow_ads_personalization = 6 [(google.api.field_behavior) = OPTIONAL]; -} - -// A definition for a custom metric. -message CustomMetric { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/CustomMetric" - pattern: "properties/{property}/customMetrics/{custom_metric}" - }; - - // Possible types of representing the custom metric's value. - // - // Currency representation may change in the future, requiring a breaking API - // change. - enum MeasurementUnit { - // MeasurementUnit unspecified or missing. - MEASUREMENT_UNIT_UNSPECIFIED = 0; - - // This metric uses default units. - STANDARD = 1; - - // This metric measures a currency. - CURRENCY = 2; - - // This metric measures feet. - FEET = 3; - - // This metric measures meters. - METERS = 4; - - // This metric measures kilometers. - KILOMETERS = 5; - - // This metric measures miles. - MILES = 6; - - // This metric measures milliseconds. - MILLISECONDS = 7; - - // This metric measures seconds. - SECONDS = 8; - - // This metric measures minutes. - MINUTES = 9; - - // This metric measures hours. - HOURS = 10; - } - - // The scope of this metric. - enum MetricScope { - // Scope unknown or not specified. - METRIC_SCOPE_UNSPECIFIED = 0; - - // Metric scoped to an event. - EVENT = 1; - } - - // Labels that mark the data in this custom metric as data that should be - // restricted to specific users. - enum RestrictedMetricType { - // Type unknown or unspecified. - RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0; - - // Metric reports cost data. - COST_DATA = 1; - - // Metric reports revenue data. - REVENUE_DATA = 2; - } - - // Output only. Resource name for this CustomMetric resource. - // Format: properties/{property}/customMetrics/{customMetric} - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. Immutable. Tagging name for this custom metric. - // - // If this is an event-scoped metric, then this is the event parameter - // name. - // - // May only contain alphanumeric and underscore charactes, starting with a - // letter. Max length of 40 characters for event-scoped metrics. - string parameter_name = 2 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Required. Display name for this custom metric as shown in the Analytics UI. - // Max length of 82 characters, alphanumeric plus space and underscore - // starting with a letter. Legacy system-generated display names may contain - // square brackets, but updates to this field will never permit square - // brackets. - string display_name = 3 [(google.api.field_behavior) = REQUIRED]; - - // Optional. Description for this custom dimension. - // Max length of 150 characters. - string description = 4 [(google.api.field_behavior) = OPTIONAL]; - - // Required. The type for the custom metric's value. - MeasurementUnit measurement_unit = 5 [(google.api.field_behavior) = REQUIRED]; - - // Required. Immutable. The scope of this custom metric. - MetricScope scope = 6 [ - (google.api.field_behavior) = REQUIRED, - (google.api.field_behavior) = IMMUTABLE - ]; - - // Optional. Types of restricted data that this metric may contain. Required for metrics - // with CURRENCY measurement unit. Must be empty for metrics with a - // non-CURRENCY measurement unit. - repeated RestrictedMetricType restricted_metric_type = 8 [(google.api.field_behavior) = OPTIONAL]; -} - -// Settings values for data retention. This is a singleton resource. -message DataRetentionSettings { - option (google.api.resource) = { - type: "analyticsadmin.googleapis.com/DataRetentionSettings" - pattern: "properties/{property}/dataRetentionSettings" - }; - - // Valid values for the data retention duration. - enum RetentionDuration { - // Data retention time duration is not specified. - RETENTION_DURATION_UNSPECIFIED = 0; - - // The data retention time duration is 2 months. - TWO_MONTHS = 1; - - // The data retention time duration is 14 months. - FOURTEEN_MONTHS = 3; - - // The data retention time duration is 26 months. - // Available to 360 properties only. - TWENTY_SIX_MONTHS = 4; - - // The data retention time duration is 38 months. - // Available to 360 properties only. - THIRTY_EIGHT_MONTHS = 5; - - // The data retention time duration is 50 months. - // Available to 360 properties only. - FIFTY_MONTHS = 6; - } - - // Output only. Resource name for this DataRetentionSetting resource. - // Format: properties/{property}/dataRetentionSettings - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The length of time that event-level data is retained. - RetentionDuration event_data_retention = 2; - - // If true, reset the retention period for the user identifier with every - // event from that user. - bool reset_user_data_on_new_activity = 3; -} diff --git a/third_party/googleapis/google/analytics/data/BUILD.bazel b/third_party/googleapis/google/analytics/data/BUILD.bazel deleted file mode 100644 index 40fd80e..0000000 --- a/third_party/googleapis/google/analytics/data/BUILD.bazel +++ /dev/null @@ -1,41 +0,0 @@ -# This build file includes a target for the Ruby wrapper library for -# google-analytics-data. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -# Export yaml configs. -exports_files(glob(["*.yaml"])) - -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", -) - -# Generates a Ruby wrapper client for analyticsdata. -# Ruby wrapper clients are versionless, but are generated from source protos -# for a particular service version, v1beta in this case. -ruby_cloud_gapic_library( - name = "analyticsdata_ruby_wrapper", - srcs = ["//google/analytics/data/v1beta:data_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-analytics-data", - "ruby-cloud-env-prefix=ANALYTICS_DATA", - "ruby-cloud-wrapper-of=v1beta:0.0", - "ruby-cloud-product-url=https://developers.google.com/analytics/devguides/reporting/data/v1", - "ruby-cloud-api-id=analyticsdata.googleapis.com", - "ruby-cloud-api-shortname=analyticsdata", - "ruby-cloud-service-override=BetaAnalyticsData=AnalyticsData", - ], - ruby_cloud_description = "The Google Analytics Data API provides programmatic methods to access report data in Google Analytics 4 (GA4) properties. Google Analytics 4 helps you understand how people use your web, iOS, or Android app.", - ruby_cloud_title = "Google Analytics Data", -) - -# Open Source package. -ruby_gapic_assembly_pkg( - name = "google-analytics-data-ruby", - deps = [ - ":analyticsdata_ruby_wrapper", - ], -) diff --git a/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel b/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel deleted file mode 100644 index f1adcb8..0000000 --- a/third_party/googleapis/google/analytics/data/v1alpha/BUILD.bazel +++ /dev/null @@ -1,370 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "data_proto", - srcs = [ - "analytics_data_api.proto", - "data.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "@com_google_protobuf//:duration_proto", - ], -) - -proto_library_with_info( - name = "data_proto_with_info", - deps = [ - ":data_proto", - "//google/cloud:common_resources_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "data_java_proto", - deps = [":data_proto"], -) - -java_grpc_library( - name = "data_java_grpc", - srcs = [":data_proto"], - deps = [":data_java_proto"], -) - -java_gapic_library( - name = "data_java_gapic", - srcs = [":data_proto_with_info"], - gapic_yaml = None, - grpc_service_config = "analytics_data_grpc_service_config.json", - service_yaml = "analyticsdata_v1alpha.yaml", - test_deps = [ - ":data_java_grpc", - ], - transport = "grpc+rest", - deps = [ - ":data_java_proto", - "//google/api:api_java_proto", - ], -) - -java_gapic_test( - name = "data_java_gapic_test_suite", - test_classes = [ - "com.google.analytics.data.v1alpha.AlphaAnalyticsDataClientHttpJsonTest", - "com.google.analytics.data.v1alpha.AlphaAnalyticsDataClientTest", - ], - runtime_deps = [":data_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-cloud-analytics-data-v1alpha-java", - transport = "grpc+rest", - deps = [ - ":data_java_gapic", - ":data_java_grpc", - ":data_java_proto", - ":data_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "data_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/analytics/data/v1alpha", - protos = [":data_proto"], - deps = [ - "//google/api:annotations_go_proto", - ], -) - -go_gapic_library( - name = "data_go_gapic", - srcs = [":data_proto_with_info"], - grpc_service_config = "analytics_data_grpc_service_config.json", - importpath = "google.golang.org/google/analytics/data/v1alpha;data", - metadata = True, - service_yaml = "analyticsdata_v1alpha.yaml", - transport = "grpc+rest", - deps = [ - ":data_go_proto", - "@io_bazel_rules_go//proto/wkt:duration_go_proto", - ], -) - -go_test( - name = "data_go_gapic_test", - srcs = [":data_go_gapic_srcjar_test"], - embed = [":data_go_gapic"], - importpath = "google.golang.org/google/analytics/data/v1alpha", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-cloud-analytics-data-v1alpha-go", - deps = [ - ":data_go_gapic", - ":data_go_gapic_srcjar-metadata.srcjar", - ":data_go_gapic_srcjar-test.srcjar", - ":data_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "data_py_gapic", - srcs = [":data_proto"], - grpc_service_config = "analytics_data_grpc_service_config.json", - service_yaml = "analyticsdata_v1alpha.yaml", - transport = "grpc+rest", -) - -py_test( - name = "data_py_gapic_test", - srcs = [ - "data_py_gapic_pytest.py", - "data_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":data_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "analytics-data-v1alpha-py", - deps = [ - ":data_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "data_php_proto", - deps = [":data_proto"], -) - -php_grpc_library( - name = "data_php_grpc", - srcs = [":data_proto"], - deps = [":data_php_proto"], -) - -php_gapic_library( - name = "data_php_gapic", - srcs = [":data_proto_with_info"], - grpc_service_config = "analytics_data_grpc_service_config.json", - service_yaml = "analyticsdata_v1alpha.yaml", - deps = [ - ":data_php_grpc", - ":data_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1alpha-php", - deps = [ - ":data_php_gapic", - ":data_php_grpc", - ":data_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "data_nodejs_gapic", - package_name = "@google-cloud/data", - src = ":data_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "analytics_data_grpc_service_config.json", - package = "google.analytics.data.v1alpha", - service_yaml = "analyticsdata_v1alpha.yaml", - deps = [], -) - -nodejs_gapic_assembly_pkg( - name = "analytics-data-v1alpha-nodejs", - deps = [ - ":data_nodejs_gapic", - ":data_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "data_ruby_proto", - deps = [":data_proto"], -) - -ruby_grpc_library( - name = "data_ruby_grpc", - srcs = [":data_proto"], - deps = [":data_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "data_ruby_gapic", - srcs = [":data_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-gem-name=google-cloud-analytics-data-v1alpha", - ], - grpc_service_config = "analytics_data_grpc_service_config.json", - deps = [ - ":data_ruby_grpc", - ":data_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1alpha-ruby", - deps = [ - ":data_ruby_gapic", - ":data_ruby_grpc", - ":data_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "data_csharp_proto", - deps = [":data_proto"], -) - -csharp_grpc_library( - name = "data_csharp_grpc", - srcs = [":data_proto"], - deps = [":data_csharp_proto"], -) - -csharp_gapic_library( - name = "data_csharp_gapic", - srcs = [":data_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "analytics_data_grpc_service_config.json", - service_yaml = "analyticsdata_v1alpha.yaml", - deps = [ - ":data_csharp_grpc", - ":data_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1alpha-csharp", - deps = [ - ":data_csharp_gapic", - ":data_csharp_grpc", - ":data_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "data_cc_proto", - deps = [":data_proto"], -) - -cc_grpc_library( - name = "data_cc_grpc", - srcs = [":data_proto"], - grpc_only = True, - deps = [":data_cc_proto"], -) diff --git a/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_api.proto b/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_api.proto deleted file mode 100644 index f86cf8d..0000000 --- a/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_api.proto +++ /dev/null @@ -1,169 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.data.v1alpha; - -import "google/analytics/data/v1alpha/data.proto"; -import "google/api/annotations.proto"; -import "google/api/client.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data"; -option java_multiple_files = true; -option java_outer_classname = "AnalyticsDataApiProto"; -option java_package = "com.google.analytics.data.v1alpha"; - -// Google Analytics reporting data service. -service AlphaAnalyticsData { - option (google.api.default_host) = "analyticsdata.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/analytics," - "https://www.googleapis.com/auth/analytics.readonly"; - - // Returns a customized funnel report of your Google Analytics event data. The - // data returned from the API is as a table with columns for the requested - // dimensions and metrics. - // - // Funnel exploration lets you visualize the steps your users take to complete - // a task and quickly see how well they are succeeding or failing at each - // step. For example, how do prospects become shoppers and then become buyers? - // How do one time buyers become repeat buyers? With this information, you can - // improve inefficient or abandoned customer journeys. To learn more, see [GA4 - // Funnel Explorations](https://support.google.com/analytics/answer/9327974). - rpc RunFunnelReport(RunFunnelReportRequest) returns (RunFunnelReportResponse) { - option (google.api.http) = { - post: "/v1alpha/{property=properties/*}:runFunnelReport" - body: "*" - }; - } -} - -// The request for a funnel report. -message RunFunnelReportRequest { - // Controls the dimensions present in the funnel visualization sub report - // response. - enum FunnelVisualizationType { - // Unspecified type. - FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED = 0; - - // A standard (stepped) funnel. The funnel visualization sub report in the - // response will not contain date. - STANDARD_FUNNEL = 1; - - // A trended (line chart) funnel. The funnel visualization sub report in the - // response will contain the date dimension. - TRENDED_FUNNEL = 2; - } - - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // Within a batch request, this property should either be unspecified or - // consistent with the batch-level property. - // - // Example: properties/1234 - string property = 1; - - // Date ranges of data to read. If multiple date ranges are requested, each - // response row will contain a zero based date range index. If two date - // ranges overlap, the event data for the overlapping days is included in the - // response rows for both date ranges. - repeated DateRange date_ranges = 2; - - // The configuration of this request's funnel. This funnel configuration is - // required. - Funnel funnel = 3; - - // If specified, this breakdown adds a dimension to the funnel table sub - // report response. This breakdown dimension expands each funnel step to the - // unique values of the breakdown dimension. For example, a breakdown by the - // `deviceCategory` dimension will create rows for `mobile`, `tablet`, - // `desktop`, and the total. - FunnelBreakdown funnel_breakdown = 4; - - // If specified, next action adds a dimension to the funnel visualization sub - // report response. This next action dimension expands each funnel step to the - // unique values of the next action. For example a next action of the - // `eventName` dimension will create rows for several events (i.e. - // `session_start` & `click`) and the total. - // - // Next action only supports `eventName` and most Page / Screen dimensions - // like `pageTitle` and `pagePath`. - FunnelNextAction funnel_next_action = 5; - - // The funnel visualization type controls the dimensions present in the funnel - // visualization sub report response. If not specified, `STANDARD_FUNNEL` is - // used. - FunnelVisualizationType funnel_visualization_type = 6; - - // The configurations of segments. Segments are subsets of a property's data. - // In a funnel report with segments, the funnel is evaluated in each segment. - // - // Each segment specified in this request - // produces a separate row in the response; in the response, each segment - // identified by its name. - // - // The segments parameter is optional. Requests are limited to 4 segments. - repeated Segment segments = 7; - - // The number of rows to return. If unspecified, 10,000 rows are returned. The - // API returns a maximum of 100,000 rows per request, no matter how many you - // ask for. `limit` must be positive. - // - // The API can also return fewer rows than the requested `limit`, if there - // aren't as many dimension values as the `limit`. - int64 limit = 9; - - // Dimension filters allow you to ask for only specific dimension values in - // the report. To learn more, see [Creating a Report: Dimension - // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) - // for examples. Metrics cannot be used in this filter. - FilterExpression dimension_filter = 10; - - // Toggles whether to return the current state of this Analytics Property's - // quota. Quota is returned in [PropertyQuota](#PropertyQuota). - bool return_property_quota = 12; -} - -// The funnel report response contains two sub reports. The two sub reports are -// different combinations of dimensions and metrics. -message RunFunnelReportResponse { - // The funnel table is a report with the funnel step, segment, breakdown - // dimension, active users, completion rate, abandonments, and abandonments - // rate. - // - // The segment dimension is only present in this response if a segment was - // requested. The breakdown dimension is only present in this response if it - // was requested. - FunnelSubReport funnel_table = 1; - - // The funnel visualization is a report with the funnel step, segment, date, - // next action dimension, and active users. - // - // The segment dimension is only present in this response if a segment was - // requested. The date dimension is only present in this response if it was - // requested via the `TRENDED_FUNNEL` funnel type. The next action dimension - // is only present in the response if it was requested. - FunnelSubReport funnel_visualization = 2; - - // This Analytics Property's quota state including this request. - PropertyQuota property_quota = 3; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#runFunnelReport". Useful to distinguish between - // response types in JSON. - string kind = 4; -} diff --git a/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_grpc_service_config.json b/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_grpc_service_config.json deleted file mode 100644 index 87520a1..0000000 --- a/third_party/googleapis/google/analytics/data/v1alpha/analytics_data_grpc_service_config.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "methodConfig": [ - { - "name": [{ "service": "google.analytics.data.v1alpha.AlphaAnalyticsData" }], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "1s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": ["UNKNOWN"] - } - }, - { - "name": [ - { - "service": "google.analytics.data.v1alpha.AlphaAnalyticsData", - "method": "RunFunnelReport" - } - ], - "timeout": "60s" - } - ] -} diff --git a/third_party/googleapis/google/analytics/data/v1alpha/analyticsdata_v1alpha.yaml b/third_party/googleapis/google/analytics/data/v1alpha/analyticsdata_v1alpha.yaml deleted file mode 100644 index b55a02f..0000000 --- a/third_party/googleapis/google/analytics/data/v1alpha/analyticsdata_v1alpha.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: google.api.Service -config_version: 3 -name: analyticsdata.googleapis.com -title: Google Analytics Data API - -apis: -- name: google.analytics.data.v1alpha.AlphaAnalyticsData - -documentation: - summary: Accesses report data in Google Analytics. - -backend: - rules: - - selector: google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport - deadline: 180.0 - -authentication: - rules: - - selector: google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReport - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics, - https://www.googleapis.com/auth/analytics.readonly diff --git a/third_party/googleapis/google/analytics/data/v1alpha/data.proto b/third_party/googleapis/google/analytics/data/v1alpha/data.proto deleted file mode 100644 index 9ef9f61..0000000 --- a/third_party/googleapis/google/analytics/data/v1alpha/data.proto +++ /dev/null @@ -1,1233 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.data.v1alpha; - -import "google/protobuf/duration.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1alpha;data"; -option java_multiple_files = true; -option java_outer_classname = "ReportingApiProto"; -option java_package = "com.google.analytics.data.v1alpha"; - -// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests -// are allowed up to 4 date ranges. -message DateRange { - // The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot - // be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also - // accepted, and in that case, the date is inferred based on the property's - // reporting time zone. - string start_date = 1; - - // The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot - // be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is - // also accepted, and in that case, the date is inferred based on the - // property's reporting time zone. - string end_date = 2; - - // Assigns a name to this date range. The dimension `dateRange` is valued to - // this name in a report response. If set, cannot begin with `date_range_` or - // `RESERVED_`. If not set, date ranges are named by their zero based index in - // the request: `date_range_0`, `date_range_1`, etc. - string name = 3; -} - -// Dimensions are attributes of your data. For example, the dimension city -// indicates the city from which an event originates. Dimension values in report -// responses are strings; for example, the city could be "Paris" or "New York". -message Dimension { - // The name of the dimension. See the [API - // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) - // for the list of dimension names. - // - // If `dimensionExpression` is specified, `name` can be any string that you - // would like within the allowed character set. For example if a - // `dimensionExpression` concatenates `country` and `city`, you could call - // that dimension `countryAndCity`. Dimension names that you choose must match - // the regular expression `^[a-zA-Z0-9_]$`. - // - // Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, - // `dimensionExpression`, and `pivots`. - string name = 1; - - // One dimension can be the result of an expression of multiple dimensions. - // For example, dimension "country, city": concatenate(country, ", ", city). - DimensionExpression dimension_expression = 2; -} - -// Used to express a dimension which is the result of a formula of multiple -// dimensions. Example usages: -// 1) lower_case(dimension) -// 2) concatenate(dimension1, symbol, dimension2). -message DimensionExpression { - // Used to convert a dimension value to a single case. - message CaseExpression { - // Name of a dimension. The name must refer back to a name in dimensions - // field of the request. - string dimension_name = 1; - } - - // Used to combine dimension values to a single dimension. - message ConcatenateExpression { - // Names of dimensions. The names must refer back to names in the dimensions - // field of the request. - repeated string dimension_names = 1; - - // The delimiter placed between dimension names. - // - // Delimiters are often single characters such as "|" or "," but can be - // longer strings. If a dimension value contains the delimiter, both will be - // present in response with no distinction. For example if dimension 1 value - // = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the - // response will contain "US,FR,JP". - string delimiter = 2; - } - - // Specify one type of dimension expression for `DimensionExpression`. - oneof one_expression { - // Used to convert a dimension value to lower case. - CaseExpression lower_case = 4; - - // Used to convert a dimension value to upper case. - CaseExpression upper_case = 5; - - // Used to combine dimension values to a single dimension. - // For example, dimension "country, city": concatenate(country, ", ", city). - ConcatenateExpression concatenate = 6; - } -} - -// To express dimension or metric filters. The fields in the same -// FilterExpression need to be either all dimensions or all metrics. -message FilterExpression { - // Specify one type of filter expression for `FilterExpression`. - oneof expr { - // The FilterExpressions in and_group have an AND relationship. - FilterExpressionList and_group = 1; - - // The FilterExpressions in or_group have an OR relationship. - FilterExpressionList or_group = 2; - - // The FilterExpression is NOT of not_expression. - FilterExpression not_expression = 3; - - // A primitive filter. In the same FilterExpression, all of the filter's - // field names need to be either all dimensions or all metrics. - Filter filter = 4; - } -} - -// A list of filter expressions. -message FilterExpressionList { - // A list of filter expressions. - repeated FilterExpression expressions = 1; -} - -// An expression to filter dimension or metric values. -message Filter { - // The dimension name or metric name. Must be a name defined in dimensions - // or metrics. - string field_name = 1; - - // Specify one type of filter for `Filter`. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 2; - - // A filter for in list values. - InListFilter in_list_filter = 3; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 4; - - // A filter for between two values. - BetweenFilter between_filter = 5; - } -} - -// The filter for string -message StringFilter { - // The match type of a string filter - enum MatchType { - // Unspecified - MATCH_TYPE_UNSPECIFIED = 0; - - // Exact match of the string value. - EXACT = 1; - - // Begins with the string value. - BEGINS_WITH = 2; - - // Ends with the string value. - ENDS_WITH = 3; - - // Contains the string value. - CONTAINS = 4; - - // Full match for the regular expression with the string value. - FULL_REGEXP = 5; - - // Partial match for the regular expression with the string value. - PARTIAL_REGEXP = 6; - } - - // The match type for this filter. - MatchType match_type = 1; - - // The string value used for the matching. - string value = 2; - - // If true, the string value is case sensitive. - bool case_sensitive = 3; -} - -// The result needs to be in a list of string values. -message InListFilter { - // The list of string values. - // Must be non-empty. - repeated string values = 1; - - // If true, the string value is case sensitive. - bool case_sensitive = 2; -} - -// Filters for numeric or date values. -message NumericFilter { - // The operation applied to a numeric filter - enum Operation { - // Unspecified. - OPERATION_UNSPECIFIED = 0; - - // Equal - EQUAL = 1; - - // Less than - LESS_THAN = 2; - - // Less than or equal - LESS_THAN_OR_EQUAL = 3; - - // Greater than - GREATER_THAN = 4; - - // Greater than or equal - GREATER_THAN_OR_EQUAL = 5; - } - - // The operation type for this filter. - Operation operation = 1; - - // A numeric value or a date value. - NumericValue value = 2; -} - -// To express that the result needs to be between two numbers (inclusive). -message BetweenFilter { - // Begins with this number. - NumericValue from_value = 1; - - // Ends with this number. - NumericValue to_value = 2; -} - -// To represent a number. -message NumericValue { - // One of a numeric value - oneof one_value { - // Integer value - int64 int64_value = 1; - - // Double value - double double_value = 2; - } -} - -// Describes a dimension column in the report. Dimensions requested in a report -// produce column entries within rows and DimensionHeaders. However, dimensions -// used exclusively within filters or expressions do not produce columns in a -// report; correspondingly, those dimensions do not produce headers. -message DimensionHeader { - // The dimension's name. - string name = 1; -} - -// Describes a metric column in the report. Visible metrics requested in a -// report produce column entries within rows and MetricHeaders. However, -// metrics used exclusively within filters or expressions do not produce columns -// in a report; correspondingly, those metrics do not produce headers. -message MetricHeader { - // The metric's name. - string name = 1; - - // The metric's data type. - MetricType type = 2; -} - -// Report data for each row. -// For example if RunReportRequest contains: -// -// ```none -// "dimensions": [ -// { -// "name": "eventName" -// }, -// { -// "name": "countryId" -// } -// ], -// "metrics": [ -// { -// "name": "eventCount" -// } -// ] -// ``` -// -// One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and -// 15 as the eventCount, would be: -// -// ```none -// "dimensionValues": [ -// { -// "value": "in_app_purchase" -// }, -// { -// "value": "JP" -// } -// ], -// "metricValues": [ -// { -// "value": "15" -// } -// ] -// ``` -message Row { - // List of requested dimension values. In a PivotReport, dimension_values - // are only listed for dimensions included in a pivot. - repeated DimensionValue dimension_values = 1; - - // List of requested visible metric values. - repeated MetricValue metric_values = 2; -} - -// The value of a dimension. -message DimensionValue { - // One kind of dimension value - oneof one_value { - // Value as a string if the dimension type is a string. - string value = 1; - } -} - -// The value of a metric. -message MetricValue { - // One of metric value - oneof one_value { - // Measurement value. See MetricHeader for type. - string value = 4; - } -} - -// Current state of all quotas for this Analytics Property. If any quota for a -// property is exhausted, all requests to that property will return Resource -// Exhausted errors. -message PropertyQuota { - // Standard Analytics Properties can use up to 25,000 tokens per day; - // Analytics 360 Properties can use 250,000 tokens per day. Most requests - // consume fewer than 10 tokens. - QuotaStatus tokens_per_day = 1; - - // Standard Analytics Properties can use up to 5,000 tokens per hour; - // Analytics 360 Properties can use 50,000 tokens per hour. An API request - // consumes a single number of tokens, and that number is deducted from both - // the hourly and daily quotas. - QuotaStatus tokens_per_hour = 2; - - // Standard Analytics Properties can send up to 10 concurrent requests; - // Analytics 360 Properties can use up to 50 concurrent requests. - QuotaStatus concurrent_requests = 3; - - // Standard Analytics Properties and cloud project pairs can have up to 10 - // server errors per hour; Analytics 360 Properties and cloud project pairs - // can have up to 50 server errors per hour. - QuotaStatus server_errors_per_project_per_hour = 4; - - // Analytics Properties can send up to 120 requests with potentially - // thresholded dimensions per hour. In a batch request, each report request - // is individually counted for this quota if the request contains potentially - // thresholded dimensions. - QuotaStatus potentially_thresholded_requests_per_hour = 5; -} - -// Current state for a particular quota group. -message QuotaStatus { - // Quota consumed by this request. - int32 consumed = 1; - - // Quota remaining after this request. - int32 remaining = 2; -} - -// Breakdowns add a dimension to the funnel table sub report response. -message FunnelBreakdown { - // The dimension column added to the funnel table sub report response. The - // breakdown dimension breaks down each funnel step. A valid - // `breakdownDimension` is required if `funnelBreakdown` is specified. - Dimension breakdown_dimension = 1; - - // The maximum number of distinct values of the breakdown dimension to return - // in the response. A `limit` of `5` is used if limit is not specified. Limit - // must exceed zero and cannot exceed 15. - optional int64 limit = 2; -} - -// Next actions state the value for a dimension after the user has achieved -// a step but before the same user has achieved the next step. For example if -// the `nextActionDimension` is `eventName`, then `nextActionDimension` in the -// `i`th funnel step row will return first event after the event that qualified -// the user into the `i`th funnel step but before the user achieved the `i+1`th -// funnel step. -message FunnelNextAction { - // The dimension column added to the funnel visualization sub report response. - // The next action dimension returns the next dimension value of this - // dimension after the user has attained the `i`th funnel step. - // - // `nextActionDimension` currently only supports `eventName` and most Page / - // Screen dimensions like `pageTitle` and `pagePath`. `nextActionDimension` - // cannot be a dimension expression. - Dimension next_action_dimension = 1; - - // The maximum number of distinct values of the breakdown dimension to return - // in the response. A `limit` of `5` is used if limit is not specified. Limit - // must exceed zero and cannot exceed 5. - optional int64 limit = 2; -} - -// Configures the funnel in a funnel report request. A funnel reports on users -// as they pass through a sequence of steps. -// -// Funnel exploration lets you visualize the steps your users take to complete a -// task and quickly see how well they are succeeding or failing at each step. -// For example, how do prospects become shoppers and then become buyers? How do -// one time buyers become repeat buyers? With this information, you can improve -// inefficient or abandoned customer journeys. -message Funnel { - // In an open funnel, users can enter the funnel in any step, and in a closed - // funnel, users must enter the funnel in the first step. Optional. If - // unspecified, a closed funnel is used. - bool is_open_funnel = 1; - - // The sequential steps of this funnel. - repeated FunnelStep steps = 2; -} - -// Steps define the user journey you want to measure. Steps contain one or -// more conditions that your users must meet to be included in that step of -// the funnel journey. -message FunnelStep { - // The distinctive name for this step. If unspecified, steps will be named - // by a 1 based indexed name (i.e. "0. ", "1. ", etc.). This name defines - // string value returned by the `funnelStepName` dimension. For example, - // specifying `name = Purchase` in the request's third funnel step will - // produce `3. Purchase` in the funnel report response. - string name = 1; - - // If true, this step must directly follow the previous step. If false, - // there can be events between the previous step and this step. If - // unspecified, `isDirectlyFollowedBy` is treated as false. - bool is_directly_followed_by = 2; - - // If specified, this step must complete within this duration of the - // completion of the prior step. `withinDurationFromPriorStep` is inclusive - // of the endpoint at the microsecond granularity. For example a duration of - // 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 - // microsecond. - // - // `withinDurationFromPriorStep` is optional, and if unspecified, steps may - // be separated by any time duration. - optional google.protobuf.Duration within_duration_from_prior_step = 3; - - // The condition that your users must meet to be included in this step of - // the funnel journey. - FunnelFilterExpression filter_expression = 4; -} - -// Funnel sub reports contain the dimension and metric data values. For example, -// 12 users reached the second step of the funnel. -message FunnelSubReport { - // Describes dimension columns. Funnel reports always include the funnel step - // dimension in sub report responses. Additional dimensions like breakdowns, - // dates, and next actions may be present in the response if requested. - repeated DimensionHeader dimension_headers = 1; - - // Describes metric columns. Funnel reports always include active users in sub - // report responses. The funnel table includes additional metrics like - // completion rate, abandonments, and abandonments rate. - repeated MetricHeader metric_headers = 2; - - // Rows of dimension value combinations and metric values in the report. - repeated Row rows = 3; - - // Metadata for the funnel report. - FunnelResponseMetadata metadata = 4; -} - -// User segments are subsets of users who engaged with your site or app. For -// example, users who have previously purchased; users who added items to their -// shopping carts, but didn’t complete a purchase. -message UserSegment { - // Defines which users are included in this segment. Optional. - UserSegmentCriteria user_inclusion_criteria = 1; - - // Defines which users are excluded in this segment. Optional. - UserSegmentExclusion exclusion = 2; -} - -// A user matches a criteria if the user's events meet the conditions in the -// criteria. -message UserSegmentCriteria { - // A user matches this criteria if the user matches each of these - // `andConditionGroups` and each of the `andSequenceGroups`. - // `andConditionGroups` may be empty if `andSequenceGroups` are specified. - repeated UserSegmentConditionGroup and_condition_groups = 1; - - // A user matches this criteria if the user matches each of these - // `andSequenceGroups` and each of the `andConditionGroups`. - // `andSequenceGroups` may be empty if `andConditionGroups` are specified. - repeated UserSegmentSequenceGroup and_sequence_groups = 2; -} - -// Scoping specifies which events are considered when evaluating if a user -// meets a criteria. -enum UserCriteriaScoping { - // Unspecified criteria scoping. Do not specify. - USER_CRITERIA_SCOPING_UNSPECIFIED = 0; - - // If the criteria is satisfied within one event, the user matches the - // criteria. - USER_CRITERIA_WITHIN_SAME_EVENT = 1; - - // If the criteria is satisfied within one session, the user matches the - // criteria. - USER_CRITERIA_WITHIN_SAME_SESSION = 2; - - // If the criteria is satisfied by any events for the user, the user - // matches the criteria. - USER_CRITERIA_ACROSS_ALL_SESSIONS = 3; -} - -// Conditions tell Analytics what data to include in or exclude from the -// segment. -message UserSegmentConditionGroup { - // Data is included or excluded from the segment based on if it matches - // the condition group. This scoping defines how many events the - // `segmentFilterExpression` is evaluated on before the condition group - // is determined to be matched or not. For example if `conditionScoping = - // USER_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all - // events in a session, and then, the condition group is determined to be - // matched or not for this user. For example if `conditionScoping = - // USER_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a single - // event, and then, the condition group is determined to be matched or not for - // this user. - // - // Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is - // used. - UserCriteriaScoping condition_scoping = 1; - - // Data is included or excluded from the segment based on if it matches - // this expression. Expressions express criteria on dimension, metrics, - // and/or parameters. - SegmentFilterExpression segment_filter_expression = 2; -} - -// Define conditions that must occur in a specific order for the user to be -// a member of the segment. -message UserSegmentSequenceGroup { - // All sequence steps must be satisfied in the scoping for the user to - // match the sequence. For example if `sequenceScoping = - // USER_CRITERIA_WITHIN_SAME_SESSION`, all sequence steps must complete within - // one session for the user to match the sequence. `sequenceScoping = - // USER_CRITERIA_WITHIN_SAME_EVENT` is not supported. - // - // Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is - // used. - UserCriteriaScoping sequence_scoping = 1; - - // Defines the time period in which the whole sequence must occur; for - // example, 30 Minutes. `sequenceMaximumDuration` is inclusive - // of the endpoint at the microsecond granularity. For example a sequence - // with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 - // seconds, but not 5 seconds and 1 microsecond. - // - // `sequenceMaximumDuration` is optional, and if unspecified, sequences can - // be completed in any time duration. - google.protobuf.Duration sequence_maximum_duration = 2; - - // An ordered sequence of condition steps. A user's events must complete - // each step in order for the user to match the - // `UserSegmentSequenceGroup`. - repeated UserSequenceStep user_sequence_steps = 3; -} - -// A condition that must occur in the specified step order for this user -// to match the sequence. -message UserSequenceStep { - // If true, the event satisfying this step must be the very next event - // after the event satifying the last step. If false, this step indirectly - // follows the prior step; for example, there may be events between the - // prior step and this step. `isDirectlyFollowedBy` must be false for - // the first step. - bool is_directly_followed_by = 1; - - // This sequence step must be satisfied in the scoping for the user to - // match the sequence. For example if `sequenceScoping = - // WITHIN_SAME_SESSION`, this sequence steps must complete within one - // session for the user to match the sequence. `stepScoping = - // ACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping = - // ACROSS_ALL_SESSIONS`. - // - // Optional. If unspecified, `stepScoping` uses the same - // `UserCriteriaScoping` as the `sequenceScoping`. - UserCriteriaScoping step_scoping = 2; - - // A user matches this sequence step if their events match this - // expression. Expressions express criteria on dimension, metrics, - // and/or parameters. - SegmentFilterExpression segment_filter_expression = 3; -} - -// Specifies which users are excluded in this segment. -message UserSegmentExclusion { - // Specifies how long an exclusion will last if a user matches the - // `userExclusionCriteria`. - // - // Optional. If unspecified, `userExclusionDuration` of - // `USER_EXCLUSION_TEMPORARY` is used. - UserExclusionDuration user_exclusion_duration = 1; - - // If a user meets this condition, the user is excluded from membership in - // the segment for the `userExclusionDuration`. - UserSegmentCriteria user_exclusion_criteria = 2; -} - -// Enumerates options for how long an exclusion will last if a user matches -// the `userExclusionCriteria`. -enum UserExclusionDuration { - // Unspecified exclusion duration. Do not specify. - USER_EXCLUSION_DURATION_UNSPECIFIED = 0; - - // Temporarily exclude users from the segment during periods when the - // user meets the `userExclusionCriteria` condition. - USER_EXCLUSION_TEMPORARY = 1; - - // Permanently exclude users from the segment if the user ever meets the - // `userExclusionCriteria` condition. - USER_EXCLUSION_PERMANENT = 2; -} - -// Session segments are subsets of the sessions that occurred on your site or -// app: for example, all the sessions that originated from a particular -// advertising campaign. -message SessionSegment { - // Defines which sessions are included in this segment. Optional. - SessionSegmentCriteria session_inclusion_criteria = 1; - - // Defines which sessions are excluded in this segment. Optional. - SessionSegmentExclusion exclusion = 2; -} - -// A session matches a criteria if the session's events meet the conditions in -// the criteria. -message SessionSegmentCriteria { - // A session matches this criteria if the session matches each of these - // `andConditionGroups`. - repeated SessionSegmentConditionGroup and_condition_groups = 1; -} - -// Scoping specifies which events are considered when evaluating if a -// session meets a criteria. -enum SessionCriteriaScoping { - // Unspecified criteria scoping. Do not specify. - SESSION_CRITERIA_SCOPING_UNSPECIFIED = 0; - - // If the criteria is satisfied within one event, the session matches the - // criteria. - SESSION_CRITERIA_WITHIN_SAME_EVENT = 1; - - // If the criteria is satisfied within one session, the session matches - // the criteria. - SESSION_CRITERIA_WITHIN_SAME_SESSION = 2; -} - -// Conditions tell Analytics what data to include in or exclude from the -// segment. -message SessionSegmentConditionGroup { - // Data is included or excluded from the segment based on if it matches - // the condition group. This scoping defines how many events the - // `segmentFilterExpression` is evaluated on before the condition group - // is determined to be matched or not. For example if `conditionScoping = - // SESSION_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all - // events in a session, and then, the condition group is determined to be - // matched or not for this session. For example if `conditionScoping = - // SESSION_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a - // single event, and then, the condition group is determined to be matched or - // not for this session. - // - // Optional. If unspecified, a `conditionScoping` of `WITHIN_SAME_SESSION` - // is used. - SessionCriteriaScoping condition_scoping = 1; - - // Data is included or excluded from the segment based on if it matches - // this expression. Expressions express criteria on dimension, metrics, - // and/or parameters. - SegmentFilterExpression segment_filter_expression = 2; -} - -// Specifies which sessions are excluded in this segment. -message SessionSegmentExclusion { - // Specifies how long an exclusion will last if a session matches the - // `sessionExclusionCriteria`. - // - // Optional. If unspecified, a `sessionExclusionDuration` of - // `SESSION_EXCLUSION_TEMPORARY` is used. - SessionExclusionDuration session_exclusion_duration = 1; - - // If a session meets this condition, the session is excluded from - // membership in the segment for the `sessionExclusionDuration`. - SessionSegmentCriteria session_exclusion_criteria = 2; -} - -// Enumerates options for how long an exclusion will last if a session -// matches the `sessionExclusionCriteria`. -enum SessionExclusionDuration { - // Unspecified exclusion duration. Do not specify. - SESSION_EXCLUSION_DURATION_UNSPECIFIED = 0; - - // Temporarily exclude sessions from the segment during periods when the - // session meets the `sessionExclusionCriteria` condition. - SESSION_EXCLUSION_TEMPORARY = 1; - - // Permanently exclude sessions from the segment if the session ever meets - // the `sessionExclusionCriteria` condition. - SESSION_EXCLUSION_PERMANENT = 2; -} - -// Event segments are subsets of events that were triggered on your site or app. -// for example, all purchase events made in a particular location; app_exception -// events that occurred on a specific operating system. -message EventSegment { - // Defines which events are included in this segment. Optional. - EventSegmentCriteria event_inclusion_criteria = 1; - - // Defines which events are excluded in this segment. Optional. - EventSegmentExclusion exclusion = 2; -} - -// An event matches a criteria if the event meet the conditions in the -// criteria. -message EventSegmentCriteria { - // An event matches this criteria if the event matches each of these - // `andConditionGroups`. - repeated EventSegmentConditionGroup and_condition_groups = 1; -} - -// Scoping specifies which events are considered when evaluating if an event -// meets a criteria. -enum EventCriteriaScoping { - // Unspecified criteria scoping. Do not specify. - EVENT_CRITERIA_SCOPING_UNSPECIFIED = 0; - - // If the criteria is satisfied within one event, the event matches the - // criteria. - EVENT_CRITERIA_WITHIN_SAME_EVENT = 1; -} - -// Conditions tell Analytics what data to include in or exclude from the -// segment. -message EventSegmentConditionGroup { - // `conditionScoping` should always be `EVENT_CRITERIA_WITHIN_SAME_EVENT`. - // - // Optional. If unspecified, a `conditionScoping` of - // `EVENT_CRITERIA_WITHIN_SAME_EVENT` is used. - EventCriteriaScoping condition_scoping = 1; - - // Data is included or excluded from the segment based on if it matches - // this expression. Expressions express criteria on dimension, metrics, - // and/or parameters. - SegmentFilterExpression segment_filter_expression = 2; -} - -// Specifies which events are excluded in this segment. -message EventSegmentExclusion { - // `eventExclusionDuration` should always be `PERMANENTLY_EXCLUDE`. - // - // Optional. If unspecified, an `eventExclusionDuration` of - // `EVENT_EXCLUSION_PERMANENT` is used. - EventExclusionDuration event_exclusion_duration = 1; - - // If an event meets this condition, the event is excluded from membership - // in the segment for the `eventExclusionDuration`. - EventSegmentCriteria event_exclusion_criteria = 2; -} - -// Enumerates options for how long an exclusion will last if an event -// matches the `eventExclusionCriteria`. -enum EventExclusionDuration { - // Unspecified exclusion duration. Do not specify. - EVENT_EXCLUSION_DURATION_UNSPECIFIED = 0; - - // Permanently exclude events from the segment if the event ever meets - // the `eventExclusionCriteria` condition. - EVENT_EXCLUSION_PERMANENT = 1; -} - -// A segment is a subset of your Analytics data. For example, of your entire set -// of users, one segment might be users from a particular country or city. -// Another segment might be users who purchase a particular line of products or -// who visit a specific part of your site or trigger certain events in your app. -// -// To learn more, see [GA4 Segment -// Builder](https://support.google.com/analytics/answer/9304353). -message Segment { - // The name for this segment. If unspecified, segments are named "Segment". - // This name defines string value returned by the `segment` dimension. The - // `segment` dimension prefixes segment names by the 1-based index number of - // the segment in the request (i.e. "1. Segment", "2. Segment", etc.). - string name = 1; - - // A segment is specified in one scope. - oneof one_segment_scope { - // User segments are subsets of users who engaged with your site or app. - UserSegment user_segment = 2; - - // Session segments are subsets of the sessions that occurred on your site - // or app. - SessionSegment session_segment = 3; - - // Event segments are subsets of events that were triggered on your site or - // app. - EventSegment event_segment = 4; - } -} - -// Expresses combinations of segment filters. -message SegmentFilterExpression { - // Specify one type of filter for `SegmentFilterExpression`. - oneof expr { - // The SegmentFilterExpression in `andGroup` have an AND relationship. - SegmentFilterExpressionList and_group = 1; - - // The SegmentFilterExpression in `orGroup` have an OR relationship. - SegmentFilterExpressionList or_group = 2; - - // The SegmentFilterExpression is NOT of `notExpression`. - SegmentFilterExpression not_expression = 3; - - // A primitive segment filter. - SegmentFilter segment_filter = 4; - - // Creates a filter that matches events of a single event name. If a - // parameter filter expression is specified, only the subset of events that - // match both the single event name and the parameter filter expressions - // match this event filter. - SegmentEventFilter segment_event_filter = 5; - } -} - -// A list of segment filter expressions. -message SegmentFilterExpressionList { - // The list of segment filter expressions - repeated SegmentFilterExpression expressions = 1; -} - -// An expression to filter dimension or metric values. -message SegmentFilter { - // The dimension name or metric name. - string field_name = 1; - - // Specify one type of filter for `Filter`. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 4; - - // A filter for in list values. - InListFilter in_list_filter = 5; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 6; - - // A filter for between two values. - BetweenFilter between_filter = 7; - } - - // Specifies the scope for the filter. - SegmentFilterScoping filter_scoping = 8; -} - -// Scopings specify how the dimensions & metrics of multiple events -// should be considered when evaluating a segment filter. -message SegmentFilterScoping { - // If `atAnyPointInTime` is true, this filter evaluates to true for all - // events if it evaluates to true for any event in the date range of the - // request. - // - // This `atAnyPointInTime` parameter does not extend the date range of - // events in the report. If `atAnyPointInTime` is true, only events within - // the report's date range are considered when evaluating this filter. - // - // This `atAnyPointInTime` is only able to be specified if the criteria - // scoping is `ACROSS_ALL_SESSIONS` and is not able to be specified in - // sequences. - // - // If the criteria scoping is `ACROSS_ALL_SESSIONS`, `atAnyPointInTime` = - // false is used if unspecified. - optional bool at_any_point_in_time = 1; -} - -// Creates a filter that matches events of a single event name. If a parameter -// filter expression is specified, only the subset of events that match both the -// single event name and the parameter filter expressions match this event -// filter. -message SegmentEventFilter { - // This filter matches events of this single event name. Event name is - // required. - optional string event_name = 1; - - // If specified, this filter matches events that match both the single event - // name and the parameter filter expressions. - // - // Inside the parameter filter expression, only parameter filters are - // available. - optional SegmentParameterFilterExpression segment_parameter_filter_expression = 2; -} - -// Expresses combinations of segment filter on parameters. -message SegmentParameterFilterExpression { - // Specify one type of filter for `SegmentParameterFilterExpression`. - oneof expr { - // The SegmentParameterFilterExpression in `andGroup` have an AND - // relationship. - SegmentParameterFilterExpressionList and_group = 1; - - // The SegmentParameterFilterExpression in `orGroup` have an OR - // relationship. - SegmentParameterFilterExpressionList or_group = 2; - - // The SegmentParameterFilterExpression is NOT of `notExpression`. - SegmentParameterFilterExpression not_expression = 3; - - // A primitive segment parameter filter. - SegmentParameterFilter segment_parameter_filter = 4; - } -} - -// A list of segment parameter filter expressions. -message SegmentParameterFilterExpressionList { - // The list of segment parameter filter expressions. - repeated SegmentParameterFilterExpression expressions = 1; -} - -// An expression to filter parameter values in a segment. -message SegmentParameterFilter { - // The field that is being filtered. - oneof one_parameter { - // This filter will be evaluated on the specified event parameter. Event - // parameters are logged as parameters of the event. Event parameters - // include fields like "firebase_screen" & "currency". - // - // Event parameters can only be used in segments & funnels and can only be - // used in a descendent filter from an EventFilter. In a descendent filter - // from an EventFilter either event or item parameters should be used. - string event_parameter_name = 1; - - // This filter will be evaluated on the specified item parameter. Item - // parameters are logged as parameters in the item array. Item parameters - // include fields like "item_name" & "item_category". - // - // Item parameters can only be used in segments & funnels and can only be - // used in a descendent filter from an EventFilter. In a descendent filter - // from an EventFilter either event or item parameters should be used. - // - // Item parameters are only available in ecommerce events. To learn more - // about ecommerce events, see the [Measure ecommerce] - // (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) - // guide. - string item_parameter_name = 2; - } - - // Specify one type of filter. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 4; - - // A filter for in list values. - InListFilter in_list_filter = 5; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 6; - - // A filter for between two values. - BetweenFilter between_filter = 7; - } - - // Specifies the scope for the filter. - SegmentParameterFilterScoping filter_scoping = 8; -} - -// Scopings specify how multiple events should be considered when evaluating a -// segment parameter filter. -message SegmentParameterFilterScoping { - // Accumulates the parameter over the specified period of days before - // applying the filter. Only supported if criteria scoping is - // `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the - // parameter is `event_count`. - // - // For example if `inAnyNDayPeriod` is 3, the event_name is "purchase", - // the event parameter is "event_count", and the Filter's criteria is - // greater than 5, this filter will accumulate the event count of purchase - // events over every 3 consecutive day period in the report's date range; a - // user will pass this Filter's criteria to be included in this segment if - // their count of purchase events exceeds 5 in any 3 consecutive day period. - // For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to - // 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered. - // - // The date range is not extended for the purpose of having a full N day - // window near the start of the date range. For example if a report is for - // 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day - // period will be effectively shortened because no event data outside the - // report's date range will be read. For example, the first four periods - // will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, - // 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04. - // - // `inAnyNDayPeriod` is optional. If not specified, the - // `segmentParameterFilter` is applied to each event individually. - optional int64 in_any_n_day_period = 1; -} - -// Expresses combinations of funnel filters. -message FunnelFilterExpression { - // Specify one type of filter for `FunnelFilterExpression`. - oneof expr { - // The FunnelFilterExpression in `andGroup` have an AND relationship. - FunnelFilterExpressionList and_group = 1; - - // The FunnelFilterExpression in `orGroup` have an OR relationship. - FunnelFilterExpressionList or_group = 2; - - // The FunnelFilterExpression is NOT of `notExpression`. - FunnelFilterExpression not_expression = 3; - - // A funnel filter for a dimension or metric. - FunnelFieldFilter funnel_field_filter = 4; - - // Creates a filter that matches events of a single event name. If a - // parameter filter expression is specified, only the subset of events that - // match both the single event name and the parameter filter expressions - // match this event filter. - FunnelEventFilter funnel_event_filter = 5; - } -} - -// A list of funnel filter expressions. -message FunnelFilterExpressionList { - // The list of funnel filter expressions. - repeated FunnelFilterExpression expressions = 1; -} - -// An expression to filter dimension or metric values. -message FunnelFieldFilter { - // The dimension name or metric name. - string field_name = 1; - - // Specify one type of filter. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 4; - - // A filter for in list values. - InListFilter in_list_filter = 5; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 6; - - // A filter for between two values. - BetweenFilter between_filter = 7; - } -} - -// Creates a filter that matches events of a single event name. If a parameter -// filter expression is specified, only the subset of events that match both the -// single event name and the parameter filter expressions match this event -// filter. -message FunnelEventFilter { - // This filter matches events of this single event name. Event name is - // required. - optional string event_name = 1; - - // If specified, this filter matches events that match both the single event - // name and the parameter filter expressions. - // - // Inside the parameter filter expression, only parameter filters are - // available. - optional FunnelParameterFilterExpression funnel_parameter_filter_expression = 2; -} - -// Expresses combinations of funnel filters on parameters. -message FunnelParameterFilterExpression { - // Specify one type of filter for `FunnelParameterFilterExpression`. - oneof expr { - // The FunnelParameterFilterExpression in `andGroup` have an AND - // relationship. - FunnelParameterFilterExpressionList and_group = 1; - - // The FunnelParameterFilterExpression in `orGroup` have an OR - // relationship. - FunnelParameterFilterExpressionList or_group = 2; - - // The FunnelParameterFilterExpression is NOT of `notExpression`. - FunnelParameterFilterExpression not_expression = 3; - - // A primitive funnel parameter filter. - FunnelParameterFilter funnel_parameter_filter = 4; - } -} - -// A list of funnel parameter filter expressions. -message FunnelParameterFilterExpressionList { - // The list of funnel parameter filter expressions. - repeated FunnelParameterFilterExpression expressions = 1; -} - -// An expression to filter parameter values in a funnel. -message FunnelParameterFilter { - // The field that is being filtered. - oneof one_parameter { - // This filter will be evaluated on the specified event parameter. Event - // parameters are logged as parameters of the event. Event parameters - // include fields like "firebase_screen" & "currency". - // - // Event parameters can only be used in segments & funnels and can only be - // used in a descendent filter from an EventFilter. In a descendent filter - // from an EventFilter either event or item parameters should be used. - string event_parameter_name = 1; - - // This filter will be evaluated on the specified item parameter. Item - // parameters are logged as parameters in the item array. Item parameters - // include fields like "item_name" & "item_category". - // - // Item parameters can only be used in segments & funnels and can only be - // used in a descendent filter from an EventFilter. In a descendent filter - // from an EventFilter either event or item parameters should be used. - // - // Item parameters are only available in ecommerce events. To learn more - // about ecommerce events, see the [Measure ecommerce] - // (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) - // guide. - string item_parameter_name = 2; - } - - // Specify one type of filter. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 4; - - // A filter for in list values. - InListFilter in_list_filter = 5; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 6; - - // A filter for between two values. - BetweenFilter between_filter = 7; - } -} - -// The funnel report's response metadata carries additional information about -// the funnel report. -message FunnelResponseMetadata { - // If funnel report results are - // [sampled](https://support.google.com/analytics/answer/2637192), this - // describes what percentage of events were used in this funnel report. One - // `samplingMetadatas` is populated for each date range. Each - // `samplingMetadatas` corresponds to a date range in order that date ranges - // were specified in the request. - // - // However if the results are not sampled, this field will not be defined. - repeated SamplingMetadata sampling_metadatas = 1; -} - -// If funnel report results are -// [sampled](https://support.google.com/analytics/answer/2637192), this -// metadata describes what percentage of events were used in this funnel -// report for a date range. Sampling is the practice of analyzing a subset of -// all data in order to uncover the meaningful information in the larger data -// set. -message SamplingMetadata { - // The total number of events read in this sampled report for a date range. - // This is the size of the subset this property's data that was analyzed in - // this funnel report. - int64 samples_read_count = 1; - - // The total number of events present in this property's data that could - // have been analyzed in this funnel report for a date range. Sampling - // uncovers the meaningful information about the larger data set, and this - // is the size of the larger data set. - // - // To calculate the percentage of available data that was used in this - // funnel report, compute `samplesReadCount/samplingSpaceSize`. - int64 sampling_space_size = 2; -} - -// A metric's value type. -enum MetricType { - // Unspecified type. - METRIC_TYPE_UNSPECIFIED = 0; - - // Integer type. - TYPE_INTEGER = 1; - - // Floating point type. - TYPE_FLOAT = 2; - - // A duration of seconds; a special floating point type. - TYPE_SECONDS = 4; - - // A duration in milliseconds; a special floating point type. - TYPE_MILLISECONDS = 5; - - // A duration in minutes; a special floating point type. - TYPE_MINUTES = 6; - - // A duration in hours; a special floating point type. - TYPE_HOURS = 7; - - // A custom metric of standard type; a special floating point type. - TYPE_STANDARD = 8; - - // An amount of money; a special floating point type. - TYPE_CURRENCY = 9; - - // A length in feet; a special floating point type. - TYPE_FEET = 10; - - // A length in miles; a special floating point type. - TYPE_MILES = 11; - - // A length in meters; a special floating point type. - TYPE_METERS = 12; - - // A length in kilometers; a special floating point type. - TYPE_KILOMETERS = 13; -} diff --git a/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel b/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel deleted file mode 100644 index d064866..0000000 --- a/third_party/googleapis/google/analytics/data/v1beta/BUILD.bazel +++ /dev/null @@ -1,388 +0,0 @@ -# This file was automatically generated by BuildFileGenerator -# https://github.com/googleapis/rules_gapic/tree/master/bazel - -# Most of the manual changes to this file will be overwritten. -# It's **only** allowed to change the following rule attribute values: -# - names of *_gapic_assembly_* rules -# - certain parameters of *_gapic_library rules, including but not limited to: -# * extra_protoc_parameters -# * extra_protoc_file_parameters -# The complete list of preserved parameters can be found in the source code. - -# This is an API workspace, having public visibility by default makes perfect sense. -package(default_visibility = ["//visibility:public"]) - -############################################################################## -# Common -############################################################################## -load("@rules_proto//proto:defs.bzl", "proto_library") -load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info") - -proto_library( - name = "data_proto", - srcs = [ - "analytics_data_api.proto", - "data.proto", - ], - deps = [ - "//google/api:annotations_proto", - "//google/api:client_proto", - "//google/api:field_behavior_proto", - "//google/api:resource_proto", - ], -) - -proto_library_with_info( - name = "data_proto_with_info", - deps = [ - ":data_proto", - "//google/cloud:common_resources_proto", - ], -) - -############################################################################## -# Java -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "java_gapic_assembly_gradle_pkg", - "java_gapic_library", - "java_gapic_test", - "java_grpc_library", - "java_proto_library", -) - -java_proto_library( - name = "data_java_proto", - deps = [":data_proto"], -) - -java_grpc_library( - name = "data_java_grpc", - srcs = [":data_proto"], - deps = [":data_java_proto"], -) - -java_gapic_library( - name = "data_java_gapic", - srcs = [":data_proto_with_info"], - gapic_yaml = None, - grpc_service_config = "analytics_data_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - test_deps = [ - ":data_java_grpc", - ], - transport = "grpc+rest", - deps = [ - ":data_java_proto", - "//google/api:api_java_proto", - ], -) - -java_gapic_test( - name = "data_java_gapic_test_suite", - test_classes = [ - "com.google.analytics.data.v1beta.BetaAnalyticsDataClientHttpJsonTest", - "com.google.analytics.data.v1beta.BetaAnalyticsDataClientTest", - ], - runtime_deps = [":data_java_gapic_test"], -) - -# Open Source Packages -java_gapic_assembly_gradle_pkg( - name = "google-analytics-data-v1beta-java", - include_samples = True, - transport = "grpc+rest", - deps = [ - ":data_java_gapic", - ":data_java_grpc", - ":data_java_proto", - ":data_proto", - ], -) - -############################################################################## -# Go -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "go_gapic_assembly_pkg", - "go_gapic_library", - "go_proto_library", - "go_test", -) - -go_proto_library( - name = "data_go_proto", - compilers = ["@io_bazel_rules_go//proto:go_grpc"], - importpath = "google.golang.org/genproto/googleapis/analytics/data/v1beta", - protos = [":data_proto"], - deps = [ - "//google/api:annotations_go_proto", - ], -) - -go_gapic_library( - name = "data_go_gapic", - srcs = [":data_proto_with_info"], - grpc_service_config = "analytics_data_grpc_service_config.json", - importpath = "google.golang.org/google/analytics/data/v1beta;data", - metadata = True, - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - transport = "grpc+rest", - deps = [ - ":data_go_proto", - ], -) - -go_test( - name = "data_go_gapic_test", - srcs = [":data_go_gapic_srcjar_test"], - embed = [":data_go_gapic"], - importpath = "google.golang.org/google/analytics/data/v1beta", -) - -# Open Source Packages -go_gapic_assembly_pkg( - name = "gapi-cloud-analytics-data-v1beta-go", - deps = [ - ":data_go_gapic", - ":data_go_gapic_srcjar-metadata.srcjar", - ":data_go_gapic_srcjar-test.srcjar", - ":data_go_proto", - ], -) - -############################################################################## -# Python -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "py_gapic_assembly_pkg", - "py_gapic_library", - "py_test", -) - -py_gapic_library( - name = "data_py_gapic", - srcs = [":data_proto"], - grpc_service_config = "analytics_data_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - transport = "grpc+rest", - deps = [ - ], -) - -py_test( - name = "data_py_gapic_test", - srcs = [ - "data_py_gapic_pytest.py", - "data_py_gapic_test.py", - ], - legacy_create_init = False, - deps = [":data_py_gapic"], -) - -# Open Source Packages -py_gapic_assembly_pkg( - name = "google-analytics-data-v1beta-py", - deps = [ - ":data_py_gapic", - ], -) - -############################################################################## -# PHP -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "php_gapic_assembly_pkg", - "php_gapic_library", - "php_grpc_library", - "php_proto_library", -) - -php_proto_library( - name = "data_php_proto", - deps = [":data_proto"], -) - -php_grpc_library( - name = "data_php_grpc", - srcs = [":data_proto"], - deps = [":data_php_proto"], -) - -php_gapic_library( - name = "data_php_gapic", - srcs = [":data_proto_with_info"], - grpc_service_config = "analytics_data_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - deps = [ - ":data_php_grpc", - ":data_php_proto", - ], -) - -# Open Source Packages -php_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1beta-php", - deps = [ - ":data_php_gapic", - ":data_php_grpc", - ":data_php_proto", - ], -) - -############################################################################## -# Node.js -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "nodejs_gapic_assembly_pkg", - "nodejs_gapic_library", -) - -nodejs_gapic_library( - name = "data_nodejs_gapic", - package_name = "@google-analytics/data", - src = ":data_proto_with_info", - extra_protoc_parameters = ["metadata"], - grpc_service_config = "analytics_data_grpc_service_config.json", - package = "google.analytics.data.v1beta", - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - deps = [], -) - -nodejs_gapic_assembly_pkg( - name = "google-analytics-data-v1beta-nodejs", - deps = [ - ":data_nodejs_gapic", - ":data_proto", - ], -) - -############################################################################## -# Ruby -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "ruby_cloud_gapic_library", - "ruby_gapic_assembly_pkg", - "ruby_grpc_library", - "ruby_proto_library", -) - -ruby_proto_library( - name = "data_ruby_proto", - deps = [":data_proto"], -) - -ruby_grpc_library( - name = "data_ruby_grpc", - srcs = [":data_proto"], - deps = [":data_ruby_proto"], -) - -ruby_cloud_gapic_library( - name = "data_ruby_gapic", - srcs = [":data_proto_with_info"], - extra_protoc_parameters = [ - "ruby-cloud-api-id=analyticsdata.googleapis.com", - "ruby-cloud-api-shortname=analyticsdata", - "ruby-cloud-env-prefix=ANALYTICS_DATA", - "ruby-cloud-gem-name=google-analytics-data-v1beta", - "ruby-cloud-product-url=https://developers.google.com/analytics/devguides/reporting/data/v1", - "ruby-cloud-service-override=BetaAnalyticsData=AnalyticsData", - ], - grpc_service_config = "analytics_data_grpc_service_config.json", - rest_numeric_enums = False, - ruby_cloud_description = "The Google Analytics Data API provides programmatic methods to access report data in Google Analytics 4 (GA4) properties. Google Analytics 4 helps you understand how people use your web, iOS, or Android app.", - ruby_cloud_title = "Google Analytics Data V1beta", - service_yaml = "analyticsdata_v1beta.yaml", - deps = [ - ":data_ruby_grpc", - ":data_ruby_proto", - ], -) - -# Open Source Packages -ruby_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1beta-ruby", - deps = [ - ":data_ruby_gapic", - ":data_ruby_grpc", - ":data_ruby_proto", - ], -) - -############################################################################## -# C# -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "csharp_gapic_assembly_pkg", - "csharp_gapic_library", - "csharp_grpc_library", - "csharp_proto_library", -) - -csharp_proto_library( - name = "data_csharp_proto", - deps = [":data_proto"], -) - -csharp_grpc_library( - name = "data_csharp_grpc", - srcs = [":data_proto"], - deps = [":data_csharp_proto"], -) - -csharp_gapic_library( - name = "data_csharp_gapic", - srcs = [":data_proto_with_info"], - common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json", - grpc_service_config = "analytics_data_grpc_service_config.json", - rest_numeric_enums = False, - service_yaml = "analyticsdata_v1beta.yaml", - deps = [ - ":data_csharp_grpc", - ":data_csharp_proto", - ], -) - -# Open Source Packages -csharp_gapic_assembly_pkg( - name = "google-cloud-analytics-data-v1beta-csharp", - deps = [ - ":data_csharp_gapic", - ":data_csharp_grpc", - ":data_csharp_proto", - ], -) - -############################################################################## -# C++ -############################################################################## -load( - "@com_google_googleapis_imports//:imports.bzl", - "cc_grpc_library", - "cc_proto_library", -) - -cc_proto_library( - name = "data_cc_proto", - deps = [":data_proto"], -) - -cc_grpc_library( - name = "data_cc_grpc", - srcs = [":data_proto"], - grpc_only = True, - deps = [":data_cc_proto"], -) diff --git a/third_party/googleapis/google/analytics/data/v1beta/analytics_data_api.proto b/third_party/googleapis/google/analytics/data/v1beta/analytics_data_api.proto deleted file mode 100644 index e5ee72c..0000000 --- a/third_party/googleapis/google/analytics/data/v1beta/analytics_data_api.proto +++ /dev/null @@ -1,628 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.data.v1beta; - -import "google/analytics/data/v1beta/data.proto"; -import "google/api/annotations.proto"; -import "google/api/client.proto"; -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; - -option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1beta;data"; -option java_multiple_files = true; -option java_outer_classname = "AnalyticsDataApiProto"; -option java_package = "com.google.analytics.data.v1beta"; - -// Google Analytics reporting data service. -service BetaAnalyticsData { - option (google.api.default_host) = "analyticsdata.googleapis.com"; - option (google.api.oauth_scopes) = - "https://www.googleapis.com/auth/analytics," - "https://www.googleapis.com/auth/analytics.readonly"; - - // Returns a customized report of your Google Analytics event data. Reports - // contain statistics derived from data collected by the Google Analytics - // tracking code. The data returned from the API is as a table with columns - // for the requested dimensions and metrics. Metrics are individual - // measurements of user activity on your property, such as active users or - // event count. Dimensions break down metrics across some common criteria, - // such as country or event name. - // - // For a guide to constructing requests & understanding responses, see - // [Creating a - // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). - rpc RunReport(RunReportRequest) returns (RunReportResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:runReport" - body: "*" - }; - } - - // Returns a customized pivot report of your Google Analytics event data. - // Pivot reports are more advanced and expressive formats than regular - // reports. In a pivot report, dimensions are only visible if they are - // included in a pivot. Multiple pivots can be specified to further dissect - // your data. - rpc RunPivotReport(RunPivotReportRequest) returns (RunPivotReportResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:runPivotReport" - body: "*" - }; - } - - // Returns multiple reports in a batch. All reports must be for the same - // GA4 Property. - rpc BatchRunReports(BatchRunReportsRequest) returns (BatchRunReportsResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:batchRunReports" - body: "*" - }; - } - - // Returns multiple pivot reports in a batch. All reports must be for the same - // GA4 Property. - rpc BatchRunPivotReports(BatchRunPivotReportsRequest) returns (BatchRunPivotReportsResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:batchRunPivotReports" - body: "*" - }; - } - - // Returns metadata for dimensions and metrics available in reporting methods. - // Used to explore the dimensions and metrics. In this method, a Google - // Analytics GA4 Property Identifier is specified in the request, and - // the metadata response includes Custom dimensions and metrics as well as - // Universal metadata. - // - // For example if a custom metric with parameter name `levels_unlocked` is - // registered to a property, the Metadata response will contain - // `customEvent:levels_unlocked`. Universal metadata are dimensions and - // metrics applicable to any property such as `country` and `totalUsers`. - rpc GetMetadata(GetMetadataRequest) returns (Metadata) { - option (google.api.http) = { - get: "/v1beta/{name=properties/*/metadata}" - }; - option (google.api.method_signature) = "name"; - } - - // Returns a customized report of realtime event data for your property. - // Events appear in realtime reports seconds after they have been sent to - // the Google Analytics. Realtime reports show events and usage data for the - // periods of time ranging from the present moment to 30 minutes ago (up to - // 60 minutes for Google Analytics 360 properties). - // - // For a guide to constructing realtime requests & understanding responses, - // see [Creating a Realtime - // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). - rpc RunRealtimeReport(RunRealtimeReportRequest) returns (RunRealtimeReportResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:runRealtimeReport" - body: "*" - }; - } - - // This compatibility method lists dimensions and metrics that can be added to - // a report request and maintain compatibility. This method fails if the - // request's dimensions and metrics are incompatible. - // - // In Google Analytics, reports fail if they request incompatible dimensions - // and/or metrics; in that case, you will need to remove dimensions and/or - // metrics from the incompatible report until the report is compatible. - // - // The Realtime and Core reports have different compatibility rules. This - // method checks compatibility for Core reports. - rpc CheckCompatibility(CheckCompatibilityRequest) returns (CheckCompatibilityResponse) { - option (google.api.http) = { - post: "/v1beta/{property=properties/*}:checkCompatibility" - body: "*" - }; - } -} - -// The request for compatibility information for a report's dimensions and -// metrics. Check compatibility provides a preview of the compatibility of a -// report; fields shared with the `runReport` request should be the same values -// as in your `runReport` request. -message CheckCompatibilityRequest { - // A Google Analytics GA4 property identifier whose events are tracked. To - // learn more, see [where to find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // `property` should be the same value as in your `runReport` request. - // - // Example: properties/1234 - // - // Set the Property ID to 0 for compatibility checking on dimensions and - // metrics common to all properties. In this special mode, this method will - // not return custom dimensions and metrics. - string property = 1; - - // The dimensions in this report. `dimensions` should be the same value as in - // your `runReport` request. - repeated Dimension dimensions = 2; - - // The metrics in this report. `metrics` should be the same value as in your - // `runReport` request. - repeated Metric metrics = 3; - - // The filter clause of dimensions. `dimensionFilter` should be the same value - // as in your `runReport` request. - FilterExpression dimension_filter = 4; - - // The filter clause of metrics. `metricFilter` should be the same value as in - // your `runReport` request - FilterExpression metric_filter = 5; - - // Filters the dimensions and metrics in the response to just this - // compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` - // to only return compatible dimensions & metrics. - Compatibility compatibility_filter = 6; -} - -// The compatibility response with the compatibility of each dimension & metric. -message CheckCompatibilityResponse { - // The compatibility of each dimension. - repeated DimensionCompatibility dimension_compatibilities = 1; - - // The compatibility of each metric. - repeated MetricCompatibility metric_compatibilities = 2; -} - -// The dimensions and metrics currently accepted in reporting methods. -message Metadata { - option (google.api.resource) = { - type: "analyticsdata.googleapis.com/Metadata" - pattern: "properties/{property}/metadata" - }; - - // Resource name of this metadata. - string name = 3; - - // The dimension descriptions. - repeated DimensionMetadata dimensions = 1; - - // The metric descriptions. - repeated MetricMetadata metrics = 2; -} - -// The request to generate a report. -message RunReportRequest { - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // Within a batch request, this property should either be unspecified or - // consistent with the batch-level property. - // - // Example: properties/1234 - string property = 1; - - // The dimensions requested and displayed. - repeated Dimension dimensions = 2; - - // The metrics requested and displayed. - repeated Metric metrics = 3; - - // Date ranges of data to read. If multiple date ranges are requested, each - // response row will contain a zero based date range index. If two date - // ranges overlap, the event data for the overlapping days is included in the - // response rows for both date ranges. In a cohort request, this `dateRanges` - // must be unspecified. - repeated DateRange date_ranges = 4; - - // Dimension filters allow you to ask for only specific dimension values in - // the report. To learn more, see [Fundamentals of Dimension - // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) - // for examples. Metrics cannot be used in this filter. - FilterExpression dimension_filter = 5; - - // The filter clause of metrics. Applied after aggregating the report's rows, - // similar to SQL having-clause. Dimensions cannot be used in this filter. - FilterExpression metric_filter = 6; - - // The row count of the start row. The first row is counted as row 0. - // - // When paging, the first request does not specify offset; or equivalently, - // sets offset to 0; the first request returns the first `limit` of rows. The - // second request sets offset to the `limit` of the first request; the second - // request returns the second `limit` of rows. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int64 offset = 7; - - // The number of rows to return. If unspecified, 10,000 rows are returned. The - // API returns a maximum of 100,000 rows per request, no matter how many you - // ask for. `limit` must be positive. - // - // The API can also return fewer rows than the requested `limit`, if there - // aren't as many dimension values as the `limit`. For instance, there are - // fewer than 300 possible values for the dimension `country`, so when - // reporting on only `country`, you can't get more than 300 rows, even if you - // set `limit` to a higher value. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int64 limit = 8; - - // Aggregation of metrics. Aggregated metric values will be shown in rows - // where the dimension_values are set to "RESERVED_(MetricAggregation)". - repeated MetricAggregation metric_aggregations = 9; - - // Specifies how rows are ordered in the response. - repeated OrderBy order_bys = 10; - - // A currency code in ISO4217 format, such as "AED", "USD", "JPY". - // If the field is empty, the report uses the property's default currency. - string currency_code = 11; - - // Cohort group associated with this request. If there is a cohort group - // in the request the 'cohort' dimension must be present. - CohortSpec cohort_spec = 12; - - // If false or unspecified, each row with all metrics equal to 0 will not be - // returned. If true, these rows will be returned if they are not separately - // removed by a filter. - bool keep_empty_rows = 13; - - // Toggles whether to return the current state of this Analytics Property's - // quota. Quota is returned in [PropertyQuota](#PropertyQuota). - bool return_property_quota = 14; -} - -// The response report table corresponding to a request. -message RunReportResponse { - // Describes dimension columns. The number of DimensionHeaders and ordering of - // DimensionHeaders matches the dimensions present in rows. - repeated DimensionHeader dimension_headers = 1; - - // Describes metric columns. The number of MetricHeaders and ordering of - // MetricHeaders matches the metrics present in rows. - repeated MetricHeader metric_headers = 2; - - // Rows of dimension value combinations and metric values in the report. - repeated Row rows = 3; - - // If requested, the totaled values of metrics. - repeated Row totals = 4; - - // If requested, the maximum values of metrics. - repeated Row maximums = 5; - - // If requested, the minimum values of metrics. - repeated Row minimums = 6; - - // The total number of rows in the query result. `rowCount` is independent of - // the number of rows returned in the response, the `limit` request - // parameter, and the `offset` request parameter. For example if a query - // returns 175 rows and includes `limit` of 50 in the API request, the - // response will contain `rowCount` of 175 but only 50 rows. - // - // To learn more about this pagination parameter, see - // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). - int32 row_count = 7; - - // Metadata for the report. - ResponseMetaData metadata = 8; - - // This Analytics Property's quota state including this request. - PropertyQuota property_quota = 9; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#runReport". Useful to distinguish between - // response types in JSON. - string kind = 10; -} - -// The request to generate a pivot report. -message RunPivotReportRequest { - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // Within a batch request, this property should either be unspecified or - // consistent with the batch-level property. - // - // Example: properties/1234 - string property = 1; - - // The dimensions requested. All defined dimensions must be used by one of the - // following: dimension_expression, dimension_filter, pivots, order_bys. - repeated Dimension dimensions = 2; - - // The metrics requested, at least one metric needs to be specified. All - // defined metrics must be used by one of the following: metric_expression, - // metric_filter, order_bys. - repeated Metric metrics = 3; - - // The date range to retrieve event data for the report. If multiple date - // ranges are specified, event data from each date range is used in the - // report. A special dimension with field name "dateRange" can be included in - // a Pivot's field names; if included, the report compares between date - // ranges. In a cohort request, this `dateRanges` must be unspecified. - repeated DateRange date_ranges = 4; - - // Describes the visual format of the report's dimensions in columns or rows. - // The union of the fieldNames (dimension names) in all pivots must be a - // subset of dimension names defined in Dimensions. No two pivots can share a - // dimension. A dimension is only visible if it appears in a pivot. - repeated Pivot pivots = 5; - - // The filter clause of dimensions. Dimensions must be requested to be used in - // this filter. Metrics cannot be used in this filter. - FilterExpression dimension_filter = 6; - - // The filter clause of metrics. Applied at post aggregation phase, similar to - // SQL having-clause. Metrics must be requested to be used in this filter. - // Dimensions cannot be used in this filter. - FilterExpression metric_filter = 7; - - // A currency code in ISO4217 format, such as "AED", "USD", "JPY". - // If the field is empty, the report uses the property's default currency. - string currency_code = 8; - - // Cohort group associated with this request. If there is a cohort group - // in the request the 'cohort' dimension must be present. - CohortSpec cohort_spec = 9; - - // If false or unspecified, each row with all metrics equal to 0 will not be - // returned. If true, these rows will be returned if they are not separately - // removed by a filter. - bool keep_empty_rows = 10; - - // Toggles whether to return the current state of this Analytics Property's - // quota. Quota is returned in [PropertyQuota](#PropertyQuota). - bool return_property_quota = 11; -} - -// The response pivot report table corresponding to a pivot request. -message RunPivotReportResponse { - // Summarizes the columns and rows created by a pivot. Each pivot in the - // request produces one header in the response. If we have a request like - // this: - // - // "pivots": [{ - // "fieldNames": ["country", - // "city"] - // }, - // { - // "fieldNames": "eventName" - // }] - // - // We will have the following `pivotHeaders` in the response: - // - // "pivotHeaders" : [{ - // "dimensionHeaders": [{ - // "dimensionValues": [ - // { "value": "United Kingdom" }, - // { "value": "London" } - // ] - // }, - // { - // "dimensionValues": [ - // { "value": "Japan" }, - // { "value": "Osaka" } - // ] - // }] - // }, - // { - // "dimensionHeaders": [{ - // "dimensionValues": [{ "value": "session_start" }] - // }, - // { - // "dimensionValues": [{ "value": "scroll" }] - // }] - // }] - repeated PivotHeader pivot_headers = 1; - - // Describes dimension columns. The number of DimensionHeaders and ordering of - // DimensionHeaders matches the dimensions present in rows. - repeated DimensionHeader dimension_headers = 2; - - // Describes metric columns. The number of MetricHeaders and ordering of - // MetricHeaders matches the metrics present in rows. - repeated MetricHeader metric_headers = 3; - - // Rows of dimension value combinations and metric values in the report. - repeated Row rows = 4; - - // Aggregation of metric values. Can be totals, minimums, or maximums. The - // returned aggregations are controlled by the metric_aggregations in the - // pivot. The type of aggregation returned in each row is shown by the - // dimension_values which are set to "RESERVED_<MetricAggregation>". - repeated Row aggregates = 5; - - // Metadata for the report. - ResponseMetaData metadata = 6; - - // This Analytics Property's quota state including this request. - PropertyQuota property_quota = 7; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#runPivotReport". Useful to distinguish between - // response types in JSON. - string kind = 8; -} - -// The batch request containing multiple report requests. -message BatchRunReportsRequest { - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // This property must be specified for the batch. The property within - // RunReportRequest may either be unspecified or consistent with this - // property. - // - // Example: properties/1234 - string property = 1; - - // Individual requests. Each request has a separate report response. Each - // batch request is allowed up to 5 requests. - repeated RunReportRequest requests = 2; -} - -// The batch response containing multiple reports. -message BatchRunReportsResponse { - // Individual responses. Each response has a separate report request. - repeated RunReportResponse reports = 1; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#batchRunReports". Useful to distinguish between - // response types in JSON. - string kind = 2; -} - -// The batch request containing multiple pivot report requests. -message BatchRunPivotReportsRequest { - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // This property must be specified for the batch. The property within - // RunPivotReportRequest may either be unspecified or consistent with this - // property. - // - // Example: properties/1234 - string property = 1; - - // Individual requests. Each request has a separate pivot report response. - // Each batch request is allowed up to 5 requests. - repeated RunPivotReportRequest requests = 2; -} - -// The batch response containing multiple pivot reports. -message BatchRunPivotReportsResponse { - // Individual responses. Each response has a separate pivot report request. - repeated RunPivotReportResponse pivot_reports = 1; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#batchRunPivotReports". Useful to distinguish - // between response types in JSON. - string kind = 2; -} - -// Request for a property's dimension and metric metadata. -message GetMetadataRequest { - // Required. The resource name of the metadata to retrieve. This name field is - // specified in the URL path and not URL parameters. Property is a numeric - // Google Analytics GA4 Property identifier. To learn more, see [where to find - // your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // - // Example: properties/1234/metadata - // - // Set the Property ID to 0 for dimensions and metrics common to all - // properties. In this special mode, this method will not return custom - // dimensions and metrics. - string name = 1 [ - (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "analyticsdata.googleapis.com/Metadata" - } - ]; -} - -// The request to generate a realtime report. -message RunRealtimeReportRequest { - // A Google Analytics GA4 property identifier whose events are tracked. - // Specified in the URL path and not the body. To learn more, see [where to - // find your Property - // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). - // - // Example: properties/1234 - string property = 1; - - // The dimensions requested and displayed. - repeated Dimension dimensions = 2; - - // The metrics requested and displayed. - repeated Metric metrics = 3; - - // The filter clause of dimensions. Metrics cannot be used in this filter. - FilterExpression dimension_filter = 4; - - // The filter clause of metrics. Applied at post aggregation phase, similar to - // SQL having-clause. Dimensions cannot be used in this filter. - FilterExpression metric_filter = 5; - - // The number of rows to return. If unspecified, 10,000 rows are returned. The - // API returns a maximum of 100,000 rows per request, no matter how many you - // ask for. `limit` must be positive. - // - // The API can also return fewer rows than the requested `limit`, if there - // aren't as many dimension values as the `limit`. For instance, there are - // fewer than 300 possible values for the dimension `country`, so when - // reporting on only `country`, you can't get more than 300 rows, even if you - // set `limit` to a higher value. - int64 limit = 6; - - // Aggregation of metrics. Aggregated metric values will be shown in rows - // where the dimension_values are set to "RESERVED_(MetricAggregation)". - repeated MetricAggregation metric_aggregations = 7; - - // Specifies how rows are ordered in the response. - repeated OrderBy order_bys = 8; - - // Toggles whether to return the current state of this Analytics Property's - // Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). - bool return_property_quota = 9; - - // The minute ranges of event data to read. If unspecified, one minute range - // for the last 30 minutes will be used. If multiple minute ranges are - // requested, each response row will contain a zero based minute range index. - // If two minute ranges overlap, the event data for the overlapping minutes is - // included in the response rows for both minute ranges. - repeated MinuteRange minute_ranges = 10; -} - -// The response realtime report table corresponding to a request. -message RunRealtimeReportResponse { - // Describes dimension columns. The number of DimensionHeaders and ordering of - // DimensionHeaders matches the dimensions present in rows. - repeated DimensionHeader dimension_headers = 1; - - // Describes metric columns. The number of MetricHeaders and ordering of - // MetricHeaders matches the metrics present in rows. - repeated MetricHeader metric_headers = 2; - - // Rows of dimension value combinations and metric values in the report. - repeated Row rows = 3; - - // If requested, the totaled values of metrics. - repeated Row totals = 4; - - // If requested, the maximum values of metrics. - repeated Row maximums = 5; - - // If requested, the minimum values of metrics. - repeated Row minimums = 6; - - // The total number of rows in the query result. `rowCount` is independent of - // the number of rows returned in the response and the `limit` request - // parameter. For example if a query returns 175 rows and includes `limit` - // of 50 in the API request, the response will contain `rowCount` of 175 but - // only 50 rows. - int32 row_count = 7; - - // This Analytics Property's Realtime quota state including this request. - PropertyQuota property_quota = 8; - - // Identifies what kind of resource this message is. This `kind` is always the - // fixed string "analyticsData#runRealtimeReport". Useful to distinguish - // between response types in JSON. - string kind = 9; -} diff --git a/third_party/googleapis/google/analytics/data/v1beta/analytics_data_grpc_service_config.json b/third_party/googleapis/google/analytics/data/v1beta/analytics_data_grpc_service_config.json deleted file mode 100644 index 8e1908c..0000000 --- a/third_party/googleapis/google/analytics/data/v1beta/analytics_data_grpc_service_config.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "methodConfig": [ - { - "name": [{ "service": "google.analytics.data.v1beta.BetaAnalyticsData" }], - "timeout": "60s", - "retryPolicy": { - "maxAttempts": 5, - "initialBackoff": "1s", - "maxBackoff": "60s", - "backoffMultiplier": 1.3, - "retryableStatusCodes": ["UNKNOWN"] - } - }, - { - "name": [ - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "RunReport" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "RunPivotReport" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "BatchRunReports" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "BatchRunPivotReports" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "RunRealtimeReport" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "GetMetadata" - }, - { - "service": "google.analytics.data.v1beta.BetaAnalyticsData", - "method": "CheckCompatibility" - } - ], - "timeout": "60s" - } - ] -} diff --git a/third_party/googleapis/google/analytics/data/v1beta/analyticsdata_v1beta.yaml b/third_party/googleapis/google/analytics/data/v1beta/analyticsdata_v1beta.yaml deleted file mode 100644 index eab7fa0..0000000 --- a/third_party/googleapis/google/analytics/data/v1beta/analyticsdata_v1beta.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: google.api.Service -config_version: 3 -name: analyticsdata.googleapis.com -title: Google Analytics Data API - -apis: -- name: google.analytics.data.v1beta.BetaAnalyticsData - -documentation: - summary: Accesses report data in Google Analytics. - -backend: - rules: - - selector: 'google.analytics.data.v1beta.BetaAnalyticsData.*' - deadline: 180.0 - -authentication: - rules: - - selector: 'google.analytics.data.v1beta.BetaAnalyticsData.*' - oauth: - canonical_scopes: |- - https://www.googleapis.com/auth/analytics, - https://www.googleapis.com/auth/analytics.readonly diff --git a/third_party/googleapis/google/analytics/data/v1beta/data.proto b/third_party/googleapis/google/analytics/data/v1beta/data.proto deleted file mode 100644 index 6c6431b..0000000 --- a/third_party/googleapis/google/analytics/data/v1beta/data.proto +++ /dev/null @@ -1,981 +0,0 @@ -// Copyright 2022 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package google.analytics.data.v1beta; - -option go_package = "google.golang.org/genproto/googleapis/analytics/data/v1beta;data"; -option java_multiple_files = true; -option java_outer_classname = "ReportingApiProto"; -option java_package = "com.google.analytics.data.v1beta"; - -// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests -// are allowed up to 4 date ranges. -message DateRange { - // The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot - // be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also - // accepted, and in that case, the date is inferred based on the property's - // reporting time zone. - string start_date = 1; - - // The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot - // be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is - // also accepted, and in that case, the date is inferred based on the - // property's reporting time zone. - string end_date = 2; - - // Assigns a name to this date range. The dimension `dateRange` is valued to - // this name in a report response. If set, cannot begin with `date_range_` or - // `RESERVED_`. If not set, date ranges are named by their zero based index in - // the request: `date_range_0`, `date_range_1`, etc. - string name = 3; -} - -// A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., -// endMinutesAgo. Requests are allowed up to 2 minute ranges. -message MinuteRange { - // The inclusive start minute for the query as a number of minutes before now. - // For example, `"startMinutesAgo": 29` specifies the report should include - // event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. - // - // If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics - // properties can request up to the last 30 minutes of event data - // (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to - // the last 60 minutes of event data (`startMinutesAgo <= 59`). - optional int32 start_minutes_ago = 1; - - // The inclusive end minute for the query as a number of minutes before now. - // Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15` - // specifies the report should include event data from prior to 15 minutes - // ago. - // - // If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics - // properties can request any minute in the last 30 minutes of event data - // (`endMinutesAgo <= 29`), and 360 Analytics properties can request any - // minute in the last 60 minutes of event data (`endMinutesAgo <= 59`). - optional int32 end_minutes_ago = 2; - - // Assigns a name to this minute range. The dimension `dateRange` is valued to - // this name in a report response. If set, cannot begin with `date_range_` or - // `RESERVED_`. If not set, minute ranges are named by their zero based index - // in the request: `date_range_0`, `date_range_1`, etc. - string name = 3; -} - -// Dimensions are attributes of your data. For example, the dimension city -// indicates the city from which an event originates. Dimension values in report -// responses are strings; for example, the city could be "Paris" or "New York". -// Requests are allowed up to 9 dimensions. -message Dimension { - // The name of the dimension. See the [API - // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) - // for the list of dimension names. - // - // If `dimensionExpression` is specified, `name` can be any string that you - // would like within the allowed character set. For example if a - // `dimensionExpression` concatenates `country` and `city`, you could call - // that dimension `countryAndCity`. Dimension names that you choose must match - // the regular expression `^[a-zA-Z0-9_]$`. - // - // Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, - // `dimensionExpression`, and `pivots`. - string name = 1; - - // One dimension can be the result of an expression of multiple dimensions. - // For example, dimension "country, city": concatenate(country, ", ", city). - DimensionExpression dimension_expression = 2; -} - -// Used to express a dimension which is the result of a formula of multiple -// dimensions. Example usages: -// 1) lower_case(dimension) -// 2) concatenate(dimension1, symbol, dimension2). -message DimensionExpression { - // Used to convert a dimension value to a single case. - message CaseExpression { - // Name of a dimension. The name must refer back to a name in dimensions - // field of the request. - string dimension_name = 1; - } - - // Used to combine dimension values to a single dimension. - message ConcatenateExpression { - // Names of dimensions. The names must refer back to names in the dimensions - // field of the request. - repeated string dimension_names = 1; - - // The delimiter placed between dimension names. - // - // Delimiters are often single characters such as "|" or "," but can be - // longer strings. If a dimension value contains the delimiter, both will be - // present in response with no distinction. For example if dimension 1 value - // = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the - // response will contain "US,FR,JP". - string delimiter = 2; - } - - // Specify one type of dimension expression for `DimensionExpression`. - oneof one_expression { - // Used to convert a dimension value to lower case. - CaseExpression lower_case = 4; - - // Used to convert a dimension value to upper case. - CaseExpression upper_case = 5; - - // Used to combine dimension values to a single dimension. - // For example, dimension "country, city": concatenate(country, ", ", city). - ConcatenateExpression concatenate = 6; - } -} - -// The quantitative measurements of a report. For example, the metric -// `eventCount` is the total number of events. Requests are allowed up to 10 -// metrics. -message Metric { - // The name of the metric. See the [API - // Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) - // for the list of metric names. - // - // If `expression` is specified, `name` can be any string that you would like - // within the allowed character set. For example if `expression` is - // `screenPageViews/sessions`, you could call that metric's name = - // `viewsPerSession`. Metric names that you choose must match the regular - // expression `^[a-zA-Z0-9_]$`. - // - // Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric - // `expression`. - string name = 1; - - // A mathematical expression for derived metrics. For example, the metric - // Event count per user is `eventCount/totalUsers`. - string expression = 2; - - // Indicates if a metric is invisible in the report response. If a metric is - // invisible, the metric will not produce a column in the response, but can be - // used in `metricFilter`, `orderBys`, or a metric `expression`. - bool invisible = 3; -} - -// To express dimension or metric filters. The fields in the same -// FilterExpression need to be either all dimensions or all metrics. -message FilterExpression { - // Specify one type of filter expression for `FilterExpression`. - oneof expr { - // The FilterExpressions in and_group have an AND relationship. - FilterExpressionList and_group = 1; - - // The FilterExpressions in or_group have an OR relationship. - FilterExpressionList or_group = 2; - - // The FilterExpression is NOT of not_expression. - FilterExpression not_expression = 3; - - // A primitive filter. In the same FilterExpression, all of the filter's - // field names need to be either all dimensions or all metrics. - Filter filter = 4; - } -} - -// A list of filter expressions. -message FilterExpressionList { - // A list of filter expressions. - repeated FilterExpression expressions = 1; -} - -// An expression to filter dimension or metric values. -message Filter { - // The filter for string - message StringFilter { - // The match type of a string filter - enum MatchType { - // Unspecified - MATCH_TYPE_UNSPECIFIED = 0; - - // Exact match of the string value. - EXACT = 1; - - // Begins with the string value. - BEGINS_WITH = 2; - - // Ends with the string value. - ENDS_WITH = 3; - - // Contains the string value. - CONTAINS = 4; - - // Full match for the regular expression with the string value. - FULL_REGEXP = 5; - - // Partial match for the regular expression with the string value. - PARTIAL_REGEXP = 6; - } - - // The match type for this filter. - MatchType match_type = 1; - - // The string value used for the matching. - string value = 2; - - // If true, the string value is case sensitive. - bool case_sensitive = 3; - } - - // The result needs to be in a list of string values. - message InListFilter { - // The list of string values. - // Must be non-empty. - repeated string values = 1; - - // If true, the string value is case sensitive. - bool case_sensitive = 2; - } - - // Filters for numeric or date values. - message NumericFilter { - // The operation applied to a numeric filter - enum Operation { - // Unspecified. - OPERATION_UNSPECIFIED = 0; - - // Equal - EQUAL = 1; - - // Less than - LESS_THAN = 2; - - // Less than or equal - LESS_THAN_OR_EQUAL = 3; - - // Greater than - GREATER_THAN = 4; - - // Greater than or equal - GREATER_THAN_OR_EQUAL = 5; - } - - // The operation type for this filter. - Operation operation = 1; - - // A numeric value or a date value. - NumericValue value = 2; - } - - // To express that the result needs to be between two numbers (inclusive). - message BetweenFilter { - // Begins with this number. - NumericValue from_value = 1; - - // Ends with this number. - NumericValue to_value = 2; - } - - // The dimension name or metric name. - // - // In most methods, dimensions & metrics can be used for the first time in - // this field. However in a RunPivotReportRequest, this field must be - // additionally specified by name in the RunPivotReportRequest's dimensions or - // metrics. - string field_name = 1; - - // Specify one type of filter for `Filter`. - oneof one_filter { - // Strings related filter. - StringFilter string_filter = 3; - - // A filter for in list values. - InListFilter in_list_filter = 4; - - // A filter for numeric or date values. - NumericFilter numeric_filter = 5; - - // A filter for two values. - BetweenFilter between_filter = 6; - } -} - -// Order bys define how rows will be sorted in the response. For example, -// ordering rows by descending event count is one ordering, and ordering rows by -// the event name string is a different ordering. -message OrderBy { - // Sorts by metric values. - message MetricOrderBy { - // A metric name in the request to order by. - string metric_name = 1; - } - - // Sorts by dimension values. - message DimensionOrderBy { - // Rule to order the string dimension values by. - enum OrderType { - // Unspecified. - ORDER_TYPE_UNSPECIFIED = 0; - - // Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < - // "b" < "z". - ALPHANUMERIC = 1; - - // Case insensitive alphanumeric sort by lower case Unicode code point. - // For example, "2" < "A" < "b" < "X" < "z". - CASE_INSENSITIVE_ALPHANUMERIC = 2; - - // Dimension values are converted to numbers before sorting. For example - // in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" < - // "25". Non-numeric dimension values all have equal ordering value below - // all numeric values. - NUMERIC = 3; - } - - // A dimension name in the request to order by. - string dimension_name = 1; - - // Controls the rule for dimension value ordering. - OrderType order_type = 2; - } - - // Sorts by a pivot column group. - message PivotOrderBy { - // A pair of dimension names and values. Rows with this dimension pivot pair - // are ordered by the metric's value. - // - // For example if pivots = {{"browser", "Chrome"}} and - // metric_name = "Sessions", - // then the rows will be sorted based on Sessions in Chrome. - // - // ---------|----------|----------------|----------|---------------- - // | Chrome | Chrome | Safari | Safari - // ---------|----------|----------------|----------|---------------- - // Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions - // ---------|----------|----------------|----------|---------------- - // US | 2 | 2 | 3 | 1 - // ---------|----------|----------------|----------|---------------- - // Canada | 3 | 1 | 4 | 1 - // ---------|----------|----------------|----------|---------------- - message PivotSelection { - // Must be a dimension name from the request. - string dimension_name = 1; - - // Order by only when the named dimension is this value. - string dimension_value = 2; - } - - // In the response to order by, order rows by this column. Must be a metric - // name from the request. - string metric_name = 1; - - // Used to select a dimension name and value pivot. If multiple pivot - // selections are given, the sort occurs on rows where all pivot selection - // dimension name and value pairs match the row's dimension name and value - // pair. - repeated PivotSelection pivot_selections = 2; - } - - // Specify one type of order by for `OrderBy`. - oneof one_order_by { - // Sorts results by a metric's values. - MetricOrderBy metric = 1; - - // Sorts results by a dimension's values. - DimensionOrderBy dimension = 2; - - // Sorts results by a metric's values within a pivot column group. - PivotOrderBy pivot = 3; - } - - // If true, sorts by descending order. - bool desc = 4; -} - -// Describes the visible dimension columns and rows in the report response. -message Pivot { - // Dimension names for visible columns in the report response. Including - // "dateRange" produces a date range column; for each row in the response, - // dimension values in the date range column will indicate the corresponding - // date range from the request. - repeated string field_names = 1; - - // Specifies how dimensions are ordered in the pivot. In the first Pivot, the - // OrderBys determine Row and PivotDimensionHeader ordering; in subsequent - // Pivots, the OrderBys determine only PivotDimensionHeader ordering. - // Dimensions specified in these OrderBys must be a subset of - // Pivot.field_names. - repeated OrderBy order_bys = 2; - - // The row count of the start row. The first row is counted as row 0. - int64 offset = 3; - - // The number of unique combinations of dimension values to return in this - // pivot. The `limit` parameter is required. A `limit` of 10,000 is common for - // single pivot requests. - // - // The product of the `limit` for each `pivot` in a `RunPivotReportRequest` - // must not exceed 100,000. For example, a two pivot request with `limit: - // 1000` in each pivot will fail because the product is `1,000,000`. - int64 limit = 4; - - // Aggregate the metrics by dimensions in this pivot using the specified - // metric_aggregations. - repeated MetricAggregation metric_aggregations = 5; -} - -// The specification of cohorts for a cohort report. -// -// Cohort reports create a time series of user retention for the cohort. For -// example, you could select the cohort of users that were acquired in the first -// week of September and follow that cohort for the next six weeks. Selecting -// the users acquired in the first week of September cohort is specified in the -// `cohort` object. Following that cohort for the next six weeks is specified in -// the `cohortsRange` object. -// -// For examples, see [Cohort Report -// Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). -// -// The report response could show a weekly time series where say your app has -// retained 60% of this cohort after three weeks and 25% of this cohort after -// six weeks. These two percentages can be calculated by the metric -// `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report. -message CohortSpec { - // Defines the selection criteria to group users into cohorts. - // - // Most cohort reports define only a single cohort. If multiple cohorts are - // specified, each cohort can be recognized in the report by their name. - repeated Cohort cohorts = 1; - - // Cohort reports follow cohorts over an extended reporting date range. This - // range specifies an offset duration to follow the cohorts over. - CohortsRange cohorts_range = 2; - - // Optional settings for a cohort report. - CohortReportSettings cohort_report_settings = 3; -} - -// Defines a cohort selection criteria. A cohort is a group of users who share -// a common characteristic. For example, users with the same `firstSessionDate` -// belong to the same cohort. -message Cohort { - // Assigns a name to this cohort. The dimension `cohort` is valued to this - // name in a report response. If set, cannot begin with `cohort_` or - // `RESERVED_`. If not set, cohorts are named by their zero based index - // `cohort_0`, `cohort_1`, etc. - string name = 1; - - // Dimension used by the cohort. Required and only supports - // `firstSessionDate`. - string dimension = 2; - - // The cohort selects users whose first touch date is between start date and - // end date defined in the `dateRange`. This `dateRange` does not specify the - // full date range of event data that is present in a cohort report. In a - // cohort report, this `dateRange` is extended by the granularity and offset - // present in the `cohortsRange`; event data for the extended reporting date - // range is present in a cohort report. - // - // In a cohort request, this `dateRange` is required and the `dateRanges` in - // the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. - // - // This `dateRange` should generally be aligned with the cohort's granularity. - // If `CohortsRange` uses daily granularity, this `dateRange` can be a single - // day. If `CohortsRange` uses weekly granularity, this `dateRange` can be - // aligned to a week boundary, starting at Sunday and ending Saturday. If - // `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to - // a month, starting at the first and ending on the last day of the month. - DateRange date_range = 3; -} - -// Configures the extended reporting date range for a cohort report. Specifies -// an offset duration to follow the cohorts over. -message CohortsRange { - // The granularity used to interpret the `startOffset` and `endOffset` for the - // extended reporting date range for a cohort report. - enum Granularity { - // Should never be specified. - GRANULARITY_UNSPECIFIED = 0; - - // Daily granularity. Commonly used if the cohort's `dateRange` is a single - // day and the request contains `cohortNthDay`. - DAILY = 1; - - // Weekly granularity. Commonly used if the cohort's `dateRange` is a week - // in duration (starting on Sunday and ending on Saturday) and the request - // contains `cohortNthWeek`. - WEEKLY = 2; - - // Monthly granularity. Commonly used if the cohort's `dateRange` is a month - // in duration and the request contains `cohortNthMonth`. - MONTHLY = 3; - } - - // Required. The granularity used to interpret the `startOffset` and - // `endOffset` for the extended reporting date range for a cohort report. - Granularity granularity = 1; - - // `startOffset` specifies the start date of the extended reporting date range - // for a cohort report. `startOffset` is commonly set to 0 so that reports - // contain data from the acquisition of the cohort forward. - // - // If `granularity` is `DAILY`, the `startDate` of the extended reporting date - // range is `startDate` of the cohort plus `startOffset` days. - // - // If `granularity` is `WEEKLY`, the `startDate` of the extended reporting - // date range is `startDate` of the cohort plus `startOffset * 7` days. - // - // If `granularity` is `MONTHLY`, the `startDate` of the extended reporting - // date range is `startDate` of the cohort plus `startOffset * 30` days. - int32 start_offset = 2; - - // Required. `endOffset` specifies the end date of the extended reporting date - // range for a cohort report. `endOffset` can be any positive integer but is - // commonly set to 5 to 10 so that reports contain data on the cohort for the - // next several granularity time periods. - // - // If `granularity` is `DAILY`, the `endDate` of the extended reporting date - // range is `endDate` of the cohort plus `endOffset` days. - // - // If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date - // range is `endDate` of the cohort plus `endOffset * 7` days. - // - // If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date - // range is `endDate` of the cohort plus `endOffset * 30` days. - int32 end_offset = 3; -} - -// Optional settings of a cohort report. -message CohortReportSettings { - // If true, accumulates the result from first touch day to the end day. Not - // supported in `RunReportRequest`. - bool accumulate = 1; -} - -// Response's metadata carrying additional information about the report content. -message ResponseMetaData { - // The schema restrictions actively enforced in creating this report. To learn - // more, see [Access and data-restriction - // management](https://support.google.com/analytics/answer/10851388). - message SchemaRestrictionResponse { - // A metric actively restricted in creating the report. - message ActiveMetricRestriction { - // The name of the restricted metric. - optional string metric_name = 1; - - // The reason for this metric's restriction. - repeated RestrictedMetricType restricted_metric_types = 2; - } - - // All restrictions actively enforced in creating the report. For example, - // `purchaseRevenue` always has the restriction type `REVENUE_DATA`. - // However, this active response restriction is only populated if the user's - // custom role disallows access to `REVENUE_DATA`. - repeated ActiveMetricRestriction active_metric_restrictions = 1; - } - - // If true, indicates some buckets of dimension combinations are rolled into - // "(other)" row. This can happen for high cardinality reports. - bool data_loss_from_other_row = 3; - - // Describes the schema restrictions actively enforced in creating this - // report. To learn more, see [Access and data-restriction - // management](https://support.google.com/analytics/answer/10851388). - optional SchemaRestrictionResponse schema_restriction_response = 4; - - // The currency code used in this report. Intended to be used in formatting - // currency metrics like `purchaseRevenue` for visualization. If currency_code - // was specified in the request, this response parameter will echo the request - // parameter; otherwise, this response parameter is the property's current - // currency_code. - // - // Currency codes are string encodings of currency types from the ISO 4217 - // standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", - // "EUR", "JPY". To learn more, see - // https://support.google.com/analytics/answer/9796179. - optional string currency_code = 5; - - // The property's current timezone. Intended to be used to interpret - // time-based dimensions like `hour` and `minute`. Formatted as strings from - // the IANA Time Zone database (https://www.iana.org/time-zones); for example - // "America/New_York" or "Asia/Tokyo". - optional string time_zone = 6; - - // If empty reason is specified, the report is empty for this reason. - optional string empty_reason = 7; - - // If `subjectToThresholding` is true, this report is subject to thresholding - // and only returns data that meets the minimum aggregation thresholds. It is - // possible for a request to be subject to thresholding thresholding and no - // data is absent from the report, and this happens when all data is above the - // thresholds. To learn more, see [Data - // thresholds](https://support.google.com/analytics/answer/9383630) and [About - // Demographics and - // Interests](https://support.google.com/analytics/answer/2799357). - optional bool subject_to_thresholding = 8; -} - -// Describes a dimension column in the report. Dimensions requested in a report -// produce column entries within rows and DimensionHeaders. However, dimensions -// used exclusively within filters or expressions do not produce columns in a -// report; correspondingly, those dimensions do not produce headers. -message DimensionHeader { - // The dimension's name. - string name = 1; -} - -// Describes a metric column in the report. Visible metrics requested in a -// report produce column entries within rows and MetricHeaders. However, -// metrics used exclusively within filters or expressions do not produce columns -// in a report; correspondingly, those metrics do not produce headers. -message MetricHeader { - // The metric's name. - string name = 1; - - // The metric's data type. - MetricType type = 2; -} - -// Dimensions' values in a single pivot. -message PivotHeader { - // The size is the same as the cardinality of the corresponding dimension - // combinations. - repeated PivotDimensionHeader pivot_dimension_headers = 1; - - // The cardinality of the pivot. The total number of rows for this pivot's - // fields regardless of how the parameters `offset` and `limit` are specified - // in the request. - int32 row_count = 2; -} - -// Summarizes dimension values from a row for this pivot. -message PivotDimensionHeader { - // Values of multiple dimensions in a pivot. - repeated DimensionValue dimension_values = 1; -} - -// Report data for each row. -// For example if RunReportRequest contains: -// -// ```none -// "dimensions": [ -// { -// "name": "eventName" -// }, -// { -// "name": "countryId" -// } -// ], -// "metrics": [ -// { -// "name": "eventCount" -// } -// ] -// ``` -// -// One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and -// 15 as the eventCount, would be: -// -// ```none -// "dimensionValues": [ -// { -// "value": "in_app_purchase" -// }, -// { -// "value": "JP" -// } -// ], -// "metricValues": [ -// { -// "value": "15" -// } -// ] -// ``` -message Row { - // List of requested dimension values. In a PivotReport, dimension_values - // are only listed for dimensions included in a pivot. - repeated DimensionValue dimension_values = 1; - - // List of requested visible metric values. - repeated MetricValue metric_values = 2; -} - -// The value of a dimension. -message DimensionValue { - // One kind of dimension value - oneof one_value { - // Value as a string if the dimension type is a string. - string value = 1; - } -} - -// The value of a metric. -message MetricValue { - // One of metric value - oneof one_value { - // Measurement value. See MetricHeader for type. - string value = 4; - } -} - -// To represent a number. -message NumericValue { - // One of a numeric value - oneof one_value { - // Integer value - int64 int64_value = 1; - - // Double value - double double_value = 2; - } -} - -// Current state of all quotas for this Analytics Property. If any quota for a -// property is exhausted, all requests to that property will return Resource -// Exhausted errors. -message PropertyQuota { - // Standard Analytics Properties can use up to 25,000 tokens per day; - // Analytics 360 Properties can use 250,000 tokens per day. Most requests - // consume fewer than 10 tokens. - QuotaStatus tokens_per_day = 1; - - // Standard Analytics Properties can use up to 5,000 tokens per hour; - // Analytics 360 Properties can use 50,000 tokens per hour. An API request - // consumes a single number of tokens, and that number is deducted from all of - // the hourly, daily, and per project hourly quotas. - QuotaStatus tokens_per_hour = 2; - - // Standard Analytics Properties can send up to 10 concurrent requests; - // Analytics 360 Properties can use up to 50 concurrent requests. - QuotaStatus concurrent_requests = 3; - - // Standard Analytics Properties and cloud project pairs can have up to 10 - // server errors per hour; Analytics 360 Properties and cloud project pairs - // can have up to 50 server errors per hour. - QuotaStatus server_errors_per_project_per_hour = 4; - - // Analytics Properties can send up to 120 requests with potentially - // thresholded dimensions per hour. In a batch request, each report request - // is individually counted for this quota if the request contains potentially - // thresholded dimensions. - QuotaStatus potentially_thresholded_requests_per_hour = 5; - - // Analytics Properties can use up to 25% of their tokens per project per - // hour. This amounts to standard Analytics Properties can use up to 1,250 - // tokens per project per hour, and Analytics 360 Properties can use 12,500 - // tokens per project per hour. An API request consumes a single number of - // tokens, and that number is deducted from all of the hourly, daily, and per - // project hourly quotas. - QuotaStatus tokens_per_project_per_hour = 6; -} - -// Current state for a particular quota group. -message QuotaStatus { - // Quota consumed by this request. - int32 consumed = 1; - - // Quota remaining after this request. - int32 remaining = 2; -} - -// Explains a dimension. -message DimensionMetadata { - // This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For - // example, `eventName`. - string api_name = 1; - - // This dimension's name within the Google Analytics user interface. For - // example, `Event name`. - string ui_name = 2; - - // Description of how this dimension is used and calculated. - string description = 3; - - // Still usable but deprecated names for this dimension. If populated, this - // dimension is available by either `apiName` or one of `deprecatedApiNames` - // for a period of time. After the deprecation period, the dimension will be - // available only by `apiName`. - repeated string deprecated_api_names = 4; - - // True if the dimension is a custom dimension for this property. - bool custom_definition = 5; - - // The display name of the category that this dimension belongs to. Similar - // dimensions and metrics are categorized together. - string category = 7; -} - -// Explains a metric. -message MetricMetadata { - // Justifications for why this metric is blocked. - enum BlockedReason { - // Will never be specified in API response. - BLOCKED_REASON_UNSPECIFIED = 0; - - // If present, your access is blocked to revenue related metrics for this - // property, and this metric is revenue related. - NO_REVENUE_METRICS = 1; - - // If present, your access is blocked to cost related metrics for this - // property, and this metric is cost related. - NO_COST_METRICS = 2; - } - - // A metric name. Useable in [Metric](#Metric)'s `name`. For example, - // `eventCount`. - string api_name = 1; - - // This metric's name within the Google Analytics user interface. For example, - // `Event count`. - string ui_name = 2; - - // Description of how this metric is used and calculated. - string description = 3; - - // Still usable but deprecated names for this metric. If populated, this - // metric is available by either `apiName` or one of `deprecatedApiNames` - // for a period of time. After the deprecation period, the metric will be - // available only by `apiName`. - repeated string deprecated_api_names = 4; - - // The type of this metric. - MetricType type = 5; - - // The mathematical expression for this derived metric. Can be used in - // [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics - // are not expressions, and for non-expressions, this field is empty. - string expression = 6; - - // True if the metric is a custom metric for this property. - bool custom_definition = 7; - - // If reasons are specified, your access is blocked to this metric for this - // property. API requests from you to this property for this metric will - // succeed; however, the report will contain only zeros for this metric. API - // requests with metric filters on blocked metrics will fail. If reasons are - // empty, you have access to this metric. - // - // To learn more, see [Access and data-restriction - // management](https://support.google.com/analytics/answer/10851388). - repeated BlockedReason blocked_reasons = 8; - - // The display name of the category that this metrics belongs to. Similar - // dimensions and metrics are categorized together. - string category = 10; -} - -// The compatibility for a single dimension. -message DimensionCompatibility { - // The dimension metadata contains the API name for this compatibility - // information. The dimension metadata also contains other helpful information - // like the UI name and description. - optional DimensionMetadata dimension_metadata = 1; - - // The compatibility of this dimension. If the compatibility is COMPATIBLE, - // this dimension can be successfully added to the report. - optional Compatibility compatibility = 2; -} - -// The compatibility for a single metric. -message MetricCompatibility { - // The metric metadata contains the API name for this compatibility - // information. The metric metadata also contains other helpful information - // like the UI name and description. - optional MetricMetadata metric_metadata = 1; - - // The compatibility of this metric. If the compatibility is COMPATIBLE, - // this metric can be successfully added to the report. - optional Compatibility compatibility = 2; -} - -// Represents aggregation of metrics. -enum MetricAggregation { - // Unspecified operator. - METRIC_AGGREGATION_UNSPECIFIED = 0; - - // SUM operator. - TOTAL = 1; - - // Minimum operator. - MINIMUM = 5; - - // Maximum operator. - MAXIMUM = 6; - - // Count operator. - COUNT = 4; -} - -// A metric's value type. -enum MetricType { - // Unspecified type. - METRIC_TYPE_UNSPECIFIED = 0; - - // Integer type. - TYPE_INTEGER = 1; - - // Floating point type. - TYPE_FLOAT = 2; - - // A duration of seconds; a special floating point type. - TYPE_SECONDS = 4; - - // A duration in milliseconds; a special floating point type. - TYPE_MILLISECONDS = 5; - - // A duration in minutes; a special floating point type. - TYPE_MINUTES = 6; - - // A duration in hours; a special floating point type. - TYPE_HOURS = 7; - - // A custom metric of standard type; a special floating point type. - TYPE_STANDARD = 8; - - // An amount of money; a special floating point type. - TYPE_CURRENCY = 9; - - // A length in feet; a special floating point type. - TYPE_FEET = 10; - - // A length in miles; a special floating point type. - TYPE_MILES = 11; - - // A length in meters; a special floating point type. - TYPE_METERS = 12; - - // A length in kilometers; a special floating point type. - TYPE_KILOMETERS = 13; -} - -// Categories of data that you may be restricted from viewing on certain GA4 -// properties. -enum RestrictedMetricType { - // Unspecified type. - RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0; - - // Cost metrics such as `adCost`. - COST_DATA = 1; - - // Revenue metrics such as `purchaseRevenue`. - REVENUE_DATA = 2; -} - -// The compatibility types for a single dimension or metric. -enum Compatibility { - // Unspecified compatibility. - COMPATIBILITY_UNSPECIFIED = 0; - - // The dimension or metric is compatible. This dimension or metric can be - // successfully added to a report. - COMPATIBLE = 1; - - // The dimension or metric is incompatible. This dimension or metric cannot be - // successfully added to a report. - INCOMPATIBLE = 2; -} |