As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.analytics.admin_v1beta.types.resources
# -*- coding: utf-8 -*-
# Copyright 2023 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.
#
from __future__ import annotations
from typing import MutableMapping, MutableSequence
from google.protobuf import timestamp_pb2 # type: ignore
from google.protobuf import wrappers_pb2 # type: ignore
import proto # type: ignore
__protobuf__ = proto.module(
package="google.analytics.admin.v1beta",
manifest={
"IndustryCategory",
"ServiceLevel",
"ActorType",
"ActionType",
"ChangeHistoryResourceType",
"PropertyType",
"Account",
"Property",
"DataStream",
"FirebaseLink",
"GoogleAdsLink",
"DataSharingSettings",
"AccountSummary",
"PropertySummary",
"MeasurementProtocolSecret",
"ChangeHistoryEvent",
"ChangeHistoryChange",
"ConversionEvent",
"CustomDimension",
"CustomMetric",
"DataRetentionSettings",
},
)
[docs]class IndustryCategory(proto.Enum):
r"""The category selected for this property, used for industry
benchmarking.
Values:
INDUSTRY_CATEGORY_UNSPECIFIED (0):
Industry category unspecified
AUTOMOTIVE (1):
Automotive
BUSINESS_AND_INDUSTRIAL_MARKETS (2):
Business and industrial markets
FINANCE (3):
Finance
HEALTHCARE (4):
Healthcare
TECHNOLOGY (5):
Technology
TRAVEL (6):
Travel
OTHER (7):
Other
ARTS_AND_ENTERTAINMENT (8):
Arts and entertainment
BEAUTY_AND_FITNESS (9):
Beauty and fitness
BOOKS_AND_LITERATURE (10):
Books and literature
FOOD_AND_DRINK (11):
Food and drink
GAMES (12):
Games
HOBBIES_AND_LEISURE (13):
Hobbies and leisure
HOME_AND_GARDEN (14):
Home and garden
INTERNET_AND_TELECOM (15):
Internet and telecom
LAW_AND_GOVERNMENT (16):
Law and government
NEWS (17):
News
ONLINE_COMMUNITIES (18):
Online communities
PEOPLE_AND_SOCIETY (19):
People and society
PETS_AND_ANIMALS (20):
Pets and animals
REAL_ESTATE (21):
Real estate
REFERENCE (22):
Reference
SCIENCE (23):
Science
SPORTS (24):
Sports
JOBS_AND_EDUCATION (25):
Jobs and education
SHOPPING (26):
Shopping
"""
INDUSTRY_CATEGORY_UNSPECIFIED = 0
AUTOMOTIVE = 1
BUSINESS_AND_INDUSTRIAL_MARKETS = 2
FINANCE = 3
HEALTHCARE = 4
TECHNOLOGY = 5
TRAVEL = 6
OTHER = 7
ARTS_AND_ENTERTAINMENT = 8
BEAUTY_AND_FITNESS = 9
BOOKS_AND_LITERATURE = 10
FOOD_AND_DRINK = 11
GAMES = 12
HOBBIES_AND_LEISURE = 13
HOME_AND_GARDEN = 14
INTERNET_AND_TELECOM = 15
LAW_AND_GOVERNMENT = 16
NEWS = 17
ONLINE_COMMUNITIES = 18
PEOPLE_AND_SOCIETY = 19
PETS_AND_ANIMALS = 20
REAL_ESTATE = 21
REFERENCE = 22
SCIENCE = 23
SPORTS = 24
JOBS_AND_EDUCATION = 25
SHOPPING = 26
[docs]class ServiceLevel(proto.Enum):
r"""Various levels of service for Google Analytics.
Values:
SERVICE_LEVEL_UNSPECIFIED (0):
Service level not specified or invalid.
GOOGLE_ANALYTICS_STANDARD (1):
The standard version of Google Analytics.
GOOGLE_ANALYTICS_360 (2):
The paid, premium version of Google
Analytics.
"""
SERVICE_LEVEL_UNSPECIFIED = 0
GOOGLE_ANALYTICS_STANDARD = 1
GOOGLE_ANALYTICS_360 = 2
[docs]class ActorType(proto.Enum):
r"""Different kinds of actors that can make changes to Google
Analytics resources.
Values:
ACTOR_TYPE_UNSPECIFIED (0):
Unknown or unspecified actor type.
USER (1):
Changes made by the user specified in actor_email.
SYSTEM (2):
Changes made by the Google Analytics system.
SUPPORT (3):
Changes made by Google Analytics support team
staff.
"""
ACTOR_TYPE_UNSPECIFIED = 0
USER = 1
SYSTEM = 2
SUPPORT = 3
[docs]class ActionType(proto.Enum):
r"""Types of actions that may change a resource.
Values:
ACTION_TYPE_UNSPECIFIED (0):
Action type unknown or not specified.
CREATED (1):
Resource was created in this change.
UPDATED (2):
Resource was updated in this change.
DELETED (3):
Resource was deleted in this change.
"""
ACTION_TYPE_UNSPECIFIED = 0
CREATED = 1
UPDATED = 2
DELETED = 3
[docs]class ChangeHistoryResourceType(proto.Enum):
r"""Types of resources whose changes may be returned from change
history.
Values:
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED (0):
Resource type unknown or not specified.
ACCOUNT (1):
Account resource
PROPERTY (2):
Property resource
FIREBASE_LINK (6):
FirebaseLink resource
GOOGLE_ADS_LINK (7):
GoogleAdsLink resource
GOOGLE_SIGNALS_SETTINGS (8):
GoogleSignalsSettings resource
CONVERSION_EVENT (9):
ConversionEvent resource
MEASUREMENT_PROTOCOL_SECRET (10):
MeasurementProtocolSecret resource
DATA_RETENTION_SETTINGS (13):
DataRetentionSettings resource
DISPLAY_VIDEO_360_ADVERTISER_LINK (14):
DisplayVideo360AdvertiserLink resource
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL (15):
DisplayVideo360AdvertiserLinkProposal
resource
DATA_STREAM (18):
DataStream resource
ATTRIBUTION_SETTINGS (20):
AttributionSettings resource
"""
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0
ACCOUNT = 1
PROPERTY = 2
FIREBASE_LINK = 6
GOOGLE_ADS_LINK = 7
GOOGLE_SIGNALS_SETTINGS = 8
CONVERSION_EVENT = 9
MEASUREMENT_PROTOCOL_SECRET = 10
DATA_RETENTION_SETTINGS = 13
DISPLAY_VIDEO_360_ADVERTISER_LINK = 14
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15
DATA_STREAM = 18
ATTRIBUTION_SETTINGS = 20
[docs]class PropertyType(proto.Enum):
r"""Types of Property resources.
Values:
PROPERTY_TYPE_UNSPECIFIED (0):
Unknown or unspecified property type
PROPERTY_TYPE_ORDINARY (1):
Ordinary GA4 property
PROPERTY_TYPE_SUBPROPERTY (2):
GA4 subproperty
PROPERTY_TYPE_ROLLUP (3):
GA4 rollup property
"""
PROPERTY_TYPE_UNSPECIFIED = 0
PROPERTY_TYPE_ORDINARY = 1
PROPERTY_TYPE_SUBPROPERTY = 2
PROPERTY_TYPE_ROLLUP = 3
[docs]class Account(proto.Message):
r"""A resource message representing a Google Analytics account.
Attributes:
name (str):
Output only. Resource name of this account.
Format: accounts/{account}
Example: "accounts/100".
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this account was
originally created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when account payload fields
were last updated.
display_name (str):
Required. Human-readable display name for
this account.
region_code (str):
Country of business. Must be a Unicode CLDR
region code.
deleted (bool):
Output only. Indicates whether this Account
is soft-deleted or not. Deleted accounts are
excluded from List results unless specifically
requested.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=2,
message=timestamp_pb2.Timestamp,
)
update_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=3,
message=timestamp_pb2.Timestamp,
)
display_name: str = proto.Field(
proto.STRING,
number=4,
)
region_code: str = proto.Field(
proto.STRING,
number=5,
)
deleted: bool = proto.Field(
proto.BOOL,
number=6,
)
[docs]class Property(proto.Message):
r"""A resource message representing a Google Analytics GA4
property.
Attributes:
name (str):
Output only. Resource name of this property. Format:
properties/{property_id} Example: "properties/1000".
property_type (google.analytics.admin_v1beta.types.PropertyType):
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 with the Google Analytics Admin API.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when the entity was
originally created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when entity payload fields
were last updated.
parent (str):
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".
display_name (str):
Required. Human-readable display name for
this property.
The max allowed display name length is 100
UTF-16 code units.
industry_category (google.analytics.admin_v1beta.types.IndustryCategory):
Industry associated with this property Example: AUTOMOTIVE,
FOOD_AND_DRINK
time_zone (str):
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".
currency_code (str):
The currency type used in reports involving monetary values.
Format: https://en.wikipedia.org/wiki/ISO_4217 Examples:
"USD", "EUR", "JPY".
service_level (google.analytics.admin_v1beta.types.ServiceLevel):
Output only. The Google Analytics service
level that applies to this property.
delete_time (google.protobuf.timestamp_pb2.Timestamp):
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.
expire_time (google.protobuf.timestamp_pb2.Timestamp):
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.
account (str):
Immutable. The resource name of the parent account Format:
accounts/{account_id} Example: "accounts/123".
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
property_type: "PropertyType" = proto.Field(
proto.ENUM,
number=14,
enum="PropertyType",
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=3,
message=timestamp_pb2.Timestamp,
)
update_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=4,
message=timestamp_pb2.Timestamp,
)
parent: str = proto.Field(
proto.STRING,
number=2,
)
display_name: str = proto.Field(
proto.STRING,
number=5,
)
industry_category: "IndustryCategory" = proto.Field(
proto.ENUM,
number=6,
enum="IndustryCategory",
)
time_zone: str = proto.Field(
proto.STRING,
number=7,
)
currency_code: str = proto.Field(
proto.STRING,
number=8,
)
service_level: "ServiceLevel" = proto.Field(
proto.ENUM,
number=10,
enum="ServiceLevel",
)
delete_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=11,
message=timestamp_pb2.Timestamp,
)
expire_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=12,
message=timestamp_pb2.Timestamp,
)
account: str = proto.Field(
proto.STRING,
number=13,
)
[docs]class DataStream(proto.Message):
r"""A resource message representing a data stream.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
web_stream_data (google.analytics.admin_v1beta.types.DataStream.WebStreamData):
Data specific to web streams. Must be populated if type is
WEB_DATA_STREAM.
This field is a member of `oneof`_ ``stream_data``.
android_app_stream_data (google.analytics.admin_v1beta.types.DataStream.AndroidAppStreamData):
Data specific to Android app streams. Must be populated if
type is ANDROID_APP_DATA_STREAM.
This field is a member of `oneof`_ ``stream_data``.
ios_app_stream_data (google.analytics.admin_v1beta.types.DataStream.IosAppStreamData):
Data specific to iOS app streams. Must be populated if type
is IOS_APP_DATA_STREAM.
This field is a member of `oneof`_ ``stream_data``.
name (str):
Output only. Resource name of this Data Stream. Format:
properties/{property_id}/dataStreams/{stream_id} Example:
"properties/1000/dataStreams/2000".
type_ (google.analytics.admin_v1beta.types.DataStream.DataStreamType):
Required. Immutable. The type of this
DataStream resource.
display_name (str):
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.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this stream was
originally created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when stream payload fields
were last updated.
"""
[docs] class DataStreamType(proto.Enum):
r"""The type of the data stream.
Values:
DATA_STREAM_TYPE_UNSPECIFIED (0):
Type unknown or not specified.
WEB_DATA_STREAM (1):
Web data stream.
ANDROID_APP_DATA_STREAM (2):
Android app data stream.
IOS_APP_DATA_STREAM (3):
iOS app data stream.
"""
DATA_STREAM_TYPE_UNSPECIFIED = 0
WEB_DATA_STREAM = 1
ANDROID_APP_DATA_STREAM = 2
IOS_APP_DATA_STREAM = 3
[docs] class WebStreamData(proto.Message):
r"""Data specific to web streams.
Attributes:
measurement_id (str):
Output only. Analytics Measurement ID.
Example: "G-1A2BCD345E".
firebase_app_id (str):
Output only. ID of the corresponding web app
in Firebase, if any. This ID can change if the
web app is deleted and recreated.
default_uri (str):
Domain name of the web app being measured, or
empty. Example: "http://www.google.com",
"https://www.google.com".
"""
measurement_id: str = proto.Field(
proto.STRING,
number=1,
)
firebase_app_id: str = proto.Field(
proto.STRING,
number=2,
)
default_uri: str = proto.Field(
proto.STRING,
number=3,
)
[docs] class AndroidAppStreamData(proto.Message):
r"""Data specific to Android app streams.
Attributes:
firebase_app_id (str):
Output only. ID of the corresponding Android
app in Firebase, if any. This ID can change if
the Android app is deleted and recreated.
package_name (str):
Immutable. The package name for the app being
measured. Example: "com.example.myandroidapp".
"""
firebase_app_id: str = proto.Field(
proto.STRING,
number=1,
)
package_name: str = proto.Field(
proto.STRING,
number=2,
)
[docs] class IosAppStreamData(proto.Message):
r"""Data specific to iOS app streams.
Attributes:
firebase_app_id (str):
Output only. ID of the corresponding iOS app
in Firebase, if any. This ID can change if the
iOS app is deleted and recreated.
bundle_id (str):
Required. Immutable. The Apple App Store
Bundle ID for the app Example:
"com.example.myiosapp".
"""
firebase_app_id: str = proto.Field(
proto.STRING,
number=1,
)
bundle_id: str = proto.Field(
proto.STRING,
number=2,
)
web_stream_data: WebStreamData = proto.Field(
proto.MESSAGE,
number=6,
oneof="stream_data",
message=WebStreamData,
)
android_app_stream_data: AndroidAppStreamData = proto.Field(
proto.MESSAGE,
number=7,
oneof="stream_data",
message=AndroidAppStreamData,
)
ios_app_stream_data: IosAppStreamData = proto.Field(
proto.MESSAGE,
number=8,
oneof="stream_data",
message=IosAppStreamData,
)
name: str = proto.Field(
proto.STRING,
number=1,
)
type_: DataStreamType = proto.Field(
proto.ENUM,
number=2,
enum=DataStreamType,
)
display_name: str = proto.Field(
proto.STRING,
number=3,
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=4,
message=timestamp_pb2.Timestamp,
)
update_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=5,
message=timestamp_pb2.Timestamp,
)
[docs]class FirebaseLink(proto.Message):
r"""A link between a GA4 property and a Firebase project.
Attributes:
name (str):
Output only. Example format:
properties/1234/firebaseLinks/5678
project (str):
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'
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this FirebaseLink was
originally created.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
project: str = proto.Field(
proto.STRING,
number=2,
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=3,
message=timestamp_pb2.Timestamp,
)
[docs]class GoogleAdsLink(proto.Message):
r"""A link between a GA4 property and a Google Ads account.
Attributes:
name (str):
Output only. Format:
properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
Note: googleAdsLinkId is not the Google Ads
customer ID.
customer_id (str):
Immutable. Google Ads customer ID.
can_manage_clients (bool):
Output only. If true, this link is for a
Google Ads manager account.
ads_personalization_enabled (google.protobuf.wrappers_pb2.BoolValue):
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.
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this link was
originally created.
update_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this link was last
updated.
creator_email_address (str):
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.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
customer_id: str = proto.Field(
proto.STRING,
number=3,
)
can_manage_clients: bool = proto.Field(
proto.BOOL,
number=4,
)
ads_personalization_enabled: wrappers_pb2.BoolValue = proto.Field(
proto.MESSAGE,
number=5,
message=wrappers_pb2.BoolValue,
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=7,
message=timestamp_pb2.Timestamp,
)
update_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=8,
message=timestamp_pb2.Timestamp,
)
creator_email_address: str = proto.Field(
proto.STRING,
number=9,
)
[docs]class DataSharingSettings(proto.Message):
r"""A resource message representing data sharing settings of a
Google Analytics account.
Attributes:
name (str):
Output only. Resource name.
Format: accounts/{account}/dataSharingSettings
Example: "accounts/1000/dataSharingSettings".
sharing_with_google_support_enabled (bool):
Allows Google support to access the data in
order to help troubleshoot issues.
sharing_with_google_assigned_sales_enabled (bool):
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.
sharing_with_google_any_sales_enabled (bool):
Allows any of Google sales to access the data
in order to suggest configuration changes to
improve results.
sharing_with_google_products_enabled (bool):
Allows Google to use the data to improve
other Google products or services.
sharing_with_others_enabled (bool):
Allows Google to share the data anonymously
in aggregate form with others.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
sharing_with_google_support_enabled: bool = proto.Field(
proto.BOOL,
number=2,
)
sharing_with_google_assigned_sales_enabled: bool = proto.Field(
proto.BOOL,
number=3,
)
sharing_with_google_any_sales_enabled: bool = proto.Field(
proto.BOOL,
number=4,
)
sharing_with_google_products_enabled: bool = proto.Field(
proto.BOOL,
number=5,
)
sharing_with_others_enabled: bool = proto.Field(
proto.BOOL,
number=6,
)
[docs]class AccountSummary(proto.Message):
r"""A virtual resource representing an overview of an account and
all its child GA4 properties.
Attributes:
name (str):
Resource name for this account summary. Format:
accountSummaries/{account_id} Example:
"accountSummaries/1000".
account (str):
Resource name of account referred to by this account summary
Format: accounts/{account_id} Example: "accounts/1000".
display_name (str):
Display name for the account referred to in
this account summary.
property_summaries (MutableSequence[google.analytics.admin_v1beta.types.PropertySummary]):
List of summaries for child accounts of this
account.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
account: str = proto.Field(
proto.STRING,
number=2,
)
display_name: str = proto.Field(
proto.STRING,
number=3,
)
property_summaries: MutableSequence["PropertySummary"] = proto.RepeatedField(
proto.MESSAGE,
number=4,
message="PropertySummary",
)
[docs]class PropertySummary(proto.Message):
r"""A virtual resource representing metadata for a GA4 property.
Attributes:
property (str):
Resource name of property referred to by this property
summary Format: properties/{property_id} Example:
"properties/1000".
display_name (str):
Display name for the property referred to in
this property summary.
property_type (google.analytics.admin_v1beta.types.PropertyType):
The property's property type.
parent (str):
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".
"""
property: str = proto.Field(
proto.STRING,
number=1,
)
display_name: str = proto.Field(
proto.STRING,
number=2,
)
property_type: "PropertyType" = proto.Field(
proto.ENUM,
number=3,
enum="PropertyType",
)
parent: str = proto.Field(
proto.STRING,
number=4,
)
[docs]class MeasurementProtocolSecret(proto.Message):
r"""A secret value used for sending hits to Measurement Protocol.
Attributes:
name (str):
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}
display_name (str):
Required. Human-readable display name for
this secret.
secret_value (str):
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.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
display_name: str = proto.Field(
proto.STRING,
number=2,
)
secret_value: str = proto.Field(
proto.STRING,
number=3,
)
[docs]class ChangeHistoryEvent(proto.Message):
r"""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.
Attributes:
id (str):
ID of this change history event. This ID is
unique across Google Analytics.
change_time (google.protobuf.timestamp_pb2.Timestamp):
Time when change was made.
actor_type (google.analytics.admin_v1beta.types.ActorType):
The type of actor that made this change.
user_actor_email (str):
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.
changes_filtered (bool):
If true, then the list of changes returned
was filtered, and does not represent all changes
that occurred in this event.
changes (MutableSequence[google.analytics.admin_v1beta.types.ChangeHistoryChange]):
A list of changes made in this change history
event that fit the filters specified in
SearchChangeHistoryEventsRequest.
"""
id: str = proto.Field(
proto.STRING,
number=1,
)
change_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=2,
message=timestamp_pb2.Timestamp,
)
actor_type: "ActorType" = proto.Field(
proto.ENUM,
number=3,
enum="ActorType",
)
user_actor_email: str = proto.Field(
proto.STRING,
number=4,
)
changes_filtered: bool = proto.Field(
proto.BOOL,
number=5,
)
changes: MutableSequence["ChangeHistoryChange"] = proto.RepeatedField(
proto.MESSAGE,
number=6,
message="ChangeHistoryChange",
)
[docs]class ChangeHistoryChange(proto.Message):
r"""A description of a change to a single Google Analytics
resource.
Attributes:
resource (str):
Resource name of the resource whose changes
are described by this entry.
action (google.analytics.admin_v1beta.types.ActionType):
The type of action that changed this
resource.
resource_before_change (google.analytics.admin_v1beta.types.ChangeHistoryChange.ChangeHistoryResource):
Resource contents from before the change was
made. If this resource was created in this
change, this field will be missing.
resource_after_change (google.analytics.admin_v1beta.types.ChangeHistoryChange.ChangeHistoryResource):
Resource contents from after the change was
made. If this resource was deleted in this
change, this field will be missing.
"""
[docs] class ChangeHistoryResource(proto.Message):
r"""A snapshot of a resource as before or after the result of a
change in change history.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
account (google.analytics.admin_v1beta.types.Account):
A snapshot of an Account resource in change
history.
This field is a member of `oneof`_ ``resource``.
property (google.analytics.admin_v1beta.types.Property):
A snapshot of a Property resource in change
history.
This field is a member of `oneof`_ ``resource``.
firebase_link (google.analytics.admin_v1beta.types.FirebaseLink):
A snapshot of a FirebaseLink resource in
change history.
This field is a member of `oneof`_ ``resource``.
google_ads_link (google.analytics.admin_v1beta.types.GoogleAdsLink):
A snapshot of a GoogleAdsLink resource in
change history.
This field is a member of `oneof`_ ``resource``.
conversion_event (google.analytics.admin_v1beta.types.ConversionEvent):
A snapshot of a ConversionEvent resource in
change history.
This field is a member of `oneof`_ ``resource``.
measurement_protocol_secret (google.analytics.admin_v1beta.types.MeasurementProtocolSecret):
A snapshot of a MeasurementProtocolSecret
resource in change history.
This field is a member of `oneof`_ ``resource``.
data_retention_settings (google.analytics.admin_v1beta.types.DataRetentionSettings):
A snapshot of a data retention settings
resource in change history.
This field is a member of `oneof`_ ``resource``.
data_stream (google.analytics.admin_v1beta.types.DataStream):
A snapshot of a DataStream resource in change
history.
This field is a member of `oneof`_ ``resource``.
"""
account: "Account" = proto.Field(
proto.MESSAGE,
number=1,
oneof="resource",
message="Account",
)
property: "Property" = proto.Field(
proto.MESSAGE,
number=2,
oneof="resource",
message="Property",
)
firebase_link: "FirebaseLink" = proto.Field(
proto.MESSAGE,
number=6,
oneof="resource",
message="FirebaseLink",
)
google_ads_link: "GoogleAdsLink" = proto.Field(
proto.MESSAGE,
number=7,
oneof="resource",
message="GoogleAdsLink",
)
conversion_event: "ConversionEvent" = proto.Field(
proto.MESSAGE,
number=11,
oneof="resource",
message="ConversionEvent",
)
measurement_protocol_secret: "MeasurementProtocolSecret" = proto.Field(
proto.MESSAGE,
number=12,
oneof="resource",
message="MeasurementProtocolSecret",
)
data_retention_settings: "DataRetentionSettings" = proto.Field(
proto.MESSAGE,
number=15,
oneof="resource",
message="DataRetentionSettings",
)
data_stream: "DataStream" = proto.Field(
proto.MESSAGE,
number=18,
oneof="resource",
message="DataStream",
)
resource: str = proto.Field(
proto.STRING,
number=1,
)
action: "ActionType" = proto.Field(
proto.ENUM,
number=2,
enum="ActionType",
)
resource_before_change: ChangeHistoryResource = proto.Field(
proto.MESSAGE,
number=3,
message=ChangeHistoryResource,
)
resource_after_change: ChangeHistoryResource = proto.Field(
proto.MESSAGE,
number=4,
message=ChangeHistoryResource,
)
[docs]class ConversionEvent(proto.Message):
r"""A conversion event in a Google Analytics property.
Attributes:
name (str):
Output only. Resource name of this conversion event. Format:
properties/{property}/conversionEvents/{conversion_event}
event_name (str):
Immutable. The event name for this conversion
event. Examples: 'click', 'purchase'
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Time when this conversion event
was created in the property.
deletable (bool):
Output only. If set, this event can currently
be deleted with DeleteConversionEvent.
custom (bool):
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.
counting_method (google.analytics.admin_v1beta.types.ConversionEvent.ConversionCountingMethod):
Optional. The method by which conversions will be counted
across multiple events within a session. If this value is
not provided, it will be set to ``ONCE_PER_EVENT``.
"""
[docs] class ConversionCountingMethod(proto.Enum):
r"""The method by which conversions will be counted across
multiple events within a session.
Values:
CONVERSION_COUNTING_METHOD_UNSPECIFIED (0):
Counting method not specified.
ONCE_PER_EVENT (1):
Each Event instance is considered a
Conversion.
ONCE_PER_SESSION (2):
An Event instance is considered a Conversion
at most once per session per user.
"""
CONVERSION_COUNTING_METHOD_UNSPECIFIED = 0
ONCE_PER_EVENT = 1
ONCE_PER_SESSION = 2
name: str = proto.Field(
proto.STRING,
number=1,
)
event_name: str = proto.Field(
proto.STRING,
number=2,
)
create_time: timestamp_pb2.Timestamp = proto.Field(
proto.MESSAGE,
number=3,
message=timestamp_pb2.Timestamp,
)
deletable: bool = proto.Field(
proto.BOOL,
number=4,
)
custom: bool = proto.Field(
proto.BOOL,
number=5,
)
counting_method: ConversionCountingMethod = proto.Field(
proto.ENUM,
number=6,
enum=ConversionCountingMethod,
)
[docs]class CustomDimension(proto.Message):
r"""A definition for a CustomDimension.
Attributes:
name (str):
Output only. Resource name for this
CustomDimension resource. Format:
properties/{property}/customDimensions/{customDimension}
parameter_name (str):
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.
If this is an item-scoped dimension, then this
is the parameter name found in the eCommerce
items array.
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.
display_name (str):
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.
description (str):
Optional. Description for this custom
dimension. Max length of 150 characters.
scope (google.analytics.admin_v1beta.types.CustomDimension.DimensionScope):
Required. Immutable. The scope of this
dimension.
disallow_ads_personalization (bool):
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.
"""
[docs] class DimensionScope(proto.Enum):
r"""Valid values for the scope of this dimension.
Values:
DIMENSION_SCOPE_UNSPECIFIED (0):
Scope unknown or not specified.
EVENT (1):
Dimension scoped to an event.
USER (2):
Dimension scoped to a user.
ITEM (3):
Dimension scoped to eCommerce items
"""
DIMENSION_SCOPE_UNSPECIFIED = 0
EVENT = 1
USER = 2
ITEM = 3
name: str = proto.Field(
proto.STRING,
number=1,
)
parameter_name: str = proto.Field(
proto.STRING,
number=2,
)
display_name: str = proto.Field(
proto.STRING,
number=3,
)
description: str = proto.Field(
proto.STRING,
number=4,
)
scope: DimensionScope = proto.Field(
proto.ENUM,
number=5,
enum=DimensionScope,
)
disallow_ads_personalization: bool = proto.Field(
proto.BOOL,
number=6,
)
[docs]class CustomMetric(proto.Message):
r"""A definition for a custom metric.
Attributes:
name (str):
Output only. Resource name for this
CustomMetric resource. Format:
properties/{property}/customMetrics/{customMetric}
parameter_name (str):
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.
display_name (str):
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.
description (str):
Optional. Description for this custom
dimension. Max length of 150 characters.
measurement_unit (google.analytics.admin_v1beta.types.CustomMetric.MeasurementUnit):
Required. The type for the custom metric's
value.
scope (google.analytics.admin_v1beta.types.CustomMetric.MetricScope):
Required. Immutable. The scope of this custom
metric.
restricted_metric_type (MutableSequence[google.analytics.admin_v1beta.types.CustomMetric.RestrictedMetricType]):
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.
"""
[docs] class MeasurementUnit(proto.Enum):
r"""Possible types of representing the custom metric's value.
Currency representation may change in the future, requiring a
breaking API change.
Values:
MEASUREMENT_UNIT_UNSPECIFIED (0):
MeasurementUnit unspecified or missing.
STANDARD (1):
This metric uses default units.
CURRENCY (2):
This metric measures a currency.
FEET (3):
This metric measures feet.
METERS (4):
This metric measures meters.
KILOMETERS (5):
This metric measures kilometers.
MILES (6):
This metric measures miles.
MILLISECONDS (7):
This metric measures milliseconds.
SECONDS (8):
This metric measures seconds.
MINUTES (9):
This metric measures minutes.
HOURS (10):
This metric measures hours.
"""
MEASUREMENT_UNIT_UNSPECIFIED = 0
STANDARD = 1
CURRENCY = 2
FEET = 3
METERS = 4
KILOMETERS = 5
MILES = 6
MILLISECONDS = 7
SECONDS = 8
MINUTES = 9
HOURS = 10
[docs] class MetricScope(proto.Enum):
r"""The scope of this metric.
Values:
METRIC_SCOPE_UNSPECIFIED (0):
Scope unknown or not specified.
EVENT (1):
Metric scoped to an event.
"""
METRIC_SCOPE_UNSPECIFIED = 0
EVENT = 1
[docs] class RestrictedMetricType(proto.Enum):
r"""Labels that mark the data in this custom metric as data that
should be restricted to specific users.
Values:
RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
Type unknown or unspecified.
COST_DATA (1):
Metric reports cost data.
REVENUE_DATA (2):
Metric reports revenue data.
"""
RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0
COST_DATA = 1
REVENUE_DATA = 2
name: str = proto.Field(
proto.STRING,
number=1,
)
parameter_name: str = proto.Field(
proto.STRING,
number=2,
)
display_name: str = proto.Field(
proto.STRING,
number=3,
)
description: str = proto.Field(
proto.STRING,
number=4,
)
measurement_unit: MeasurementUnit = proto.Field(
proto.ENUM,
number=5,
enum=MeasurementUnit,
)
scope: MetricScope = proto.Field(
proto.ENUM,
number=6,
enum=MetricScope,
)
restricted_metric_type: MutableSequence[RestrictedMetricType] = proto.RepeatedField(
proto.ENUM,
number=8,
enum=RestrictedMetricType,
)
[docs]class DataRetentionSettings(proto.Message):
r"""Settings values for data retention. This is a singleton
resource.
Attributes:
name (str):
Output only. Resource name for this
DataRetentionSetting resource. Format:
properties/{property}/dataRetentionSettings
event_data_retention (google.analytics.admin_v1beta.types.DataRetentionSettings.RetentionDuration):
The length of time that event-level data is
retained.
reset_user_data_on_new_activity (bool):
If true, reset the retention period for the
user identifier with every event from that user.
"""
[docs] class RetentionDuration(proto.Enum):
r"""Valid values for the data retention duration.
Values:
RETENTION_DURATION_UNSPECIFIED (0):
Data retention time duration is not
specified.
TWO_MONTHS (1):
The data retention time duration is 2 months.
FOURTEEN_MONTHS (3):
The data retention time duration is 14
months.
TWENTY_SIX_MONTHS (4):
The data retention time duration is 26
months. Available to 360 properties only.
THIRTY_EIGHT_MONTHS (5):
The data retention time duration is 38
months. Available to 360 properties only.
FIFTY_MONTHS (6):
The data retention time duration is 50
months. Available to 360 properties only.
"""
RETENTION_DURATION_UNSPECIFIED = 0
TWO_MONTHS = 1
FOURTEEN_MONTHS = 3
TWENTY_SIX_MONTHS = 4
THIRTY_EIGHT_MONTHS = 5
FIFTY_MONTHS = 6
name: str = proto.Field(
proto.STRING,
number=1,
)
event_data_retention: RetentionDuration = proto.Field(
proto.ENUM,
number=2,
enum=RetentionDuration,
)
reset_user_data_on_new_activity: bool = proto.Field(
proto.BOOL,
number=3,
)
__all__ = tuple(sorted(__protobuf__.manifest))
