Google Analytics API v3 (revision 41)



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

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.Goals
All Implemented Interfaces:
Cloneable, Map<String,Object>

public final class Goals
extends GenericJson

A goal collection lists Analytics goals to which the user has access. Each profile can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.

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
 
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
Goals()
           
 
Method Summary
 Goals clone()
           
 List<Goal> getItems()
          A list of goals.
 Integer getItemsPerPage()
          The maximum number of resources the response can contain, regardless of the actual number of resources returned.
 String getKind()
          Collection type.
 String getNextLink()
          Link to next page for this goal collection.
 String getPreviousLink()
          Link to previous page for this goal collection.
 Integer getStartIndex()
          The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
 Integer getTotalResults()
          The total number of results for the query, regardless of the number of resources in the result.
 String getUsername()
          Email ID of the authenticated user
 Goals set(String fieldName, Object value)
           
 Goals setItems(List<Goal> items)
          A list of goals.
 Goals setItemsPerPage(Integer itemsPerPage)
          The maximum number of resources the response can contain, regardless of the actual number of resources returned.
 Goals setKind(String kind)
          Collection type.
 Goals setNextLink(String nextLink)
          Link to next page for this goal collection.
 Goals setPreviousLink(String previousLink)
          Link to previous page for this goal collection.
 Goals setStartIndex(Integer startIndex)
          The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.
 Goals setTotalResults(Integer totalResults)
          The total number of results for the query, regardless of the number of resources in the result.
 Goals setUsername(String username)
          Email ID of the authenticated user
 
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

Goals

public Goals()
Method Detail

getItems

public List<Goal> getItems()
A list of goals.

Returns:
value or null for none

setItems

public Goals setItems(List<Goal> items)
A list of goals.

Parameters:
items - items or null for none

getItemsPerPage

public Integer getItemsPerPage()
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Returns:
value or null for none

setItemsPerPage

public Goals setItemsPerPage(Integer itemsPerPage)
The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Parameters:
itemsPerPage - itemsPerPage or null for none

getKind

public String getKind()
Collection type.

Returns:
value or null for none

setKind

public Goals setKind(String kind)
Collection type.

Parameters:
kind - kind or null for none

getNextLink

public String getNextLink()
Link to next page for this goal collection.

Returns:
value or null for none

setNextLink

public Goals setNextLink(String nextLink)
Link to next page for this goal collection.

Parameters:
nextLink - nextLink or null for none

getPreviousLink

public String getPreviousLink()
Link to previous page for this goal collection.

Returns:
value or null for none

setPreviousLink

public Goals setPreviousLink(String previousLink)
Link to previous page for this goal collection.

Parameters:
previousLink - previousLink or null for none

getStartIndex

public Integer getStartIndex()
The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.

Returns:
value or null for none

setStartIndex

public Goals setStartIndex(Integer startIndex)
The starting index of the resources, which is 1 by default or otherwise specified by the start- index query parameter.

Parameters:
startIndex - startIndex or null for none

getTotalResults

public Integer getTotalResults()
The total number of results for the query, regardless of the number of resources in the result.

Returns:
value or null for none

setTotalResults

public Goals setTotalResults(Integer totalResults)
The total number of results for the query, regardless of the number of resources in the result.

Parameters:
totalResults - totalResults or null for none

getUsername

public String getUsername()
Email ID of the authenticated user

Returns:
value or null for none

setUsername

public Goals setUsername(String username)
Email ID of the authenticated user

Parameters:
username - username or null for none

set

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

clone

public Goals clone()
Overrides:
clone in class GenericJson