Class RunPivotReportRequest

The request to generate a pivot report.

Inheritance
object
RunPivotReportRequest
Implements
Inherited Members
Namespace: Google.Analytics.Data.V1Beta
Assembly: Google.Analytics.Data.V1Beta.dll
Syntax
public sealed class RunPivotReportRequest : IMessage<RunPivotReportRequest>, IEquatable<RunPivotReportRequest>, IDeepCloneable<RunPivotReportRequest>, IBufferMessage, IMessage

Constructors

RunPivotReportRequest()

Declaration
public RunPivotReportRequest()

RunPivotReportRequest(RunPivotReportRequest)

Declaration
public RunPivotReportRequest(RunPivotReportRequest other)
Parameters
Type Name Description
RunPivotReportRequest other

Properties

CohortSpec

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

Declaration
public CohortSpec CohortSpec { get; set; }
Property Value
Type Description
CohortSpec

Comparisons

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.

Declaration
public RepeatedField<Comparison> Comparisons { get; }
Property Value
Type Description
RepeatedField<Comparison>

CurrencyCode

A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency.

Declaration
public string CurrencyCode { get; set; }
Property Value
Type Description
string

DateRanges

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.

Declaration
public RepeatedField<DateRange> DateRanges { get; }
Property Value
Type Description
RepeatedField<DateRange>

DimensionFilter

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

Declaration
public FilterExpression DimensionFilter { get; set; }
Property Value
Type Description
FilterExpression

Dimensions

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

Declaration
public RepeatedField<Dimension> Dimensions { get; }
Property Value
Type Description
RepeatedField<Dimension>

KeepEmptyRows

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.

Declaration
public bool KeepEmptyRows { get; set; }
Property Value
Type Description
bool

MetricFilter

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.

Declaration
public FilterExpression MetricFilter { get; set; }
Property Value
Type Description
FilterExpression

Metrics

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.

Declaration
public RepeatedField<Metric> Metrics { get; }
Property Value
Type Description
RepeatedField<Metric>

Pivots

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.

Declaration
public RepeatedField<Pivot> Pivots { get; }
Property Value
Type Description
RepeatedField<Pivot>

Property

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

Declaration
public string Property { get; set; }
Property Value
Type Description
string

ReturnPropertyQuota

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

Declaration
public bool ReturnPropertyQuota { get; set; }
Property Value
Type Description
bool