CustomMetric (Google Analytics API v3 (Rev. 116) 1.20.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.CustomMetric

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class CustomMetric
extends com.google.api.client.json.GenericJson
```
JSON template for Analytics 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 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 CustomMetric.ParentLink
Parent link for the custom metric.
- 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`	`CustomMetric.ParentLink` Parent link for the custom metric.

Constructor Summary

Constructors
Constructor and Description

CustomMetric()

Constructors
Constructor and Description
`CustomMetric()`

Method Summary

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

- Constructor Detail
  - CustomMetric
```
public CustomMetric()
```
- Method Detail
  - getAccountId
```
public java.lang.String getAccountId()
```
    Account ID.
    
    Returns:
    value or null for none
  - setAccountId
```
public CustomMetric 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 metric is active.
    
    Returns:
    value or null for none
  - setActive
```
public CustomMetric setActive(java.lang.Boolean active)
```
    Boolean indicating whether the custom metric is active.
    
    Parameters:
    active - active or null for none
  - getCreated
```
public com.google.api.client.util.DateTime getCreated()
```
    Time the custom metric was created.
    
    Returns:
    value or null for none
  - setCreated
```
public CustomMetric setCreated(com.google.api.client.util.DateTime created)
```
    Time the custom metric was created.
    
    Parameters:
    created - created or null for none
  - getId
```
public java.lang.String getId()
```
    Custom metric ID.
    
    Returns:
    value or null for none
  - setId
```
public CustomMetric setId(java.lang.String id)
```
    Custom metric ID.
    
    Parameters:
    id - id or null for none
  - getIndex
```
public java.lang.Integer getIndex()
```
    Index of the custom metric.
    
    Returns:
    value or null for none
  - setIndex
```
public CustomMetric setIndex(java.lang.Integer index)
```
    Index of the custom metric.
    
    Parameters:
    index - index or null for none
  - getKind
```
public java.lang.String getKind()
```
    Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
    
    Returns:
    value or null for none
  - setKind
```
public CustomMetric setKind(java.lang.String kind)
```
    Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
    
    Parameters:
    kind - kind or null for none
  - getMaxValue
```
public java.lang.String getMaxValue()
```
    Max value of custom metric.
    
    Returns:
    value or null for none
  - setMaxValue
```
public CustomMetric setMaxValue(java.lang.String maxValue)
```
    Max value of custom metric.
    
    Parameters:
    maxValue - maxValue or null for none
  - getMinValue
```
public java.lang.String getMinValue()
```
    Min value of custom metric.
    
    Returns:
    value or null for none
  - setMinValue
```
public CustomMetric setMinValue(java.lang.String minValue)
```
    Min value of custom metric.
    
    Parameters:
    minValue - minValue or null for none
  - getName
```
public java.lang.String getName()
```
    Name of the custom metric.
    
    Returns:
    value or null for none
  - setName
```
public CustomMetric setName(java.lang.String name)
```
    Name of the custom metric.
    
    Parameters:
    name - name or null for none
  - getParentLink
```
public CustomMetric.ParentLink getParentLink()
```
    Parent link for the custom metric. Points to the property to which the custom metric belongs.
    
    Returns:
    value or null for none
  - setParentLink
```
public CustomMetric setParentLink(CustomMetric.ParentLink parentLink)
```
    Parent link for the custom metric. Points to the property to which the custom metric belongs.
    
    Parameters:
    parentLink - parentLink or null for none
  - getScope
```
public java.lang.String getScope()
```
    Scope of the custom metric: HIT or PRODUCT.
    
    Returns:
    value or null for none
  - setScope
```
public CustomMetric setScope(java.lang.String scope)
```
    Scope of the custom metric: HIT or PRODUCT.
    
    Parameters:
    scope - scope or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    Link for the custom metric
    
    Returns:
    value or null for none
  - setSelfLink
```
public CustomMetric setSelfLink(java.lang.String selfLink)
```
    Link for the custom metric
    
    Parameters:
    selfLink - selfLink or null for none
  - getType
```
public java.lang.String getType()
```
    Data type of custom metric.
    
    Returns:
    value or null for none
  - setType
```
public CustomMetric setType(java.lang.String type)
```
    Data type of custom metric.
    
    Parameters:
    type - type or null for none
  - getUpdated
```
public com.google.api.client.util.DateTime getUpdated()
```
    Time the custom metric was last modified.
    
    Returns:
    value or null for none
  - setUpdated
```
public CustomMetric setUpdated(com.google.api.client.util.DateTime updated)
```
    Time the custom metric 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 CustomMetric setWebPropertyId(java.lang.String webPropertyId)
```
    Property ID.
    
    Parameters:
    webPropertyId - webPropertyId or null for none
  - set
```
public CustomMetric set(java.lang.String fieldName,
               java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CustomMetric clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Analytics API v3 (revision 116)

Class CustomMetric

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

Constructor Detail

CustomMetric

Method Detail

getAccountId

setAccountId

getActive

setActive

getCreated

setCreated

getId

setId

getIndex

setIndex

getKind

setKind

getMaxValue

setMaxValue

getMinValue

setMinValue

getName

setName

getParentLink

setParentLink

getScope

setScope

getSelfLink

setSelfLink

getType

setType

getUpdated

setUpdated

getWebPropertyId

setWebPropertyId

set

clone