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

Class MetricMetadata

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Explains a metric.

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
MetricMetadata()

Method Summary

Modifier and Type	Method and Description
MetricMetadata	clone()
String	getApiName() A metric name.
List<String>	getBlockedReasons() If reasons are specified, your access is blocked to this metric for this property.
String	getCategory() The display name of the category that this metrics belongs to.
Boolean	getCustomDefinition() True if the metric is a custom metric for this property.
List<String>	getDeprecatedApiNames() Still usable but deprecated names for this metric.
String	getDescription() Description of how this metric is used and calculated.
String	getExpression() The mathematical expression for this derived metric.
String	getType() The type of this metric.
String	getUiName() This metric's name within the Google Analytics user interface.
MetricMetadata	set(String fieldName, Object value)
MetricMetadata	setApiName(String apiName) A metric name.
MetricMetadata	setBlockedReasons(List<String> blockedReasons) If reasons are specified, your access is blocked to this metric for this property.
MetricMetadata	setCategory(String category) The display name of the category that this metrics belongs to.
MetricMetadata	setCustomDefinition(Boolean customDefinition) True if the metric is a custom metric for this property.
MetricMetadata	setDeprecatedApiNames(List<String> deprecatedApiNames) Still usable but deprecated names for this metric.
MetricMetadata	setDescription(String description) Description of how this metric is used and calculated.
MetricMetadata	setExpression(String expression) The mathematical expression for this derived metric.
MetricMetadata	setType(String type) The type of this metric.
MetricMetadata	setUiName(String uiName) This metric'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

MetricMetadata

public MetricMetadata()

Method Detail

getApiName

public String getApiName()

A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.

Returns:

value or null for none

setApiName

public MetricMetadata setApiName(String apiName)

A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.

Parameters:

apiName - apiName or null for none

getBlockedReasons

public List<String> getBlockedReasons()

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data- restriction management](https://support.google.com/analytics/answer/10851388).

Returns:

value or null for none

setBlockedReasons

public MetricMetadata setBlockedReasons(List<String> blockedReasons)

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data- restriction management](https://support.google.com/analytics/answer/10851388).

Parameters:

blockedReasons - blockedReasons or null for none

getCategory

public String getCategory()

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

Returns:

value or null for none

setCategory

public MetricMetadata setCategory(String category)

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

Parameters:

category - category or null for none

getCustomDefinition

public Boolean getCustomDefinition()

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

Returns:

value or null for none

setCustomDefinition

public MetricMetadata setCustomDefinition(Boolean customDefinition)

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

Parameters:

customDefinition - customDefinition or null for none

getDeprecatedApiNames

public List<String> getDeprecatedApiNames()

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

Returns:

value or null for none

setDeprecatedApiNames

public MetricMetadata setDeprecatedApiNames(List<String> deprecatedApiNames)

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

Parameters:

deprecatedApiNames - deprecatedApiNames or null for none

getDescription

public String getDescription()

Description of how this metric is used and calculated.

Returns:

value or null for none

setDescription

public MetricMetadata setDescription(String description)

Description of how this metric is used and calculated.

Parameters:

description - description or null for none

getExpression

public String getExpression()

The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non- expressions, this field is empty.

Returns:

value or null for none

setExpression

public MetricMetadata setExpression(String expression)

The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non- expressions, this field is empty.

Parameters:

expression - expression or null for none

getType

public String getType()

The type of this metric.

Returns:

value or null for none

setType

public MetricMetadata setType(String type)

The type of this metric.

Parameters:

type - type or null for none

getUiName

public String getUiName()

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

Returns:

value or null for none

setUiName

public MetricMetadata setUiName(String uiName)

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

Parameters:

uiName - uiName or null for none

set

public MetricMetadata set(String fieldName,
                          Object value)

Overrides:

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

clone

public MetricMetadata clone()

Overrides:

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