Reference documentation and code samples for the Google Analytics Data V1alpha Client class RunReportRequest.
The request to generate a report.
Generated from protobuf message google.analytics.data.v1alpha.RunReportRequest
Methods
__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
↳ metrics
↳ date_ranges
array< Google\Analytics\Data\V1alpha\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|string
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|string
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 .
↳ metric_aggregations
int[]
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
↳ 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.
↳ order_bys
↳ 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 and displayed.
setDimensions
The dimensions requested and displayed.
$this
getMetrics
The metrics requested and displayed.
setMetrics
The metrics requested and displayed.
$this
getDateRanges
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.
setDateRanges
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.
$this
getOffset
The row count of the start row. The first row is counted as row 0.
To learn more about this pagination parameter, see Pagination .
int|string
setOffset
The row count of the start row. The first row is counted as row 0.
To learn more about this pagination parameter, see Pagination .
var
int|string
$this
getLimit
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 .
int|string
setLimit
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 .
var
int|string
$this
getMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
setMetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
var
int[]
$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
getOrderBys
Specifies how rows are ordered in the response.
setOrderBys
Specifies how rows are ordered in the response.
$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
