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.

AnalyticsAdminService

class google.analytics.admin_v1alpha.services.analytics_admin_service.AnalyticsAdminServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service Interface for the Analytics Admin API (GA4).

Instantiate the analytics admin service client.

Parameters

• credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

• transport (Union[str, AnalyticsAdminServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

• client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static account_path(account: str) → str

Return a fully-qualified account string.

static account_summary_path(account_summary: str) → str

Return a fully-qualified account_summary string.

static android_app_data_stream_path(property: str, android_app_data_stream: str) → str

Return a fully-qualified android_app_data_stream string.

async audit_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksAsyncPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.AuditUserLinksRequest) – The request object. Request message for AuditUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for AuditUserLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksAsyncPager

async batch_create_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateUserLinksResponse

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.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchCreateUserLinksRequest) – The request object. Request message for BatchCreateUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchCreateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchCreateUserLinksResponse

async batch_delete_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchDeleteUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchDeleteUserLinksRequest) – The request object. Request message for BatchDeleteUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async batch_get_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchGetUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchGetUserLinksResponse

Gets information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchGetUserLinksRequest) – The request object. Request message for BatchGetUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchGetUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchGetUserLinksResponse

async batch_update_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateUserLinksResponse

Updates information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchUpdateUserLinksRequest) – The request object. Request message for BatchUpdateUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchUpdateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchUpdateUserLinksResponse

static common_billing_account_path(billing_account: str) → str

Return a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Return a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Return a fully-qualified location string.

static common_organization_path(organization: str) → str

Return a fully-qualified organization string.

static common_project_path(project: str) → str

Return a fully-qualified project string.

async create_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateAndroidAppDataStreamRequest] = None, *, parent: Optional[str] = None, android_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Creates an android app stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateAndroidAppDataStreamRequest) – The request object. Request message for CreateAndroidAppDataStream RPC.

• parent (str) –

  Required. The parent resource where this android app data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• android_app_data_stream (google.analytics.admin_v1alpha.types.AndroidAppDataStream) –

  Required. The android app stream to create.

  This corresponds to the android_app_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

async create_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateFirebaseLinkRequest] = None, *, parent: Optional[str] = None, firebase_link: Optional[google.analytics.admin_v1alpha.types.resources.FirebaseLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.FirebaseLink

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateFirebaseLinkRequest) – The request object. Request message for CreateFirebaseLink RPC

• parent (str) –

  Required. Format: properties/{property_id} Example: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink) –

  Required. The Firebase link to create.

  This corresponds to the firebase_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

async create_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateGoogleAdsLinkRequest] = None, *, parent: Optional[str] = None, google_ads_link: Optional[google.analytics.admin_v1alpha.types.resources.GoogleAdsLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleAdsLink

Creates a GoogleAdsLink.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateGoogleAdsLinkRequest) – The request object. Request message for CreateGoogleAdsLink RPC

• parent (str) –

  Required. Example format: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink) –

  Required. The GoogleAdsLink to create.

  This corresponds to the google_ads_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Google Ads account.

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

async create_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateIosAppDataStreamRequest] = None, *, parent: Optional[str] = None, ios_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.IosAppDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Creates an iOS app data stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateIosAppDataStreamRequest) – The request object. Request message for CreateIosAppDataStream RPC.

• parent (str) –

  Required. The parent resource where this ios app data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• ios_app_data_stream (google.analytics.admin_v1alpha.types.IosAppDataStream) –

  Required. The iOS app data stream to create.

  This corresponds to the ios_app_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

async create_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreatePropertyRequest] = None, *, property: Optional[google.analytics.admin_v1alpha.types.resources.Property] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Creates an “GA4” property with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreatePropertyRequest) – The request object. Request message for CreateProperty RPC.

• property (google.analytics.admin_v1alpha.types.Property) –

  Required. The property to create. Note: the supplied property must specify its parent.

  This corresponds to the property field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

async create_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateUserLinkRequest] = None, *, parent: Optional[str] = None, user_link: Optional[google.analytics.admin_v1alpha.types.resources.UserLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

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.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateUserLinkRequest) – The request object. 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.

• parent (str) –

  Required. Example format: accounts/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• user_link (google.analytics.admin_v1alpha.types.UserLink) – Required. The user link to create. This corresponds to the user_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

async create_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateWebDataStreamRequest] = None, *, parent: Optional[str] = None, web_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.WebDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Creates a web stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateWebDataStreamRequest) – The request object. Request message for CreateWebDataStream RPC.

• parent (str) –

  Required. The parent resource where this web data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream) – Required. The web stream to create. This corresponds to the web_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static data_sharing_settings_path(account: str) → str

Return a fully-qualified data_sharing_settings string.

async delete_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteAccountRequest) – The request object. Request message for DeleteAccount RPC.

• name (str) –

  Required. The name of the Account to soft-delete. Format: accounts/{account} Example: “accounts/100”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAndroidAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes an android app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteAndroidAppDataStreamRequest) – The request object. Request message for DeleteAndroidAppDataStream RPC.

• name (str) –

  Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteFirebaseLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a FirebaseLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteFirebaseLinkRequest) – The request object. Request message for DeleteFirebaseLink RPC

• name (str) –

  Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteGoogleAdsLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a GoogleAdsLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteGoogleAdsLinkRequest) – The request object. Request message for DeleteGoogleAdsLink RPC.

• name (str) –

  Required. Example format: properties/1234/googleAdsLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteIosAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes an iOS app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteIosAppDataStreamRequest) – The request object. Request message for DeleteIosAppDataStream RPC.

• name (str) –

  Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeletePropertyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

Parameters

• request (google.analytics.admin_v1alpha.types.DeletePropertyRequest) – The request object. Request message for DeleteProperty RPC.

• name (str) –

  Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: “properties/1000”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteUserLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a user link on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteUserLinkRequest) – The request object. Request message for DeleteUserLink RPC.

• name (str) –

  Required. Example format: accounts/1234/userLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteWebDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a web stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteWebDataStreamRequest) – The request object. Request message for DeleteWebDataStream RPC.

• name (str) –

  Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static enhanced_measurement_settings_path(property: str, web_data_stream: str) → str

Return a fully-qualified enhanced_measurement_settings string.

static firebase_link_path(property: str, firebase_link: str) → str

Return a fully-qualified firebase_link string.

classmethod from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters

• info (dict) – The service account private key info.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

async get_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Account

Lookup for a single Account.

Parameters

• request (google.analytics.admin_v1alpha.types.GetAccountRequest) – The request object. Request message for GetAccount RPC.

• name (str) –

  Required. The name of the account to lookup. Format: accounts/{account} Example: “accounts/100”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

async get_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetAndroidAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Lookup for a single AndroidAppDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetAndroidAppDataStreamRequest) – The request object. Request message for GetAndroidAppDataStream RPC.

• name (str) –

  Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

async get_data_sharing_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetDataSharingSettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataSharingSettings

Get data sharing settings on an account. Data sharing settings are singletons.

Parameters

• request (google.analytics.admin_v1alpha.types.GetDataSharingSettingsRequest) – The request object. Request message for GetDataSharingSettings RPC.

• name (str) –

  Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: “accounts/1000/dataSharingSettings”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing data sharing settings of a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.DataSharingSettings

async get_enhanced_measurement_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetEnhancedMeasurementSettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

• request (google.analytics.admin_v1alpha.types.GetEnhancedMeasurementSettingsRequest) – The request object. Request message for GetEnhancedMeasurementSettings RPC.

• name (str) –

  Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: “properties/1000/webDataStreams/2000/enhancedMeasurementSettings”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

Return type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

async get_global_site_tag(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetGlobalSiteTagRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GlobalSiteTag

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Parameters

• request (google.analytics.admin_v1alpha.types.GetGlobalSiteTagRequest) – The request object. Request message for GetGlobalSiteTag RPC.

• name (str) –

  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}/webDataStreams/{stream_id}/globalSiteTag Example: “properties/123/webDataStreams/456/globalSiteTag”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Read-only resource with the tag for sending data from a website to a WebDataStream.

Return type

google.analytics.admin_v1alpha.types.GlobalSiteTag

async get_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetIosAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Lookup for a single IosAppDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetIosAppDataStreamRequest) – The request object. Request message for GetIosAppDataStream RPC.

• name (str) –

  Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

async get_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetPropertyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Lookup for a single “GA4” Property.

Parameters

• request (google.analytics.admin_v1alpha.types.GetPropertyRequest) – The request object. Request message for GetProperty RPC.

• name (str) –

  Required. The name of the property to lookup. Format: properties/{property_id} Example: “properties/1000”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

get_transport_class() → Type[google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport]

Return an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async get_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetUserLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

Gets information about a user’s link to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.GetUserLinkRequest) – The request object. Request message for GetUserLink RPC.

• name (str) –

  Required. Example format: accounts/1234/userLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

async get_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetWebDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Lookup for a single WebDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetWebDataStreamRequest) – The request object. Request message for GetWebDataStream RPC.

• name (str) –

  Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static global_site_tag_path(property: str) → str

Return a fully-qualified global_site_tag string.

static google_ads_link_path(property: str, google_ads_link: str) → str

Return a fully-qualified google_ads_link string.

static ios_app_data_stream_path(property: str, ios_app_data_stream: str) → str

Return a fully-qualified ios_app_data_stream string.

async list_account_summaries(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesAsyncPager

Returns summaries of all accounts accessible by the caller.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAccountSummariesRequest) – The request object. Request message for ListAccountSummaries RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListAccountSummaries RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesAsyncPager

async list_accounts(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAccountsRequest) – The request object. Request message for ListAccounts RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListAccounts RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager

async list_android_app_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsAsyncPager

Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsRequest) – The request object. Request message for ListAndroidAppDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListAndroidDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsAsyncPager

async list_firebase_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksAsyncPager

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Parameters

• request (google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest) – The request object. Request message for ListFirebaseLinks RPC

• parent (str) –

  Required. Format: properties/{property_id} Example: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListFirebaseLinks RPC Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksAsyncPager

async list_google_ads_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksAsyncPager

Lists GoogleAdsLinks on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest) – The request object. Request message for ListGoogleAdsLinks RPC.

• parent (str) –

  Required. Example format: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListGoogleAdsLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksAsyncPager

async list_ios_app_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsAsyncPager

Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsRequest) – The request object. Request message for ListIosAppDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListIosAppDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsAsyncPager

async list_properties(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesAsyncPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.ListPropertiesRequest) – The request object. Request message for ListProperties RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListProperties RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesAsyncPager

async list_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksAsyncPager

Lists all user links on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.ListUserLinksRequest) – The request object. Request message for ListUserLinks RPC.

• parent (str) –

  Required. Example format: accounts/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListUserLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksAsyncPager

async list_web_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsAsyncPager

Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListWebDataStreamsRequest) – The request object. Request message for ListWebDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListWebDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsAsyncPager

static parse_account_path(path: str) → Dict[str, str]

Parse a account path into its component segments.

static parse_account_summary_path(path: str) → Dict[str, str]

Parse a account_summary path into its component segments.

static parse_android_app_data_stream_path(path: str) → Dict[str, str]

Parse a android_app_data_stream path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_data_sharing_settings_path(path: str) → Dict[str, str]

Parse a data_sharing_settings path into its component segments.

static parse_enhanced_measurement_settings_path(path: str) → Dict[str, str]

Parse a enhanced_measurement_settings path into its component segments.

static parse_firebase_link_path(path: str) → Dict[str, str]

Parse a firebase_link path into its component segments.

static parse_global_site_tag_path(path: str) → Dict[str, str]

Parse a global_site_tag path into its component segments.

static parse_google_ads_link_path(path: str) → Dict[str, str]

Parse a google_ads_link path into its component segments.

static parse_ios_app_data_stream_path(path: str) → Dict[str, str]

Parse a ios_app_data_stream path into its component segments.

static parse_property_path(path: str) → Dict[str, str]

Parse a property path into its component segments.

static parse_user_link_path(path: str) → Dict[str, str]

Parse a user_link path into its component segments.

static parse_web_data_stream_path(path: str) → Dict[str, str]

Parse a web_data_stream path into its component segments.

static property_path(property: str) → str

Return a fully-qualified property string.

async provision_account_ticket(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ProvisionAccountTicketRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.ProvisionAccountTicketResponse

Requests a ticket for creating an account.

Parameters

• request (google.analytics.admin_v1alpha.types.ProvisionAccountTicketRequest) – The request object. Request message for ProvisionAccountTicket RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ProvisionAccountTicket RPC.

Return type

google.analytics.admin_v1alpha.types.ProvisionAccountTicketResponse

property transport

Return the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

AnalyticsAdminServiceTransport

async update_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateAccountRequest] = None, *, account: Optional[google.analytics.admin_v1alpha.types.resources.Account] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Account

Updates an account.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateAccountRequest) – The request object. Request message for UpdateAccount RPC.

• account (google.analytics.admin_v1alpha.types.Account) –

  Required. The account to update. The account’s name field is used to identify the account.

  This corresponds to the account field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

async update_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateAndroidAppDataStreamRequest] = None, *, android_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Updates an android app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateAndroidAppDataStreamRequest) – The request object. Request message for UpdateAndroidAppDataStream RPC.

• android_app_data_stream (google.analytics.admin_v1alpha.types.AndroidAppDataStream) –

  Required. The android app stream to update. The name field is used to identify the android app stream to be updated.

  This corresponds to the android_app_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

async update_enhanced_measurement_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateEnhancedMeasurementSettingsRequest] = None, *, enhanced_measurement_settings: Optional[google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateEnhancedMeasurementSettingsRequest) – The request object. Request message for UpdateEnhancedMeasurementSettings RPC.

• enhanced_measurement_settings (google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings) –

  Required. The settings to update. The name field is used to identify the settings to be updated.

  This corresponds to the enhanced_measurement_settings field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

Return type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

async update_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateFirebaseLinkRequest] = None, *, firebase_link: Optional[google.analytics.admin_v1alpha.types.resources.FirebaseLink] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.FirebaseLink

Updates a FirebaseLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateFirebaseLinkRequest) – The request object. Request message for UpdateFirebaseLink RPC

• firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink) –

  Required. The Firebase link to update.

  This corresponds to the firebase_link field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

async update_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateGoogleAdsLinkRequest] = None, *, google_ads_link: Optional[google.analytics.admin_v1alpha.types.resources.GoogleAdsLink] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleAdsLink

Updates a GoogleAdsLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateGoogleAdsLinkRequest) – The request object. Request message for UpdateGoogleAdsLink RPC

• google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink) – The GoogleAdsLink to update This corresponds to the google_ads_link field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Google Ads account.

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

async update_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateIosAppDataStreamRequest] = None, *, ios_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.IosAppDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Updates an iOS app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateIosAppDataStreamRequest) – The request object. Request message for UpdateIosAppDataStream RPC.

• ios_app_data_stream (google.analytics.admin_v1alpha.types.IosAppDataStream) –

  Required. The iOS app stream to update. The name field is used to identify the iOS app stream to be updated.

  This corresponds to the ios_app_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

async update_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdatePropertyRequest] = None, *, property: Optional[google.analytics.admin_v1alpha.types.resources.Property] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Updates a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdatePropertyRequest) – The request object. Request message for UpdateProperty RPC.

• property (google.analytics.admin_v1alpha.types.Property) –

  Required. The property to update. The property’s name field is used to identify the property to be updated.

  This corresponds to the property field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

async update_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateUserLinkRequest] = None, *, user_link: Optional[google.analytics.admin_v1alpha.types.resources.UserLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

Updates a user link on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateUserLinkRequest) – The request object. Request message for UpdateUserLink RPC.

• user_link (google.analytics.admin_v1alpha.types.UserLink) – Required. The user link to update. This corresponds to the user_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

async update_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateWebDataStreamRequest] = None, *, web_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.WebDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Updates a web stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateWebDataStreamRequest) – The request object. Request message for UpdateWebDataStream RPC.

• web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream) –

  Required. The web stream to update. The name field is used to identify the web stream to be updated.

  This corresponds to the web_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static user_link_path(account: str, user_link: str) → str

Return a fully-qualified user_link string.

static web_data_stream_path(property: str, web_data_stream: str) → str

Return a fully-qualified web_data_stream string.

class google.analytics.admin_v1alpha.services.analytics_admin_service.AnalyticsAdminServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service Interface for the Analytics Admin API (GA4).

Instantiate the analytics admin service client.

Parameters

• credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

• transport (Union[str, AnalyticsAdminServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

• client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

• client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static account_path(account: str) → str

Return a fully-qualified account string.

static account_summary_path(account_summary: str) → str

Return a fully-qualified account_summary string.

static android_app_data_stream_path(property: str, android_app_data_stream: str) → str

Return a fully-qualified android_app_data_stream string.

audit_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.AuditUserLinksRequest) – The request object. Request message for AuditUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for AuditUserLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksPager

batch_create_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateUserLinksResponse

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.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchCreateUserLinksRequest) – The request object. Request message for BatchCreateUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchCreateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchCreateUserLinksResponse

batch_delete_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchDeleteUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchDeleteUserLinksRequest) – The request object. Request message for BatchDeleteUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

batch_get_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchGetUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchGetUserLinksResponse

Gets information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchGetUserLinksRequest) – The request object. Request message for BatchGetUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchGetUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchGetUserLinksResponse

batch_update_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateUserLinksRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateUserLinksResponse

Updates information about multiple users’ links to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.BatchUpdateUserLinksRequest) – The request object. Request message for BatchUpdateUserLinks RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for BatchUpdateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchUpdateUserLinksResponse

static common_billing_account_path(billing_account: str) → str

Return a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Return a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Return a fully-qualified location string.

static common_organization_path(organization: str) → str

Return a fully-qualified organization string.

static common_project_path(project: str) → str

Return a fully-qualified project string.

create_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateAndroidAppDataStreamRequest] = None, *, parent: Optional[str] = None, android_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Creates an android app stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateAndroidAppDataStreamRequest) – The request object. Request message for CreateAndroidAppDataStream RPC.

• parent (str) –

  Required. The parent resource where this android app data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• android_app_data_stream (google.analytics.admin_v1alpha.types.AndroidAppDataStream) –

  Required. The android app stream to create.

  This corresponds to the android_app_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

create_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateFirebaseLinkRequest] = None, *, parent: Optional[str] = None, firebase_link: Optional[google.analytics.admin_v1alpha.types.resources.FirebaseLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.FirebaseLink

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateFirebaseLinkRequest) – The request object. Request message for CreateFirebaseLink RPC

• parent (str) –

  Required. Format: properties/{property_id} Example: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink) –

  Required. The Firebase link to create.

  This corresponds to the firebase_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

create_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateGoogleAdsLinkRequest] = None, *, parent: Optional[str] = None, google_ads_link: Optional[google.analytics.admin_v1alpha.types.resources.GoogleAdsLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleAdsLink

Creates a GoogleAdsLink.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateGoogleAdsLinkRequest) – The request object. Request message for CreateGoogleAdsLink RPC

• parent (str) –

  Required. Example format: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink) –

  Required. The GoogleAdsLink to create.

  This corresponds to the google_ads_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Google Ads account.

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

create_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateIosAppDataStreamRequest] = None, *, parent: Optional[str] = None, ios_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.IosAppDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Creates an iOS app data stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateIosAppDataStreamRequest) – The request object. Request message for CreateIosAppDataStream RPC.

• parent (str) –

  Required. The parent resource where this ios app data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• ios_app_data_stream (google.analytics.admin_v1alpha.types.IosAppDataStream) –

  Required. The iOS app data stream to create.

  This corresponds to the ios_app_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

create_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreatePropertyRequest] = None, *, property: Optional[google.analytics.admin_v1alpha.types.resources.Property] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Creates an “GA4” property with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreatePropertyRequest) – The request object. Request message for CreateProperty RPC.

• property (google.analytics.admin_v1alpha.types.Property) –

  Required. The property to create. Note: the supplied property must specify its parent.

  This corresponds to the property field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

create_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateUserLinkRequest] = None, *, parent: Optional[str] = None, user_link: Optional[google.analytics.admin_v1alpha.types.resources.UserLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

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.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateUserLinkRequest) – The request object. 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.

• parent (str) –

  Required. Example format: accounts/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• user_link (google.analytics.admin_v1alpha.types.UserLink) – Required. The user link to create. This corresponds to the user_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

create_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.CreateWebDataStreamRequest] = None, *, parent: Optional[str] = None, web_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.WebDataStream] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Creates a web stream with the specified location and attributes.

Parameters

• request (google.analytics.admin_v1alpha.types.CreateWebDataStreamRequest) – The request object. Request message for CreateWebDataStream RPC.

• parent (str) –

  Required. The parent resource where this web data stream will be created. Format: properties/123

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream) – Required. The web stream to create. This corresponds to the web_data_stream field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static data_sharing_settings_path(account: str) → str

Return a fully-qualified data_sharing_settings string.

delete_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteAccountRequest) – The request object. Request message for DeleteAccount RPC.

• name (str) –

  Required. The name of the Account to soft-delete. Format: accounts/{account} Example: “accounts/100”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAndroidAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes an android app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteAndroidAppDataStreamRequest) – The request object. Request message for DeleteAndroidAppDataStream RPC.

• name (str) –

  Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteFirebaseLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a FirebaseLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteFirebaseLinkRequest) – The request object. Request message for DeleteFirebaseLink RPC

• name (str) –

  Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteGoogleAdsLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a GoogleAdsLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteGoogleAdsLinkRequest) – The request object. Request message for DeleteGoogleAdsLink RPC.

• name (str) –

  Required. Example format: properties/1234/googleAdsLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteIosAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes an iOS app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteIosAppDataStreamRequest) – The request object. Request message for DeleteIosAppDataStream RPC.

• name (str) –

  Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeletePropertyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

Parameters

• request (google.analytics.admin_v1alpha.types.DeletePropertyRequest) – The request object. Request message for DeleteProperty RPC.

• name (str) –

  Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: “properties/1000”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteUserLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a user link on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteUserLinkRequest) – The request object. Request message for DeleteUserLink RPC.

• name (str) –

  Required. Example format: accounts/1234/userLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.DeleteWebDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a web stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.DeleteWebDataStreamRequest) – The request object. Request message for DeleteWebDataStream RPC.

• name (str) –

  Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static enhanced_measurement_settings_path(property: str, web_data_stream: str) → str

Return a fully-qualified enhanced_measurement_settings string.

static firebase_link_path(property: str, firebase_link: str) → str

Return a fully-qualified firebase_link string.

classmethod from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters

• info (dict) – The service account private key info.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

• filename (str) – The path to the service account private key json file.

• args – Additional arguments to pass to the constructor.

• kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

get_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Account

Lookup for a single Account.

Parameters

• request (google.analytics.admin_v1alpha.types.GetAccountRequest) – The request object. Request message for GetAccount RPC.

• name (str) –

  Required. The name of the account to lookup. Format: accounts/{account} Example: “accounts/100”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

get_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetAndroidAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Lookup for a single AndroidAppDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetAndroidAppDataStreamRequest) – The request object. Request message for GetAndroidAppDataStream RPC.

• name (str) –

  Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

get_data_sharing_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetDataSharingSettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataSharingSettings

Get data sharing settings on an account. Data sharing settings are singletons.

Parameters

• request (google.analytics.admin_v1alpha.types.GetDataSharingSettingsRequest) – The request object. Request message for GetDataSharingSettings RPC.

• name (str) –

  Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: “accounts/1000/dataSharingSettings”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing data sharing settings of a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.DataSharingSettings

get_enhanced_measurement_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetEnhancedMeasurementSettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

• request (google.analytics.admin_v1alpha.types.GetEnhancedMeasurementSettingsRequest) – The request object. Request message for GetEnhancedMeasurementSettings RPC.

• name (str) –

  Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: “properties/1000/webDataStreams/2000/enhancedMeasurementSettings”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

Return type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

get_global_site_tag(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetGlobalSiteTagRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GlobalSiteTag

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Parameters

• request (google.analytics.admin_v1alpha.types.GetGlobalSiteTagRequest) – The request object. Request message for GetGlobalSiteTag RPC.

• name (str) –

  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}/webDataStreams/{stream_id}/globalSiteTag Example: “properties/123/webDataStreams/456/globalSiteTag”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Read-only resource with the tag for sending data from a website to a WebDataStream.

Return type

google.analytics.admin_v1alpha.types.GlobalSiteTag

get_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetIosAppDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Lookup for a single IosAppDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetIosAppDataStreamRequest) – The request object. Request message for GetIosAppDataStream RPC.

• name (str) –

  Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

get_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetPropertyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Lookup for a single “GA4” Property.

Parameters

• request (google.analytics.admin_v1alpha.types.GetPropertyRequest) – The request object. Request message for GetProperty RPC.

• name (str) –

  Required. The name of the property to lookup. Format: properties/{property_id} Example: “properties/1000”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

get_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetUserLinkRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

Gets information about a user’s link to an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.GetUserLinkRequest) – The request object. Request message for GetUserLink RPC.

• name (str) –

  Required. Example format: accounts/1234/userLinks/5678

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

get_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.GetWebDataStreamRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Lookup for a single WebDataStream

Parameters

• request (google.analytics.admin_v1alpha.types.GetWebDataStreamRequest) – The request object. Request message for GetWebDataStream RPC.

• name (str) –

  Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”

  This corresponds to the name field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static global_site_tag_path(property: str) → str

Return a fully-qualified global_site_tag string.

static google_ads_link_path(property: str, google_ads_link: str) → str

Return a fully-qualified google_ads_link string.

static ios_app_data_stream_path(property: str, ios_app_data_stream: str) → str

Return a fully-qualified ios_app_data_stream string.

list_account_summaries(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesPager

Returns summaries of all accounts accessible by the caller.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAccountSummariesRequest) – The request object. Request message for ListAccountSummaries RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListAccountSummaries RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesPager

list_accounts(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAccountsRequest) – The request object. Request message for ListAccounts RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListAccounts RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager

list_android_app_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsPager

Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsRequest) – The request object. Request message for ListAndroidAppDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListAndroidDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsPager

list_firebase_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksPager

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Parameters

• request (google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest) – The request object. Request message for ListFirebaseLinks RPC

• parent (str) –

  Required. Format: properties/{property_id} Example: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListFirebaseLinks RPC Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksPager

list_google_ads_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksPager

Lists GoogleAdsLinks on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest) – The request object. Request message for ListGoogleAdsLinks RPC.

• parent (str) –

  Required. Example format: properties/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListGoogleAdsLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksPager

list_ios_app_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsPager

Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsRequest) – The request object. Request message for ListIosAppDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListIosAppDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsPager

list_properties(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesPager

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.

Parameters

• request (google.analytics.admin_v1alpha.types.ListPropertiesRequest) – The request object. Request message for ListProperties RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListProperties RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesPager

list_user_links(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksPager

Lists all user links on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.ListUserLinksRequest) – The request object. Request message for ListUserLinks RPC.

• parent (str) –

  Required. Example format: accounts/1234

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListUserLinks RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksPager

list_web_data_streams(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsPager

Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.

Parameters

• request (google.analytics.admin_v1alpha.types.ListWebDataStreamsRequest) – The request object. Request message for ListWebDataStreams RPC.

• parent (str) –

  Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: “properties/123”

  This corresponds to the parent field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Request message for ListWebDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsPager

static parse_account_path(path: str) → Dict[str, str]

Parse a account path into its component segments.

static parse_account_summary_path(path: str) → Dict[str, str]

Parse a account_summary path into its component segments.

static parse_android_app_data_stream_path(path: str) → Dict[str, str]

Parse a android_app_data_stream path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_data_sharing_settings_path(path: str) → Dict[str, str]

Parse a data_sharing_settings path into its component segments.

static parse_enhanced_measurement_settings_path(path: str) → Dict[str, str]

Parse a enhanced_measurement_settings path into its component segments.

static parse_firebase_link_path(path: str) → Dict[str, str]

Parse a firebase_link path into its component segments.

static parse_global_site_tag_path(path: str) → Dict[str, str]

Parse a global_site_tag path into its component segments.

static parse_google_ads_link_path(path: str) → Dict[str, str]

Parse a google_ads_link path into its component segments.

static parse_ios_app_data_stream_path(path: str) → Dict[str, str]

Parse a ios_app_data_stream path into its component segments.

static parse_property_path(path: str) → Dict[str, str]

Parse a property path into its component segments.

static parse_user_link_path(path: str) → Dict[str, str]

Parse a user_link path into its component segments.

static parse_web_data_stream_path(path: str) → Dict[str, str]

Parse a web_data_stream path into its component segments.

static property_path(property: str) → str

Return a fully-qualified property string.

provision_account_ticket(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.ProvisionAccountTicketRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.analytics_admin.ProvisionAccountTicketResponse

Requests a ticket for creating an account.

Parameters

• request (google.analytics.admin_v1alpha.types.ProvisionAccountTicketRequest) – The request object. Request message for ProvisionAccountTicket RPC.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ProvisionAccountTicket RPC.

Return type

google.analytics.admin_v1alpha.types.ProvisionAccountTicketResponse

property transport

Return the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

AnalyticsAdminServiceTransport

update_account(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateAccountRequest] = None, *, account: Optional[google.analytics.admin_v1alpha.types.resources.Account] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Account

Updates an account.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateAccountRequest) – The request object. Request message for UpdateAccount RPC.

• account (google.analytics.admin_v1alpha.types.Account) –

  Required. The account to update. The account’s name field is used to identify the account.

  This corresponds to the account field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

update_android_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateAndroidAppDataStreamRequest] = None, *, android_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.AndroidAppDataStream

Updates an android app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateAndroidAppDataStreamRequest) – The request object. Request message for UpdateAndroidAppDataStream RPC.

• android_app_data_stream (google.analytics.admin_v1alpha.types.AndroidAppDataStream) –

  Required. The android app stream to update. The name field is used to identify the android app stream to be updated.

  This corresponds to the android_app_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics Android app stream.

Return type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

update_enhanced_measurement_settings(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateEnhancedMeasurementSettingsRequest] = None, *, enhanced_measurement_settings: Optional[google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateEnhancedMeasurementSettingsRequest) – The request object. Request message for UpdateEnhancedMeasurementSettings RPC.

• enhanced_measurement_settings (google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings) –

  Required. The settings to update. The name field is used to identify the settings to be updated.

  This corresponds to the enhanced_measurement_settings field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

Return type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

update_firebase_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateFirebaseLinkRequest] = None, *, firebase_link: Optional[google.analytics.admin_v1alpha.types.resources.FirebaseLink] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.FirebaseLink

Updates a FirebaseLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateFirebaseLinkRequest) – The request object. Request message for UpdateFirebaseLink RPC

• firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink) –

  Required. The Firebase link to update.

  This corresponds to the firebase_link field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

update_google_ads_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateGoogleAdsLinkRequest] = None, *, google_ads_link: Optional[google.analytics.admin_v1alpha.types.resources.GoogleAdsLink] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleAdsLink

Updates a GoogleAdsLink on a property

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateGoogleAdsLinkRequest) – The request object. Request message for UpdateGoogleAdsLink RPC

• google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink) – The GoogleAdsLink to update This corresponds to the google_ads_link field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A link between an GA4 property and a Google Ads account.

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

update_ios_app_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateIosAppDataStreamRequest] = None, *, ios_app_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.IosAppDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.IosAppDataStream

Updates an iOS app stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateIosAppDataStreamRequest) – The request object. Request message for UpdateIosAppDataStream RPC.

• ios_app_data_stream (google.analytics.admin_v1alpha.types.IosAppDataStream) –

  Required. The iOS app stream to update. The name field is used to identify the iOS app stream to be updated.

  This corresponds to the ios_app_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics IOS app stream.

Return type

google.analytics.admin_v1alpha.types.IosAppDataStream

update_property(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdatePropertyRequest] = None, *, property: Optional[google.analytics.admin_v1alpha.types.resources.Property] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property

Updates a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdatePropertyRequest) – The request object. Request message for UpdateProperty RPC.

• property (google.analytics.admin_v1alpha.types.Property) –

  Required. The property to update. The property’s name field is used to identify the property to be updated.

  This corresponds to the property field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

update_user_link(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateUserLinkRequest] = None, *, user_link: Optional[google.analytics.admin_v1alpha.types.resources.UserLink] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.UserLink

Updates a user link on an account or property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateUserLinkRequest) – The request object. Request message for UpdateUserLink RPC.

• user_link (google.analytics.admin_v1alpha.types.UserLink) – Required. The user link to update. This corresponds to the user_link field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a user’s permissions on an Account or Property resource.

Return type

google.analytics.admin_v1alpha.types.UserLink

update_web_data_stream(request: Optional[google.analytics.admin_v1alpha.types.analytics_admin.UpdateWebDataStreamRequest] = None, *, web_data_stream: Optional[google.analytics.admin_v1alpha.types.resources.WebDataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.WebDataStream

Updates a web stream on a property.

Parameters

• request (google.analytics.admin_v1alpha.types.UpdateWebDataStreamRequest) – The request object. Request message for UpdateWebDataStream RPC.

• web_data_stream (google.analytics.admin_v1alpha.types.WebDataStream) –

  Required. The web stream to update. The name field is used to identify the web stream to be updated.

  This corresponds to the web_data_stream field on the request instance; if request is provided, this should not be set.

• update_mask (google.protobuf.field_mask_pb2.FieldMask) –

  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.

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource message representing a Google Analytics web stream.

Return type

google.analytics.admin_v1alpha.types.WebDataStream

static user_link_path(account: str, user_link: str) → str

Return a fully-qualified user_link string.

static web_data_stream_path(property: str, web_data_stream: str) → str

Return a fully-qualified web_data_stream string.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through audit_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.AuditUserLinksResponse object, and provides an __aiter__ method to iterate through its user_links field.

If there are more pages, the __aiter__ method will make additional AuditUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.AuditUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.AuditUserLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.AuditUserLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through audit_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.AuditUserLinksResponse object, and provides an __iter__ method to iterate through its user_links field.

If there are more pages, the __iter__ method will make additional AuditUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.AuditUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.AuditUserLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.AuditUserLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_account_summaries requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountSummariesResponse object, and provides an __aiter__ method to iterate through its account_summaries field.

If there are more pages, the __aiter__ method will make additional ListAccountSummaries requests and continue to iterate through the account_summaries field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountSummariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAccountSummariesRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAccountSummariesResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_account_summaries requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountSummariesResponse object, and provides an __iter__ method to iterate through its account_summaries field.

If there are more pages, the __iter__ method will make additional ListAccountSummaries requests and continue to iterate through the account_summaries field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountSummariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAccountSummariesRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAccountSummariesResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_accounts requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountsResponse object, and provides an __aiter__ method to iterate through its accounts field.

If there are more pages, the __aiter__ method will make additional ListAccounts requests and continue to iterate through the accounts field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAccountsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAccountsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_accounts requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountsResponse object, and provides an __iter__ method to iterate through its accounts field.

If there are more pages, the __iter__ method will make additional ListAccounts requests and continue to iterate through the accounts field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAccountsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAccountsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_android_app_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse object, and provides an __aiter__ method to iterate through its android_app_data_streams field.

If there are more pages, the __aiter__ method will make additional ListAndroidAppDataStreams requests and continue to iterate through the android_app_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAndroidAppDataStreamsPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAndroidAppDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_android_app_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse object, and provides an __iter__ method to iterate through its android_app_data_streams field.

If there are more pages, the __iter__ method will make additional ListAndroidAppDataStreams requests and continue to iterate through the android_app_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_firebase_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse object, and provides an __aiter__ method to iterate through its firebase_links field.

If there are more pages, the __aiter__ method will make additional ListFirebaseLinks requests and continue to iterate through the firebase_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_firebase_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse object, and provides an __iter__ method to iterate through its firebase_links field.

If there are more pages, the __iter__ method will make additional ListFirebaseLinks requests and continue to iterate through the firebase_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_google_ads_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse object, and provides an __aiter__ method to iterate through its google_ads_links field.

If there are more pages, the __aiter__ method will make additional ListGoogleAdsLinks requests and continue to iterate through the google_ads_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_google_ads_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse object, and provides an __iter__ method to iterate through its google_ads_links field.

If there are more pages, the __iter__ method will make additional ListGoogleAdsLinks requests and continue to iterate through the google_ads_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_ios_app_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse object, and provides an __aiter__ method to iterate through its ios_app_data_streams field.

If there are more pages, the __aiter__ method will make additional ListIosAppDataStreams requests and continue to iterate through the ios_app_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListIosAppDataStreamsPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListIosAppDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_ios_app_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse object, and provides an __iter__ method to iterate through its ios_app_data_streams field.

If there are more pages, the __iter__ method will make additional ListIosAppDataStreams requests and continue to iterate through the ios_app_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_properties requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListPropertiesResponse object, and provides an __aiter__ method to iterate through its properties field.

If there are more pages, the __aiter__ method will make additional ListProperties requests and continue to iterate through the properties field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListPropertiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListPropertiesRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListPropertiesResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_properties requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListPropertiesResponse object, and provides an __iter__ method to iterate through its properties field.

If there are more pages, the __iter__ method will make additional ListProperties requests and continue to iterate through the properties field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListPropertiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListPropertiesRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListPropertiesResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListUserLinksResponse object, and provides an __aiter__ method to iterate through its user_links field.

If there are more pages, the __aiter__ method will make additional ListUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListUserLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListUserLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListUserLinksResponse object, and provides an __iter__ method to iterate through its user_links field.

If there are more pages, the __iter__ method will make additional ListUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListUserLinksRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListUserLinksResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsAsyncPager(method: Callable[[…], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_web_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse object, and provides an __aiter__ method to iterate through its web_data_streams field.

If there are more pages, the __aiter__ method will make additional ListWebDataStreams requests and continue to iterate through the web_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListWebDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListWebDataStreamsPager(method: Callable[[…], google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListWebDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_web_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse object, and provides an __iter__ method to iterate through its web_data_streams field.

If there are more pages, the __iter__ method will make additional ListWebDataStreams requests and continue to iterate through the web_data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.analytics.admin_v1alpha.types.ListWebDataStreamsRequest) – The initial request object.

• response (google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse) – The initial response object.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.