Google Analytics Data V1beta Client - Class RunPivotReportRequest (0.21.1)

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

The request to generate a pivot report.

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

Constructor.

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

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

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

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.

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.

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.

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.

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.

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.

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

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.

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.

A currency code in ISO4217 format, such as "AED", "USD", "JPY".

If the field is empty, the report uses the property's default currency.

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 group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present.

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

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.

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.

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

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

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

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