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

Class GoogleAnalyticsAdminV1betaCustomDimension

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A definition for a CustomDimension.

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

Method Summary

Modifier and Type	Method and Description
GoogleAnalyticsAdminV1betaCustomDimension	clone()
String	getDescription() Optional.
Boolean	getDisallowAdsPersonalization() Optional.
String	getDisplayName() Required.
String	getName() Output only.
String	getParameterName() Required.
String	getScope() Required.
GoogleAnalyticsAdminV1betaCustomDimension	set(String fieldName, Object value)
GoogleAnalyticsAdminV1betaCustomDimension	setDescription(String description) Optional.
GoogleAnalyticsAdminV1betaCustomDimension	setDisallowAdsPersonalization(Boolean disallowAdsPersonalization) Optional.
GoogleAnalyticsAdminV1betaCustomDimension	setDisplayName(String displayName) Required.
GoogleAnalyticsAdminV1betaCustomDimension	setName(String name) Output only.
GoogleAnalyticsAdminV1betaCustomDimension	setParameterName(String parameterName) Required.
GoogleAnalyticsAdminV1betaCustomDimension	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

GoogleAnalyticsAdminV1betaCustomDimension

public GoogleAnalyticsAdminV1betaCustomDimension()

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 GoogleAnalyticsAdminV1betaCustomDimension setDescription(String description)

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

Parameters:

description - description or null for none

getDisallowAdsPersonalization

public Boolean getDisallowAdsPersonalization()

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

Returns:

value or null for none

setDisallowAdsPersonalization

public GoogleAnalyticsAdminV1betaCustomDimension setDisallowAdsPersonalization(Boolean disallowAdsPersonalization)

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

Parameters:

disallowAdsPersonalization - disallowAdsPersonalization or null for none

getDisplayName

public String getDisplayName()

Required. Display name for this custom dimension 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 GoogleAnalyticsAdminV1betaCustomDimension setDisplayName(String displayName)

Required. Display name for this custom dimension 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

getName

public String getName()

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

Returns:

value or null for none

setName

public GoogleAnalyticsAdminV1betaCustomDimension setName(String name)

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

Parameters:

name - name or null for none

getParameterName

public String getParameterName()

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

Returns:

value or null for none

setParameterName

public GoogleAnalyticsAdminV1betaCustomDimension setParameterName(String parameterName)

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

Parameters:

parameterName - parameterName or null for none

getScope

public String getScope()

Required. Immutable. The scope of this dimension.

Returns:

value or null for none

setScope

public GoogleAnalyticsAdminV1betaCustomDimension setScope(String scope)

Required. Immutable. The scope of this dimension.

Parameters:

scope - scope or null for none

set

public GoogleAnalyticsAdminV1betaCustomDimension set(String fieldName,
                                                     Object value)

Overrides:

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

clone

public GoogleAnalyticsAdminV1betaCustomDimension clone()

Overrides:

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