Google Analytics API v2.4 (revision 33)

com.google.api.services.analytics
Class Analytics.Data.Get

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  com.google.api.services.analytics.AnalyticsRequest<Void>
                      com.google.api.services.analytics.Analytics.Data.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Data

public class Analytics.Data.Get
extends AnalyticsRequest<Void>

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

protected

Analytics.Data.Get(String ids, String startDate, String endDate, String metrics) Returns Analytics report data for a profile.

Method Summary

HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getDimensions() A comma-separated list of Analytics dimensions.
String	getEndDate() End date for fetching report data.
String	getFilters() A comma-separated list of dimension or metric filters to be applied to the report data.
String	getIds() Unique table ID for retrieving report data.
Integer	getMaxResults() The maximum number of entries to include in this feed.
String	getMetrics() A comma-separated list of Analytics metrics.
String	getSegment() An Analytics advanced segment to be applied to the report data.
String	getSort() A comma-separated list of dimensions or metrics that determine the sort order for the report data.
String	getStartDate() Start date for fetching report data.
Integer	getStartIndex() An index of the first entity to retrieve.
Analytics.Data.Get	setAlt(String alt) Data format for the response.
Analytics.Data.Get	setDimensions(String dimensions) A comma-separated list of Analytics dimensions.
Analytics.Data.Get	setEndDate(String endDate) End date for fetching report data.
Analytics.Data.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Data.Get	setFilters(String filters) A comma-separated list of dimension or metric filters to be applied to the report data.
Analytics.Data.Get	setIds(String ids) Unique table ID for retrieving report data.
Analytics.Data.Get	setKey(String key) API key.
Analytics.Data.Get	setMaxResults(Integer maxResults) The maximum number of entries to include in this feed.
Analytics.Data.Get	setMetrics(String metrics) A comma-separated list of Analytics metrics.
Analytics.Data.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Data.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Data.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Data.Get	setSegment(String segment) An Analytics advanced segment to be applied to the report data.
Analytics.Data.Get	setSort(String sort) A comma-separated list of dimensions or metrics that determine the sort order for the report data.
Analytics.Data.Get	setStartDate(String startDate) Start date for fetching report data.
Analytics.Data.Get	setStartIndex(Integer startIndex) An index of the first entity to retrieve.
Analytics.Data.Get	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.analytics.AnalyticsRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Analytics.Data.Get

protected Analytics.Data.Get(String ids,
                             String startDate,
                             String endDate,
                             String metrics)

Returns Analytics report data for a profile. Create a request for the method "data.get". This request holds the parameters needed by the the analytics server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Analytics.initialize(AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

ids - Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID.

startDate - Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM- DD.

endDate - End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.

metrics - A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Void>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Void>

Throws:

IOException

setAlt

public Analytics.Data.Get setAlt(String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<Void>

setFields

public Analytics.Data.Get setFields(String fields)

Description copied from class: AnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsRequest<Void>

setKey

public Analytics.Data.Get setKey(String key)

Description copied from class: AnalyticsRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class AnalyticsRequest<Void>

setOauthToken

public Analytics.Data.Get setOauthToken(String oauthToken)

Description copied from class: AnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsRequest<Void>

setPrettyPrint

public Analytics.Data.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<Void>

setQuotaUser

public Analytics.Data.Get setQuotaUser(String quotaUser)

Description copied from class: AnalyticsRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class AnalyticsRequest<Void>

setUserIp

public Analytics.Data.Get setUserIp(String userIp)

Description copied from class: AnalyticsRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class AnalyticsRequest<Void>

getIds

public String getIds()

Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID.

setIds

public Analytics.Data.Get setIds(String ids)

Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID.

getStartDate

public String getStartDate()

Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM- DD.

setStartDate

public Analytics.Data.Get setStartDate(String startDate)

Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD.

getEndDate

public String getEndDate()

End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD.

setEndDate

public Analytics.Data.Get setEndDate(String endDate)

End date for fetching report data. All requests should specify an end date formatted as YYYY- MM-DD.

getMetrics

public String getMetrics()

A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.

setMetrics

public Analytics.Data.Get setMetrics(String metrics)

A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report.

getMaxResults

public Integer getMaxResults()

The maximum number of entries to include in this feed.

setMaxResults

public Analytics.Data.Get setMaxResults(Integer maxResults)

The maximum number of entries to include in this feed.

getSort

public String getSort()

A comma-separated list of dimensions or metrics that determine the sort order for the report data.

setSort

public Analytics.Data.Get setSort(String sort)

A comma-separated list of dimensions or metrics that determine the sort order for the report data.

getDimensions

public String getDimensions()

A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

setDimensions

public Analytics.Data.Get setDimensions(String dimensions)

A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

getStartIndex

public Integer getStartIndex()

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. [minimum: 1]

setStartIndex

public Analytics.Data.Get setStartIndex(Integer startIndex)

An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

getSegment

public String getSegment()

An Analytics advanced segment to be applied to the report data.

setSegment

public Analytics.Data.Get setSegment(String segment)

An Analytics advanced segment to be applied to the report data.

getFilters

public String getFilters()

A comma-separated list of dimension or metric filters to be applied to the report data.

setFilters

public Analytics.Data.Get setFilters(String filters)

A comma-separated list of dimension or metric filters to be applied to the report data.