Google Analytics API v3 (revision 41)



com.google.api.services.analytics.model
Class Profile

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.json.GenericJson
              extended by com.google.api.services.analytics.model.Profile
All Implemented Interfaces:
Cloneable, Map<String,Object>

public final class Profile
extends GenericJson

JSON template for an Analytics profile.

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-api-java-client/wiki/Json

Author:
Google, Inc.

Nested Class Summary
static class Profile.ChildLink
          Child link for this profile.
static class Profile.ParentLink
          Parent link for this profile.
 
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
Profile()
           
 
Method Summary
 Profile clone()
           
 String getAccountId()
          Account ID to which this profile belongs.
 Profile.ChildLink getChildLink()
          Child link for this profile.
 DateTime getCreated()
          Time this profile was created.
 String getCurrency()
          The currency type associated with this profile.
 String getDefaultPage()
          Default page for this profile.
 Boolean getECommerceTracking()
          E-commerce tracking parameter for this profile.
 String getExcludeQueryParameters()
          The query parameters that are excluded from this profile.
 String getId()
          Profile ID.
 String getInternalWebPropertyId()
          Internal ID for the web property to which this profile belongs.
 String getKind()
          Resource type for Analytics profile.
 String getName()
          Name of this profile.
 Profile.ParentLink getParentLink()
          Parent link for this profile.
 String getSelfLink()
          Link for this profile.
 String getSiteSearchCategoryParameters()
          Site search category parameters for this profile.
 String getSiteSearchQueryParameters()
          The site search query parameters for this profile.
 String getTimezone()
          Time zone for which this profile has been configured.
 String getType()
          Profile type.
 DateTime getUpdated()
          Time this profile was last modified.
 String getWebPropertyId()
          Web property ID of the form UA-XXXXX-YY to which this profile belongs.
 String getWebsiteUrl()
          Website URL for this profile.
 Profile set(String fieldName, Object value)
           
 Profile setAccountId(String accountId)
          Account ID to which this profile belongs.
 Profile setChildLink(Profile.ChildLink childLink)
          Child link for this profile.
 Profile setCreated(DateTime created)
          Time this profile was created.
 Profile setCurrency(String currency)
          The currency type associated with this profile.
 Profile setDefaultPage(String defaultPage)
          Default page for this profile.
 Profile setECommerceTracking(Boolean eCommerceTracking)
          E-commerce tracking parameter for this profile.
 Profile setExcludeQueryParameters(String excludeQueryParameters)
          The query parameters that are excluded from this profile.
 Profile setId(String id)
          Profile ID.
 Profile setInternalWebPropertyId(String internalWebPropertyId)
          Internal ID for the web property to which this profile belongs.
 Profile setKind(String kind)
          Resource type for Analytics profile.
 Profile setName(String name)
          Name of this profile.
 Profile setParentLink(Profile.ParentLink parentLink)
          Parent link for this profile.
 Profile setSelfLink(String selfLink)
          Link for this profile.
 Profile setSiteSearchCategoryParameters(String siteSearchCategoryParameters)
          Site search category parameters for this profile.
 Profile setSiteSearchQueryParameters(String siteSearchQueryParameters)
          The site search query parameters for this profile.
 Profile setTimezone(String timezone)
          Time zone for which this profile has been configured.
 Profile setType(String type)
          Profile type.
 Profile setUpdated(DateTime updated)
          Time this profile was last modified.
 Profile setWebPropertyId(String webPropertyId)
          Web property ID of the form UA-XXXXX-YY to which this profile belongs.
 Profile setWebsiteUrl(String websiteUrl)
          Website URL for this profile.
 
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

Profile

public Profile()
Method Detail

getAccountId

public String getAccountId()
Account ID to which this profile belongs.

Returns:
value or null for none

setAccountId

public Profile setAccountId(String accountId)
Account ID to which this profile belongs.

Parameters:
accountId - accountId or null for none

getChildLink

public Profile.ChildLink getChildLink()
Child link for this profile. Points to the list of goals for this profile.

Returns:
value or null for none

setChildLink

public Profile setChildLink(Profile.ChildLink childLink)
Child link for this profile. Points to the list of goals for this profile.

Parameters:
childLink - childLink or null for none

getCreated

public DateTime getCreated()
Time this profile was created.

Returns:
value or null for none

setCreated

public Profile setCreated(DateTime created)
Time this profile was created.

Parameters:
created - created or null for none

getCurrency

public String getCurrency()
The currency type associated with this profile.

Returns:
value or null for none

setCurrency

public Profile setCurrency(String currency)
The currency type associated with this profile.

Parameters:
currency - currency or null for none

getDefaultPage

public String getDefaultPage()
Default page for this profile.

Returns:
value or null for none

setDefaultPage

public Profile setDefaultPage(String defaultPage)
Default page for this profile.

Parameters:
defaultPage - defaultPage or null for none

getECommerceTracking

public Boolean getECommerceTracking()
E-commerce tracking parameter for this profile.

Returns:
value or null for none

setECommerceTracking

public Profile setECommerceTracking(Boolean eCommerceTracking)
E-commerce tracking parameter for this profile.

Parameters:
eCommerceTracking - eCommerceTracking or null for none

getExcludeQueryParameters

public String getExcludeQueryParameters()
The query parameters that are excluded from this profile.

Returns:
value or null for none

setExcludeQueryParameters

public Profile setExcludeQueryParameters(String excludeQueryParameters)
The query parameters that are excluded from this profile.

Parameters:
excludeQueryParameters - excludeQueryParameters or null for none

getId

public String getId()
Profile ID.

Returns:
value or null for none

setId

public Profile setId(String id)
Profile ID.

Parameters:
id - id or null for none

getInternalWebPropertyId

public String getInternalWebPropertyId()
Internal ID for the web property to which this profile belongs.

Returns:
value or null for none

setInternalWebPropertyId

public Profile setInternalWebPropertyId(String internalWebPropertyId)
Internal ID for the web property to which this profile belongs.

Parameters:
internalWebPropertyId - internalWebPropertyId or null for none

getKind

public String getKind()
Resource type for Analytics profile.

Returns:
value or null for none

setKind

public Profile setKind(String kind)
Resource type for Analytics profile.

Parameters:
kind - kind or null for none

getName

public String getName()
Name of this profile.

Returns:
value or null for none

setName

public Profile setName(String name)
Name of this profile.

Parameters:
name - name or null for none

getParentLink

public Profile.ParentLink getParentLink()
Parent link for this profile. Points to the web property to which this profile belongs.

Returns:
value or null for none

setParentLink

public Profile setParentLink(Profile.ParentLink parentLink)
Parent link for this profile. Points to the web property to which this profile belongs.

Parameters:
parentLink - parentLink or null for none

getSelfLink

public String getSelfLink()
Link for this profile.

Returns:
value or null for none

setSelfLink

public Profile setSelfLink(String selfLink)
Link for this profile.

Parameters:
selfLink - selfLink or null for none

getSiteSearchCategoryParameters

public String getSiteSearchCategoryParameters()
Site search category parameters for this profile.

Returns:
value or null for none

setSiteSearchCategoryParameters

public Profile setSiteSearchCategoryParameters(String siteSearchCategoryParameters)
Site search category parameters for this profile.

Parameters:
siteSearchCategoryParameters - siteSearchCategoryParameters or null for none

getSiteSearchQueryParameters

public String getSiteSearchQueryParameters()
The site search query parameters for this profile.

Returns:
value or null for none

setSiteSearchQueryParameters

public Profile setSiteSearchQueryParameters(String siteSearchQueryParameters)
The site search query parameters for this profile.

Parameters:
siteSearchQueryParameters - siteSearchQueryParameters or null for none

getTimezone

public String getTimezone()
Time zone for which this profile has been configured.

Returns:
value or null for none

setTimezone

public Profile setTimezone(String timezone)
Time zone for which this profile has been configured.

Parameters:
timezone - timezone or null for none

getType

public String getType()
Profile type. Supported types: WEB or APP.

Returns:
value or null for none

setType

public Profile setType(String type)
Profile type. Supported types: WEB or APP.

Parameters:
type - type or null for none

getUpdated

public DateTime getUpdated()
Time this profile was last modified.

Returns:
value or null for none

setUpdated

public Profile setUpdated(DateTime updated)
Time this profile was last modified.

Parameters:
updated - updated or null for none

getWebPropertyId

public String getWebPropertyId()
Web property ID of the form UA-XXXXX-YY to which this profile belongs.

Returns:
value or null for none

setWebPropertyId

public Profile setWebPropertyId(String webPropertyId)
Web property ID of the form UA-XXXXX-YY to which this profile belongs.

Parameters:
webPropertyId - webPropertyId or null for none

getWebsiteUrl

public String getWebsiteUrl()
Website URL for this profile.

Returns:
value or null for none

setWebsiteUrl

public Profile setWebsiteUrl(String websiteUrl)
Website URL for this profile.

Parameters:
websiteUrl - websiteUrl or null for none

set

public Profile set(String fieldName,
                   Object value)
Overrides:
set in class GenericJson

clone

public Profile clone()
Overrides:
clone in class GenericJson