com.google.analytics.data.v1beta

Interface DimensionMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DimensionMetadata, DimensionMetadata.Builder

public interface DimensionMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getApiName() This dimension's name.
com.google.protobuf.ByteString	getApiNameBytes() This dimension's name.
String	getCategory() The display name of the category that this dimension belongs to.
com.google.protobuf.ByteString	getCategoryBytes() The display name of the category that this dimension belongs to.
boolean	getCustomDefinition() True if the dimension is a custom dimension for this property.
String	getDeprecatedApiNames(int index) Still usable but deprecated names for this dimension.
com.google.protobuf.ByteString	getDeprecatedApiNamesBytes(int index) Still usable but deprecated names for this dimension.
int	getDeprecatedApiNamesCount() Still usable but deprecated names for this dimension.
List<String>	getDeprecatedApiNamesList() Still usable but deprecated names for this dimension.
String	getDescription() Description of how this dimension is used and calculated.
com.google.protobuf.ByteString	getDescriptionBytes() Description of how this dimension is used and calculated.
String	getUiName() This dimension's name within the Google Analytics user interface.
com.google.protobuf.ByteString	getUiNameBytes() This dimension's name within the Google Analytics user interface.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getApiName

String getApiName()

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Returns:

The apiName.

getApiNameBytes

com.google.protobuf.ByteString getApiNameBytes()

 This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For
 example, `eventName`.
 

string api_name = 1;

Returns:

The bytes for apiName.

getUiName

String getUiName()

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

string ui_name = 2;

Returns:

The uiName.

getUiNameBytes

com.google.protobuf.ByteString getUiNameBytes()

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

string ui_name = 2;

Returns:

The bytes for uiName.

getDescription

String getDescription()

 Description of how this dimension is used and calculated.
 

string description = 3;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Description of how this dimension is used and calculated.
 

string description = 3;

Returns:

The bytes for description.

getDeprecatedApiNamesList

List<String> 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:

A list containing the deprecatedApiNames.

getDeprecatedApiNamesCount

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:

The count of deprecatedApiNames.

getDeprecatedApiNames

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;

Parameters:

index - The index of the element to return.

Returns:

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the deprecatedApiNames at the given index.

getCustomDefinition

boolean getCustomDefinition()

 True if the dimension is a custom dimension for this property.
 

bool custom_definition = 5;

Returns:

The customDefinition.

getCategory

String getCategory()

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

string category = 7;

Returns:

The category.

getCategoryBytes

com.google.protobuf.ByteString getCategoryBytes()

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

string category = 7;

Returns:

The bytes for category.