Google Analytics API v3 (revision 41)

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GaData
extends GenericJson

Analytics data for a given 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	GaData.ColumnHeaders Model definition for GaDataColumnHeaders.
static class	GaData.ProfileInfo Information for the profile, for which the Analytics data was requested.
static class	GaData.Query Analytics data request query parameters.

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()

Method Summary

GaData	clone()
List<GaData.ColumnHeaders>	getColumnHeaders() Column headers that list dimension names followed by the metric names.
Boolean	getContainsSampledData() Determines if Analytics data contains samples.
String	getId() Unique ID for this data response.
Integer	getItemsPerPage() The maximum number of rows the response can contain, regardless of the actual number of rows returned.
String	getKind() Resource type.
String	getNextLink() Link to next page for this Analytics data query.
String	getPreviousLink() Link to previous page for this Analytics data query.
GaData.ProfileInfo	getProfileInfo() Information for the profile, for which the Analytics data was requested.
GaData.Query	getQuery() Analytics data request query parameters.
List<List<String>>	getRows() Analytics data rows, where each row contains a list of dimension values followed by the metric values.
String	getSelfLink() Link to this page.
Integer	getTotalResults() The total number of rows for the query, regardless of the number of rows in the response.
Map<String,String>	getTotalsForAllResults() Total values for the requested metrics over all the results, not just the results returned in this response.
GaData	set(String fieldName, Object value)
GaData	setColumnHeaders(List<GaData.ColumnHeaders> columnHeaders) Column headers that list dimension names followed by the metric names.
GaData	setContainsSampledData(Boolean containsSampledData) Determines if Analytics data contains samples.
GaData	setId(String id) Unique ID for this data response.
GaData	setItemsPerPage(Integer itemsPerPage) The maximum number of rows the response can contain, regardless of the actual number of rows returned.
GaData	setKind(String kind) Resource type.
GaData	setNextLink(String nextLink) Link to next page for this Analytics data query.
GaData	setPreviousLink(String previousLink) Link to previous page for this Analytics data query.
GaData	setProfileInfo(GaData.ProfileInfo profileInfo) Information for the profile, for which the Analytics data was requested.
GaData	setQuery(GaData.Query query) Analytics data request query parameters.
GaData	setRows(List<List<String>> rows) Analytics data rows, where each row contains a list of dimension values followed by the metric values.
GaData	setSelfLink(String selfLink) Link to this page.
GaData	setTotalResults(Integer totalResults) The total number of rows for the query, regardless of the number of rows in the response.
GaData	setTotalsForAllResults(Map<String,String> totalsForAllResults) Total values for the requested metrics over all the results, not just the results returned in this response.

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

public GaData()

Method Detail

getColumnHeaders

public List<GaData.ColumnHeaders> getColumnHeaders()

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setColumnHeaders

public GaData setColumnHeaders(List<GaData.ColumnHeaders> columnHeaders)

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Parameters:

columnHeaders - columnHeaders or null for none

getContainsSampledData

public Boolean getContainsSampledData()

Determines if Analytics data contains samples.

Returns:

value or null for none

setContainsSampledData

public GaData setContainsSampledData(Boolean containsSampledData)

Determines if Analytics data contains samples.

Parameters:

containsSampledData - containsSampledData or null for none

getId

public String getId()

Unique ID for this data response.

Returns:

value or null for none

setId

public GaData setId(String id)

Unique ID for this data response.

Parameters:

id - id or null for none

getItemsPerPage

public Integer getItemsPerPage()

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.

Returns:

value or null for none

setItemsPerPage

public GaData setItemsPerPage(Integer itemsPerPage)

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 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()

Resource type.

Returns:

value or null for none

setKind

public GaData setKind(String kind)

Resource type.

Parameters:

kind - kind or null for none

getNextLink

public String getNextLink()

Link to next page for this Analytics data query.

Returns:

value or null for none

setNextLink

public GaData setNextLink(String nextLink)

Link to next page for this Analytics data query.

Parameters:

nextLink - nextLink or null for none

getPreviousLink

public String getPreviousLink()

Link to previous page for this Analytics data query.

Returns:

value or null for none

setPreviousLink

public GaData setPreviousLink(String previousLink)

Link to previous page for this Analytics data query.

Parameters:

previousLink - previousLink or null for none

getProfileInfo

public GaData.ProfileInfo getProfileInfo()

Information for the profile, for which the Analytics data was requested.

Returns:

value or null for none

setProfileInfo

public GaData setProfileInfo(GaData.ProfileInfo profileInfo)

Information for the profile, for which the Analytics data was requested.

Parameters:

profileInfo - profileInfo or null for none

getQuery

public GaData.Query getQuery()

Analytics data request query parameters.

Returns:

value or null for none

setQuery

public GaData setQuery(GaData.Query query)

Analytics data request query parameters.

Parameters:

query - query or null for none

getRows

public List<List<String>> getRows()

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setRows

public GaData setRows(List<List<String>> rows)

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Parameters:

rows - rows or null for none

getSelfLink

public String getSelfLink()

Link to this page.

Returns:

value or null for none

setSelfLink

public GaData setSelfLink(String selfLink)

Link to this page.

Parameters:

selfLink - selfLink or null for none

getTotalResults

public Integer getTotalResults()

The total number of rows for the query, regardless of the number of rows in the response.

Returns:

value or null for none

setTotalResults

public GaData setTotalResults(Integer totalResults)

The total number of rows for the query, regardless of the number of rows in the response.

Parameters:

totalResults - totalResults or null for none

getTotalsForAllResults

public Map<String,String> getTotalsForAllResults()

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Returns:

value or null for none

setTotalsForAllResults

public GaData setTotalsForAllResults(Map<String,String> totalsForAllResults)

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Parameters:

totalsForAllResults - totalsForAllResults or null for none

set

public GaData set(String fieldName,
                  Object value)

Overrides:

set in class GenericJson

clone

public GaData clone()

Overrides:

clone in class GenericJson