Class DimensionMetadata (0.64.0)

public final class DimensionMetadata extends GeneratedMessageV3 implements DimensionMetadataOrBuilder

Explains a dimension.

Protobuf type google.analytics.data.v1beta.DimensionMetadata

Static Fields

API_NAME_FIELD_NUMBER

public static final int API_NAME_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_DEFINITION_FIELD_NUMBER

public static final int CUSTOM_DEFINITION_FIELD_NUMBER
Field Value
Type Description
int

DEPRECATED_API_NAMES_FIELD_NUMBER

public static final int DEPRECATED_API_NAMES_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

UI_NAME_FIELD_NUMBER

public static final int UI_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DimensionMetadata getDefaultInstance()
Returns
Type Description
DimensionMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DimensionMetadata.Builder newBuilder()
Returns
Type Description
DimensionMetadata.Builder

newBuilder(DimensionMetadata prototype)

public static DimensionMetadata.Builder newBuilder(DimensionMetadata prototype)
Parameter
Name Description
prototype DimensionMetadata
Returns
Type Description
DimensionMetadata.Builder

parseDelimitedFrom(InputStream input)

public static DimensionMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DimensionMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DimensionMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DimensionMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DimensionMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DimensionMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DimensionMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DimensionMetadata> parser()
Returns
Type Description
Parser<DimensionMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiName()

public String getApiName()

This dimension's name. Useable in Dimension's name. For example, eventName.

string api_name = 1;

Returns
Type Description
String

The apiName.

getApiNameBytes()

public ByteString getApiNameBytes()

This dimension's name. Useable in Dimension's name. For example, eventName.

string api_name = 1;

Returns
Type Description
ByteString

The bytes for apiName.

getCategory()

public String getCategory()

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

string category = 7;

Returns
Type Description
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

string category = 7;

Returns
Type Description
ByteString

The bytes for category.

getCustomDefinition()

public boolean getCustomDefinition()

True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.

bool custom_definition = 5;

Returns
Type Description
boolean

The customDefinition.

getDefaultInstanceForType()

public DimensionMetadata getDefaultInstanceForType()
Returns
Type Description
DimensionMetadata

getDeprecatedApiNames(int index)

public String getDeprecatedApiNames(int index)

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes(int index)

public ByteString getDeprecatedApiNamesBytes(int index)

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

repeated string deprecated_api_names = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the deprecatedApiNames at the given index.

getDeprecatedApiNamesCount()

public int getDeprecatedApiNamesCount()

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

repeated string deprecated_api_names = 4;

Returns
Type Description
int

The count of deprecatedApiNames.

getDeprecatedApiNamesList()

public ProtocolStringList getDeprecatedApiNamesList()

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

repeated string deprecated_api_names = 4;

Returns
Type Description
ProtocolStringList

A list containing the deprecatedApiNames.

getDescription()

public String getDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getParserForType()

public Parser<DimensionMetadata> getParserForType()
Returns
Type Description
Parser<DimensionMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUiName()

public String getUiName()

This dimension's name within the Google Analytics user interface. For example, Event name.

string ui_name = 2;

Returns
Type Description
String

The uiName.

getUiNameBytes()

public ByteString getUiNameBytes()

This dimension's name within the Google Analytics user interface. For example, Event name.

string ui_name = 2;

Returns
Type Description
ByteString

The bytes for uiName.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DimensionMetadata.Builder newBuilderForType()
Returns
Type Description
DimensionMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DimensionMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DimensionMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DimensionMetadata.Builder toBuilder()
Returns
Type Description
DimensionMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException