CustomDimension (Google Analytics API v3 (Rev. 161) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.analytics.model.CustomDimension

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class CustomDimension
extends com.google.api.client.json.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: https://developers.google.com/api-client-library/java/google-http-java-client/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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

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

Constructor Summary

Constructors
Constructor and Description

CustomDimension()

Constructors
Constructor and Description
`CustomDimension()`

Method Summary

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - CustomDimension
```
public CustomDimension()
```
- Method Detail
  - getAccountId
```
public java.lang.String getAccountId()
```
    Account ID.
    
    Returns:
    
    value or null for none
  - setAccountId
```
public CustomDimension setAccountId(java.lang.String accountId)
```
    Account ID.
    
    Parameters:
    
    accountId - accountId or null for none
  - getActive
```
public java.lang.Boolean getActive()
```
    Boolean indicating whether the custom dimension is active.
    
    Returns:
    
    value or null for none
  - setActive
```
public CustomDimension setActive(java.lang.Boolean active)
```
    Boolean indicating whether the custom dimension is active.
    
    Parameters:
    
    active - active or null for none
  - getCreated
```
public com.google.api.client.util.DateTime getCreated()
```
    Time the custom dimension was created.
    
    Returns:
    
    value or null for none
  - setCreated
```
public CustomDimension setCreated(com.google.api.client.util.DateTime created)
```
    Time the custom dimension was created.
    
    Parameters:
    
    created - created or null for none
  - getId
```
public java.lang.String getId()
```
    Custom dimension ID.
    
    Returns:
    
    value or null for none
  - setId
```
public CustomDimension setId(java.lang.String id)
```
    Custom dimension ID.
    
    Parameters:
    
    id - id or null for none
  - getIndex
```
public java.lang.Integer getIndex()
```
    Index of the custom dimension.
    
    Returns:
    
    value or null for none
  - setIndex
```
public CustomDimension setIndex(java.lang.Integer index)
```
    Index of the custom dimension.
    
    Parameters:
    
    index - index or null for none
  - getKind
```
public java.lang.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(java.lang.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 java.lang.String getName()
```
    Name of the custom dimension.
    
    Returns:
    
    value or null for none
  - setName
```
public CustomDimension setName(java.lang.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 java.lang.String getScope()
```
    Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
    
    Returns:
    
    value or null for none
  - setScope
```
public CustomDimension setScope(java.lang.String scope)
```
    Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
    
    Parameters:
    
    scope - scope or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    Link for the custom dimension
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public CustomDimension setSelfLink(java.lang.String selfLink)
```
    Link for the custom dimension
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getUpdated
```
public com.google.api.client.util.DateTime getUpdated()
```
    Time the custom dimension was last modified.
    
    Returns:
    
    value or null for none
  - setUpdated
```
public CustomDimension setUpdated(com.google.api.client.util.DateTime updated)
```
    Time the custom dimension was last modified.
    
    Parameters:
    
    updated - updated or null for none
  - getWebPropertyId
```
public java.lang.String getWebPropertyId()
```
    Property ID.
    
    Returns:
    
    value or null for none
  - setWebPropertyId
```
public CustomDimension setWebPropertyId(java.lang.String webPropertyId)
```
    Property ID.
    
    Parameters:
    
    webPropertyId - webPropertyId or null for none
  - set
```
public CustomDimension set(java.lang.String fieldName,
                           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CustomDimension clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Analytics API v3 (revision 161)

Class CustomDimension

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CustomDimension

Method Detail

getAccountId

setAccountId

getActive

setActive

getCreated

setCreated

getId

setId

getIndex

setIndex

getKind

setKind

getName

setName

getParentLink

setParentLink

getScope

setScope

getSelfLink

setSelfLink

getUpdated

setUpdated

getWebPropertyId

setWebPropertyId

set

clone