Google Analytics API v3 (revision 41)



com.google.api.services.analytics.model
Class GaData.Query

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.GaData.Query
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
GaData

public static final class GaData.Query
extends GenericJson

Analytics data request query parameters.


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
GaData.Query()
           
 
Method Summary
 GaData.Query clone()
           
 String getDimensions()
          List of analytics dimensions.
 String getEndDate()
          End date.
 String getFilters()
          Comma-separated list of dimension or metric filters.
 String getIds()
          Unique table ID.
 Integer getMaxResults()
          Maximum results per page.
 List<String> getMetrics()
          List of analytics metrics.
 String getSegment()
          Analytics advanced segment.
 List<String> getSort()
          List of dimensions or metrics based on which Analytics data is sorted.
 String getStartDate()
          Start date.
 Integer getStartIndex()
          Start index.
 GaData.Query set(String fieldName, Object value)
           
 GaData.Query setDimensions(String dimensions)
          List of analytics dimensions.
 GaData.Query setEndDate(String endDate)
          End date.
 GaData.Query setFilters(String filters)
          Comma-separated list of dimension or metric filters.
 GaData.Query setIds(String ids)
          Unique table ID.
 GaData.Query setMaxResults(Integer maxResults)
          Maximum results per page.
 GaData.Query setMetrics(List<String> metrics)
          List of analytics metrics.
 GaData.Query setSegment(String segment)
          Analytics advanced segment.
 GaData.Query setSort(List<String> sort)
          List of dimensions or metrics based on which Analytics data is sorted.
 GaData.Query setStartDate(String startDate)
          Start date.
 GaData.Query setStartIndex(Integer startIndex)
          Start index.
 
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

GaData.Query

public GaData.Query()
Method Detail

getDimensions

public String getDimensions()
List of analytics dimensions.

Returns:
value or null for none

setDimensions

public GaData.Query setDimensions(String dimensions)
List of analytics dimensions.

Parameters:
dimensions - dimensions or null for none

getEndDate

public String getEndDate()
End date.

Returns:
value or null for none

setEndDate

public GaData.Query setEndDate(String endDate)
End date.

Parameters:
endDate - endDate or null for none

getFilters

public String getFilters()
Comma-separated list of dimension or metric filters.

Returns:
value or null for none

setFilters

public GaData.Query setFilters(String filters)
Comma-separated list of dimension or metric filters.

Parameters:
filters - filters or null for none

getIds

public String getIds()
Unique table ID.

Returns:
value or null for none

setIds

public GaData.Query setIds(String ids)
Unique table ID.

Parameters:
ids - ids or null for none

getMaxResults

public Integer getMaxResults()
Maximum results per page.

Returns:
value or null for none

setMaxResults

public GaData.Query setMaxResults(Integer maxResults)
Maximum results per page.

Parameters:
maxResults - maxResults or null for none

getMetrics

public List<String> getMetrics()
List of analytics metrics.

Returns:
value or null for none

setMetrics

public GaData.Query setMetrics(List<String> metrics)
List of analytics metrics.

Parameters:
metrics - metrics or null for none

getSegment

public String getSegment()
Analytics advanced segment.

Returns:
value or null for none

setSegment

public GaData.Query setSegment(String segment)
Analytics advanced segment.

Parameters:
segment - segment or null for none

getSort

public List<String> getSort()
List of dimensions or metrics based on which Analytics data is sorted.

Returns:
value or null for none

setSort

public GaData.Query setSort(List<String> sort)
List of dimensions or metrics based on which Analytics data is sorted.

Parameters:
sort - sort or null for none

getStartDate

public String getStartDate()
Start date.

Returns:
value or null for none

setStartDate

public GaData.Query setStartDate(String startDate)
Start date.

Parameters:
startDate - startDate or null for none

getStartIndex

public Integer getStartIndex()
Start index.

Returns:
value or null for none

setStartIndex

public GaData.Query setStartIndex(Integer startIndex)
Start index.

Parameters:
startIndex - startIndex or null for none

set

public GaData.Query set(String fieldName,
                        Object value)
Overrides:
set in class GenericJson

clone

public GaData.Query clone()
Overrides:
clone in class GenericJson