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

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[Union[google.analytics.data_v1beta.types.analytics_data_api.BatchRunPivotReportsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 ¶: 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[Union[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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

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.

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[Union[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.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 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[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 (Union[str, BetaAnalyticsDataTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

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

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

request (Union[google.analytics.data_v1beta.types.BatchRunPivotReportsRequest, dict]) – The request object. The batch request containing multiple pivot report requests.
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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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

request (Union[google.analytics.data_v1beta.types.BatchRunReportsRequest, dict]) – The request object. The batch request containing multiple report requests.
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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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.

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[Union[google.analytics.data_v1beta.types.analytics_data_api.GetMetadataRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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 and metrics 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.

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[Union[google.analytics.data_v1beta.types.analytics_data_api.RunPivotReportRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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

request (Union[google.analytics.data_v1beta.types.RunPivotReportRequest, dict]) – The request object. The request to generate a pivot report.
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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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

request (Union[google.analytics.data_v1beta.types.RunRealtimeReportRequest, dict]) – The request object. The request to generate a realtime report.
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 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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

request (Union[google.analytics.data_v1beta.types.RunReportRequest, dict]) – The request object. The request to generate a report.
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 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

BetaAnalyticsData¶

google-analytics-data

Navigation

Related Topics