com.google.api.services.analyticsdata.v1beta.model

Class DimensionMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsdata.v1beta.model.DimensionMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DimensionMetadata
extends com.google.api.client.json.GenericJson

Explains a dimension.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Analytics Data API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DimensionMetadata()

Method Summary

Modifier and Type	Method and Description
DimensionMetadata	clone()
String	getApiName() This dimension's name.
String	getCategory() The display name of the category that this dimension belongs to.
Boolean	getCustomDefinition() True if the dimension is a custom dimension for this property.
List<String>	getDeprecatedApiNames() Still usable but deprecated names for this dimension.
String	getDescription() Description of how this dimension is used and calculated.
String	getUiName() This dimension's name within the Google Analytics user interface.
DimensionMetadata	set(String fieldName, Object value)
DimensionMetadata	setApiName(String apiName) This dimension's name.
DimensionMetadata	setCategory(String category) The display name of the category that this dimension belongs to.
DimensionMetadata	setCustomDefinition(Boolean customDefinition) True if the dimension is a custom dimension for this property.
DimensionMetadata	setDeprecatedApiNames(List<String> deprecatedApiNames) Still usable but deprecated names for this dimension.
DimensionMetadata	setDescription(String description) Description of how this dimension is used and calculated.
DimensionMetadata	setUiName(String uiName) This dimension's name within the Google Analytics user interface.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DimensionMetadata

public DimensionMetadata()

Method Detail

getApiName

public String getApiName()

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

Returns:

value or null for none

setApiName

public DimensionMetadata setApiName(String apiName)

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

Parameters:

apiName - apiName or null for none

getCategory

public String getCategory()

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

Returns:

value or null for none

setCategory

public DimensionMetadata setCategory(String category)

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

Parameters:

category - category or null for none

getCustomDefinition

public Boolean getCustomDefinition()

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

Returns:

value or null for none

setCustomDefinition

public DimensionMetadata setCustomDefinition(Boolean customDefinition)

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

Parameters:

customDefinition - customDefinition or null for none

getDeprecatedApiNames

public List<String> getDeprecatedApiNames()

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`.

Returns:

value or null for none

setDeprecatedApiNames

public DimensionMetadata setDeprecatedApiNames(List<String> deprecatedApiNames)

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`.

Parameters:

deprecatedApiNames - deprecatedApiNames or null for none

getDescription

public String getDescription()

Description of how this dimension is used and calculated.

Returns:

value or null for none

setDescription

public DimensionMetadata setDescription(String description)

Description of how this dimension is used and calculated.

Parameters:

description - description or null for none

getUiName

public String getUiName()

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

Returns:

value or null for none

setUiName

public DimensionMetadata setUiName(String uiName)

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

Parameters:

uiName - uiName or null for none

set

public DimensionMetadata set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DimensionMetadata clone()

Overrides:

clone in class com.google.api.client.json.GenericJson