Class RunRealtimeReportRequest

The request to generate a realtime report.

Inheritance

object

RunRealtimeReportRequest

Implements

IMessage<RunRealtimeReportRequest>

IEquatable<RunRealtimeReportRequest>

IDeepCloneable<RunRealtimeReportRequest>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

public sealed class RunRealtimeReportRequest : IMessage<RunRealtimeReportRequest>, IEquatable<RunRealtimeReportRequest>, IDeepCloneable<RunRealtimeReportRequest>, IBufferMessage, IMessage

Constructors

RunRealtimeReportRequest()

Declaration

public RunRealtimeReportRequest()

RunRealtimeReportRequest(RunRealtimeReportRequest)

Declaration

public RunRealtimeReportRequest(RunRealtimeReportRequest other)

Parameters

Type	Name	Description
RunRealtimeReportRequest	other

Properties

DimensionFilter

The filter clause of dimensions. 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
RepeatedField<Dimension>

Limit

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,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.

Declaration

public long Limit { get; set; }

Property Value

Type	Description
long

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
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
RepeatedField<Metric>

MinuteRanges

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

Declaration

public RepeatedField<MinuteRange> MinuteRanges { get; }

Property Value

Type	Description
RepeatedField<MinuteRange>

OrderBys

Specifies how rows are ordered in the response.

Declaration

public RepeatedField<OrderBy> OrderBys { get; }

Property Value

Type	Description
RepeatedField<OrderBy>

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.

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 Realtime quota. Quota is returned in PropertyQuota.

Declaration

public bool ReturnPropertyQuota { get; set; }

Property Value

Type	Description
bool