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: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport] = 'grpc_asyncio', client_options: typing.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>)[source]

Service Interface for the Analytics Admin API (GA4).

Instantiates the analytics admin service async 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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 access_binding_path(account: str, access_binding: str) str

Returns a fully-qualified access_binding string.

static account_path(account: str) str

Returns a fully-qualified account string.

static account_summary_path(account_summary: str) str

Returns a fully-qualified account_summary string.

async acknowledge_user_data_collection(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.AcknowledgeUserDataCollectionRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.AcknowledgeUserDataCollectionResponse[source]

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionRequest, dict]]) – The request object. Request message for AcknowledgeUserDataCollection RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 AcknowledgeUserDataCollection RPC.

Return type

google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionResponse

Returns a fully-qualified ad_sense_link string.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Parameters
Returns

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Return type

google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalResponse

async archive_audience(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveAudienceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Archives an Audience on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ArchiveAudienceRequest, dict]]) – The request object. Request message for ArchiveAudience RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 archive_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomDimensionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Archives a CustomDimension on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ArchiveCustomDimensionRequest, dict]]) – The request object. Request message for ArchiveCustomDimension RPC.

  • name (str) –

    Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/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_async.AsyncRetry) – 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 archive_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Archives a CustomMetric on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ArchiveCustomMetricRequest, dict]]) – The request object. Request message for ArchiveCustomMetric RPC.

  • name (str) –

    Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/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_async.AsyncRetry) – 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 attribution_settings_path(property: str) str

Returns a fully-qualified attribution_settings string.

static audience_path(property: str, audience: str) str

Returns a fully-qualified audience string.

async batch_create_access_bindings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateAccessBindingsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.BatchCreateAccessBindingsResponse[source]

Creates information about multiple access bindings to an account or property.

This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.BatchCreateAccessBindingsRequest, dict]]) – The request object. Request message for BatchCreateAccessBindings RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 BatchCreateAccessBindings RPC.

Return type

google.analytics.admin_v1alpha.types.BatchCreateAccessBindingsResponse

async batch_delete_access_bindings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.BatchDeleteAccessBindingsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

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

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.BatchDeleteAccessBindingsRequest, dict]]) – The request object. Request message for BatchDeleteAccessBindings RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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_access_bindings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.BatchGetAccessBindingsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.BatchGetAccessBindingsResponse[source]

Gets information about multiple access bindings to an account or property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.BatchGetAccessBindingsRequest, dict]]) – The request object. Request message for BatchGetAccessBindings RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 BatchGetAccessBindings RPC.

Return type

google.analytics.admin_v1alpha.types.BatchGetAccessBindingsResponse

async batch_update_access_bindings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateAccessBindingsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.BatchUpdateAccessBindingsResponse[source]

Updates information about multiple access bindings to an account or property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.BatchUpdateAccessBindingsRequest, dict]]) – The request object. Request message for BatchUpdateAccessBindings RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 BatchUpdateAccessBindings RPC.

Return type

google.analytics.admin_v1alpha.types.BatchUpdateAccessBindingsResponse

Returns a fully-qualified big_query_link string.

static calculated_metric_path(property: str, calculated_metric: str) str

Returns a fully-qualified calculated_metric string.

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:

  • Declining a proposal initiated from Display & Video 360

  • Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Parameters
Returns

A proposal for a link between a GA4 property and a Display & Video 360 advertiser.

A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal

static channel_group_path(property: str, channel_group: str) str

Returns a fully-qualified channel_group string.

static common_billing_account_path(billing_account: str) str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str

Returns a fully-qualified folder string.

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

Returns a fully-qualified location string.

static common_organization_path(organization: str) str

Returns a fully-qualified organization string.

static common_project_path(project: str) str

Returns a fully-qualified project string.

static conversion_event_path(property: str, conversion_event: str) str

Returns a fully-qualified conversion_event string.

async create_access_binding(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateAccessBindingRequest, dict]] = None, *, parent: Optional[str] = None, access_binding: Optional[google.analytics.admin_v1alpha.types.resources.AccessBinding] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.AccessBinding[source]

Creates an access binding on an account or property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateAccessBindingRequest, dict]]) – The request object. Request message for CreateAccessBinding RPC.

  • parent (str) –

    Required. Formats:

    • accounts/{account}

    • properties/{property}

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

  • access_binding (google.analytics.admin_v1alpha.types.AccessBinding) –

    Required. The access binding to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 binding of a user to a set of roles.

Return type

google.analytics.admin_v1alpha.types.AccessBinding

Creates an AdSenseLink.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateAdSenseLinkRequest, dict]]) – The request object. Request message to be passed to CreateAdSenseLink method.

  • parent (str) –

    Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234

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

  • adsense_link (google.analytics.admin_v1alpha.types.AdSenseLink) – Required. The AdSense Link to create This corresponds to the adsense_link field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 a GA4 Property and an AdSense for Content ad client.

Return type

google.analytics.admin_v1alpha.types.AdSenseLink

async create_audience(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateAudienceRequest, dict]] = None, *, parent: Optional[str] = None, audience: Optional[google.analytics.admin_v1alpha.types.audience.Audience] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.audience.Audience[source]

Creates an Audience.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateAudienceRequest, dict]]) – The request object. Request message for CreateAudience 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.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 GA4 Audience.

Return type

google.analytics.admin_v1alpha.types.Audience

async create_calculated_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateCalculatedMetricRequest, dict]] = None, *, parent: Optional[str] = None, calculated_metric: Optional[google.analytics.admin_v1alpha.types.resources.CalculatedMetric] = None, calculated_metric_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CalculatedMetric[source]

Creates a CalculatedMetric.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateCalculatedMetricRequest, dict]]) – The request object. Request message for CreateCalculatedMetric 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.

  • calculated_metric (google.analytics.admin_v1alpha.types.CalculatedMetric) –

    Required. The CalculatedMetric to create.

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

  • calculated_metric_id (str) –

    Required. The ID to use for the calculated metric which will become the final component of the calculated metric’s resource name.

    This value should be 1-80 characters and valid characters are [a-zA-Z0-9_], no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, “calcMetric:{calculated_metric_id}”.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 definition for a calculated metric.

Return type

google.analytics.admin_v1alpha.types.CalculatedMetric

async create_channel_group(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateChannelGroupRequest, dict]] = None, *, parent: Optional[str] = None, channel_group: Optional[google.analytics.admin_v1alpha.types.channel_group.ChannelGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.channel_group.ChannelGroup[source]

Creates a ChannelGroup.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateChannelGroupRequest, dict]]) – The request object. Request message for CreateChannelGroup RPC.

  • parent (str) –

    Required. The property for which to create a ChannelGroup. Example format: properties/1234

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

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 Channel Group.

Return type

google.analytics.admin_v1alpha.types.ChannelGroup

async create_connected_site_tag(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateConnectedSiteTagRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.CreateConnectedSiteTagResponse[source]

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateConnectedSiteTagRequest, dict]]) – The request object. Request message for CreateConnectedSiteTag RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 CreateConnectedSiteTag RPC.

Return type

google.analytics.admin_v1alpha.types.CreateConnectedSiteTagResponse

async create_conversion_event(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateConversionEventRequest, dict]] = None, *, parent: Optional[str] = None, conversion_event: Optional[google.analytics.admin_v1alpha.types.resources.ConversionEvent] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.ConversionEvent[source]

Creates a conversion event with the specified attributes.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateConversionEventRequest, dict]]) – The request object. Request message for CreateConversionEvent RPC

  • parent (str) –

    Required. The resource name of the parent property where this conversion event 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.

  • conversion_event (google.analytics.admin_v1alpha.types.ConversionEvent) –

    Required. The conversion event to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 conversion event in a Google Analytics property.

Return type

google.analytics.admin_v1alpha.types.ConversionEvent

async create_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateCustomDimensionRequest, dict]] = None, *, parent: Optional[str] = None, custom_dimension: Optional[google.analytics.admin_v1alpha.types.resources.CustomDimension] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Creates a CustomDimension.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateCustomDimensionRequest, dict]]) – The request object. Request message for CreateCustomDimension 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.

  • custom_dimension (google.analytics.admin_v1alpha.types.CustomDimension) –

    Required. The CustomDimension to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

async create_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateCustomMetricRequest, dict]] = None, *, parent: Optional[str] = None, custom_metric: Optional[google.analytics.admin_v1alpha.types.resources.CustomMetric] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Creates a CustomMetric.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateCustomMetricRequest, dict]]) – The request object. Request message for CreateCustomMetric 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.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

async create_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateDataStreamRequest, dict]] = None, *, parent: Optional[str] = None, data_stream: Optional[google.analytics.admin_v1alpha.types.resources.DataStream] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.DataStream[source]

Creates a DataStream.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateDataStreamRequest, dict]]) – The request object. Request message for CreateDataStream 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.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkRequest, dict]]) – The request object. Request message for CreateDisplayVideo360AdvertiserLink 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.

  • display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink) –

    Required. The DisplayVideo360AdvertiserLink to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 a GA4 property and a Display & Video 360 advertiser.

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkProposalRequest, dict]]) – The request object. Request message for CreateDisplayVideo360AdvertiserLinkProposal 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.

  • display_video_360_advertiser_link_proposal (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal) –

    Required. The DisplayVideo360AdvertiserLinkProposal to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 proposal for a link between a GA4 property and a Display & Video 360 advertiser.

A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal

async create_event_create_rule(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateEventCreateRuleRequest, dict]] = None, *, parent: Optional[str] = None, event_create_rule: Optional[google.analytics.admin_v1alpha.types.event_create_and_edit.EventCreateRule] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.event_create_and_edit.EventCreateRule[source]

Creates an EventCreateRule.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateEventCreateRuleRequest, dict]]) – The request object. Request message for CreateEventCreateRule RPC.

  • parent (str) –

    Required. Example format: properties/123/dataStreams/456

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

  • event_create_rule (google.analytics.admin_v1alpha.types.EventCreateRule) –

    Required. The EventCreateRule to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined.

Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.

Event Edit and Event Create rules can’t be used to modify an event created from an Event Create rule.

Return type

google.analytics.admin_v1alpha.types.EventCreateRule

async create_expanded_data_set(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateExpandedDataSetRequest, dict]] = None, *, parent: Optional[str] = None, expanded_data_set: Optional[google.analytics.admin_v1alpha.types.expanded_data_set.ExpandedDataSet] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.expanded_data_set.ExpandedDataSet[source]

Creates a ExpandedDataSet.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateExpandedDataSetRequest, dict]]) – The request object. Request message for CreateExpandedDataSet 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.

  • expanded_data_set (google.analytics.admin_v1alpha.types.ExpandedDataSet) –

    Required. The ExpandedDataSet to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 GA4 ExpandedDataSet.

Return type

google.analytics.admin_v1alpha.types.ExpandedDataSet

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateFirebaseLinkRequest, dict]]) – 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_async.AsyncRetry) – 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 a GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

Creates a GoogleAdsLink.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateGoogleAdsLinkRequest, dict]]) – 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_async.AsyncRetry) – 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 a GA4 property and a Google Ads account.

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

async create_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateMeasurementProtocolSecretRequest, dict]] = None, *, parent: Optional[str] = None, measurement_protocol_secret: Optional[google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Creates a measurement protocol secret.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateMeasurementProtocolSecretRequest, dict]]) – The request object. Request message for CreateMeasurementProtocolSecret RPC

  • parent (str) –

    Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

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

  • measurement_protocol_secret (google.analytics.admin_v1alpha.types.MeasurementProtocolSecret) –

    Required. The measurement protocol secret to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 secret value used for sending hits to Measurement Protocol.

Return type

google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

async create_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreatePropertyRequest, dict]] = None, *, property: Optional[google.analytics.admin_v1alpha.types.resources.Property] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.Property[source]

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

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreatePropertyRequest, dict]]) – 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_async.AsyncRetry) – 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_rollup_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateRollupPropertyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.CreateRollupPropertyResponse[source]

Create a roll-up property and all roll-up property source links.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateRollupPropertyRequest, dict]]) – The request object. Request message for CreateRollupProperty RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 CreateRollupProperty RPC.

Return type

google.analytics.admin_v1alpha.types.CreateRollupPropertyResponse

Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateRollupPropertySourceLinkRequest, dict]]) – The request object. Request message for CreateRollupPropertySourceLink 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.

  • rollup_property_source_link (google.analytics.admin_v1alpha.types.RollupPropertySourceLink) –

    Required. The roll-up property source link to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 that references a source property under the parent rollup property.

Return type

google.analytics.admin_v1alpha.types.RollupPropertySourceLink

Creates a SearchAds360Link.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateSearchAds360LinkRequest, dict]]) – The request object. Request message for CreateSearchAds360Link 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.

  • search_ads_360_link (google.analytics.admin_v1alpha.types.SearchAds360Link) –

    Required. The SearchAds360Link to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 a GA4 property and a Search Ads 360 entity.

Return type

google.analytics.admin_v1alpha.types.SearchAds360Link

async create_sk_ad_network_conversion_value_schema(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateSKAdNetworkConversionValueSchemaRequest, dict]] = None, *, parent: Optional[str] = None, skadnetwork_conversion_value_schema: Optional[google.analytics.admin_v1alpha.types.resources.SKAdNetworkConversionValueSchema] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.SKAdNetworkConversionValueSchema[source]

Creates a SKAdNetworkConversionValueSchema.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateSKAdNetworkConversionValueSchemaRequest, dict]]) – The request object. Request message for CreateSKAdNetworkConversionValueSchema RPC.

  • parent (str) –

    Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}

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

  • skadnetwork_conversion_value_schema (google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema) –

    Required. SKAdNetwork conversion value schema to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

SKAdNetwork conversion value schema of an iOS stream.

Return type

google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema

async create_subproperty(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateSubpropertyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.CreateSubpropertyResponse[source]

Create a subproperty and a subproperty event filter that applies to the created subproperty.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateSubpropertyRequest, dict]]) – The request object. Request message for CreateSubproperty RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 CreateSubproperty RPC.

Return type

google.analytics.admin_v1alpha.types.CreateSubpropertyResponse

async create_subproperty_event_filter(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.CreateSubpropertyEventFilterRequest, dict]] = None, *, parent: Optional[str] = None, subproperty_event_filter: Optional[google.analytics.admin_v1alpha.types.subproperty_event_filter.SubpropertyEventFilter] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.subproperty_event_filter.SubpropertyEventFilter[source]

Creates a subproperty Event Filter.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.CreateSubpropertyEventFilterRequest, dict]]) – The request object. Request message for CreateSubpropertyEventFilter RPC.

  • parent (str) –

    Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123

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

  • subproperty_event_filter (google.analytics.admin_v1alpha.types.SubpropertyEventFilter) –

    Required. The subproperty event filter to create.

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 GA4 Subproperty event filter.

Return type

google.analytics.admin_v1alpha.types.SubpropertyEventFilter

static custom_dimension_path(property: str, custom_dimension: str) str

Returns a fully-qualified custom_dimension string.

static custom_metric_path(property: str, custom_metric: str) str

Returns a fully-qualified custom_metric string.

static data_redaction_settings_path(property: str, data_stream: str) str

Returns a fully-qualified data_redaction_settings string.

static data_retention_settings_path(property: str) str

Returns a fully-qualified data_retention_settings string.

static data_sharing_settings_path(account: str) str

Returns a fully-qualified data_sharing_settings string.

static data_stream_path(property: str, data_stream: str) str

Returns a fully-qualified data_stream string.

async delete_access_binding(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccessBindingRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes an access binding on an account or property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteAccessBindingRequest, dict]]) – The request object. Request message for DeleteAccessBinding RPC.

  • name (str) –

    Required. Formats:

    • accounts/{account}/accessBindings/{accessBinding}

    • properties/{property}/accessBindings/{accessBinding}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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_account(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteAccountRequest, dict]]) – 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_async.AsyncRetry) – 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.

Deletes an AdSenseLink.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteAdSenseLinkRequest, dict]]) – The request object. Request message to be passed to DeleteAdSenseLink method.

  • name (str) –

    Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/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_async.AsyncRetry) – 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_calculated_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteCalculatedMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a CalculatedMetric on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteCalculatedMetricRequest, dict]]) – The request object. Request message for DeleteCalculatedMetric RPC.

  • name (str) –

    Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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_channel_group(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteChannelGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a ChannelGroup on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteChannelGroupRequest, dict]]) – The request object. Request message for DeleteChannelGroup RPC.

  • name (str) –

    Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/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_async.AsyncRetry) – 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_connected_site_tag(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteConnectedSiteTagRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteConnectedSiteTagRequest, dict]]) – The request object. Request message for DeleteConnectedSiteTag RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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_conversion_event(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteConversionEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a conversion event in a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteConversionEventRequest, dict]]) – The request object. Request message for DeleteConversionEvent RPC

  • name (str) –

    Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: “properties/123/conversionEvents/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_async.AsyncRetry) – 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_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a DataStream on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteDataStreamRequest, dict]]) – The request object. Request message for DeleteDataStream RPC.

  • name (str) –

    Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/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_async.AsyncRetry) – 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.

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkRequest, dict]]) – The request object. Request message for DeleteDisplayVideo360AdvertiserLink RPC.

  • name (str) –

    Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/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_async.AsyncRetry) – 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.

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkProposalRequest, dict]]) – The request object. Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.

  • name (str) –

    Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/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_async.AsyncRetry) – 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_event_create_rule(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteEventCreateRuleRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes an EventCreateRule.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteEventCreateRuleRequest, dict]]) – The request object. Request message for DeleteEventCreateRule RPC.

  • name (str) –

    Required. Example format:

    properties/123/dataStreams/456/eventCreateRules/789

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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_expanded_data_set(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteExpandedDataSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a ExpandedDataSet on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteExpandedDataSetRequest, dict]]) – The request object. Request message for DeleteExpandedDataSet RPC.

  • name (str) –

    Required. Example format: properties/1234/expandedDataSets/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_async.AsyncRetry) – 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.

Deletes a FirebaseLink on a property

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteFirebaseLinkRequest, dict]]) – 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_async.AsyncRetry) – 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.

Deletes a GoogleAdsLink on a property

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteGoogleAdsLinkRequest, dict]]) – 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_async.AsyncRetry) – 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_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteMeasurementProtocolSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes target MeasurementProtocolSecret.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteMeasurementProtocolSecretRequest, dict]]) – The request object. Request message for DeleteMeasurementProtocolSecret RPC

  • name (str) –

    Required. The name of the MeasurementProtocolSecret to delete. Format:

    properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeletePropertyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.Property[source]

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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not a GA4 Property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeletePropertyRequest, dict]]) – 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_async.AsyncRetry) – 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

Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteRollupPropertySourceLinkRequest, dict]]) – The request object. Request message for DeleteRollupPropertySourceLink RPC.

  • name (str) –

    Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/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_async.AsyncRetry) – 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.

Deletes a SearchAds360Link on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteSearchAds360LinkRequest, dict]]) – The request object. Request message for DeleteSearchAds360Link RPC.

  • name (str) –

    Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/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_async.AsyncRetry) – 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_sk_ad_network_conversion_value_schema(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteSKAdNetworkConversionValueSchemaRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes target SKAdNetworkConversionValueSchema.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteSKAdNetworkConversionValueSchemaRequest, dict]]) – The request object. Request message for DeleteSKAdNetworkConversionValueSchema RPC.

  • name (str) –

    Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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_subproperty_event_filter(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteSubpropertyEventFilterRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Deletes a subproperty event filter.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.DeleteSubpropertyEventFilterRequest, dict]]) – The request object. Request message for DeleteSubpropertyEventFilter RPC.

  • name (str) –

    Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/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_async.AsyncRetry) – 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 fully-qualified display_video360_advertiser_link string.

Returns a fully-qualified display_video360_advertiser_link_proposal string.

static enhanced_measurement_settings_path(property: str, data_stream: str) str

Returns a fully-qualified enhanced_measurement_settings string.

static event_create_rule_path(property: str, data_stream: str, event_create_rule: str) str

Returns a fully-qualified event_create_rule string.

static expanded_data_set_path(property: str, expanded_data_set: str) str

Returns a fully-qualified expanded_data_set string.

async fetch_automated_ga4_configuration_opt_out(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.FetchAutomatedGa4ConfigurationOptOutRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.FetchAutomatedGa4ConfigurationOptOutResponse[source]

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutRequest, dict]]) – The request object. Request for fetching the opt out status for the automated GA4 setup process.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 fetching the opt out status for the automated GA4 setup process.

Return type

google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutResponse

async fetch_connected_ga4_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.FetchConnectedGa4PropertyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.FetchConnectedGa4PropertyResponse[source]

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.FetchConnectedGa4PropertyRequest, dict]]) – The request object. Request for looking up GA4 property connected to a UA property.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 for looking up GA4 property connected to a UA property.

Return type

google.analytics.admin_v1alpha.types.FetchConnectedGa4PropertyResponse

Returns a fully-qualified firebase_link string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
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

AnalyticsAdminServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
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

AnalyticsAdminServiceAsyncClient

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

AnalyticsAdminServiceAsyncClient

async get_access_binding(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetAccessBindingRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.AccessBinding[source]

Gets information about an access binding.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetAccessBindingRequest, dict]]) – The request object. Request message for GetAccessBinding RPC.

  • name (str) –

    Required. The name of the access binding to retrieve. Formats:

    • accounts/{account}/accessBindings/{accessBinding}

    • properties/{property}/accessBindings/{accessBinding}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 binding of a user to a set of roles.

Return type

google.analytics.admin_v1alpha.types.AccessBinding

async get_account(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.Account[source]

Lookup for a single Account.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetAccountRequest, dict]]) – 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_async.AsyncRetry) – 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

Looks up a single AdSenseLink.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetAdSenseLinkRequest, dict]]) – The request object. Request message to be passed to GetAdSenseLink method.

  • name (str) –

    Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/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_async.AsyncRetry) – 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 a GA4 Property and an AdSense for Content ad client.

Return type

google.analytics.admin_v1alpha.types.AdSenseLink

async get_attribution_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetAttributionSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.AttributionSettings[source]

Lookup for a AttributionSettings singleton.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetAttributionSettingsRequest, dict]]) – The request object. Request message for GetAttributionSettings RPC.

  • name (str) –

    Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

The attribution settings used for a given property. This is a singleton resource.

Return type

google.analytics.admin_v1alpha.types.AttributionSettings

async get_audience(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetAudienceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.audience.Audience[source]

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetAudienceRequest, dict]]) – The request object. Request message for GetAudience RPC.

  • name (str) –

    Required. The name of the Audience to get. Example format: properties/1234/audiences/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_async.AsyncRetry) – 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 GA4 Audience.

Return type

google.analytics.admin_v1alpha.types.Audience

Lookup for a single BigQuery Link.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetBigQueryLinkRequest, dict]]) – The request object. Request message for GetBigQueryLink RPC.

  • name (str) –

    Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/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_async.AsyncRetry) – 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 a GA4 Property and BigQuery project.

Return type

google.analytics.admin_v1alpha.types.BigQueryLink

async get_calculated_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetCalculatedMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CalculatedMetric[source]

Lookup for a single CalculatedMetric.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetCalculatedMetricRequest, dict]]) – The request object. Request message for GetCalculatedMetric RPC.

  • name (str) –

    Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 definition for a calculated metric.

Return type

google.analytics.admin_v1alpha.types.CalculatedMetric

async get_channel_group(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetChannelGroupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.channel_group.ChannelGroup[source]

Lookup for a single ChannelGroup.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetChannelGroupRequest, dict]]) – The request object. Request message for GetChannelGroup RPC.

  • name (str) –

    Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/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_async.AsyncRetry) – 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 Channel Group.

Return type

google.analytics.admin_v1alpha.types.ChannelGroup

async get_conversion_event(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetConversionEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.ConversionEvent[source]

Retrieve a single conversion event.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetConversionEventRequest, dict]]) – The request object. Request message for GetConversionEvent RPC

  • name (str) –

    Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: “properties/123/conversionEvents/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_async.AsyncRetry) – 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 conversion event in a Google Analytics property.

Return type

google.analytics.admin_v1alpha.types.ConversionEvent

async get_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetCustomDimensionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Lookup for a single CustomDimension.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetCustomDimensionRequest, dict]]) – The request object. Request message for GetCustomDimension RPC.

  • name (str) –

    Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/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_async.AsyncRetry) – 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 definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

async get_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetCustomMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Lookup for a single CustomMetric.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetCustomMetricRequest, dict]]) – The request object. Request message for GetCustomMetric RPC.

  • name (str) –

    Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/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_async.AsyncRetry) – 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 definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

async get_data_redaction_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataRedactionSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.DataRedactionSettings[source]

Lookup for a single DataRedactionSettings.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDataRedactionSettingsRequest, dict]]) – The request object. Request message for GetDataRedactionSettings RPC.

  • name (str) –

    Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: “properties/1000/dataStreams/2000/dataRedactionSettings”

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Settings for client-side data redaction. Singleton resource under a Web Stream.

Return type

google.analytics.admin_v1alpha.types.DataRedactionSettings

async get_data_retention_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataRetentionSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.DataRetentionSettings[source]

Returns the singleton data retention settings for this property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDataRetentionSettingsRequest, dict]]) – The request object. Request message for GetDataRetentionSettings RPC.

  • name (str) –

    Required. The name of the settings to lookup. Format:

    properties/{property}/dataRetentionSettings Example: “properties/1000/dataRetentionSettings”

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Settings values for data retention. This is a singleton resource.

Return type

google.analytics.admin_v1alpha.types.DataRetentionSettings

async get_data_sharing_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataSharingSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.DataSharingSettings[source]

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

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDataSharingSettingsRequest, dict]]) – 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_async.AsyncRetry) – 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_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.DataStream[source]

Lookup for a single DataStream.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDataStreamRequest, dict]]) – The request object. Request message for GetDataStream RPC.

  • name (str) –

    Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/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_async.AsyncRetry) – 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 data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Look up a single DisplayVideo360AdvertiserLink

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkRequest, dict]]) – The request object. Request message for GetDisplayVideo360AdvertiserLink RPC.

  • name (str) –

    Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/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_async.AsyncRetry) – 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 a GA4 property and a Display & Video 360 advertiser.

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkProposalRequest, dict]]) – The request object. Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.

  • name (str) –

    Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/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_async.AsyncRetry) – 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 proposal for a link between a GA4 property and a Display & Video 360 advertiser.

A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal

async get_enhanced_measurement_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetEnhancedMeasurementSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.EnhancedMeasurementSettings[source]

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

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetEnhancedMeasurementSettingsRequest, dict]]) – The request object. Request message for GetEnhancedMeasurementSettings RPC.

  • name (str) –

    Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: “properties/1000/dataStreams/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_async.AsyncRetry) – 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 web DataStream, configuring measurement of additional site interactions and content.

Return type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

async get_event_create_rule(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetEventCreateRuleRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.event_create_and_edit.EventCreateRule[source]

Lookup for a single EventCreateRule.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetEventCreateRuleRequest, dict]]) – The request object. Request message for GetEventCreateRule RPC.

  • name (str) –

    Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined.

Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.

Event Edit and Event Create rules can’t be used to modify an event created from an Event Create rule.

Return type

google.analytics.admin_v1alpha.types.EventCreateRule

async get_expanded_data_set(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetExpandedDataSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.expanded_data_set.ExpandedDataSet[source]

Lookup for a single ExpandedDataSet.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetExpandedDataSetRequest, dict]]) – The request object. Request message for GetExpandedDataSet RPC.

  • name (str) –

    Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/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_async.AsyncRetry) – 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 GA4 ExpandedDataSet.

Return type

google.analytics.admin_v1alpha.types.ExpandedDataSet

async get_global_site_tag(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetGlobalSiteTagRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.GlobalSiteTag[source]

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

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetGlobalSiteTagRequest, dict]]) – 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}/dataStreams/{stream_id}/globalSiteTag Example: “properties/123/dataStreams/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_async.AsyncRetry) – 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 DataStream. Only present for web DataStream resources.

Return type

google.analytics.admin_v1alpha.types.GlobalSiteTag

async get_google_signals_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetGoogleSignalsSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings[source]

Lookup for Google Signals settings for a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetGoogleSignalsSettingsRequest, dict]]) – The request object. Request message for GetGoogleSignalsSettings RPC

  • name (str) –

    Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Settings values for Google Signals. This is a singleton resource.

Return type

google.analytics.admin_v1alpha.types.GoogleSignalsSettings

async get_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetMeasurementProtocolSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Lookup for a single “GA4” MeasurementProtocolSecret.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetMeasurementProtocolSecretRequest, dict]]) – The request object. Request message for GetMeasurementProtocolSecret RPC.

  • name (str) –

    Required. The name of the measurement protocol secret to lookup. Format:

    properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 secret value used for sending hits to Measurement Protocol.

Return type

google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetPropertyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.Property[source]

Lookup for a single “GA4” Property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetPropertyRequest, dict]]) – 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_async.AsyncRetry) – 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

Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetRollupPropertySourceLinkRequest, dict]]) – The request object. Request message for GetRollupPropertySourceLink RPC.

  • name (str) –

    Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/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_async.AsyncRetry) – 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 that references a source property under the parent rollup property.

Return type

google.analytics.admin_v1alpha.types.RollupPropertySourceLink

Look up a single SearchAds360Link

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetSearchAds360LinkRequest, dict]]) – The request object. Request message for GetSearchAds360Link RPC.

  • name (str) –

    Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/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_async.AsyncRetry) – 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 a GA4 property and a Search Ads 360 entity.

Return type

google.analytics.admin_v1alpha.types.SearchAds360Link

async get_sk_ad_network_conversion_value_schema(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetSKAdNetworkConversionValueSchemaRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.resources.SKAdNetworkConversionValueSchema[source]

Looks up a single SKAdNetworkConversionValueSchema.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetSKAdNetworkConversionValueSchemaRequest, dict]]) – The request object. Request message for GetSKAdNetworkConversionValueSchema RPC.

  • name (str) –

    Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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

SKAdNetwork conversion value schema of an iOS stream.

Return type

google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema

async get_subproperty_event_filter(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetSubpropertyEventFilterRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.subproperty_event_filter.SubpropertyEventFilter[source]

Lookup for a single subproperty Event Filter.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.GetSubpropertyEventFilterRequest, dict]]) – The request object. Request message for GetSubpropertyEventFilter RPC.

  • name (str) –

    Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/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_async.AsyncRetry) – 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 GA4 Subproperty event filter.

Return type

google.analytics.admin_v1alpha.types.SubpropertyEventFilter

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

Returns 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.

static global_site_tag_path(property: str, data_stream: str) str

Returns a fully-qualified global_site_tag string.

Returns a fully-qualified google_ads_link string.

static google_signals_settings_path(property: str) str

Returns a fully-qualified google_signals_settings string.

async list_access_bindings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAccessBindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccessBindingsAsyncPager[source]

Lists all access bindings on an account or property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListAccessBindingsRequest, dict]]) – The request object. Request message for ListAccessBindings RPC.

  • parent (str) –

    Required. Formats:

    • accounts/{account}

    • properties/{property}

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

  • retry (google.api_core.retry_async.AsyncRetry) – 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 ListAccessBindings RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccessBindingsAsyncPager

async list_account_summaries(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesAsyncPager[source]

Returns summaries of all accounts accessible by the caller.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListAccountSummariesRequest, dict]]) – The request object. Request message for ListAccountSummaries RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager[source]

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 (Optional[Union[google.analytics.admin_v1alpha.types.ListAccountsRequest, dict]]) – The request object. Request message for ListAccounts RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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

Lists AdSenseLinks on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListAdSenseLinksRequest, dict]]) – The request object. Request message to be passed to ListAdSenseLinks method.

  • parent (str) –

    Required. Resource name of the parent property. Format: properties/{propertyId} 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_async.AsyncRetry) – 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 ListAdSenseLinks method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAdSenseLinksAsyncPager

async list_audiences(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAudiencesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAudiencesAsyncPager[source]

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListAudiencesRequest, dict]]) – The request object. Request message for ListAudiences 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_async.AsyncRetry) – 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 ListAudiences RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAudiencesAsyncPager

Lists BigQuery Links on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListBigQueryLinksRequest, dict]]) – The request object. Request message for ListBigQueryLinks RPC.

  • parent (str) –

    Required. The name of the property to list BigQuery links under. 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_async.AsyncRetry) – 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 ListBigQueryLinks RPC Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListBigQueryLinksAsyncPager

async list_calculated_metrics(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListCalculatedMetricsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCalculatedMetricsAsyncPager[source]

Lists CalculatedMetrics on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListCalculatedMetricsRequest, dict]]) – The request object. Request message for ListCalculatedMetrics 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_async.AsyncRetry) – 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 ListCalculatedMetrics RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCalculatedMetricsAsyncPager

async list_channel_groups(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListChannelGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListChannelGroupsAsyncPager[source]

Lists ChannelGroups on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListChannelGroupsRequest, dict]]) – The request object. Request message for ListChannelGroups RPC.

  • parent (str) –

    Required. The property for which to list ChannelGroups. 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_async.AsyncRetry) – 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 ListChannelGroups RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListChannelGroupsAsyncPager

async list_connected_site_tags(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListConnectedSiteTagsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.types.analytics_admin.ListConnectedSiteTagsResponse[source]

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListConnectedSiteTagsRequest, dict]]) – The request object. Request message for ListConnectedSiteTags RPC.

  • retry (google.api_core.retry_async.AsyncRetry) – 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 ListConnectedSiteTags RPC.

Return type

google.analytics.admin_v1alpha.types.ListConnectedSiteTagsResponse

async list_conversion_events(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListConversionEventsAsyncPager[source]

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListConversionEventsRequest, dict]]) – The request object. Request message for ListConversionEvents RPC

  • parent (str) –

    Required. The resource name of the parent property. Example: ‘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_async.AsyncRetry) – 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 ListConversionEvents RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListConversionEventsAsyncPager

async list_custom_dimensions(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomDimensionsAsyncPager[source]

Lists CustomDimensions on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListCustomDimensionsRequest, dict]]) – The request object. Request message for ListCustomDimensions 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_async.AsyncRetry) – 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 ListCustomDimensions RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomDimensionsAsyncPager

async list_custom_metrics(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomMetricsAsyncPager[source]

Lists CustomMetrics on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListCustomMetricsRequest, dict]]) – The request object. Request message for ListCustomMetrics 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_async.AsyncRetry) – 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 ListCustomMetrics RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomMetricsAsyncPager

async list_data_streams(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDataStreamsAsyncPager[source]

Lists DataStreams on a property.

Parameters
  • request (Optional[Union[google.analytics.admin_v1alpha.types.ListDataStreamsRequest, dict]]) – The request object. Request message for ListDataStreams 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_async.AsyncRetry) – 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 ListDataStreams RPC. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDataStreamsAsyncPager