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

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Constructors

Constructor and Description
GaData()

Method Summary

Methods

Modifier and Type	Method and Description
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	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

clone, getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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. The value returned may be null.

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. The value set may be null.

getContainsSampledData

public Boolean getContainsSampledData()

Determines if Analytics data contains samples. The value returned may be null.

setContainsSampledData

public GaData setContainsSampledData(Boolean containsSampledData)

Determines if Analytics data contains samples. The value set may be null.

getId

public String getId()

Unique ID for this data response. The value returned may be null.

setId

public GaData setId(String id)

Unique ID for this data response. The value set may be null.

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. The value returned may be null.

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. The value set may be null.

getKind

public String getKind()

Resource type. The value returned may be null.

setKind

public GaData setKind(String kind)

Resource type. The value set may be null.

getNextLink

public String getNextLink()

Link to next page for this Analytics data query. The value returned may be null.

setNextLink

public GaData setNextLink(String nextLink)

Link to next page for this Analytics data query. The value set may be null.

getPreviousLink

public String getPreviousLink()

Link to previous page for this Analytics data query. The value returned may be null.

setPreviousLink

public GaData setPreviousLink(String previousLink)

Link to previous page for this Analytics data query. The value set may be null.

getProfileInfo

public GaData.ProfileInfo getProfileInfo()

Information for the profile, for which the Analytics data was requested. The value returned may be null.

setProfileInfo

public GaData setProfileInfo(GaData.ProfileInfo profileInfo)

Information for the profile, for which the Analytics data was requested. The value set may be null.

getQuery

public GaData.Query getQuery()

Analytics data request query parameters. The value returned may be null.

setQuery

public GaData setQuery(GaData.Query query)

Analytics data request query parameters. The value set may be null.

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. The value returned may be null.

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. The value set may be null.

getSelfLink

public String getSelfLink()

Link to this page. The value returned may be null.

setSelfLink

public GaData setSelfLink(String selfLink)

Link to this page. The value set may be null.

getTotalResults

public Integer getTotalResults()

The total number of rows for the query, regardless of the number of rows in the response. The value returned may be null.

setTotalResults

public GaData setTotalResults(Integer totalResults)

The total number of rows for the query, regardless of the number of rows in the response. The value set may be null.

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. The value returned may be null.

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. The value set may be null.