Google Analytics Data V1alpha Client - Class RunReportRequest (0.24.0)

0.24.0 (latest) 0.23.3 0.22.3 0.21.1 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 RunReportRequest.

The request to generate a report.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ property	string Required. A Google Analytics 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<Dimension> Optional. The dimensions requested and displayed.
↳ metrics	array<Metric> Optional. The metrics requested and displayed.
↳ date_ranges	array<DateRange> Optional. 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.
↳ dimension_filter	FilterExpression Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
↳ metric_filter	FilterExpression Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
↳ offset	int|string Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows. To learn more about this pagination parameter, see Pagination.
↳ limit	int|string Optional. The maximum number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive. The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination.
↳ metric_aggregations	int[] Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges.
↳ order_bys	array<OrderBy> Optional. Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons.
↳ currency_code	string Optional. 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	CohortSpec Optional. 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 Optional. 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 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 Optional. Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in PropertyQuota.
↳ comparisons	array<Comparison> Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.
↳ conversion_spec	ConversionSpec Optional. Controls conversion reporting. This field is optional. If this field is set or any conversion metrics are requested, the report will be a conversion report.

getProperty

Required. A Google Analytics 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

Required. A Google Analytics 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

Optional. The dimensions requested and displayed.

Returns
Type	Description
Google\Protobuf\RepeatedField<Dimension>

setDimensions

Optional. The dimensions requested and displayed.

Parameter
Name	Description
var	array<Dimension>

Returns
Type	Description
$this

getMetrics

Optional. The metrics requested and displayed.

Returns
Type	Description
Google\Protobuf\RepeatedField<Metric>

setMetrics

Optional. The metrics requested and displayed.

Parameter
Name	Description
var	array<Metric>

Returns
Type	Description
$this

getDateRanges

Optional. 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.

Returns
Type	Description
Google\Protobuf\RepeatedField<DateRange>

setDateRanges

Optional. 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.

Parameter
Name	Description
var	array<DateRange>

Returns
Type	Description
$this

getDimensionFilter

Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

Returns
Type	Description
FilterExpression|null

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

Parameter
Name	Description
var	FilterExpression

Returns
Type	Description
$this

getMetricFilter

Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

Returns
Type	Description
FilterExpression|null

hasMetricFilter

clearMetricFilter

setMetricFilter

Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

Parameter
Name	Description
var	FilterExpression

Returns
Type	Description
$this

getOffset

Optional. The row count of the start row. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows. To learn more about this pagination parameter, see Pagination.

Returns
Type	Description
int|string

setOffset

Optional. The row count of the start row. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows. To learn more about this pagination parameter, see Pagination.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getLimit

Optional. The maximum number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination.

Returns
Type	Description
int|string

setLimit

Optional. The maximum number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value. To learn more about this pagination parameter, see Pagination.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMetricAggregations

Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges.

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setMetricAggregations

Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".

Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getOrderBys

Optional. Specifies how rows are ordered in the response.

Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons.

Returns
Type	Description
Google\Protobuf\RepeatedField<OrderBy>

setOrderBys

Optional. Specifies how rows are ordered in the response.

Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons.

Parameter
Name	Description
var	array<OrderBy>

Returns
Type	Description
$this

getCurrencyCode

Optional. 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

Optional. 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

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

Returns
Type	Description
CohortSpec|null

hasCohortSpec

clearCohortSpec

setCohortSpec

Optional. 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	CohortSpec

Returns
Type	Description
$this

getKeepEmptyRows

Optional. 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 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

Optional. 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 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

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

Returns
Type	Description
bool

setReturnPropertyQuota

Optional. Toggles whether to return the current state of this Google 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 only requires a comparisons field in order to receive a comparison column in the response.

Returns
Type	Description
Google\Protobuf\RepeatedField<Comparison>

setComparisons

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

Parameter
Name	Description
var	array<Comparison>

Returns
Type	Description
$this

getConversionSpec

Optional. Controls conversion reporting. This field is optional. If this field is set or any conversion metrics are requested, the report will be a conversion report.

Returns
Type	Description
ConversionSpec|null

hasConversionSpec

clearConversionSpec

setConversionSpec

Optional. Controls conversion reporting. This field is optional. If this field is set or any conversion metrics are requested, the report will be a conversion report.

Parameter
Name	Description
var	ConversionSpec

Returns
Type	Description
$this