public final class Pivot extends GeneratedMessageV3 implements PivotOrBuilder
Describes the visible dimension columns and rows in the report response.
Protobuf type google.analytics.data.v1beta.Pivot
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>)
Static Fields
FIELD_NAMES_FIELD_NUMBER
public static final int FIELD_NAMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_AGGREGATIONS_FIELD_NUMBER
public static final int METRIC_AGGREGATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BYS_FIELD_NUMBER
public static final int ORDER_BYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Pivot getDefaultInstance()
| Returns |
|---|
| Type | Description |
Pivot | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Pivot.Builder newBuilder()
newBuilder(Pivot prototype)
public static Pivot.Builder newBuilder(Pivot prototype)
| Parameter |
|---|
| Name | Description |
prototype | Pivot
|
public static Pivot parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Pivot | |
public static Pivot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(byte[] data)
public static Pivot parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(ByteString data)
public static Pivot parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
public static Pivot parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Pivot | |
public static Pivot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
public static Pivot parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Pivot | |
public static Pivot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(ByteBuffer data)
public static Pivot parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Pivot | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Pivot | |
parser()
public static Parser<Pivot> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Pivot getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Pivot | |
getFieldNames(int index)
public String getFieldNames(int index)
Dimension names for visible columns in the report response. Including
"dateRange" produces a date range column; for each row in the response,
dimension values in the date range column will indicate the corresponding
date range from the request.
repeated string field_names = 1;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The fieldNames at the given index.
|
getFieldNamesBytes(int index)
public ByteString getFieldNamesBytes(int index)
Dimension names for visible columns in the report response. Including
"dateRange" produces a date range column; for each row in the response,
dimension values in the date range column will indicate the corresponding
date range from the request.
repeated string field_names = 1;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the fieldNames at the given index.
|
getFieldNamesCount()
public int getFieldNamesCount()
Dimension names for visible columns in the report response. Including
"dateRange" produces a date range column; for each row in the response,
dimension values in the date range column will indicate the corresponding
date range from the request.
repeated string field_names = 1;
| Returns |
|---|
| Type | Description |
int | The count of fieldNames.
|
getFieldNamesList()
public ProtocolStringList getFieldNamesList()
Dimension names for visible columns in the report response. Including
"dateRange" produces a date range column; for each row in the response,
dimension values in the date range column will indicate the corresponding
date range from the request.
repeated string field_names = 1;
getLimit()
The number of unique combinations of dimension values to return in this
pivot. The limit parameter is required. A limit of 10,000 is common for
single pivot requests.
The product of the limit for each pivot in a RunPivotReportRequest
must not exceed 250,000. For example, a two pivot request with limit:
1000 in each pivot will fail because the product is 1,000,000.
int64 limit = 4;
| Returns |
|---|
| Type | Description |
long | The limit.
|
getMetricAggregations(int index)
public MetricAggregation getMetricAggregations(int index)
Aggregate the metrics by dimensions in this pivot using the specified
metric_aggregations.
repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
getMetricAggregationsCount()
public int getMetricAggregationsCount()
Aggregate the metrics by dimensions in this pivot using the specified
metric_aggregations.
repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
| Returns |
|---|
| Type | Description |
int | The count of metricAggregations.
|
getMetricAggregationsList()
public List<MetricAggregation> getMetricAggregationsList()
Aggregate the metrics by dimensions in this pivot using the specified
metric_aggregations.
repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
getMetricAggregationsValue(int index)
public int getMetricAggregationsValue(int index)
Aggregate the metrics by dimensions in this pivot using the specified
metric_aggregations.
repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire of metricAggregations at the given index.
|
getMetricAggregationsValueList()
public List<Integer> getMetricAggregationsValueList()
Aggregate the metrics by dimensions in this pivot using the specified
metric_aggregations.
repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;
| Returns |
|---|
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for metricAggregations.
|
getOffset()
The row count of the start row. The first row is counted as row 0.
int64 offset = 3;
| Returns |
|---|
| Type | Description |
long | The offset.
|
getOrderBys(int index)
public OrderBy getOrderBys(int index)
Specifies how dimensions are ordered in the pivot. In the first Pivot, the
OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of
Pivot.field_names.
repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getOrderBysCount()
public int getOrderBysCount()
Specifies how dimensions are ordered in the pivot. In the first Pivot, the
OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of
Pivot.field_names.
repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;
| Returns |
|---|
| Type | Description |
int | |
getOrderBysList()
public List<OrderBy> getOrderBysList()
Specifies how dimensions are ordered in the pivot. In the first Pivot, the
OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of
Pivot.field_names.
repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;
getOrderBysOrBuilder(int index)
public OrderByOrBuilder getOrderBysOrBuilder(int index)
Specifies how dimensions are ordered in the pivot. In the first Pivot, the
OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of
Pivot.field_names.
repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getOrderBysOrBuilderList()
public List<? extends OrderByOrBuilder> getOrderBysOrBuilderList()
Specifies how dimensions are ordered in the pivot. In the first Pivot, the
OrderBys determine Row and PivotDimensionHeader ordering; in subsequent
Pivots, the OrderBys determine only PivotDimensionHeader ordering.
Dimensions specified in these OrderBys must be a subset of
Pivot.field_names.
repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1beta.OrderByOrBuilder> | |
getParserForType()
public Parser<Pivot> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Pivot.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Pivot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Pivot.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
