Class ResponseMetaData (0.58.0) 

public final class ResponseMetaData extends GeneratedMessageV3 implements ResponseMetaDataOrBuilder

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResponseMetaData

Static Fields

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER

public static final int DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER
Field Value
Type Description
int

EMPTY_REASON_FIELD_NUMBER

public static final int EMPTY_REASON_FIELD_NUMBER
Field Value
Type Description
int

SAMPLING_METADATAS_FIELD_NUMBER

public static final int SAMPLING_METADATAS_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER

public static final int SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_TO_THRESHOLDING_FIELD_NUMBER

public static final int SUBJECT_TO_THRESHOLDING_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResponseMetaData getDefaultInstance()
Returns
Type Description
ResponseMetaData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResponseMetaData.Builder newBuilder()
Returns
Type Description
ResponseMetaData.Builder

newBuilder(ResponseMetaData prototype)

public static ResponseMetaData.Builder newBuilder(ResponseMetaData prototype)
Parameter
Name Description
prototype ResponseMetaData
Returns
Type Description
ResponseMetaData.Builder

parseDelimitedFrom(InputStream input)

public static ResponseMetaData parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResponseMetaData parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResponseMetaData parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResponseMetaData parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResponseMetaData parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResponseMetaData parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResponseMetaData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMetaData
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResponseMetaData> parser()
Returns
Type Description
Parser<ResponseMetaData>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCurrencyCode()

public String getCurrencyCode()

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.

optional string currency_code = 5;

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

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.

optional string currency_code = 5;

Returns
Type Description
ByteString

The bytes for currencyCode.

getDataLossFromOtherRow()

public boolean getDataLossFromOtherRow()

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.

bool data_loss_from_other_row = 3;

Returns
Type Description
boolean

The dataLossFromOtherRow.

getDefaultInstanceForType()

public ResponseMetaData getDefaultInstanceForType()
Returns
Type Description
ResponseMetaData

getEmptyReason()

public String getEmptyReason()

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

optional string empty_reason = 7;

Returns
Type Description
String

The emptyReason.

getEmptyReasonBytes()

public ByteString getEmptyReasonBytes()

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

optional string empty_reason = 7;

Returns
Type Description
ByteString

The bytes for emptyReason.

getParserForType()

public Parser<ResponseMetaData> getParserForType()
Returns
Type Description
Parser<ResponseMetaData>
Overrides

getSamplingMetadatas(int index)

public SamplingMetadata getSamplingMetadatas(int index)

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.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadata

getSamplingMetadatasCount()

public int getSamplingMetadatasCount()

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.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type Description
int

getSamplingMetadatasList()

public List<SamplingMetadata> getSamplingMetadatasList()

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.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type Description
List<SamplingMetadata>

getSamplingMetadatasOrBuilder(int index)

public SamplingMetadataOrBuilder getSamplingMetadatasOrBuilder(int index)

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.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadataOrBuilder

getSamplingMetadatasOrBuilderList()

public List<? extends SamplingMetadataOrBuilder> getSamplingMetadatasOrBuilderList()

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.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.SamplingMetadataOrBuilder>

getSchemaRestrictionResponse()

public ResponseMetaData.SchemaRestrictionResponse getSchemaRestrictionResponse()

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

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
ResponseMetaData.SchemaRestrictionResponse

The schemaRestrictionResponse.

getSchemaRestrictionResponseOrBuilder()

public ResponseMetaData.SchemaRestrictionResponseOrBuilder getSchemaRestrictionResponseOrBuilder()

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

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
ResponseMetaData.SchemaRestrictionResponseOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubjectToThresholding()

public boolean getSubjectToThresholding()

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.

optional bool subject_to_thresholding = 8;

Returns
Type Description
boolean

The subjectToThresholding.

getTimeZone()

public String getTimeZone()

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

optional string time_zone = 6;

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

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

optional string time_zone = 6;

Returns
Type Description
ByteString

The bytes for timeZone.

hasCurrencyCode()

public boolean hasCurrencyCode()

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.

optional string currency_code = 5;

Returns
Type Description
boolean

Whether the currencyCode field is set.

hasEmptyReason()

public boolean hasEmptyReason()

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

optional string empty_reason = 7;

Returns
Type Description
boolean

Whether the emptyReason field is set.

hasSchemaRestrictionResponse()

public boolean hasSchemaRestrictionResponse()

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

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type Description
boolean

Whether the schemaRestrictionResponse field is set.

hasSubjectToThresholding()

public boolean hasSubjectToThresholding()

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.

optional bool subject_to_thresholding = 8;

Returns
Type Description
boolean

Whether the subjectToThresholding field is set.

hasTimeZone()

public boolean hasTimeZone()

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

optional string time_zone = 6;

Returns
Type Description
boolean

Whether the timeZone field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResponseMetaData.Builder newBuilderForType()
Returns
Type Description
ResponseMetaData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResponseMetaData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResponseMetaData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResponseMetaData.Builder toBuilder()
Returns
Type Description
ResponseMetaData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException