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.

BetaAnalyticsData

class google.analytics.data_v1beta.services.beta_analytics_data.BetaAnalyticsDataAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport, typing.Callable[[...], google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Google Analytics reporting data service.

Instantiates the beta analytics data async client.

Parameters

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

  • transport (Optional[Union[str,BetaAnalyticsDataTransport,Callable[..., BetaAnalyticsDataTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the BetaAnalyticsDataTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

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

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

Raises

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

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static audience_export_path(property: str, audience_export: str) → str

Returns a fully-qualified audience_export string.

async batch_run_pivot_reports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsResponse[source]

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_batch_run_pivot_reports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.BatchRunPivotReportsRequest(
    )

    # Make the request
    response = await client.batch_run_pivot_reports(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.BatchRunPivotReportsRequest, dict]]) – The request object. The batch request containing multiple pivot report requests.

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

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

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

Returns

The batch response containing multiple pivot reports.

Return type

google.analytics.data_v1beta.types.BatchRunPivotReportsResponse

async batch_run_reports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsResponse[source]

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_batch_run_reports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.BatchRunReportsRequest(
    )

    # Make the request
    response = await client.batch_run_reports(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.BatchRunReportsRequest, dict]]) – The request object. The batch request containing multiple report requests.

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

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

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

Returns

The batch response containing multiple reports.

Return type

google.analytics.data_v1beta.types.BatchRunReportsResponse

async check_compatibility(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.CheckCompatibilityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.CheckCompatibilityResponse[source]

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request’s dimensions and metrics are incompatible.

In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_check_compatibility():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.CheckCompatibilityRequest(
    )

    # Make the request
    response = await client.check_compatibility(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.CheckCompatibilityRequest, dict]]) – The request object. The request for compatibility information for a report’s dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the runReport request should be the same values as in your runReport request.

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

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

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

Returns

The compatibility response with the compatibility of each dimension & metric.

Return type

google.analytics.data_v1beta.types.CheckCompatibilityResponse

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.

async create_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.CreateAudienceExportRequest, dict]] = None, *, parent: Optional[str] = None, audience_export: Optional[google.analytics.data_v1beta.types.analytics_data_api.AudienceExport] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]

Creates an audience export for later retrieval. This method quickly returns the audience export’s resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method.

See Creating an Audience Export for an introduction to Audience Exports with examples.

An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_create_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    audience_export = data_v1beta.AudienceExport()
    audience_export.audience = "audience_value"

    request = data_v1beta.CreateAudienceExportRequest(
        parent="parent_value",
        audience_export=audience_export,
    )

    # Make the request
    operation = client.create_audience_export(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.CreateAudienceExportRequest, dict]]) – The request object. A request to create a new audience export.

  • parent (str) –

    Required. The parent resource where this audience export will be created. Format: properties/{property}

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

  • audience_export (google.analytics.data_v1beta.types.AudienceExport) –

    Required. The audience export to create.

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

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

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

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

Returns

An object representing a long-running operation.

The result type for the operation will be google.analytics.data_v1beta.types.AudienceExport An audience export is a list of users in an audience at the time of the

list’s creation. One audience may have multiple audience exports created for different days.

Return type

google.api_core.operation_async.AsyncOperation

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

BetaAnalyticsDataAsyncClient

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

BetaAnalyticsDataAsyncClient

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

BetaAnalyticsDataAsyncClient

async get_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.GetAudienceExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.AudienceExport[source]

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_get_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.GetAudienceExportRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_audience_export(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.GetAudienceExportRequest, dict]]) – The request object. A request to retrieve configuration metadata about a specific audience export.

  • name (str) –

    Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}

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

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

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

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

Returns

An audience export is a list of users in an audience at the time of the list’s creation. One audience may have multiple audience exports created for different days.

Return type

google.analytics.data_v1beta.types.AudienceExport

async get_metadata(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.Metadata[source]

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata.

For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_get_metadata():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.GetMetadataRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_metadata(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.GetMetadataRequest, dict]]) – The request object. Request for a property’s dimension and metric metadata.

  • name (str) –

    Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

    Example: properties/1234/metadata

    Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

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

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

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

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

Returns

The dimensions, metrics and comparisons currently accepted in reporting methods.

Return type

google.analytics.data_v1beta.types.Metadata

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

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

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

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

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

Parameters

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

Returns

returns the API endpoint and the

client cert source to use.

Return type

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

Raises

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

classmethod get_transport_class(label: Optional[str] = None) → Type[google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport]

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.

async list_audience_exports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsAsyncPager[source]

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_list_audience_exports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.ListAudienceExportsRequest(
        parent="parent_value",
    )

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

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

  • request (Optional[Union[google.analytics.data_v1beta.types.ListAudienceExportsRequest, dict]]) – The request object. A request to list all audience exports for a property.

  • parent (str) –

    Required. All audience exports for this property will be listed in the response. Format: properties/{property}

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

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

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

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

Returns

A list of all audience exports for a property. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsAsyncPager

static metadata_path(property: str) → str

Returns a fully-qualified metadata string.

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

Parses a audience_export 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_metadata_path(path: str) → Dict[str, str]

Parses a metadata path into its component segments.

async query_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.QueryAudienceExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.QueryAudienceExportResponse[source]

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_query_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.QueryAudienceExportRequest(
        name="name_value",
    )

    # Make the request
    response = await client.query_audience_export(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.QueryAudienceExportRequest, dict]]) – The request object. A request to list users in an audience export.

  • name (str) –

    Required. The name of the audience export to retrieve users from. Format: properties/{property}/audienceExports/{audience_export}

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

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

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

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

Returns

A list of users in an audience export.

Return type

google.analytics.data_v1beta.types.QueryAudienceExportResponse

async run_pivot_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportResponse[source]

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_run_pivot_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.RunPivotReportRequest(
    )

    # Make the request
    response = await client.run_pivot_report(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.RunPivotReportRequest, dict]]) – The request object. The request to generate a pivot report.

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

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

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

Returns

The response pivot report table corresponding to a pivot request.

Return type

google.analytics.data_v1beta.types.RunPivotReportResponse

async run_realtime_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportResponse[source]

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties).

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_run_realtime_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.RunRealtimeReportRequest(
    )

    # Make the request
    response = await client.run_realtime_report(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.RunRealtimeReportRequest, dict]]) – The request object. The request to generate a realtime report.

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

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

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

Returns

The response realtime report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunRealtimeReportResponse

async run_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunReportResponse[source]

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

For a guide to constructing requests & understanding responses, see Creating a Report.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

async def sample_run_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataAsyncClient()

    # Initialize request argument(s)
    request = data_v1beta.RunReportRequest(
    )

    # Make the request
    response = await client.run_report(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.analytics.data_v1beta.types.RunReportRequest, dict]]) – The request object. The request to generate a report.

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

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

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

Returns

The response report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunReportResponse

property transport: google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

BetaAnalyticsDataTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

class google.analytics.data_v1beta.services.beta_analytics_data.BetaAnalyticsDataClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport, typing.Callable[[...], google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Google Analytics reporting data service.

Instantiates the beta analytics data 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 (Optional[Union[str,BetaAnalyticsDataTransport,Callable[..., BetaAnalyticsDataTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the BetaAnalyticsDataTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

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

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

Raises

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

__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!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static audience_export_path(property: str, audience_export: str) → str[source]

Returns a fully-qualified audience_export string.

batch_run_pivot_reports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsResponse[source]

Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_batch_run_pivot_reports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.BatchRunPivotReportsRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Returns

The batch response containing multiple pivot reports.

Return type

google.analytics.data_v1beta.types.BatchRunPivotReportsResponse

batch_run_reports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsResponse[source]

Returns multiple reports in a batch. All reports must be for the same GA4 Property.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_batch_run_reports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.BatchRunReportsRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Returns

The batch response containing multiple reports.

Return type

google.analytics.data_v1beta.types.BatchRunReportsResponse

check_compatibility(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.CheckCompatibilityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.CheckCompatibilityResponse[source]

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request’s dimensions and metrics are incompatible.

In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible.

The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_check_compatibility():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.CheckCompatibilityRequest(
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.data_v1beta.types.CheckCompatibilityRequest, dict]) – The request object. The request for compatibility information for a report’s dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the runReport request should be the same values as in your runReport request.

  • 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

The compatibility response with the compatibility of each dimension & metric.

Return type

google.analytics.data_v1beta.types.CheckCompatibilityResponse

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.

create_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.CreateAudienceExportRequest, dict]] = None, *, parent: Optional[str] = None, audience_export: Optional[google.analytics.data_v1beta.types.analytics_data_api.AudienceExport] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]

Creates an audience export for later retrieval. This method quickly returns the audience export’s resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the QueryAudienceExport method.

See Creating an Audience Export for an introduction to Audience Exports with examples.

An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_create_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    audience_export = data_v1beta.AudienceExport()
    audience_export.audience = "audience_value"

    request = data_v1beta.CreateAudienceExportRequest(
        parent="parent_value",
        audience_export=audience_export,
    )

    # Make the request
    operation = client.create_audience_export(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.data_v1beta.types.CreateAudienceExportRequest, dict]) – The request object. A request to create a new audience export.

  • parent (str) –

    Required. The parent resource where this audience export will be created. Format: properties/{property}

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

  • audience_export (google.analytics.data_v1beta.types.AudienceExport) –

    Required. The audience export to create.

    This corresponds to the audience_export 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

An object representing a long-running operation.

The result type for the operation will be google.analytics.data_v1beta.types.AudienceExport An audience export is a list of users in an audience at the time of the

list’s creation. One audience may have multiple audience exports created for different days.

Return type

google.api_core.operation.Operation

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

BetaAnalyticsDataClient

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

BetaAnalyticsDataClient

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

BetaAnalyticsDataClient

get_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.GetAudienceExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.AudienceExport[source]

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_get_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.GetAudienceExportRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.data_v1beta.types.GetAudienceExportRequest, dict]) – The request object. A request to retrieve configuration metadata about a specific audience export.

  • name (str) –

    Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}

    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

An audience export is a list of users in an audience at the time of the list’s creation. One audience may have multiple audience exports created for different days.

Return type

google.analytics.data_v1beta.types.AudienceExport

get_metadata(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.Metadata[source]

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata.

For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_get_metadata():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.GetMetadataRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.data_v1beta.types.GetMetadataRequest, dict]) – The request object. Request for a property’s dimension and metric metadata.

  • name (str) –

    Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

    Example: properties/1234/metadata

    Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

    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

The dimensions, metrics and comparisons currently accepted in reporting methods.

Return type

google.analytics.data_v1beta.types.Metadata

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

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

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

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

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

Parameters

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

Returns

returns the API endpoint and the

client cert source to use.

Return type

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

Raises

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

list_audience_exports(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsPager[source]

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_list_audience_exports():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.ListAudienceExportsRequest(
        parent="parent_value",
    )

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

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

  • request (Union[google.analytics.data_v1beta.types.ListAudienceExportsRequest, dict]) – The request object. A request to list all audience exports for a property.

  • parent (str) –

    Required. All audience exports for this property will be listed in the response. Format: properties/{property}

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

  • retry (google.api_core.retry.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 list of all audience exports for a property. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.analytics.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsPager

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

Returns a fully-qualified metadata string.

static parse_audience_export_path(path: str) → Dict[str, str][source]

Parses a audience_export 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_metadata_path(path: str) → Dict[str, str][source]

Parses a metadata path into its component segments.

query_audience_export(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.QueryAudienceExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.QueryAudienceExportResponse[source]

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to CreateAudienceExport is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export.

See Creating an Audience Export for an introduction to Audience Exports with examples.

Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_query_audience_export():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.QueryAudienceExportRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters

  • request (Union[google.analytics.data_v1beta.types.QueryAudienceExportRequest, dict]) – The request object. A request to list users in an audience export.

  • name (str) –

    Required. The name of the audience export to retrieve users from. Format: properties/{property}/audienceExports/{audience_export}

    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 list of users in an audience export.

Return type

google.analytics.data_v1beta.types.QueryAudienceExportResponse

run_pivot_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportResponse[source]

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_run_pivot_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.RunPivotReportRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Returns

The response pivot report table corresponding to a pivot request.

Return type

google.analytics.data_v1beta.types.RunPivotReportResponse

run_realtime_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportResponse[source]

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties).

For a guide to constructing realtime requests & understanding responses, see Creating a Realtime Report.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_run_realtime_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.RunRealtimeReportRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Returns

The response realtime report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunRealtimeReportResponse

run_report(request: Optional[Union[google.analytics.data_v1beta.types.analytics_data_api.RunReportRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunReportResponse[source]

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.

For a guide to constructing requests & understanding responses, see Creating a Report.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.analytics import data_v1beta

def sample_run_report():
    # Create a client
    client = data_v1beta.BetaAnalyticsDataClient()

    # Initialize request argument(s)
    request = data_v1beta.RunReportRequest(
    )

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

    # Handle the response
    print(response)
Parameters
Returns

The response report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunReportResponse

property transport: google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

BetaAnalyticsDataTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

class google.analytics.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsAsyncPager(method: Callable[[...], Awaitable[google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsResponse]], request: google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsRequest, response: google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_audience_exports requests.

This class thinly wraps an initial google.analytics.data_v1beta.types.ListAudienceExportsResponse object, and provides an __aiter__ method to iterate through its audience_exports field.

If there are more pages, the __aiter__ method will make additional ListAudienceExports requests and continue to iterate through the audience_exports field on the corresponding responses.

All the usual google.analytics.data_v1beta.types.ListAudienceExportsResponse 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.data_v1beta.services.beta_analytics_data.pagers.ListAudienceExportsPager(method: Callable[[...], google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsResponse], request: google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsRequest, response: google.analytics.data_v1beta.types.analytics_data_api.ListAudienceExportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_audience_exports requests.

This class thinly wraps an initial google.analytics.data_v1beta.types.ListAudienceExportsResponse object, and provides an __iter__ method to iterate through its audience_exports field.

If there are more pages, the __iter__ method will make additional ListAudienceExports requests and continue to iterate through the audience_exports field on the corresponding responses.

All the usual google.analytics.data_v1beta.types.ListAudienceExportsResponse 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