Class RunPivotReportRequest

The request to generate a pivot report.

Inheritance

System.Object

RunPivotReportRequest

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.AnalyticsData.v1alpha.Data

Assembly: Google.Apis.AnalyticsData.v1alpha.dll

Syntax

public class RunPivotReportRequest : IDirectResponseSchema

Properties

CohortSpec

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

Declaration

[JsonProperty("cohortSpec")]
public virtual CohortSpec CohortSpec { get; set; }

Property Value

Type	Description
CohortSpec

CurrencyCode

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

Declaration

[JsonProperty("currencyCode")]
public virtual string CurrencyCode { get; set; }

Property Value

Type	Description
System.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

[JsonProperty("dateRanges")]
public virtual IList<DateRange> DateRanges { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<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

[JsonProperty("dimensionFilter")]
public virtual 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

[JsonProperty("dimensions")]
public virtual IList<Dimension> Dimensions { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<Dimension>

Entity

A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity.

Declaration

[JsonProperty("entity")]
public virtual Entity Entity { get; set; }

Property Value

Type	Description
Entity

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

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.

Declaration

[JsonProperty("keepEmptyRows")]
public virtual bool? KeepEmptyRows { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

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

[JsonProperty("metricFilter")]
public virtual 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

[JsonProperty("metrics")]
public virtual IList<Metric> Metrics { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<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

[JsonProperty("pivots")]
public virtual IList<Pivot> Pivots { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<Pivot>

ReturnPropertyQuota

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

Declaration

[JsonProperty("returnPropertyQuota")]
public virtual bool? ReturnPropertyQuota { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Implements

IDirectResponseSchema