com.google.api.services.analytics.model

Class CustomDimension

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analytics.model.CustomDimension

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CustomDimension
extends GenericJson

JSON template for Analytics Custom 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 API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomDimension.ParentLink Parent link for the custom dimension.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
CustomDimension	clone()
String	getAccountId() Account ID.
Boolean	getActive() Boolean indicating whether the custom dimension is active.
DateTime	getCreated() Time the custom dimension was created.
String	getId() Custom dimension ID.
Integer	getIndex() Index of the custom dimension.
String	getKind() Kind value for a custom dimension.
String	getName() Name of the custom dimension.
CustomDimension.ParentLink	getParentLink() Parent link for the custom dimension.
String	getScope() Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
String	getSelfLink() Link for the custom dimension
DateTime	getUpdated() Time the custom dimension was last modified.
String	getWebPropertyId() Property ID.
CustomDimension	set(String fieldName, Object value)
CustomDimension	setAccountId(String accountId) Account ID.
CustomDimension	setActive(Boolean active) Boolean indicating whether the custom dimension is active.
CustomDimension	setCreated(DateTime created) Time the custom dimension was created.
CustomDimension	setId(String id) Custom dimension ID.
CustomDimension	setIndex(Integer index) Index of the custom dimension.
CustomDimension	setKind(String kind) Kind value for a custom dimension.
CustomDimension	setName(String name) Name of the custom dimension.
CustomDimension	setParentLink(CustomDimension.ParentLink parentLink) Parent link for the custom dimension.
CustomDimension	setScope(String scope) Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
CustomDimension	setSelfLink(String selfLink) Link for the custom dimension
CustomDimension	setUpdated(DateTime updated) Time the custom dimension was last modified.
CustomDimension	setWebPropertyId(String webPropertyId) Property ID.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDimension

public CustomDimension()

Method Detail

getAccountId

public String getAccountId()

Account ID.

Returns:

value or null for none

setAccountId

public CustomDimension setAccountId(String accountId)

Account ID.

Parameters:

accountId - accountId or null for none

getActive

public Boolean getActive()

Boolean indicating whether the custom dimension is active.

Returns:

value or null for none

setActive

public CustomDimension setActive(Boolean active)

Boolean indicating whether the custom dimension is active.

Parameters:

active - active or null for none

getCreated

public DateTime getCreated()

Time the custom dimension was created.

Returns:

value or null for none

setCreated

public CustomDimension setCreated(DateTime created)

Time the custom dimension was created.

Parameters:

created - created or null for none

getId

public String getId()

Custom dimension ID.

Returns:

value or null for none

setId

public CustomDimension setId(String id)

Custom dimension ID.

Parameters:

id - id or null for none

getIndex

public Integer getIndex()

Index of the custom dimension.

Returns:

value or null for none

setIndex

public CustomDimension setIndex(Integer index)

Index of the custom dimension.

Parameters:

index - index or null for none

getKind

public String getKind()

Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.

Returns:

value or null for none

setKind

public CustomDimension setKind(String kind)

Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.

Parameters:

kind - kind or null for none

getName

public String getName()

Name of the custom dimension.

Returns:

value or null for none

setName

public CustomDimension setName(String name)

Name of the custom dimension.

Parameters:

name - name or null for none

getParentLink

public CustomDimension.ParentLink getParentLink()

Parent link for the custom dimension. Points to the property to which the custom dimension belongs.

Returns:

value or null for none

setParentLink

public CustomDimension setParentLink(CustomDimension.ParentLink parentLink)

Parent link for the custom dimension. Points to the property to which the custom dimension belongs.

Parameters:

parentLink - parentLink or null for none

getScope

public String getScope()

Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

Returns:

value or null for none

setScope

public CustomDimension setScope(String scope)

Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.

Parameters:

scope - scope or null for none

getSelfLink

public String getSelfLink()

Link for the custom dimension

Returns:

value or null for none

setSelfLink

public CustomDimension setSelfLink(String selfLink)

Link for the custom dimension

Parameters:

selfLink - selfLink or null for none

getUpdated

public DateTime getUpdated()

Time the custom dimension was last modified.

Returns:

value or null for none

setUpdated

public CustomDimension setUpdated(DateTime updated)

Time the custom dimension was last modified.

Parameters:

updated - updated or null for none

getWebPropertyId

public String getWebPropertyId()

Property ID.

Returns:

value or null for none

setWebPropertyId

public CustomDimension setWebPropertyId(String webPropertyId)

Property ID.

Parameters:

webPropertyId - webPropertyId or null for none

set

public CustomDimension set(String fieldName,
                  Object value)

Overrides:

set in class GenericJson

clone

public CustomDimension clone()

Overrides:

clone in class GenericJson