com.google.api.services.analyticsadmin.v1beta.model

Class GoogleAnalyticsAdminV1betaCustomMetric

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsadmin.v1beta.model.GoogleAnalyticsAdminV1betaCustomMetric

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A definition for a custom 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 Admin 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
GoogleAnalyticsAdminV1betaCustomMetric()

Method Summary

Modifier and Type	Method and Description
GoogleAnalyticsAdminV1betaCustomMetric	clone()
String	getDescription() Optional.
String	getDisplayName() Required.
String	getMeasurementUnit() Required.
String	getName() Output only.
String	getParameterName() Required.
List<String>	getRestrictedMetricType() Optional.
String	getScope() Required.
GoogleAnalyticsAdminV1betaCustomMetric	set(String fieldName, Object value)
GoogleAnalyticsAdminV1betaCustomMetric	setDescription(String description) Optional.
GoogleAnalyticsAdminV1betaCustomMetric	setDisplayName(String displayName) Required.
GoogleAnalyticsAdminV1betaCustomMetric	setMeasurementUnit(String measurementUnit) Required.
GoogleAnalyticsAdminV1betaCustomMetric	setName(String name) Output only.
GoogleAnalyticsAdminV1betaCustomMetric	setParameterName(String parameterName) Required.
GoogleAnalyticsAdminV1betaCustomMetric	setRestrictedMetricType(List<String> restrictedMetricType) Optional.
GoogleAnalyticsAdminV1betaCustomMetric	setScope(String scope) Required.

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

GoogleAnalyticsAdminV1betaCustomMetric

public GoogleAnalyticsAdminV1betaCustomMetric()

Method Detail

getDescription

public String getDescription()

Optional. Description for this custom dimension. Max length of 150 characters.

Returns:

value or null for none

setDescription

public GoogleAnalyticsAdminV1betaCustomMetric setDescription(String description)

Optional. Description for this custom dimension. Max length of 150 characters.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system- generated display names may contain square brackets, but updates to this field will never permit square brackets.

Returns:

value or null for none

setDisplayName

public GoogleAnalyticsAdminV1betaCustomMetric setDisplayName(String displayName)

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system- generated display names may contain square brackets, but updates to this field will never permit square brackets.

Parameters:

displayName - displayName or null for none

getMeasurementUnit

public String getMeasurementUnit()

Required. The type for the custom metric's value.

Returns:

value or null for none

setMeasurementUnit

public GoogleAnalyticsAdminV1betaCustomMetric setMeasurementUnit(String measurementUnit)

Required. The type for the custom metric's value.

Parameters:

measurementUnit - measurementUnit or null for none

getName

public String getName()

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

Returns:

value or null for none

setName

public GoogleAnalyticsAdminV1betaCustomMetric setName(String name)

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

Parameters:

name - name or null for none

getParameterName

public String getParameterName()

Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

Returns:

value or null for none

setParameterName

public GoogleAnalyticsAdminV1betaCustomMetric setParameterName(String parameterName)

Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

Parameters:

parameterName - parameterName or null for none

getRestrictedMetricType

public List<String> getRestrictedMetricType()

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

Returns:

value or null for none

setRestrictedMetricType

public GoogleAnalyticsAdminV1betaCustomMetric setRestrictedMetricType(List<String> restrictedMetricType)

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

Parameters:

restrictedMetricType - restrictedMetricType or null for none

getScope

public String getScope()

Required. Immutable. The scope of this custom metric.

Returns:

value or null for none

setScope

public GoogleAnalyticsAdminV1betaCustomMetric setScope(String scope)

Required. Immutable. The scope of this custom metric.

Parameters:

scope - scope or null for none

set

public GoogleAnalyticsAdminV1betaCustomMetric set(String fieldName,
                                                  Object value)

Overrides:

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

clone

public GoogleAnalyticsAdminV1betaCustomMetric clone()

Overrides:

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