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

Service Interface for the Analytics Admin API (GA4).

Instantiates the analytics admin service client.

Parameters

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

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

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

Raises

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

static account_path(account: str) → str

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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 via this API) before MeasurementProtocolSecret resources may be created.

from google.analytics import admin_v1alpha

def sample_acknowledge_user_data_collection():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.AcknowledgeUserDataCollectionRequest(
        property="property_value",
        acknowledgement="acknowledgement_value",
    )

    # Make the request
    response = client.acknowledge_user_data_collection(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for AcknowledgeUserDataCollection RPC.

Return type

google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionResponse

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

from google.analytics import admin_v1alpha

def sample_approve_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.approve_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Return type

google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalResponse

async archive_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomDimensionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Archives a CustomDimension on a property.

from google.analytics import admin_v1alpha

def sample_archive_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ArchiveCustomDimensionRequest(
        name="name_value",
    )

    # Make the request
    client.archive_custom_dimension(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

async archive_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Archives a CustomMetric on a property.

from google.analytics import admin_v1alpha

def sample_archive_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ArchiveCustomMetricRequest(
        name="name_value",
    )

    # Make the request
    client.archive_custom_metric(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

from google.analytics import admin_v1alpha

def sample_audit_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.AuditUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.audit_user_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

Creates information about multiple users’ links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

from google.analytics import admin_v1alpha

def sample_batch_create_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    requests = admin_v1alpha.CreateUserLinkRequest()
    requests.parent = "parent_value"

    request = admin_v1alpha.BatchCreateUserLinksRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    response = client.batch_create_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchCreateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchCreateUserLinksResponse

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

from google.analytics import admin_v1alpha

def sample_batch_delete_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    requests = admin_v1alpha.DeleteUserLinkRequest()
    requests.name = "name_value"

    request = admin_v1alpha.BatchDeleteUserLinksRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    client.batch_delete_user_links(request=request)
Parameters

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

from google.analytics import admin_v1alpha

def sample_batch_get_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.BatchGetUserLinksRequest(
        parent="parent_value",
        names=['names_value_1', 'names_value_2'],
    )

    # Make the request
    response = client.batch_get_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchGetUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchGetUserLinksResponse

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

from google.analytics import admin_v1alpha

def sample_batch_update_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.BatchUpdateUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.batch_update_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchUpdateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchUpdateUserLinksResponse

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.

from google.analytics import admin_v1alpha

def sample_cancel_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CancelDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.cancel_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
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 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_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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.ConversionEvent[source]

Creates a conversion event with the specified attributes.

from google.analytics import admin_v1alpha

def sample_create_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateConversionEventRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_conversion_event(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Creates a CustomDimension.

from google.analytics import admin_v1alpha

def sample_create_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    custom_dimension = admin_v1alpha.CustomDimension()
    custom_dimension.parameter_name = "parameter_name_value"
    custom_dimension.display_name = "display_name_value"
    custom_dimension.scope = "USER"

    request = admin_v1alpha.CreateCustomDimensionRequest(
        parent="parent_value",
        custom_dimension=custom_dimension,
    )

    # Make the request
    response = client.create_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Creates a CustomMetric.

from google.analytics import admin_v1alpha

def sample_create_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    custom_metric = admin_v1alpha.CustomMetric()
    custom_metric.parameter_name = "parameter_name_value"
    custom_metric.display_name = "display_name_value"
    custom_metric.measurement_unit = "HOURS"
    custom_metric.scope = "EVENT"

    request = admin_v1alpha.CreateCustomMetricRequest(
        parent="parent_value",
        custom_metric=custom_metric,
    )

    # Make the request
    response = client.create_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Creates a DataStream.

from google.analytics import admin_v1alpha

def sample_create_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    data_stream = admin_v1alpha.DataStream()
    data_stream.type_ = "IOS_APP_DATA_STREAM"

    request = admin_v1alpha.CreateDataStreamRequest(
        parent="parent_value",
        data_stream=data_stream,
    )

    # Make the request
    response = client.create_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a 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.

from google.analytics import admin_v1alpha

def sample_create_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateDisplayVideo360AdvertiserLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Creates a DisplayVideo360AdvertiserLinkProposal.

from google.analytics import admin_v1alpha

def sample_create_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateDisplayVideo360AdvertiserLinkProposalRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
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

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

from google.analytics import admin_v1alpha

def sample_create_firebase_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateFirebaseLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_firebase_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A link between a GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

Creates a GoogleAdsLink.

from google.analytics import admin_v1alpha

def sample_create_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateGoogleAdsLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_google_ads_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A link between 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Creates a measurement protocol secret.

from google.analytics import admin_v1alpha

def sample_create_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    measurement_protocol_secret = admin_v1alpha.MeasurementProtocolSecret()
    measurement_protocol_secret.display_name = "display_name_value"

    request = admin_v1alpha.CreateMeasurementProtocolSecretRequest(
        parent="parent_value",
        measurement_protocol_secret=measurement_protocol_secret,
    )

    # Make the request
    response = client.create_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property[source]

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

from google.analytics import admin_v1alpha

def sample_create_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    property = admin_v1alpha.Property()
    property.display_name = "display_name_value"
    property.time_zone = "time_zone_value"

    request = admin_v1alpha.CreatePropertyRequest(
        property=property,
    )

    # Make the request
    response = client.create_property(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user’s existing permissions will be unioned with the permissions specified in the new UserLink.

from google.analytics import admin_v1alpha

def sample_create_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateUserLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_user_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.CreateUserLinkRequest, dict]) – The request object. Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the “primary” email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the “primary” email address. As a result, the input and output email address for this request may differ.

  • parent (str) –

    Required. Example format: accounts/1234

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

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

static custom_dimension_path(property: str) → str

Returns a fully-qualified custom_dimension string.

static custom_metric_path(property: str) → str

Returns a fully-qualified custom_metric 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_account(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

from google.analytics import admin_v1alpha

def sample_delete_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteAccountRequest(
        name="name_value",
    )

    # Make the request
    client.delete_account(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

async delete_conversion_event(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteConversionEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a conversion event in a property.

from google.analytics import admin_v1alpha

def sample_delete_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteConversionEventRequest(
        name="name_value",
    )

    # Make the request
    client.delete_conversion_event(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

async delete_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a DataStream on a property.

from google.analytics import admin_v1alpha

def sample_delete_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDataStreamRequest(
        name="name_value",
    )

    # Make the request
    client.delete_data_stream(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a DisplayVideo360AdvertiserLink on a property.

from google.analytics import admin_v1alpha

def sample_delete_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDisplayVideo360AdvertiserLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_display_video360_advertiser_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

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

from google.analytics import admin_v1alpha

def sample_delete_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    client.delete_display_video360_advertiser_link_proposal(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a FirebaseLink on a property

from google.analytics import admin_v1alpha

def sample_delete_firebase_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteFirebaseLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_firebase_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a GoogleAdsLink on a property

from google.analytics import admin_v1alpha

def sample_delete_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteGoogleAdsLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_google_ads_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

async delete_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteMeasurementProtocolSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes target MeasurementProtocolSecret.

from google.analytics import admin_v1alpha

def sample_delete_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteMeasurementProtocolSecretRequest(
        name="name_value",
    )

    # Make the request
    client.delete_measurement_protocol_secret(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

async delete_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeletePropertyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

from google.analytics import admin_v1alpha

def sample_delete_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeletePropertyRequest(
        name="name_value",
    )

    # Make the request
    response = client.delete_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Deletes a user link on an account or property.

from google.analytics import admin_v1alpha

def sample_delete_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteUserLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_user_link(request=request)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.DeleteUserLinkRequest, dict]) – The request object. Request message for DeleteUserLink RPC.

  • name (str) –

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

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

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

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

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

Returns a fully-qualified display_video360_advertiser_link string.

Returns a fully-qualified display_video360_advertiser_link_proposal string.

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_account(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Account[source]

Lookup for a single Account.

from google.analytics import admin_v1alpha

def sample_get_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetAccountRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_account(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

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

Retrieve a single conversion event.

from google.analytics import admin_v1alpha

def sample_get_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetConversionEventRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_conversion_event(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Lookup for a single CustomDimension.

from google.analytics import admin_v1alpha

def sample_get_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetCustomDimensionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Lookup for a single CustomMetric.

from google.analytics import admin_v1alpha

def sample_get_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetCustomMetricRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

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

Returns the singleton data retention settings for this property.

from google.analytics import admin_v1alpha

def sample_get_data_retention_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataRetentionSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_retention_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_get_data_sharing_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataSharingSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_sharing_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DataSharingSettings

async get_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Lookup for a single DataStream.

from google.analytics import admin_v1alpha

def sample_get_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataStreamRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Look up a single DisplayVideo360AdvertiserLink

from google.analytics import admin_v1alpha

def sample_get_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDisplayVideo360AdvertiserLinkRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

from google.analytics import admin_v1alpha

def sample_get_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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_global_site_tag(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetGlobalSiteTagRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_get_global_site_tag():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetGlobalSiteTagRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_global_site_tag(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Read-only resource with the tag for sending data from a website to a 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings[source]

Lookup for Google Signals settings for a property.

from google.analytics import admin_v1alpha

def sample_get_google_signals_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetGoogleSignalsSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_google_signals_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Lookup for a single “GA4” MeasurementProtocolSecret.

from google.analytics import admin_v1alpha

def sample_get_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetMeasurementProtocolSecretRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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 variabel 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property[source]

Lookup for a single “GA4” Property.

from google.analytics import admin_v1alpha

def sample_get_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetPropertyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

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

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.

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

from google.analytics import admin_v1alpha

def sample_get_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetUserLinkRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_user_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.GetUserLinkRequest, dict]) – The request object. Request message for GetUserLink RPC.

  • name (str) –

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

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

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_account_summaries(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_list_account_summaries():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListAccountSummariesRequest(
    )

    # Make the request
    page_result = client.list_account_summaries(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_list_accounts():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListAccountsRequest(
    )

    # Make the request
    page_result = client.list_accounts(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

async list_conversion_events(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_list_conversion_events():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListConversionEventsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_conversion_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomDimensionsAsyncPager[source]

Lists CustomDimensions on a property.

from google.analytics import admin_v1alpha

def sample_list_custom_dimensions():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListCustomDimensionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_dimensions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomMetricsAsyncPager[source]

Lists CustomMetrics on a property.

from google.analytics import admin_v1alpha

def sample_list_custom_metrics():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListCustomMetricsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_metrics(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDataStreamsAsyncPager[source]

Lists DataStreams on a property.

from google.analytics import admin_v1alpha

def sample_list_data_streams():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDataStreamsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_data_streams(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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

Lists DisplayVideo360AdvertiserLinkProposals on a property.

from google.analytics import admin_v1alpha

def sample_list_display_video360_advertiser_link_proposals():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDisplayVideo360AdvertiserLinkProposalsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_display_video360_advertiser_link_proposals(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinkProposalsAsyncPager

Lists all DisplayVideo360AdvertiserLinks on a property.

from google.analytics import admin_v1alpha

def sample_list_display_video360_advertiser_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDisplayVideo360AdvertiserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_display_video360_advertiser_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinksAsyncPager

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

from google.analytics import admin_v1alpha

def sample_list_firebase_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListFirebaseLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_firebase_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest, dict]) – The request object. Request message for ListFirebaseLinks RPC

  • parent (str) –

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

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

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

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

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

Returns

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

Return type

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

Lists GoogleAdsLinks on a property.

from google.analytics import admin_v1alpha

def sample_list_google_ads_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListGoogleAdsLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_google_ads_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest, dict]) – The request object. Request message for ListGoogleAdsLinks RPC.

  • parent (str) –

    Required. Example format: properties/1234

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

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

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

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

Returns

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

Return type

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

async list_measurement_protocol_secrets(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsAsyncPager[source]

Returns child MeasurementProtocolSecrets under the specified parent Property.

from google.analytics import admin_v1alpha

def sample_list_measurement_protocol_secrets():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListMeasurementProtocolSecretsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_measurement_protocol_secrets(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsRequest, dict]) – The request object. Request message for ListMeasurementProtocolSecret RPC

  • parent (str) –

    Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsAsyncPager

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

Returns child Properties under the specified parent Account. Only “GA4” properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: “trashed”) properties are excluded by default. Returns an empty list if no relevant properties are found.

from google.analytics import admin_v1alpha

def sample_list_properties():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListPropertiesRequest(
        filter="filter_value",
    )

    # Make the request
    page_result = client.list_properties(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

Lists all user links on an account or property.

from google.analytics import admin_v1alpha

def sample_list_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_user_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListUserLinksRequest, dict]) – The request object. Request message for ListUserLinks RPC.

  • parent (str) –

    Required. Example format: accounts/1234

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

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

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

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

Returns

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

Return type

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

static measurement_protocol_secret_path(property: str, data_stream: str, measurement_protocol_secret: str) → str

Returns a fully-qualified measurement_protocol_secret string.

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

Parses a account path into its component segments.

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

Parses a account_summary path into its component segments.

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

Parse a billing_account path into its component segments.

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

Parse a folder path into its component segments.

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

Parse a location path into its component segments.

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

Parse a organization path into its component segments.

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

Parse a project path into its component segments.

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

Parses a conversion_event path into its component segments.

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

Parses a custom_dimension path into its component segments.

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

Parses a custom_metric path into its component segments.

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

Parses a data_retention_settings path into its component segments.

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

Parses a data_sharing_settings path into its component segments.

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

Parses a data_stream path into its component segments.

Parses a display_video360_advertiser_link path into its component segments.

Parses a display_video360_advertiser_link_proposal path into its component segments.

Parses a firebase_link path into its component segments.

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

Parses a global_site_tag path into its component segments.

Parses a google_ads_link path into its component segments.

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

Parses a google_signals_settings path into its component segments.

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

Parses a measurement_protocol_secret path into its component segments.

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

Parses a property path into its component segments.

Parses a user_link path into its component segments.

static property_path(property: str) → str

Returns a fully-qualified property string.

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

Requests a ticket for creating an account.

from google.analytics import admin_v1alpha

def sample_provision_account_ticket():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ProvisionAccountTicketRequest(
    )

    # Make the request
    response = client.provision_account_ticket(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for ProvisionAccountTicket RPC.

Return type

google.analytics.admin_v1alpha.types.ProvisionAccountTicketResponse

async search_change_history_events(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsAsyncPager[source]

Searches through all changes to an account or its children given the specified set of filters.

from google.analytics import admin_v1alpha

def sample_search_change_history_events():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.SearchChangeHistoryEventsRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.search_change_history_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsAsyncPager

property transport: google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

AnalyticsAdminServiceTransport

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

Updates an account.

from google.analytics import admin_v1alpha

def sample_update_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    account = admin_v1alpha.Account()
    account.display_name = "display_name_value"

    request = admin_v1alpha.UpdateAccountRequest(
        account=account,
    )

    # Make the request
    response = client.update_account(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateAccountRequest, dict]) – The request object. Request message for UpdateAccount RPC.

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

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

async update_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateCustomDimensionRequest, dict]] = None, *, custom_dimension: Optional[google.analytics.admin_v1alpha.types.resources.CustomDimension] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Updates a CustomDimension on a property.

from google.analytics import admin_v1alpha

def sample_update_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateCustomDimensionRequest(
    )

    # Make the request
    response = client.update_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

async update_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateCustomMetricRequest, dict]] = None, *, custom_metric: Optional[google.analytics.admin_v1alpha.types.resources.CustomMetric] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Updates a CustomMetric on a property.

from google.analytics import admin_v1alpha

def sample_update_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateCustomMetricRequest(
    )

    # Make the request
    response = client.update_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

async update_data_retention_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateDataRetentionSettingsRequest, dict]] = None, *, data_retention_settings: Optional[google.analytics.admin_v1alpha.types.resources.DataRetentionSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataRetentionSettings[source]

Updates the singleton data retention settings for this property.

from google.analytics import admin_v1alpha

def sample_update_data_retention_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDataRetentionSettingsRequest(
    )

    # Make the request
    response = client.update_data_retention_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateDataRetentionSettingsRequest, dict]) – The request object. Request message for UpdateDataRetentionSettings RPC.

  • data_retention_settings (google.analytics.admin_v1alpha.types.DataRetentionSettings) –

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DataRetentionSettings

async update_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateDataStreamRequest, dict]] = None, *, data_stream: Optional[google.analytics.admin_v1alpha.types.resources.DataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Updates a DataStream on a property.

from google.analytics import admin_v1alpha

def sample_update_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDataStreamRequest(
    )

    # Make the request
    response = client.update_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateDataStreamRequest, dict]) – The request object. Request message for UpdateDataStream RPC.

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

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

    Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Updates a DisplayVideo360AdvertiserLink on a property.

from google.analytics import admin_v1alpha

def sample_update_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDisplayVideo360AdvertiserLinkRequest(
    )

    # Make the request
    response = client.update_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Updates a GoogleAdsLink on a property

from google.analytics import admin_v1alpha

def sample_update_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateGoogleAdsLinkRequest(
    )

    # Make the request
    response = client.update_google_ads_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateGoogleAdsLinkRequest, dict]) – The request object. Request message for UpdateGoogleAdsLink RPC

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

async update_google_signals_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateGoogleSignalsSettingsRequest, dict]] = None, *, google_signals_settings: Optional[google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings[source]

Updates Google Signals settings for a property.

from google.analytics import admin_v1alpha

def sample_update_google_signals_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateGoogleSignalsSettingsRequest(
    )

    # Make the request
    response = client.update_google_signals_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateGoogleSignalsSettingsRequest, dict]) – The request object. Request message for UpdateGoogleSignalsSettings RPC

  • google_signals_settings (google.analytics.admin_v1alpha.types.GoogleSignalsSettings) –

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleSignalsSettings

async update_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateMeasurementProtocolSecretRequest, dict]] = None, *, measurement_protocol_secret: Optional[google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Updates a measurement protocol secret.

from google.analytics import admin_v1alpha

def sample_update_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    measurement_protocol_secret = admin_v1alpha.MeasurementProtocolSecret()
    measurement_protocol_secret.display_name = "display_name_value"

    request = admin_v1alpha.UpdateMeasurementProtocolSecretRequest(
        measurement_protocol_secret=measurement_protocol_secret,
    )

    # Make the request
    response = client.update_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A secret value used for sending hits to Measurement Protocol.

Return type

google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

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

Updates a property.

from google.analytics import admin_v1alpha

def sample_update_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    property = admin_v1alpha.Property()
    property.display_name = "display_name_value"
    property.time_zone = "time_zone_value"

    request = admin_v1alpha.UpdatePropertyRequest(
        property=property,
    )

    # Make the request
    response = client.update_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdatePropertyRequest, dict]) – The request object. Request message for UpdateProperty RPC.

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

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Updates a user link on an account or property.

from google.analytics import admin_v1alpha

def sample_update_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateUserLinkRequest(
    )

    # Make the request
    response = client.update_user_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

Returns a fully-qualified user_link string.

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

Service Interface for the Analytics Admin API (GA4).

Instantiates the analytics admin service client.

Parameters

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

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

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

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

Raises

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

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static account_path(account: str) → str[source]

Returns a fully-qualified account string.

static account_summary_path(account_summary: str) → str[source]

Returns a fully-qualified account_summary string.

acknowledge_user_data_collection(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.AcknowledgeUserDataCollectionRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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 via this API) before MeasurementProtocolSecret resources may be created.

from google.analytics import admin_v1alpha

def sample_acknowledge_user_data_collection():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.AcknowledgeUserDataCollectionRequest(
        property="property_value",
        acknowledgement="acknowledgement_value",
    )

    # Make the request
    response = client.acknowledge_user_data_collection(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for AcknowledgeUserDataCollection RPC.

Return type

google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionResponse

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

from google.analytics import admin_v1alpha

def sample_approve_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ApproveDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.approve_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Return type

google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalResponse

archive_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomDimensionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Archives a CustomDimension on a property.

from google.analytics import admin_v1alpha

def sample_archive_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ArchiveCustomDimensionRequest(
        name="name_value",
    )

    # Make the request
    client.archive_custom_dimension(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

archive_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ArchiveCustomMetricRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Archives a CustomMetric on a property.

from google.analytics import admin_v1alpha

def sample_archive_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ArchiveCustomMetricRequest(
        name="name_value",
    )

    # Make the request
    client.archive_custom_metric(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

from google.analytics import admin_v1alpha

def sample_audit_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.AuditUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.audit_user_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

Creates information about multiple users’ links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

from google.analytics import admin_v1alpha

def sample_batch_create_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    requests = admin_v1alpha.CreateUserLinkRequest()
    requests.parent = "parent_value"

    request = admin_v1alpha.BatchCreateUserLinksRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    response = client.batch_create_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchCreateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchCreateUserLinksResponse

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

from google.analytics import admin_v1alpha

def sample_batch_delete_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    requests = admin_v1alpha.DeleteUserLinkRequest()
    requests.name = "name_value"

    request = admin_v1alpha.BatchDeleteUserLinksRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    client.batch_delete_user_links(request=request)
Parameters

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

from google.analytics import admin_v1alpha

def sample_batch_get_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.BatchGetUserLinksRequest(
        parent="parent_value",
        names=['names_value_1', 'names_value_2'],
    )

    # Make the request
    response = client.batch_get_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchGetUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchGetUserLinksResponse

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

from google.analytics import admin_v1alpha

def sample_batch_update_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.BatchUpdateUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.batch_update_user_links(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for BatchUpdateUserLinks RPC.

Return type

google.analytics.admin_v1alpha.types.BatchUpdateUserLinksResponse

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.

from google.analytics import admin_v1alpha

def sample_cancel_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CancelDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.cancel_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
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 common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

static conversion_event_path(property: str, conversion_event: str) → str[source]

Returns a fully-qualified conversion_event string.

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.ConversionEvent[source]

Creates a conversion event with the specified attributes.

from google.analytics import admin_v1alpha

def sample_create_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateConversionEventRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_conversion_event(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A conversion event in a Google Analytics property.

Return type

google.analytics.admin_v1alpha.types.ConversionEvent

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Creates a CustomDimension.

from google.analytics import admin_v1alpha

def sample_create_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    custom_dimension = admin_v1alpha.CustomDimension()
    custom_dimension.parameter_name = "parameter_name_value"
    custom_dimension.display_name = "display_name_value"
    custom_dimension.scope = "USER"

    request = admin_v1alpha.CreateCustomDimensionRequest(
        parent="parent_value",
        custom_dimension=custom_dimension,
    )

    # Make the request
    response = client.create_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Creates a CustomMetric.

from google.analytics import admin_v1alpha

def sample_create_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    custom_metric = admin_v1alpha.CustomMetric()
    custom_metric.parameter_name = "parameter_name_value"
    custom_metric.display_name = "display_name_value"
    custom_metric.measurement_unit = "HOURS"
    custom_metric.scope = "EVENT"

    request = admin_v1alpha.CreateCustomMetricRequest(
        parent="parent_value",
        custom_metric=custom_metric,
    )

    # Make the request
    response = client.create_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Creates a DataStream.

from google.analytics import admin_v1alpha

def sample_create_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    data_stream = admin_v1alpha.DataStream()
    data_stream.type_ = "IOS_APP_DATA_STREAM"

    request = admin_v1alpha.CreateDataStreamRequest(
        parent="parent_value",
        data_stream=data_stream,
    )

    # Make the request
    response = client.create_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a 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.

from google.analytics import admin_v1alpha

def sample_create_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateDisplayVideo360AdvertiserLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Creates a DisplayVideo360AdvertiserLinkProposal.

from google.analytics import admin_v1alpha

def sample_create_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateDisplayVideo360AdvertiserLinkProposalRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
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

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

from google.analytics import admin_v1alpha

def sample_create_firebase_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateFirebaseLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_firebase_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A link between a GA4 property and a Firebase project.

Return type

google.analytics.admin_v1alpha.types.FirebaseLink

Creates a GoogleAdsLink.

from google.analytics import admin_v1alpha

def sample_create_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateGoogleAdsLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_google_ads_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Creates a measurement protocol secret.

from google.analytics import admin_v1alpha

def sample_create_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    measurement_protocol_secret = admin_v1alpha.MeasurementProtocolSecret()
    measurement_protocol_secret.display_name = "display_name_value"

    request = admin_v1alpha.CreateMeasurementProtocolSecretRequest(
        parent="parent_value",
        measurement_protocol_secret=measurement_protocol_secret,
    )

    # Make the request
    response = client.create_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A secret value used for sending hits to Measurement Protocol.

Return type

google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.Property[source]

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

from google.analytics import admin_v1alpha

def sample_create_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    property = admin_v1alpha.Property()
    property.display_name = "display_name_value"
    property.time_zone = "time_zone_value"

    request = admin_v1alpha.CreatePropertyRequest(
        property=property,
    )

    # Make the request
    response = client.create_property(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user’s existing permissions will be unioned with the permissions specified in the new UserLink.

from google.analytics import admin_v1alpha

def sample_create_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.CreateUserLinkRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_user_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.CreateUserLinkRequest, dict]) – The request object. Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the “primary” email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the “primary” email address. As a result, the input and output email address for this request may differ.

  • parent (str) –

    Required. Example format: accounts/1234

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

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

static custom_dimension_path(property: str) → str[source]

Returns a fully-qualified custom_dimension string.

static custom_metric_path(property: str) → str[source]

Returns a fully-qualified custom_metric string.

static data_retention_settings_path(property: str) → str[source]

Returns a fully-qualified data_retention_settings string.

static data_sharing_settings_path(account: str) → str[source]

Returns a fully-qualified data_sharing_settings string.

static data_stream_path(property: str, data_stream: str) → str[source]

Returns a fully-qualified data_stream string.

delete_account(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

from google.analytics import admin_v1alpha

def sample_delete_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteAccountRequest(
        name="name_value",
    )

    # Make the request
    client.delete_account(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

delete_conversion_event(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteConversionEventRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a conversion event in a property.

from google.analytics import admin_v1alpha

def sample_delete_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteConversionEventRequest(
        name="name_value",
    )

    # Make the request
    client.delete_conversion_event(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

delete_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a DataStream on a property.

from google.analytics import admin_v1alpha

def sample_delete_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDataStreamRequest(
        name="name_value",
    )

    # Make the request
    client.delete_data_stream(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a DisplayVideo360AdvertiserLink on a property.

from google.analytics import admin_v1alpha

def sample_delete_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDisplayVideo360AdvertiserLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_display_video360_advertiser_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

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

from google.analytics import admin_v1alpha

def sample_delete_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    client.delete_display_video360_advertiser_link_proposal(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a FirebaseLink on a property

from google.analytics import admin_v1alpha

def sample_delete_firebase_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteFirebaseLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_firebase_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Deletes a GoogleAdsLink on a property

from google.analytics import admin_v1alpha

def sample_delete_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteGoogleAdsLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_google_ads_link(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

delete_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeleteMeasurementProtocolSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes target MeasurementProtocolSecret.

from google.analytics import admin_v1alpha

def sample_delete_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteMeasurementProtocolSecretRequest(
        name="name_value",
    )

    # Make the request
    client.delete_measurement_protocol_secret(request=request)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

delete_property(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.DeletePropertyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

from google.analytics import admin_v1alpha

def sample_delete_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeletePropertyRequest(
        name="name_value",
    )

    # Make the request
    response = client.delete_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Deletes a user link on an account or property.

from google.analytics import admin_v1alpha

def sample_delete_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.DeleteUserLinkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_user_link(request=request)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.DeleteUserLinkRequest, dict]) – The request object. Request message for DeleteUserLink RPC.

  • name (str) –

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

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

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

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

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

Returns a fully-qualified display_video360_advertiser_link string.

Returns a fully-qualified display_video360_advertiser_link_proposal string.

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

AnalyticsAdminServiceClient

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

AnalyticsAdminServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

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

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

AnalyticsAdminServiceClient

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

Lookup for a single Account.

from google.analytics import admin_v1alpha

def sample_get_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetAccountRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_account(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

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

Retrieve a single conversion event.

from google.analytics import admin_v1alpha

def sample_get_conversion_event():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetConversionEventRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_conversion_event(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A conversion event in a Google Analytics property.

Return type

google.analytics.admin_v1alpha.types.ConversionEvent

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

Lookup for a single CustomDimension.

from google.analytics import admin_v1alpha

def sample_get_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetCustomDimensionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

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

Lookup for a single CustomMetric.

from google.analytics import admin_v1alpha

def sample_get_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetCustomMetricRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

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

Returns the singleton data retention settings for this property.

from google.analytics import admin_v1alpha

def sample_get_data_retention_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataRetentionSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_retention_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DataRetentionSettings

get_data_sharing_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataSharingSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_get_data_sharing_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataSharingSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_sharing_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DataSharingSettings

get_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetDataStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Lookup for a single DataStream.

from google.analytics import admin_v1alpha

def sample_get_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDataStreamRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Look up a single DisplayVideo360AdvertiserLink

from google.analytics import admin_v1alpha

def sample_get_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDisplayVideo360AdvertiserLinkRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

from google.analytics import admin_v1alpha

def sample_get_display_video360_advertiser_link_proposal():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetDisplayVideo360AdvertiserLinkProposalRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_display_video360_advertiser_link_proposal(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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

get_global_site_tag(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.GetGlobalSiteTagRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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.

from google.analytics import admin_v1alpha

def sample_get_global_site_tag():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetGlobalSiteTagRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_global_site_tag(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.

Return type

google.analytics.admin_v1alpha.types.GlobalSiteTag

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

Lookup for Google Signals settings for a property.

from google.analytics import admin_v1alpha

def sample_get_google_signals_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetGoogleSignalsSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_google_signals_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleSignalsSettings

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

Lookup for a single “GA4” MeasurementProtocolSecret.

from google.analytics import admin_v1alpha

def sample_get_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetMeasurementProtocolSecretRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A 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 variabel 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.

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

Lookup for a single “GA4” Property.

from google.analytics import admin_v1alpha

def sample_get_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetPropertyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

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

from google.analytics import admin_v1alpha

def sample_get_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.GetUserLinkRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_user_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.GetUserLinkRequest, dict]) – The request object. Request message for GetUserLink RPC.

  • name (str) –

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

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

static global_site_tag_path(property: str, data_stream: str) → str[source]

Returns a fully-qualified global_site_tag string.

Returns a fully-qualified google_ads_link string.

static google_signals_settings_path(property: str) → str[source]

Returns a fully-qualified google_signals_settings string.

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

Returns summaries of all accounts accessible by the caller.

from google.analytics import admin_v1alpha

def sample_list_account_summaries():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListAccountSummariesRequest(
    )

    # Make the request
    page_result = client.list_account_summaries(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

list_accounts(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager[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.

from google.analytics import admin_v1alpha

def sample_list_accounts():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListAccountsRequest(
    )

    # Make the request
    page_result = client.list_accounts(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

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

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

from google.analytics import admin_v1alpha

def sample_list_conversion_events():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListConversionEventsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_conversion_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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.ListConversionEventsPager

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

Lists CustomDimensions on a property.

from google.analytics import admin_v1alpha

def sample_list_custom_dimensions():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListCustomDimensionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_dimensions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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.ListCustomDimensionsPager

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

Lists CustomMetrics on a property.

from google.analytics import admin_v1alpha

def sample_list_custom_metrics():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListCustomMetricsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_metrics(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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.ListCustomMetricsPager

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

Lists DataStreams on a property.

from google.analytics import admin_v1alpha

def sample_list_data_streams():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDataStreamsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_data_streams(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (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.Retry) – Designation of what errors, if any, should be retried.

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

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

Returns

Response message for 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.ListDataStreamsPager

Lists DisplayVideo360AdvertiserLinkProposals on a property.

from google.analytics import admin_v1alpha

def sample_list_display_video360_advertiser_link_proposals():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDisplayVideo360AdvertiserLinkProposalsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_display_video360_advertiser_link_proposals(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinkProposalsPager

Lists all DisplayVideo360AdvertiserLinks on a property.

from google.analytics import admin_v1alpha

def sample_list_display_video360_advertiser_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListDisplayVideo360AdvertiserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_display_video360_advertiser_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinksPager

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

from google.analytics import admin_v1alpha

def sample_list_firebase_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListFirebaseLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_firebase_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest, dict]) – The request object. Request message for ListFirebaseLinks RPC

  • parent (str) –

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

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

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

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

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

Returns

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

Return type

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

Lists GoogleAdsLinks on a property.

from google.analytics import admin_v1alpha

def sample_list_google_ads_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListGoogleAdsLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_google_ads_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest, dict]) – The request object. Request message for ListGoogleAdsLinks RPC.

  • parent (str) –

    Required. Example format: properties/1234

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

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

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

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

Returns

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

Return type

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

list_measurement_protocol_secrets(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsPager[source]

Returns child MeasurementProtocolSecrets under the specified parent Property.

from google.analytics import admin_v1alpha

def sample_list_measurement_protocol_secrets():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListMeasurementProtocolSecretsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_measurement_protocol_secrets(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsRequest, dict]) – The request object. Request message for ListMeasurementProtocolSecret RPC

  • parent (str) –

    Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsPager

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

Returns child Properties under the specified parent Account. Only “GA4” properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: “trashed”) properties are excluded by default. Returns an empty list if no relevant properties are found.

from google.analytics import admin_v1alpha

def sample_list_properties():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListPropertiesRequest(
        filter="filter_value",
    )

    # Make the request
    page_result = client.list_properties(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

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

Lists all user links on an account or property.

from google.analytics import admin_v1alpha

def sample_list_user_links():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ListUserLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_user_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.ListUserLinksRequest, dict]) – The request object. Request message for ListUserLinks RPC.

  • parent (str) –

    Required. Example format: accounts/1234

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

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

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

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

Returns

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

Return type

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

static measurement_protocol_secret_path(property: str, data_stream: str, measurement_protocol_secret: str) → str[source]

Returns a fully-qualified measurement_protocol_secret string.

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

Parses a account path into its component segments.

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

Parses a account_summary path into its component segments.

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

Parse a billing_account path into its component segments.

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

Parse a folder path into its component segments.

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

Parse a location path into its component segments.

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

Parse a organization path into its component segments.

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

Parse a project path into its component segments.

static parse_conversion_event_path(path: str) → Dict[str, str][source]

Parses a conversion_event path into its component segments.

static parse_custom_dimension_path(path: str) → Dict[str, str][source]

Parses a custom_dimension path into its component segments.

static parse_custom_metric_path(path: str) → Dict[str, str][source]

Parses a custom_metric path into its component segments.

static parse_data_retention_settings_path(path: str) → Dict[str, str][source]

Parses a data_retention_settings path into its component segments.

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

Parses a data_sharing_settings path into its component segments.

static parse_data_stream_path(path: str) → Dict[str, str][source]

Parses a data_stream path into its component segments.

Parses a display_video360_advertiser_link path into its component segments.

Parses a display_video360_advertiser_link_proposal path into its component segments.

Parses a firebase_link path into its component segments.

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

Parses a global_site_tag path into its component segments.

Parses a google_ads_link path into its component segments.

static parse_google_signals_settings_path(path: str) → Dict[str, str][source]

Parses a google_signals_settings path into its component segments.

static parse_measurement_protocol_secret_path(path: str) → Dict[str, str][source]

Parses a measurement_protocol_secret path into its component segments.

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

Parses a property path into its component segments.

Parses a user_link path into its component segments.

static property_path(property: str) → str[source]

Returns a fully-qualified property string.

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

Requests a ticket for creating an account.

from google.analytics import admin_v1alpha

def sample_provision_account_ticket():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.ProvisionAccountTicketRequest(
    )

    # Make the request
    response = client.provision_account_ticket(request=request)

    # Handle the response
    print(response)
Parameters
Returns

Response message for ProvisionAccountTicket RPC.

Return type

google.analytics.admin_v1alpha.types.ProvisionAccountTicketResponse

search_change_history_events(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsPager[source]

Searches through all changes to an account or its children given the specified set of filters.

from google.analytics import admin_v1alpha

def sample_search_change_history_events():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.SearchChangeHistoryEventsRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.search_change_history_events(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsPager

property transport: google.analytics.admin_v1alpha.services.analytics_admin_service.transports.base.AnalyticsAdminServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

AnalyticsAdminServiceTransport

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

Updates an account.

from google.analytics import admin_v1alpha

def sample_update_account():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    account = admin_v1alpha.Account()
    account.display_name = "display_name_value"

    request = admin_v1alpha.UpdateAccountRequest(
        account=account,
    )

    # Make the request
    response = client.update_account(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateAccountRequest, dict]) – The request object. Request message for UpdateAccount RPC.

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

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a Google Analytics account.

Return type

google.analytics.admin_v1alpha.types.Account

update_custom_dimension(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateCustomDimensionRequest, dict]] = None, *, custom_dimension: Optional[google.analytics.admin_v1alpha.types.resources.CustomDimension] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomDimension[source]

Updates a CustomDimension on a property.

from google.analytics import admin_v1alpha

def sample_update_custom_dimension():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateCustomDimensionRequest(
    )

    # Make the request
    response = client.update_custom_dimension(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A definition for a CustomDimension.

Return type

google.analytics.admin_v1alpha.types.CustomDimension

update_custom_metric(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateCustomMetricRequest, dict]] = None, *, custom_metric: Optional[google.analytics.admin_v1alpha.types.resources.CustomMetric] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.CustomMetric[source]

Updates a CustomMetric on a property.

from google.analytics import admin_v1alpha

def sample_update_custom_metric():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateCustomMetricRequest(
    )

    # Make the request
    response = client.update_custom_metric(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A definition for a custom metric.

Return type

google.analytics.admin_v1alpha.types.CustomMetric

update_data_retention_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateDataRetentionSettingsRequest, dict]] = None, *, data_retention_settings: Optional[google.analytics.admin_v1alpha.types.resources.DataRetentionSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataRetentionSettings[source]

Updates the singleton data retention settings for this property.

from google.analytics import admin_v1alpha

def sample_update_data_retention_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDataRetentionSettingsRequest(
    )

    # Make the request
    response = client.update_data_retention_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateDataRetentionSettingsRequest, dict]) – The request object. Request message for UpdateDataRetentionSettings RPC.

  • data_retention_settings (google.analytics.admin_v1alpha.types.DataRetentionSettings) –

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.DataRetentionSettings

update_data_stream(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateDataStreamRequest, dict]] = None, *, data_stream: Optional[google.analytics.admin_v1alpha.types.resources.DataStream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.DataStream[source]

Updates a DataStream on a property.

from google.analytics import admin_v1alpha

def sample_update_data_stream():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDataStreamRequest(
    )

    # Make the request
    response = client.update_data_stream(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateDataStreamRequest, dict]) – The request object. Request message for UpdateDataStream RPC.

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

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

    Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a data stream.

Return type

google.analytics.admin_v1alpha.types.DataStream

Updates a DisplayVideo360AdvertiserLink on a property.

from google.analytics import admin_v1alpha

def sample_update_display_video360_advertiser_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateDisplayVideo360AdvertiserLinkRequest(
    )

    # Make the request
    response = client.update_display_video360_advertiser_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

Updates a GoogleAdsLink on a property

from google.analytics import admin_v1alpha

def sample_update_google_ads_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateGoogleAdsLinkRequest(
    )

    # Make the request
    response = client.update_google_ads_link(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateGoogleAdsLinkRequest, dict]) – The request object. Request message for UpdateGoogleAdsLink RPC

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleAdsLink

update_google_signals_settings(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateGoogleSignalsSettingsRequest, dict]] = None, *, google_signals_settings: Optional[google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.GoogleSignalsSettings[source]

Updates Google Signals settings for a property.

from google.analytics import admin_v1alpha

def sample_update_google_signals_settings():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateGoogleSignalsSettingsRequest(
    )

    # Make the request
    response = client.update_google_signals_settings(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdateGoogleSignalsSettingsRequest, dict]) – The request object. Request message for UpdateGoogleSignalsSettings RPC

  • google_signals_settings (google.analytics.admin_v1alpha.types.GoogleSignalsSettings) –

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

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

Return type

google.analytics.admin_v1alpha.types.GoogleSignalsSettings

update_measurement_protocol_secret(request: Optional[Union[google.analytics.admin_v1alpha.types.analytics_admin.UpdateMeasurementProtocolSecretRequest, dict]] = None, *, measurement_protocol_secret: Optional[google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.admin_v1alpha.types.resources.MeasurementProtocolSecret[source]

Updates a measurement protocol secret.

from google.analytics import admin_v1alpha

def sample_update_measurement_protocol_secret():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    measurement_protocol_secret = admin_v1alpha.MeasurementProtocolSecret()
    measurement_protocol_secret.display_name = "display_name_value"

    request = admin_v1alpha.UpdateMeasurementProtocolSecretRequest(
        measurement_protocol_secret=measurement_protocol_secret,
    )

    # Make the request
    response = client.update_measurement_protocol_secret(request=request)

    # Handle the response
    print(response)
Parameters
Returns

A secret value used for sending hits to Measurement Protocol.

Return type

google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

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

Updates a property.

from google.analytics import admin_v1alpha

def sample_update_property():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    property = admin_v1alpha.Property()
    property.display_name = "display_name_value"
    property.time_zone = "time_zone_value"

    request = admin_v1alpha.UpdatePropertyRequest(
        property=property,
    )

    # Make the request
    response = client.update_property(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.admin_v1alpha.types.UpdatePropertyRequest, dict]) – The request object. Request message for UpdateProperty RPC.

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

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

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

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

    Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.

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

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

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

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

Returns

A resource message representing a Google Analytics GA4 property.

Return type

google.analytics.admin_v1alpha.types.Property

Updates a user link on an account or property.

from google.analytics import admin_v1alpha

def sample_update_user_link():
    # Create a client
    client = admin_v1alpha.AnalyticsAdminServiceClient()

    # Initialize request argument(s)
    request = admin_v1alpha.UpdateUserLinkRequest(
    )

    # Make the request
    response = client.update_user_link(request=request)

    # Handle the response
    print(response)
Parameters
Returns

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

Return type

google.analytics.admin_v1alpha.types.UserLink

Returns a fully-qualified user_link string.

class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through audit_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.AuditUserLinksResponse object, and provides an __aiter__ method to iterate through its user_links field.

If there are more pages, the __aiter__ method will make additional AuditUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.AuditUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.AuditUserLinksPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.AuditUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through audit_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.AuditUserLinksResponse object, and provides an __iter__ method to iterate through its user_links field.

If there are more pages, the __iter__ method will make additional AuditUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.AuditUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_account_summaries requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountSummariesResponse object, and provides an __aiter__ method to iterate through its account_summaries field.

If there are more pages, the __aiter__ method will make additional ListAccountSummaries requests and continue to iterate through the account_summaries field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountSummariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountSummariesPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountSummariesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_account_summaries requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountSummariesResponse object, and provides an __iter__ method to iterate through its account_summaries field.

If there are more pages, the __iter__ method will make additional ListAccountSummaries requests and continue to iterate through the account_summaries field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountSummariesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_accounts requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountsResponse object, and provides an __aiter__ method to iterate through its accounts field.

If there are more pages, the __aiter__ method will make additional ListAccounts requests and continue to iterate through the accounts field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListAccountsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_accounts requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListAccountsResponse object, and provides an __iter__ method to iterate through its accounts field.

If there are more pages, the __iter__ method will make additional ListAccounts requests and continue to iterate through the accounts field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListAccountsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListConversionEventsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_conversion_events requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListConversionEventsResponse object, and provides an __aiter__ method to iterate through its conversion_events field.

If there are more pages, the __aiter__ method will make additional ListConversionEvents requests and continue to iterate through the conversion_events field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListConversionEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListConversionEventsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListConversionEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_conversion_events requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListConversionEventsResponse object, and provides an __iter__ method to iterate through its conversion_events field.

If there are more pages, the __iter__ method will make additional ListConversionEvents requests and continue to iterate through the conversion_events field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListConversionEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomDimensionsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_custom_dimensions requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListCustomDimensionsResponse object, and provides an __aiter__ method to iterate through its custom_dimensions field.

If there are more pages, the __aiter__ method will make additional ListCustomDimensions requests and continue to iterate through the custom_dimensions field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListCustomDimensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomDimensionsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomDimensionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_custom_dimensions requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListCustomDimensionsResponse object, and provides an __iter__ method to iterate through its custom_dimensions field.

If there are more pages, the __iter__ method will make additional ListCustomDimensions requests and continue to iterate through the custom_dimensions field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListCustomDimensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomMetricsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_custom_metrics requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListCustomMetricsResponse object, and provides an __aiter__ method to iterate through its custom_metrics field.

If there are more pages, the __aiter__ method will make additional ListCustomMetrics requests and continue to iterate through the custom_metrics field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListCustomMetricsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListCustomMetricsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListCustomMetricsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_custom_metrics requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListCustomMetricsResponse object, and provides an __iter__ method to iterate through its custom_metrics field.

If there are more pages, the __iter__ method will make additional ListCustomMetrics requests and continue to iterate through the custom_metrics field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListCustomMetricsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDataStreamsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDataStreamsResponse object, and provides an __aiter__ method to iterate through its data_streams field.

If there are more pages, the __aiter__ method will make additional ListDataStreams requests and continue to iterate through the data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDataStreamsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDataStreamsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_data_streams requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDataStreamsResponse object, and provides an __iter__ method to iterate through its data_streams field.

If there are more pages, the __iter__ method will make additional ListDataStreams requests and continue to iterate through the data_streams field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDataStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinkProposalsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_display_video360_advertiser_link_proposals requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsResponse object, and provides an __aiter__ method to iterate through its display_video_360_advertiser_link_proposals field.

If there are more pages, the __aiter__ method will make additional ListDisplayVideo360AdvertiserLinkProposals requests and continue to iterate through the display_video_360_advertiser_link_proposals field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinkProposalsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinkProposalsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_display_video360_advertiser_link_proposals requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsResponse object, and provides an __iter__ method to iterate through its display_video_360_advertiser_link_proposals field.

If there are more pages, the __iter__ method will make additional ListDisplayVideo360AdvertiserLinkProposals requests and continue to iterate through the display_video_360_advertiser_link_proposals field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinksAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_display_video360_advertiser_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksResponse object, and provides an __aiter__ method to iterate through its display_video_360_advertiser_links field.

If there are more pages, the __aiter__ method will make additional ListDisplayVideo360AdvertiserLinks requests and continue to iterate through the display_video_360_advertiser_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListDisplayVideo360AdvertiserLinksPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListDisplayVideo360AdvertiserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_display_video360_advertiser_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksResponse object, and provides an __iter__ method to iterate through its display_video_360_advertiser_links field.

If there are more pages, the __iter__ method will make additional ListDisplayVideo360AdvertiserLinks requests and continue to iterate through the display_video_360_advertiser_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_firebase_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse object, and provides an __aiter__ method to iterate through its firebase_links field.

If there are more pages, the __aiter__ method will make additional ListFirebaseLinks requests and continue to iterate through the firebase_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListFirebaseLinksPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListFirebaseLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_firebase_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse object, and provides an __iter__ method to iterate through its firebase_links field.

If there are more pages, the __iter__ method will make additional ListFirebaseLinks requests and continue to iterate through the firebase_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_google_ads_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse object, and provides an __aiter__ method to iterate through its google_ads_links field.

If there are more pages, the __aiter__ method will make additional ListGoogleAdsLinks requests and continue to iterate through the google_ads_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListGoogleAdsLinksPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListGoogleAdsLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_google_ads_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse object, and provides an __iter__ method to iterate through its google_ads_links field.

If there are more pages, the __iter__ method will make additional ListGoogleAdsLinks requests and continue to iterate through the google_ads_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_measurement_protocol_secrets requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsResponse object, and provides an __aiter__ method to iterate through its measurement_protocol_secrets field.

If there are more pages, the __aiter__ method will make additional ListMeasurementProtocolSecrets requests and continue to iterate through the measurement_protocol_secrets field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListMeasurementProtocolSecretsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListMeasurementProtocolSecretsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_measurement_protocol_secrets requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsResponse object, and provides an __iter__ method to iterate through its measurement_protocol_secrets field.

If there are more pages, the __iter__ method will make additional ListMeasurementProtocolSecrets requests and continue to iterate through the measurement_protocol_secrets field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_properties requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListPropertiesResponse object, and provides an __aiter__ method to iterate through its properties field.

If there are more pages, the __aiter__ method will make additional ListProperties requests and continue to iterate through the properties field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListPropertiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListPropertiesPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListPropertiesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_properties requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListPropertiesResponse object, and provides an __iter__ method to iterate through its properties field.

If there are more pages, the __iter__ method will make additional ListProperties requests and continue to iterate through the properties field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListPropertiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListUserLinksResponse object, and provides an __aiter__ method to iterate through its user_links field.

If there are more pages, the __aiter__ method will make additional ListUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.ListUserLinksPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.ListUserLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_user_links requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.ListUserLinksResponse object, and provides an __iter__ method to iterate through its user_links field.

If there are more pages, the __iter__ method will make additional ListUserLinks requests and continue to iterate through the user_links field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.ListUserLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsAsyncPager(method: Callable[[...], Awaitable[google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsResponse]], request: google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_change_history_events requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsResponse object, and provides an __aiter__ method to iterate through its change_history_events field.

If there are more pages, the __aiter__ method will make additional SearchChangeHistoryEvents requests and continue to iterate through the change_history_events field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.analytics.admin_v1alpha.services.analytics_admin_service.pagers.SearchChangeHistoryEventsPager(method: Callable[[...], google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsResponse], request: google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsRequest, response: google.analytics.admin_v1alpha.types.analytics_admin.SearchChangeHistoryEventsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through search_change_history_events requests.

This class thinly wraps an initial google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsResponse object, and provides an __iter__ method to iterate through its change_history_events field.

If there are more pages, the __iter__ method will make additional SearchChangeHistoryEvents requests and continue to iterate through the change_history_events field on the corresponding responses.

All the usual google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters