Google Analytics Data V1beta Client - Class RunReportRequest (0.12.0)

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

The request to generate a report.

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

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 and displayed.
`↳ metrics`	`array<Google\Analytics\Data\V1beta\Metric>` The metrics requested and displayed.
`↳ date_ranges`	`array<Google\Analytics\Data\V1beta\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.
`↳ dimension_filter`	`Google\Analytics\Data\V1beta\FilterExpression` 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`	`Google\Analytics\Data\V1beta\FilterExpression` 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` 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` The 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`	`array` Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
`↳ order_bys`	`array<Google\Analytics\Data\V1beta\OrderBy>` Specifies how rows are ordered in the response.
`↳ 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.

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDimensions

The dimensions requested and displayed.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDimensions

The dimensions requested and displayed.

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1beta\Dimension>`

Returns
Type	Description
`$this`

getMetrics

The metrics requested and displayed.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMetrics

The metrics requested and displayed.

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1beta\Metric>`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDateRanges

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1beta\DateRange>`

Returns
Type	Description
`$this`

getDimensionFilter

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
`Google\Analytics\Data\V1beta\FilterExpression\|null`

hasDimensionFilter

clearDimensionFilter

setDimensionFilter

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`	`Google\Analytics\Data\V1beta\FilterExpression`

Returns
Type	Description
`$this`

getMetricFilter

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
`Google\Analytics\Data\V1beta\FilterExpression\|null`

hasMetricFilter

clearMetricFilter

setMetricFilter

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`	`Google\Analytics\Data\V1beta\FilterExpression`

Returns
Type	Description
`$this`

getOffset

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

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getLimit

The 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

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getMetricAggregations

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMetricAggregations

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

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getOrderBys

Specifies how rows are ordered in the response.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setOrderBys

Specifies how rows are ordered in the response.

Parameter
Name	Description
`var`	`array<Google\Analytics\Data\V1beta\OrderBy>`

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.

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`