This is first release of the API protos and Bazel BUILD files for the Analytics Admin API V1alpha.

PiperOrigin-RevId: 319180144
pull/610/head
Google APIs 5 years ago committed by Copybara-Service
parent 332db1a7db
commit e6ab0a55f2
  1. 384
      google/analytics/admin/v1alpha/BUILD.bazel
  2. 158
      google/analytics/admin/v1alpha/admin_grpc_service_config.json
  3. 1344
      google/analytics/admin/v1alpha/analytics_admin.proto
  4. 18
      google/analytics/admin/v1alpha/analyticsadmin_gapic.yaml
  5. 114
      google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml
  6. 571
      google/analytics/admin/v1alpha/resources.proto

@ -0,0 +1,384 @@
# This file was automatically generated by BuildFileGenerator
# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/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",
src = ":admin_proto_with_info",
gapic_yaml = "analyticsadmin_gapic.yaml",
grpc_service_config = "admin_grpc_service_config.json",
package = "google.analytics.admin.v1alpha",
service_yaml = "analyticsadmin_v1alpha.yaml",
test_deps = [
":admin_java_grpc",
],
deps = [
":admin_java_proto",
],
)
java_gapic_test(
name = "admin_java_gapic_test_suite",
test_classes = [
"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",
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",
service_yaml = "analyticsadmin_v1alpha.yaml",
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/v1alpha",
)
# Open Source Packages
go_gapic_assembly_pkg(
name = "gapi-analytics-admin-v1alpha-go",
deps = [
":admin_go_gapic",
":admin_go_gapic_srcjar-test.srcjar",
":admin_go_proto",
],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"moved_proto_library",
"py_gapic_assembly_pkg",
"py_gapic_library",
"py_grpc_library",
"py_proto_library",
)
moved_proto_library(
name = "admin_moved_proto",
srcs = [":admin_proto"],
# Customization (ikuleshov): Without this parameter, the proto resources
# are generated with "google.cloud" package prefix and the generated
# clients do not compile.
import_prefix="google/analytics/admin/v1alpha/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",
],
)
py_proto_library(
name = "admin_py_proto",
plugin = "@protoc_docs_plugin//:docs_plugin",
deps = [":admin_moved_proto"],
)
py_grpc_library(
name = "admin_py_grpc",
srcs = [":admin_moved_proto"],
deps = [":admin_py_proto"],
)
py_gapic_library(
name = "admin_py_gapic",
src = ":admin_proto_with_info",
gapic_yaml = "analyticsadmin_gapic.yaml",
grpc_service_config = "admin_grpc_service_config.json",
package = "google.analytics.admin.v1alpha",
service_yaml = "analyticsadmin_v1alpha.yaml",
deps = [
":admin_py_grpc",
":admin_py_proto",
],
)
# Open Source Packages
py_gapic_assembly_pkg(
name = "google-analytics-admin-v1alpha-py",
deps = [
":admin_py_gapic",
":admin_py_grpc",
":admin_py_proto",
],
)
##############################################################################
# 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",
src = ":admin_proto_with_info",
gapic_yaml = "analyticsadmin_gapic.yaml",
grpc_service_config = "admin_grpc_service_config.json",
package = "google.analytics.admin.v1alpha",
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",
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_gapic_assembly_pkg",
"ruby_gapic_library",
"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_gapic_library(
name = "admin_ruby_gapic",
src = ":admin_proto_with_info",
gapic_yaml = "analyticsadmin_gapic.yaml",
grpc_service_config = "admin_grpc_service_config.json",
package = "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",
src = ":admin_proto_with_info",
gapic_yaml = "analyticsadmin_gapic.yaml",
grpc_service_config = "admin_grpc_service_config.json",
package = "google.analytics.admin.v1alpha",
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++
##############################################################################
# Put your C++ rules here

@ -0,0 +1,158 @@
{
"methodConfig": [
{
"name": [{"service": "google.analytics.admin.v1alpha.AnalyticsAdminService"}],
"timeout": "60s",
"retryPolicy": {
"maxAttempts": 5,
"initialBackoff": "1s",
"maxBackoff": "60s",
"backoffMultiplier": 1.3,
"retryableStatusCodes": ["UNAVAILABLE", "UNKNOWN"]
}
},
{
"name": [
{
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetAccount"
},
{
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListAccounts"
},
{
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteAccount"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateAccount"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ProvisionAccountTicket"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetProperty"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListProperties"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteProperty"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateProperty"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateProperty"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetUserLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "BatchGetUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "AuditUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateUserLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "BatchCreateUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateUserLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "BatchUpdateUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteUserLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "BatchDeleteUserLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetWebDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateWebDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateWebDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListWebDataStreams"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetIosAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteIosAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateIosAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateIosAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListIosAppDataStreams"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetAndroidAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteAndroidAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateAndroidAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateAndroidAppDataStream"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListAndroidAppDataStreams"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetEnhancedMeasurementSettings"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateEnhancedMeasurementSettings"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateFirebaseLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateFirebaseLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteFirebaseLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListFirebaseLinks"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "GetGlobalSiteTag"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "CreateGoogleAdsLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "UpdateGoogleAdsLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "DeleteGoogleAdsLink"
}, {
"service": "google.analytics.admin.v1alpha.AnalyticsAdminService",
"method": "ListGoogleAdsLinks"
}
],
"timeout": "60s"
}
]
}

File diff suppressed because it is too large Load Diff

@ -0,0 +1,18 @@
type: com.google.api.codegen.ConfigProto
config_schema_version: 2.0.0
language_settings:
java:
package_name: com.google.analytics.admin.v1alpha
python:
package_name: google.analytics.admin.v1alpha.gapic
go:
package_name: google.golang.org/api/analyticsadmin/v1alpha
csharp:
package_name: Google.Analytics.Admin.V1alpha
ruby:
package_name: Google::Analytics::Admin::V1alpha
php:
package_name: Google\Analytics\Admin\V1alpha
nodejs:
package_name: google.analytics.admin.v1alpha
domain_layer_location: analyticsadmin.google.com

@ -0,0 +1,114 @@
type: google.api.Service
config_version: 3
name: analyticsadmin.googleapis.com
title: 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.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.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.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAndroidAppDataStream
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetDataSharingSettings
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetEnhancedMeasurementSettings
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetGlobalSiteTag
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetIosAppDataStream
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetProperty
oauth:
canonical_scopes: |-
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.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetWebDataStream
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAccounts
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListAndroidAppDataStreams
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListFirebaseLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListGoogleAdsLinks
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListIosAppDataStreams
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/analytics.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListProperties
oauth:
canonical_scopes: |-
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.readonly
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListWebDataStreams
oauth:
canonical_scopes: |-
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

@ -0,0 +1,571 @@
// Copyright 2020 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";
// 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 non-deprecated code for a UN M.49 region.
// https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
string country_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 App+Web 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];
// 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}
// Example: "accounts/100"
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;
// 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;
// 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. Indicates whether this Property is soft-deleted or not. Deleted properties
// are excluded from List results unless specifically requested.
bool deleted = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A resource message representing a Google Analytics Android app stream.
message AndroidAppDataStream {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/AndroidAppDataStream"
pattern: "properties/{property}/androidAppDataStreams/{android_app_data_stream}"
};
// Output only. Resource name of this Data Stream.
// Format: properties/{property_id}/androidAppDataStreams/{stream_id}
// Example: "properties/1000/androidAppDataStreams/2000"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// 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 = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this stream was originally created.
google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when stream payload fields were last updated.
google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. The package name for the app being measured.
// Example: "com.example.myandroidapp"
string package_name = 5 [(google.api.field_behavior) = IMMUTABLE];
// Human-readable display name for the Data Stream.
//
// The max allowed display name length is 255 UTF-16 code units.
string display_name = 6;
}
// A resource message representing a Google Analytics IOS app stream.
message IosAppDataStream {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/IosAppDataStream"
pattern: "properties/{property}/iosAppDataStreams/{ios_app_data_stream}"
};
// Output only. Resource name of this Data Stream.
// Format: properties/{property_id}/iosAppDataStreams/{stream_id}
// Example: "properties/1000/iosAppDataStreams/2000"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// 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 = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this stream was originally created.
google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when stream payload fields were last updated.
google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Immutable. The Apple App Store Bundle ID for the app
// Example: "com.example.myiosapp"
string bundle_id = 5 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED
];
// Human-readable display name for the Data Stream.
//
// The max allowed display name length is 255 UTF-16 code units.
string display_name = 6;
}
// A resource message representing a Google Analytics web stream.
message WebDataStream {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/WebDataStream"
pattern: "properties/{property}/webDataStreams/{web_data_stream}"
};
// Output only. Resource name of this Data Stream.
// Format: properties/{property_id}/webDataStreams/{stream_id}
// Example: "properties/1000/webDataStreams/2000"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Analytics "Measurement ID", without the "G-" prefix.
// Example: "G-1A2BCD345E" would just be "1A2BCD345E"
string measurement_id = 2 [(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 = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this stream was originally created.
google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when stream payload fields were last updated.
google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. Domain name of the web app being measured, or empty.
// Example: "http://www.google.com", "https://www.google.com"
string default_uri = 6 [(google.api.field_behavior) = IMMUTABLE];
// Required. Human-readable display name for the Data Stream.
//
// The max allowed display name length is 100 UTF-16 code units.
string display_name = 7 [(google.api.field_behavior) = REQUIRED];
}
// 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}"
};
// Example format: properties/1234/userLinks/5678
string name = 1;
// Email address of the user to link
string email_address = 2;
// Roles directly assigned to this user for this account or property.
//
// Valid values:
// predefinedRoles/read
// predefinedRoles/collaborate
// predefinedRoles/edit
// predefinedRoles/manage-users
//
// 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/read
//
// 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/read
repeated string effective_roles = 4;
}
// Singleton resource under a WebDataStream, configuring measurement of
// additional site interactions and content.
message EnhancedMeasurementSettings {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/EnhancedMeasurementSettings"
pattern: "properties/{property}/webDataStreams/{web_data_stream}/enhancedMeasurementSettings"
};
// Output only. Resource name of this Data Stream.
// Format:
// properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings
// Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Indicates whether Enhanced Measurement Settings will be used to
// automatically measure interactions and content on this web stream.
//
// Changing this value does not affect the settings themselves, but determines
// whether they are respected.
bool stream_enabled = 2;
// Output only. If enabled, capture a page view event each time a page loads or the
// website changes the browser history state.
bool page_views_enabled = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// If enabled, capture scroll events each time a visitor gets to the bottom of
// a page.
bool scrolls_enabled = 4;
// If enabled, capture an outbound click event each time a visitor clicks a
// link that leads them away from your domain.
bool outbound_clicks_enabled = 5;
// Capture events when your visitors view content on your site that has
// structured data (eg, articles, blog posts, product details screens, etc.).
bool content_views_enabled = 6;
// If enabled, capture a view search results event each time a visitor
// performs a search on your site (based on a query parameter).
bool site_search_enabled = 7;
// If enabled, capture a view search results event each time a visitor
// interacts with a form on your site.
bool form_interactions_enabled = 8;
// If enabled, capture video play, progress, and complete events as visitors
// view embedded videos on your site.
bool video_engagement_enabled = 9;
// If enabled, capture a file download event each time a link is clicked with
// a common document, compressed file, application, video, or audio extension.
bool file_downloads_enabled = 10;
// If enabled, capture a click event each time a visitor clicks a link or
// element that has data attributes beginning with "data-ga".
bool data_tagged_element_clicks_enabled = 11;
// If enabled, capture a page view event each time a page loads.
bool page_loads_enabled = 12;
// If enabled, capture a page view event each time the website changes the
// browser history state.
bool page_changes_enabled = 13;
// Capture events when your visitors view content on your site that has
// articles or blog posts.
bool articles_and_blogs_enabled = 14;
// Capture events when your visitors view content on your site that has
// product details screens, etc.
bool products_and_ecommerce_enabled = 15;
// Required. URL query parameters to interpret as site search parameters.
// Max length is 1024 characters. Must not be empty.
string search_query_parameter = 16 [(google.api.field_behavior) = REQUIRED];
// Additional URL query parameters.
// Max length is 1024 characters.
string url_query_parameter = 17;
// Domains to exclude from measurement. Max length is 1024 characters.
string excluded_domains = 18;
}
// A link between an App+Web 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];
// Maximum user access to the App + Web property allowed to admins of
// the linked Firebase project.
MaximumUserAccess maximum_user_access = 4;
}
// Read-only resource with the tag for sending data from a website to a
// WebDataStream.
message GlobalSiteTag {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/GlobalSiteTag"
pattern: "properties/{property}/globalSiteTag"
};
// Immutable. JavaScript code snippet to be pasted as the first item into the head tag of
// every webpage to measure.
string snippet = 1 [(google.api.field_behavior) = IMMUTABLE];
}
// A link between an App+Web 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. Format: properties/{propertyId}
string parent = 2 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Google Ads customer ID.
string customer_id = 3 [(google.api.field_behavior) = IMMUTABLE];
// 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. Email address of the user that created the link.
// An empty string will be returned if the email address can't be retrieved.
string email_address = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this link was originally created.
google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this link was last updated.
google.protobuf.Timestamp update_time = 8 [(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;
}
// 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;
}
// Maximum access settings that Firebase user receive on the linked Analytics
// property.
enum MaximumUserAccess {
// Unspecified maximum user access.
MAXIMUM_USER_ACCESS_UNSPECIFIED = 0;
// Firebase users have no access to the Analytics property.
NO_ACCESS = 1;
// Firebase users have Read & Analyze access to the Analytics property.
READ_AND_ANALYZE = 2;
// Firebase users have edit access to the Analytics property, but may not
// manage the Firebase link.
EDITOR_WITHOUT_LINK_MANAGEMENT = 3;
// Firebase users have edit access to the Analytics property and may manage
// the Firebase link.
EDITOR_INCLUDING_LINK_MANAGEMENT = 4;
}
Loading…
Cancel
Save