Google Analytics Data V1alpha Client - Class AlphaAnalyticsDataClient (0.13.0)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class AlphaAnalyticsDataClient.

Service Description: Google Analytics reporting data service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->batchRunPivotReports();
} finally {
    $alphaAnalyticsDataClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ serviceAddress`	`string` Deprecated. This option will be removed in a future major release. Please utilize the `$apiEndpoint` option instead.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $serviceAddress setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchRunPivotReports

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

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->batchRunPivotReports();
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ entity`	`Entity` A property whose events are tracked. This entity must be specified for the batch. The entity within RunPivotReportRequest may either be unspecified or consistent with this entity.
`↳ requests`	`RunPivotReportRequest[]` Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\BatchRunPivotReportsResponse`

batchRunReports

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

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->batchRunReports();
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ entity`	`Entity` A property whose events are tracked. This entity must be specified for the batch. The entity within RunReportRequest may either be unspecified or consistent with this entity.
`↳ requests`	`RunReportRequest[]` Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\BatchRunReportsResponse`

getMetadata

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.

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $formattedName = $alphaAnalyticsDataClient->metadataName('[PROPERTY]');
    $response = $alphaAnalyticsDataClient->getMetadata($formattedName);
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`name`	`string` 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.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\Metadata`

runPivotReport

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.

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->runPivotReport();
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ entity`	`Entity` A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.
`↳ dimensions`	`Dimension[]` The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
`↳ metrics`	`Metric[]` The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.
`↳ dimensionFilter`	`FilterExpression` The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
`↳ metricFilter`	`FilterExpression` The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
`↳ pivots`	`Pivot[]` Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.
`↳ dateRanges`	`DateRange[]` The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.
`↳ currencyCode`	`string` A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.
`↳ cohortSpec`	`CohortSpec` Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
`↳ keepEmptyRows`	`bool` If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
`↳ returnPropertyQuota`	`bool` Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\RunPivotReportResponse`

runRealtimeReport

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.

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->runRealtimeReport();
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ property`	`string` A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Example: properties/1234
`↳ dimensions`	`Dimension[]` The dimensions requested and displayed.
`↳ metrics`	`Metric[]` The metrics requested and displayed.
`↳ limit`	`int` The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.
`↳ dimensionFilter`	`FilterExpression` The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
`↳ metricFilter`	`FilterExpression` The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
`↳ metricAggregations`	`int[]` Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". For allowed values, use constants defined on Google\Analytics\Data\V1alpha\MetricAggregation
`↳ orderBys`	`OrderBy[]` Specifies how rows are ordered in the response.
`↳ returnPropertyQuota`	`bool` Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in PropertyQuota.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\RunRealtimeReportResponse`

runReport

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.

Sample code:

$alphaAnalyticsDataClient = new AlphaAnalyticsDataClient();
try {
    $response = $alphaAnalyticsDataClient->runReport();
} finally {
    $alphaAnalyticsDataClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ entity`	`Entity` A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.
`↳ dimensions`	`Dimension[]` The dimensions requested and displayed.
`↳ metrics`	`Metric[]` The metrics requested and displayed.
`↳ dateRanges`	`DateRange[]` Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.
`↳ offset`	`int` The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see Pagination.
`↳ limit`	`int` The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see Pagination.
`↳ metricAggregations`	`int[]` Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". For allowed values, use constants defined on Google\Analytics\Data\V1alpha\MetricAggregation
`↳ dimensionFilter`	`FilterExpression` The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
`↳ metricFilter`	`FilterExpression` The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.
`↳ orderBys`	`OrderBy[]` Specifies how rows are ordered in the response.
`↳ currencyCode`	`string` A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the entity's default currency.
`↳ cohortSpec`	`CohortSpec` Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
`↳ keepEmptyRows`	`bool` If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.
`↳ returnPropertyQuota`	`bool` Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\Analytics\Data\V1alpha\Gapic\Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Analytics\Data\V1alpha\RunReportResponse`

static::metadataName

Formats a string containing the fully-qualified path to represent a metadata resource.

Parameter
Name	Description
`property`	`string`

Returns
Type	Description
`string`	The formatted metadata resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

metadata: properties/{property}/metadata

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.analytics.data.v1alpha.AlphaAnalyticsData'

The name of the service.

SERVICE_ADDRESS

Value: 'analyticsdata.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.