Google Analytics Data V1beta Client - Class RunPivotReportRequest (0.18.0)

Reference documentation and code samples for the Google Analytics Data V1beta Client class RunPivotReportRequest.

The request to generate a pivot report.

Generated from protobuf message google.analytics.data.v1beta.RunPivotReportRequest

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ 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. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

↳ dimensions array<Google\Analytics\Data\V1beta\Dimension>

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

↳ metrics array<Google\Analytics\Data\V1beta\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.

↳ date_ranges array<Google\Analytics\Data\V1beta\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.

↳ pivots array<Google\Analytics\Data\V1beta\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.

↳ dimension_filter Google\Analytics\Data\V1beta\FilterExpression

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

↳ metric_filter Google\Analytics\Data\V1beta\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.

↳ currency_code string

A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

↳ cohort_spec Google\Analytics\Data\V1beta\CohortSpec

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

↳ keep_empty_rows 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. Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

↳ return_property_quota bool

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

↳ comparisons array<Google\Analytics\Data\V1beta\Comparison>

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

getProperty

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. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Returns
Type Description
string

setProperty

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. Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234

Parameter
Name Description
var string
Returns
Type Description
$this

getDimensions

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDimensions

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

Parameter
Name Description
var array<Google\Analytics\Data\V1beta\Dimension>
Returns
Type Description
$this

getMetrics

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMetrics

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.

Parameter
Name Description
var array<Google\Analytics\Data\V1beta\Metric>
Returns
Type Description
$this

getDateRanges

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDateRanges

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.

Parameter
Name Description
var array<Google\Analytics\Data\V1beta\DateRange>
Returns
Type Description
$this

getPivots

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPivots

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.

Parameter
Name Description
var array<Google\Analytics\Data\V1beta\Pivot>
Returns
Type Description
$this

getDimensionFilter

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Returns
Type Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Parameter
Name Description
var Google\Analytics\Data\V1beta\FilterExpression
Returns
Type Description
$this

getMetricFilter

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.

Returns
Type Description
Google\Analytics\Data\V1beta\FilterExpression|null

hasMetricFilter

clearMetricFilter

setMetricFilter

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.

Parameter
Name Description
var Google\Analytics\Data\V1beta\FilterExpression
Returns
Type Description
$this

getCurrencyCode

A currency code in ISO4217 format, such as "AED", "USD", "JPY".

If the field is empty, the report uses the property's default currency.

Returns
Type Description
string

setCurrencyCode

A currency code in ISO4217 format, such as "AED", "USD", "JPY".

If the field is empty, the report uses the property's default currency.

Parameter
Name Description
var string
Returns
Type Description
$this

getCohortSpec

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Returns
Type Description
Google\Analytics\Data\V1beta\CohortSpec|null

hasCohortSpec

clearCohortSpec

setCohortSpec

Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

Parameter
Name Description
var Google\Analytics\Data\V1beta\CohortSpec
Returns
Type Description
$this

getKeepEmptyRows

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.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

Returns
Type Description
bool

setKeepEmptyRows

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.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: "purchase" and eventCount: 0.

Parameter
Name Description
var bool
Returns
Type Description
$this

getReturnPropertyQuota

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

Returns
Type Description
bool

setReturnPropertyQuota

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

Parameter
Name Description
var bool
Returns
Type Description
$this

getComparisons

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setComparisons

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

Parameter
Name Description
var array<Google\Analytics\Data\V1beta\Comparison>
Returns
Type Description
$this