Google Analytics API v2.4 (revision 33)

com.google.api.services.analytics
Class Analytics.Management.Profiles.List

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.Management.Profiles.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Management.Profiles

public class Analytics.Management.Profiles.List
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.Management.Profiles.List(String accountId, String webPropertyId) Lists profiles to which the user has access.

Method Summary

HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getAccountId() Account ID for the profiles to retrieve.
Integer	getMaxResults() The maximum number of profiles to include in this response.
Integer	getStartIndex() An index of the first entity to retrieve.
String	getWebPropertyId() Web property ID for the profiles to retrieve.
Analytics.Management.Profiles.List	setAccountId(String accountId) Account ID for the profiles to retrieve.
Analytics.Management.Profiles.List	setAlt(String alt) Data format for the response.
Analytics.Management.Profiles.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.Profiles.List	setKey(String key) API key.
Analytics.Management.Profiles.List	setMaxResults(Integer maxResults) The maximum number of profiles to include in this response.
Analytics.Management.Profiles.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.Profiles.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.Profiles.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Management.Profiles.List	setStartIndex(Integer startIndex) An index of the first entity to retrieve.
Analytics.Management.Profiles.List	setUserIp(String userIp) IP address of the site where the request originates.
Analytics.Management.Profiles.List	setWebPropertyId(String webPropertyId) Web property ID for the profiles to retrieve.

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.Management.Profiles.List

protected Analytics.Management.Profiles.List(String accountId,
                                             String webPropertyId)

Lists profiles to which the user has access. Create a request for the method "profiles.list". 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:

accountId - Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.

webPropertyId - Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.

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.Management.Profiles.List setAlt(String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<Void>

setFields

public Analytics.Management.Profiles.List 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.Management.Profiles.List 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.Management.Profiles.List 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.Management.Profiles.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<Void>

setQuotaUser

public Analytics.Management.Profiles.List 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.Management.Profiles.List 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>

getAccountId

public String getAccountId()

Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.

setAccountId

public Analytics.Management.Profiles.List setAccountId(String accountId)

Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.

getWebPropertyId

public String getWebPropertyId()

Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.

setWebPropertyId

public Analytics.Management.Profiles.List setWebPropertyId(String webPropertyId)

Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.

getMaxResults

public Integer getMaxResults()

The maximum number of profiles to include in this response.

setMaxResults

public Analytics.Management.Profiles.List setMaxResults(Integer maxResults)

The maximum number of profiles to include in this response.

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.Management.Profiles.List setStartIndex(Integer startIndex)

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