Interface DimensionMetadataOrBuilder (0.40.0)

public interface DimensionMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiName()

public abstract String getApiName()

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

string api_name = 1;

Returns
TypeDescription
String

The apiName.

getApiNameBytes()

public abstract ByteString getApiNameBytes()

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

string api_name = 1;

Returns
TypeDescription
ByteString

The bytes for apiName.

getCategory()

public abstract String getCategory()

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

string category = 7;

Returns
TypeDescription
String

The category.

getCategoryBytes()

public abstract ByteString getCategoryBytes()

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

string category = 7;

Returns
TypeDescription
ByteString

The bytes for category.

getCustomDefinition()

public abstract boolean getCustomDefinition()

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

bool custom_definition = 5;

Returns
TypeDescription
boolean

The customDefinition.

getDeprecatedApiNames(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the deprecatedApiNames at the given index.

getDeprecatedApiNamesCount()

public abstract 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
TypeDescription
int

The count of deprecatedApiNames.

getDeprecatedApiNamesList()

public abstract 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
TypeDescription
List<String>

A list containing the deprecatedApiNames.

getDescription()

public abstract String getDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getUiName()

public abstract String getUiName()

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

string ui_name = 2;

Returns
TypeDescription
String

The uiName.

getUiNameBytes()

public abstract ByteString getUiNameBytes()

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

string ui_name = 2;

Returns
TypeDescription
ByteString

The bytes for uiName.