public final class RunPivotReportResponse extends GeneratedMessageV3 implements RunPivotReportResponseOrBuilder
The response pivot report table corresponding to a pivot request.
Protobuf type google.analytics.data.v1beta.RunPivotReportResponse
Static Fields
AGGREGATES_FIELD_NUMBER
public static final int AGGREGATES_FIELD_NUMBER
Field Value
public static final int DIMENSION_HEADERS_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
public static final int METRIC_HEADERS_FIELD_NUMBER
Field Value
public static final int PIVOT_HEADERS_FIELD_NUMBER
Field Value
PROPERTY_QUOTA_FIELD_NUMBER
public static final int PROPERTY_QUOTA_FIELD_NUMBER
Field Value
ROWS_FIELD_NUMBER
public static final int ROWS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RunPivotReportResponse getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RunPivotReportResponse.Builder newBuilder()
Returns
newBuilder(RunPivotReportResponse prototype)
public static RunPivotReportResponse.Builder newBuilder(RunPivotReportResponse prototype)
Parameter
Returns
public static RunPivotReportResponse parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunPivotReportResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RunPivotReportResponse parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunPivotReportResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RunPivotReportResponse parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunPivotReportResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunPivotReportResponse parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RunPivotReportResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunPivotReportResponse parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunPivotReportResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RunPivotReportResponse parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunPivotReportResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RunPivotReportResponse> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAggregates(int index)
public Row getAggregates(int index)
Aggregation of metric values. Can be totals, minimums, or maximums. The
returned aggregations are controlled by the metric_aggregations in the
pivot. The type of aggregation returned in each row is shown by the
dimension_values which are set to "RESERVED_<MetricAggregation>".
repeated .google.analytics.data.v1beta.Row aggregates = 5;
Parameter
Returns
getAggregatesCount()
public int getAggregatesCount()
Aggregation of metric values. Can be totals, minimums, or maximums. The
returned aggregations are controlled by the metric_aggregations in the
pivot. The type of aggregation returned in each row is shown by the
dimension_values which are set to "RESERVED_<MetricAggregation>".
repeated .google.analytics.data.v1beta.Row aggregates = 5;
Returns
getAggregatesList()
public List<Row> getAggregatesList()
Aggregation of metric values. Can be totals, minimums, or maximums. The
returned aggregations are controlled by the metric_aggregations in the
pivot. The type of aggregation returned in each row is shown by the
dimension_values which are set to "RESERVED_<MetricAggregation>".
repeated .google.analytics.data.v1beta.Row aggregates = 5;
Returns
getAggregatesOrBuilder(int index)
public RowOrBuilder getAggregatesOrBuilder(int index)
Aggregation of metric values. Can be totals, minimums, or maximums. The
returned aggregations are controlled by the metric_aggregations in the
pivot. The type of aggregation returned in each row is shown by the
dimension_values which are set to "RESERVED_<MetricAggregation>".
repeated .google.analytics.data.v1beta.Row aggregates = 5;
Parameter
Returns
getAggregatesOrBuilderList()
public List<? extends RowOrBuilder> getAggregatesOrBuilderList()
Aggregation of metric values. Can be totals, minimums, or maximums. The
returned aggregations are controlled by the metric_aggregations in the
pivot. The type of aggregation returned in each row is shown by the
dimension_values which are set to "RESERVED_<MetricAggregation>".
repeated .google.analytics.data.v1beta.Row aggregates = 5;
Returns
Type | Description |
List<? extends com.google.analytics.data.v1beta.RowOrBuilder> | |
getDefaultInstanceForType()
public RunPivotReportResponse getDefaultInstanceForType()
Returns
public DimensionHeader getDimensionHeaders(int index)
Describes dimension columns. The number of DimensionHeaders and ordering of
DimensionHeaders matches the dimensions present in rows.
repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;
Parameter
Returns
public int getDimensionHeadersCount()
Describes dimension columns. The number of DimensionHeaders and ordering of
DimensionHeaders matches the dimensions present in rows.
repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;
Returns
public List<DimensionHeader> getDimensionHeadersList()
Describes dimension columns. The number of DimensionHeaders and ordering of
DimensionHeaders matches the dimensions present in rows.
repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;
Returns
public DimensionHeaderOrBuilder getDimensionHeadersOrBuilder(int index)
Describes dimension columns. The number of DimensionHeaders and ordering of
DimensionHeaders matches the dimensions present in rows.
repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;
Parameter
Returns
public List<? extends DimensionHeaderOrBuilder> getDimensionHeadersOrBuilderList()
Describes dimension columns. The number of DimensionHeaders and ordering of
DimensionHeaders matches the dimensions present in rows.
repeated .google.analytics.data.v1beta.DimensionHeader dimension_headers = 2;
Returns
Type | Description |
List<? extends com.google.analytics.data.v1beta.DimensionHeaderOrBuilder> | |
getKind()
Identifies what kind of resource this message is. This kind
is always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
string kind = 8;
Returns
Type | Description |
String | The kind.
|
getKindBytes()
public ByteString getKindBytes()
Identifies what kind of resource this message is. This kind
is always the
fixed string "analyticsData#runPivotReport". Useful to distinguish between
response types in JSON.
string kind = 8;
Returns
public ResponseMetaData getMetadata()
Metadata for the report.
.google.analytics.data.v1beta.ResponseMetaData metadata = 6;
Returns
public ResponseMetaDataOrBuilder getMetadataOrBuilder()
Metadata for the report.
.google.analytics.data.v1beta.ResponseMetaData metadata = 6;
Returns
public MetricHeader getMetricHeaders(int index)
Describes metric columns. The number of MetricHeaders and ordering of
MetricHeaders matches the metrics present in rows.
repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;
Parameter
Returns
public int getMetricHeadersCount()
Describes metric columns. The number of MetricHeaders and ordering of
MetricHeaders matches the metrics present in rows.
repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;
Returns
public List<MetricHeader> getMetricHeadersList()
Describes metric columns. The number of MetricHeaders and ordering of
MetricHeaders matches the metrics present in rows.
repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;
Returns
public MetricHeaderOrBuilder getMetricHeadersOrBuilder(int index)
Describes metric columns. The number of MetricHeaders and ordering of
MetricHeaders matches the metrics present in rows.
repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;
Parameter
Returns
public List<? extends MetricHeaderOrBuilder> getMetricHeadersOrBuilderList()
Describes metric columns. The number of MetricHeaders and ordering of
MetricHeaders matches the metrics present in rows.
repeated .google.analytics.data.v1beta.MetricHeader metric_headers = 3;
Returns
Type | Description |
List<? extends com.google.analytics.data.v1beta.MetricHeaderOrBuilder> | |
getParserForType()
public Parser<RunPivotReportResponse> getParserForType()
Returns
Overrides
public PivotHeader getPivotHeaders(int index)
Summarizes the columns and rows created by a pivot. Each pivot in the
request produces one header in the response. If we have a request like
this:
"pivots": [{
"fieldNames": ["country",
"city"]
},
{
"fieldNames": "eventName"
}]
We will have the following pivotHeaders
in the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;
Parameter
Returns
public int getPivotHeadersCount()
Summarizes the columns and rows created by a pivot. Each pivot in the
request produces one header in the response. If we have a request like
this:
"pivots": [{
"fieldNames": ["country",
"city"]
},
{
"fieldNames": "eventName"
}]
We will have the following pivotHeaders
in the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;
Returns
public List<PivotHeader> getPivotHeadersList()
Summarizes the columns and rows created by a pivot. Each pivot in the
request produces one header in the response. If we have a request like
this:
"pivots": [{
"fieldNames": ["country",
"city"]
},
{
"fieldNames": "eventName"
}]
We will have the following pivotHeaders
in the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;
Returns
public PivotHeaderOrBuilder getPivotHeadersOrBuilder(int index)
Summarizes the columns and rows created by a pivot. Each pivot in the
request produces one header in the response. If we have a request like
this:
"pivots": [{
"fieldNames": ["country",
"city"]
},
{
"fieldNames": "eventName"
}]
We will have the following pivotHeaders
in the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;
Parameter
Returns
public List<? extends PivotHeaderOrBuilder> getPivotHeadersOrBuilderList()
Summarizes the columns and rows created by a pivot. Each pivot in the
request produces one header in the response. If we have a request like
this:
"pivots": [{
"fieldNames": ["country",
"city"]
},
{
"fieldNames": "eventName"
}]
We will have the following pivotHeaders
in the response:
"pivotHeaders" : [{
"dimensionHeaders": [{
"dimensionValues": [
{ "value": "United Kingdom" },
{ "value": "London" }
]
},
{
"dimensionValues": [
{ "value": "Japan" },
{ "value": "Osaka" }
]
}]
},
{
"dimensionHeaders": [{
"dimensionValues": [{ "value": "session_start" }]
},
{
"dimensionValues": [{ "value": "scroll" }]
}]
}]
repeated .google.analytics.data.v1beta.PivotHeader pivot_headers = 1;
Returns
Type | Description |
List<? extends com.google.analytics.data.v1beta.PivotHeaderOrBuilder> | |
getPropertyQuota()
public PropertyQuota getPropertyQuota()
This Analytics Property's quota state including this request.
.google.analytics.data.v1beta.PropertyQuota property_quota = 7;
Returns
getPropertyQuotaOrBuilder()
public PropertyQuotaOrBuilder getPropertyQuotaOrBuilder()
This Analytics Property's quota state including this request.
.google.analytics.data.v1beta.PropertyQuota property_quota = 7;
Returns
getRows(int index)
public Row getRows(int index)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1beta.Row rows = 4;
Parameter
Returns
getRowsCount()
public int getRowsCount()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1beta.Row rows = 4;
Returns
getRowsList()
public List<Row> getRowsList()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1beta.Row rows = 4;
Returns
getRowsOrBuilder(int index)
public RowOrBuilder getRowsOrBuilder(int index)
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1beta.Row rows = 4;
Parameter
Returns
getRowsOrBuilderList()
public List<? extends RowOrBuilder> getRowsOrBuilderList()
Rows of dimension value combinations and metric values in the report.
repeated .google.analytics.data.v1beta.Row rows = 4;
Returns
Type | Description |
List<? extends com.google.analytics.data.v1beta.RowOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasMetadata()
Metadata for the report.
.google.analytics.data.v1beta.ResponseMetaData metadata = 6;
Returns
Type | Description |
boolean | Whether the metadata field is set.
|
hasPropertyQuota()
public boolean hasPropertyQuota()
This Analytics Property's quota state including this request.
.google.analytics.data.v1beta.PropertyQuota property_quota = 7;
Returns
Type | Description |
boolean | Whether the propertyQuota field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RunPivotReportResponse.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunPivotReportResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RunPivotReportResponse.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions