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: google.auth.credentials.Credentials = None, transport: Union[str, google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[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 (Union[str, BetaAnalyticsDataTransport]) – 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.

async batch_run_pivot_reports(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
Returns

The batch response containing multiple pivot reports.

Return type

google.analytics.data_v1beta.types.BatchRunPivotReportsResponse

async batch_run_reports(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
Returns

The batch response containing multiple reports.

Return type

google.analytics.data_v1beta.types.BatchRunReportsResponse

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.

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_metadata(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters

  • request (google.analytics.data_v1beta.types.GetMetadataRequest) – 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 and metrics currently accepted in reporting methods.

Return type

google.analytics.data_v1beta.types.Metadata

get_transport_class() → 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.

static metadata_path(property: str) → str

Returns a fully-qualified metadata string.

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 run_pivot_report(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
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[google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportResponse[source]

The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

Parameters
Returns

The response realtime report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunRealtimeReportResponse

async run_report(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.RunReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

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

class google.analytics.data_v1beta.services.beta_analytics_data.BetaAnalyticsDataClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.analytics.data_v1beta.services.beta_analytics_data.transports.base.BetaAnalyticsDataTransport]] = 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]

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 (Union[str, BetaAnalyticsDataTransport]) – 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.

batch_run_pivot_reports(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
Returns

The batch response containing multiple pivot reports.

Return type

google.analytics.data_v1beta.types.BatchRunPivotReportsResponse

batch_run_reports(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.BatchRunReportsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters
Returns

The batch response containing multiple reports.

Return type

google.analytics.data_v1beta.types.BatchRunReportsResponse

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.

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_metadata(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

Parameters

  • request (google.analytics.data_v1beta.types.GetMetadataRequest) – 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 and metrics currently accepted in reporting methods.

Return type

google.analytics.data_v1beta.types.Metadata

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

Returns a fully-qualified metadata string.

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.

run_pivot_report(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

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[google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.analytics.data_v1beta.types.analytics_data_api.RunRealtimeReportResponse[source]

The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

Parameters
Returns

The response realtime report table corresponding to a request.

Return type

google.analytics.data_v1beta.types.RunRealtimeReportResponse

run_report(request: Optional[google.analytics.data_v1beta.types.analytics_data_api.RunReportRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, 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.

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