Class Pivot (0.30.0)

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

Inheritance

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

Implements

PivotOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Pivot.Builder newBuilder()

Returns
Type	Description
`Pivot.Builder`

newBuilder(Pivot prototype)

public static Pivot.Builder newBuilder(Pivot prototype)

Parameter
Name	Description
`prototype`	`Pivot`

Returns
Type	Description
`Pivot.Builder`

parseDelimitedFrom(InputStream input)

public static Pivot parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pivot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Pivot parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pivot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Pivot parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pivot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Pivot parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pivot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Pivot parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pivot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Pivot parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pivot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Pivot`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Pivot> parser()

Returns
Type	Description
`Parser<Pivot>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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)

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()

repeated string field_names = 1;

Returns
Type	Description
`int`	The count of fieldNames.

getFieldNamesList()

public ProtocolStringList getFieldNamesList()

repeated string field_names = 1;

Returns
Type	Description
`ProtocolStringList`	A list containing the fieldNames.

getLimit()

public long 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;

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.

Returns
Type	Description
`MetricAggregation`	The metricAggregations at the given index.

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;

Returns
Type	Description
`List<MetricAggregation>`	A list containing the metricAggregations.

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()

public long 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.