Class RunReportRequest
The request to generate a report.
Inheritance
Implements
Inherited Members
Namespace: Google.Analytics.Data.V1Alpha
Assembly: Google.Analytics.Data.V1Alpha.dll
Syntax
public sealed class RunReportRequest : IMessage<RunReportRequest>, IEquatable<RunReportRequest>, IDeepCloneable<RunReportRequest>, IBufferMessage, IMessage
Constructors
RunReportRequest()
Declaration
public RunReportRequest()
RunReportRequest(RunReportRequest)
Declaration
public RunReportRequest(RunReportRequest other)
Parameters
Type | Name | Description |
---|---|---|
RunReportRequest | 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 |
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
public 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
public RepeatedField<DateRange> DateRanges { get; }
Property Value
Type | Description |
---|---|
Google.Protobuf.Collections.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 and displayed.
Declaration
public RepeatedField<Dimension> Dimensions { get; }
Property Value
Type | Description |
---|---|
Google.Protobuf.Collections.RepeatedField<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
public Entity Entity { get; set; }
Property Value
Type | Description |
---|---|
Entity |
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
public bool KeepEmptyRows { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Limit
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.
Declaration
public long Limit { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
MetricAggregations
Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
Declaration
public RepeatedField<MetricAggregation> MetricAggregations { get; }
Property Value
Type | Description |
---|---|
Google.Protobuf.Collections.RepeatedField<MetricAggregation> |
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 and displayed.
Declaration
public RepeatedField<Metric> Metrics { get; }
Property Value
Type | Description |
---|---|
Google.Protobuf.Collections.RepeatedField<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
public long Offset { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
OrderBys
Specifies how rows are ordered in the response.
Declaration
public RepeatedField<OrderBy> OrderBys { get; }
Property Value
Type | Description |
---|---|
Google.Protobuf.Collections.RepeatedField<OrderBy> |
ReturnPropertyQuota
Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in PropertyQuota.
Declaration
public bool ReturnPropertyQuota { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |