public final class ResponseMetaData extends GeneratedMessageV3 implements ResponseMetaDataOrBuilder
Response's metadata carrying additional information about the report content.
Protobuf type google.analytics.data.v1alpha.ResponseMetaData
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CURRENCY_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EMPTY_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SAMPLING_METADATAS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SUBJECT_TO_THRESHOLDING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TIME_ZONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ResponseMetaData getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ResponseMetaData.Builder newBuilder()
public static ResponseMetaData.Builder newBuilder(ResponseMetaData prototype)
public static ResponseMetaData parseDelimitedFrom(InputStream input)
public static ResponseMetaData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResponseMetaData parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ResponseMetaData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ResponseMetaData parseFrom(ByteString data)
public static ResponseMetaData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResponseMetaData parseFrom(CodedInputStream input)
public static ResponseMetaData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ResponseMetaData parseFrom(InputStream input)
public static ResponseMetaData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResponseMetaData parseFrom(ByteBuffer data)
public static ResponseMetaData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ResponseMetaData> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
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.
|
public ResponseMetaData getDefaultInstanceForType()
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.
|
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.
|
public Parser<ResponseMetaData> getParserForType()
Overrides
public SamplingMetadata getSamplingMetadatas(int index)
If this report's results are
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 the 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
| Parameter |
| Name |
Description |
index |
int
|
public int getSamplingMetadatasCount()
If this report's results are
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 the 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
| Returns |
| Type |
Description |
int |
|
public List<SamplingMetadata> getSamplingMetadatasList()
If this report's results are
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 the 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
public SamplingMetadataOrBuilder getSamplingMetadatasOrBuilder(int index)
If this report's results are
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 the 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends SamplingMetadataOrBuilder> getSamplingMetadatasOrBuilderList()
If this report's results are
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 the 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
| Returns |
| Type |
Description |
List<? extends com.google.analytics.data.v1alpha.SamplingMetadataOrBuilder> |
|
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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 and About
Demographics and
Interests.
optional bool subject_to_thresholding = 8;
| Returns |
| Type |
Description |
boolean |
The subjectToThresholding.
|
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.
|
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.
|
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.
|
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.
|
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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
| Returns |
| Type |
Description |
boolean |
Whether the schemaRestrictionResponse field is set.
|
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 and About
Demographics and
Interests.
optional bool subject_to_thresholding = 8;
| Returns |
| Type |
Description |
boolean |
Whether the subjectToThresholding field is set.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ResponseMetaData.Builder newBuilderForType()
protected ResponseMetaData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ResponseMetaData.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
