Google Analytics Data V1alpha Client - Class RunReportRequest (0.9.5)

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.

Parameters
NameDescription
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 and displayed.

↳ metrics array<Google\Analytics\Data\V1alpha\Metric>

The metrics requested and displayed.

↳ 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 array<Google\Analytics\Data\V1alpha\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 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
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\Entity
Returns
TypeDescription
$this

getDimensions

The dimensions requested and displayed.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDimensions

The dimensions requested and displayed.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Dimension>
Returns
TypeDescription
$this

getMetrics

The metrics requested and displayed.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetrics

The metrics requested and displayed.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\Metric>
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\DateRange>
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getMetricAggregations

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

Returns
TypeDescription
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
NameDescription
var int[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\FilterExpression
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\FilterExpression
Returns
TypeDescription
$this

getOrderBys

Specifies how rows are ordered in the response.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setOrderBys

Specifies how rows are ordered in the response.

Parameter
NameDescription
var array<Google\Analytics\Data\V1alpha\OrderBy>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getCohortSpec

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

Returns
TypeDescription
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
NameDescription
var Google\Analytics\Data\V1alpha\CohortSpec
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getReturnPropertyQuota

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

Returns
TypeDescription
bool

setReturnPropertyQuota

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this