Class RunReportRequest

The request to generate a report.

Inheritance

System.Object

RunReportRequest

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 RunReportRequest : 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

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.

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

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>

Limit

The number of rows to return. If the limit parameter is unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. To learn more about this pagination parameter, see Pagination.

Declaration

[JsonProperty("limit")]
public virtual long? Limit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

MetricAggregations

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

Declaration

[JsonProperty("metricAggregations")]
public virtual IList<string> MetricAggregations { get; set; }

Property Value

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

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

Declaration

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

Property Value

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

Offset

The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see Pagination.

Declaration

[JsonProperty("offset")]
public virtual long? Offset { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

OrderBys

Specifies how rows are ordered in the response.

Declaration

[JsonProperty("orderBys")]
public virtual IList<OrderBy> OrderBys { get; set; }

Property Value

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

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