Google Analytics Data V1alpha Client - Class RunPivotReportRequest (0.16.4)

Version 0.16.4

• 0.21.1 (latest)
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

The request to generate a pivot report.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ entity	Google\Analytics\Data\V1alpha\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	array<Google\Analytics\Data\V1alpha\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\V1alpha\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.
↳ dimension_filter	Google\Analytics\Data\V1alpha\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\V1alpha\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	array<Google\Analytics\Data\V1alpha\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.
↳ date_ranges	array<Google\Analytics\Data\V1alpha\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.
↳ currency_code	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.
↳ cohort_spec	Google\Analytics\Data\V1alpha\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.
↳ return_property_quota	bool Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.

getEntity

A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

Returns
Type	Description
Google\Analytics\Data\V1alpha\Entity|null

hasEntity

clearEntity

setEntity

A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

Parameter
Name	Description
var	Google\Analytics\Data\V1alpha\Entity

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\V1alpha\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\V1alpha\Metric>

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\V1alpha\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\V1alpha\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\V1alpha\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\V1alpha\FilterExpression

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\V1alpha\Pivot>

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\V1alpha\DateRange>

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 entity'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 entity'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\V1alpha\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\V1alpha\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.

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.

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