Class ResponseMetaData

Response's metadata carrying additional information about the report content.

Inheritance
object
ResponseMetaData
Implements
Inherited Members
Namespace: Google.Analytics.Data.V1Beta
Assembly: Google.Analytics.Data.V1Beta.dll
Syntax
public sealed class ResponseMetaData : IMessage<ResponseMetaData>, IEquatable<ResponseMetaData>, IDeepCloneable<ResponseMetaData>, IBufferMessage, IMessage

Constructors

ResponseMetaData()

Declaration
public ResponseMetaData()

ResponseMetaData(ResponseMetaData)

Declaration
public ResponseMetaData(ResponseMetaData other)
Parameters
Type Name Description
ResponseMetaData other

Properties

CurrencyCode

The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code.

Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.

Declaration
public string CurrencyCode { get; set; }
Property Value
Type Description
string

DataLossFromOtherRow

If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

Declaration
public bool DataLossFromOtherRow { get; set; }
Property Value
Type Description
bool

EmptyReason

If empty reason is specified, the report is empty for this reason.

Declaration
public string EmptyReason { get; set; }
Property Value
Type Description
string

HasCurrencyCode

Gets whether the "currency_code" field is set

Declaration
public bool HasCurrencyCode { get; }
Property Value
Type Description
bool

HasEmptyReason

Gets whether the "empty_reason" field is set

Declaration
public bool HasEmptyReason { get; }
Property Value
Type Description
bool

HasSubjectToThresholding

Gets whether the "subject_to_thresholding" field is set

Declaration
public bool HasSubjectToThresholding { get; }
Property Value
Type Description
bool

HasTimeZone

Gets whether the "time_zone" field is set

Declaration
public bool HasTimeZone { get; }
Property Value
Type Description
bool

SamplingMetadatas

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

Declaration
public RepeatedField<SamplingMetadata> SamplingMetadatas { get; }
Property Value
Type Description
RepeatedField<SamplingMetadata>

SchemaRestrictionResponse

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

Declaration
public ResponseMetaData.Types.SchemaRestrictionResponse SchemaRestrictionResponse { get; set; }
Property Value
Type Description
ResponseMetaData.Types.SchemaRestrictionResponse

SubjectToThresholding

If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see Data thresholds.

Declaration
public bool SubjectToThresholding { get; set; }
Property Value
Type Description
bool

TimeZone

The property's current timezone. Intended to be used to interpret time-based dimensions like hour and minute. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Declaration
public string TimeZone { get; set; }
Property Value
Type Description
string