Class Dimension (0.47.0)

public final class Dimension extends GeneratedMessageV3 implements DimensionOrBuilder

Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York".

Protobuf type google.analytics.data.v1alpha.Dimension

Implements

DimensionOrBuilder

Static Fields

DIMENSION_EXPRESSION_FIELD_NUMBER

public static final int DIMENSION_EXPRESSION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Dimension getDefaultInstance()
Returns
TypeDescription
Dimension

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Dimension.Builder newBuilder()
Returns
TypeDescription
Dimension.Builder

newBuilder(Dimension prototype)

public static Dimension.Builder newBuilder(Dimension prototype)
Parameter
NameDescription
prototypeDimension
Returns
TypeDescription
Dimension.Builder

parseDelimitedFrom(InputStream input)

public static Dimension parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dimension parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Dimension parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Dimension parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Dimension parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Dimension parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Dimension parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Dimension parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Dimension parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Dimension parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Dimension parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Dimension parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dimension
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Dimension> parser()
Returns
TypeDescription
Parser<Dimension>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Dimension getDefaultInstanceForType()
Returns
TypeDescription
Dimension

getDimensionExpression()

public DimensionExpression getDimensionExpression()

One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

.google.analytics.data.v1alpha.DimensionExpression dimension_expression = 2;

Returns
TypeDescription
DimensionExpression

The dimensionExpression.

getDimensionExpressionOrBuilder()

public DimensionExpressionOrBuilder getDimensionExpressionOrBuilder()

One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

.google.analytics.data.v1alpha.DimensionExpression dimension_expression = 2;

Returns
TypeDescription
DimensionExpressionOrBuilder

getName()

public String getName()

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method.

If dimensionExpression is specified, name can be any string that you would like within the allowed character set. For example if a dimensionExpression concatenates country and city, you could call that dimension countryAndCity. Dimension names that you choose must match the regular expression ^[a-zA-Z0-9_]$.

Dimensions are referenced by name in dimensionFilter, orderBys, dimensionExpression, and pivots.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method.

If dimensionExpression is specified, name can be any string that you would like within the allowed character set. For example if a dimensionExpression concatenates country and city, you could call that dimension countryAndCity. Dimension names that you choose must match the regular expression ^[a-zA-Z0-9_]$.

Dimensions are referenced by name in dimensionFilter, orderBys, dimensionExpression, and pivots.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Dimension> getParserForType()
Returns
TypeDescription
Parser<Dimension>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDimensionExpression()

public boolean hasDimensionExpression()

One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).

.google.analytics.data.v1alpha.DimensionExpression dimension_expression = 2;

Returns
TypeDescription
boolean

Whether the dimensionExpression field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Dimension.Builder newBuilderForType()
Returns
TypeDescription
Dimension.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Dimension.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Dimension.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Dimension.Builder toBuilder()
Returns
TypeDescription
Dimension.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException