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
Static Fields
FIELD_NAMES_FIELD_NUMBER
public static final int FIELD_NAMES_FIELD_NUMBER
Field Value
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
Field Value
METRIC_AGGREGATIONS_FIELD_NUMBER
public static final int METRIC_AGGREGATIONS_FIELD_NUMBER
Field Value
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BYS_FIELD_NUMBER
public static final int ORDER_BYS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Pivot getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Pivot.Builder newBuilder()
Returns
newBuilder(Pivot prototype)
public static Pivot.Builder newBuilder(Pivot prototype)
Parameter
| Name | Description |
prototype | Pivot
|
Returns
public static Pivot parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Pivot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Pivot parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Pivot parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Pivot parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Pivot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Pivot parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Pivot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Pivot parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Pivot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Pivot> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Pivot getDefaultInstanceForType()
Returns
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;
| 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;
| 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;
| 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 100,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;
| 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;
| Name | Description |
index | int
The index of the element to return.
|
Returns
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;
| 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;
| 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;
| 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;
| 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;
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;
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;
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;
| Type | Description |
List<? extends com.google.analytics.data.v1beta.OrderByOrBuilder> | |
getParserForType()
public Parser<Pivot> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Pivot.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Pivot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Pivot.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
