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 \ V1alphaMethods
__construct
Constructor.
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.
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.
$this
getDimensions
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
setDimensions
The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.
$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.
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.
$this
getDimensionFilter
The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.
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.
$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.
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.
$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.
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.
$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.
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.
$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.
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.
var
string
$this
getCohortSpec
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
hasCohortSpec
clearCohortSpec
setCohortSpec
Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.
$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.
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.
var
bool
$this
getReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota .
bool
setReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota .
var
bool
$this
