Class RunReportRequest

The request to generate a report.

Inheritance

System.Object

RunReportRequest

Implements

Google.Protobuf.IMessage<RunReportRequest>

System.IEquatable<RunReportRequest>

Google.Protobuf.IDeepCloneable<RunReportRequest>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage

Inherited Members

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.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 property'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

Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. 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>

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,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren't as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.

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

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

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>

Property

A Google Analytics GA4 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
System.String

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