Google Analytics API v3 (revision 41)

com.google.api.services.analytics
Class Analytics.Management.Experiments.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<Experiment>
                      com.google.api.services.analytics.Analytics.Management.Experiments.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Management.Experiments

public class Analytics.Management.Experiments.Get
extends AnalyticsRequest<Experiment>

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.Experiments.Get(String accountId, String webPropertyId, String profileId, String experimentId) Returns an experiment to which the user has access.

Method Summary

HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getAccountId() Account ID to retrieve the experiment for.
String	getExperimentId() Experiment ID to retrieve the experiment for.
String	getProfileId() Profile ID to retrieve the experiment for.
String	getWebPropertyId() Web property ID to retrieve the experiment for.
Analytics.Management.Experiments.Get	set(String parameterName, Object value)
Analytics.Management.Experiments.Get	setAccountId(String accountId) Account ID to retrieve the experiment for.
Analytics.Management.Experiments.Get	setAlt(String alt) Data format for the response.
Analytics.Management.Experiments.Get	setExperimentId(String experimentId) Experiment ID to retrieve the experiment for.
Analytics.Management.Experiments.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.Experiments.Get	setKey(String key) API key.
Analytics.Management.Experiments.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.Experiments.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.Experiments.Get	setProfileId(String profileId) Profile ID to retrieve the experiment for.
Analytics.Management.Experiments.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Management.Experiments.Get	setUserIp(String userIp) IP address of the site where the request originates.
Analytics.Management.Experiments.Get	setWebPropertyId(String webPropertyId) Web property ID to retrieve the experiment for.

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, checkRequiredParameter, 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, 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.Experiments.Get

protected Analytics.Management.Experiments.Get(String accountId,
                                               String webPropertyId,
                                               String profileId,
                                               String experimentId)

Returns an experiment to which the user has access. Create a request for the method "experiments.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(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

accountId - Account ID to retrieve the experiment for.

webPropertyId - Web property ID to retrieve the experiment for.

profileId - Profile ID to retrieve the experiment for.

experimentId - Experiment ID to retrieve the experiment for.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Experiment>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Experiment>

Throws:

IOException

setAlt

public Analytics.Management.Experiments.Get setAlt(String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<Experiment>

setFields

public Analytics.Management.Experiments.Get setFields(String fields)

Description copied from class: AnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsRequest<Experiment>

setKey

public Analytics.Management.Experiments.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<Experiment>

setOauthToken

public Analytics.Management.Experiments.Get setOauthToken(String oauthToken)

Description copied from class: AnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsRequest<Experiment>

setPrettyPrint

public Analytics.Management.Experiments.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<Experiment>

setQuotaUser

public Analytics.Management.Experiments.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<Experiment>

setUserIp

public Analytics.Management.Experiments.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<Experiment>

getAccountId

public String getAccountId()

Account ID to retrieve the experiment for.

setAccountId

public Analytics.Management.Experiments.Get setAccountId(String accountId)

Account ID to retrieve the experiment for.

getWebPropertyId

public String getWebPropertyId()

Web property ID to retrieve the experiment for.

setWebPropertyId

public Analytics.Management.Experiments.Get setWebPropertyId(String webPropertyId)

Web property ID to retrieve the experiment for.

getProfileId

public String getProfileId()

Profile ID to retrieve the experiment for.

setProfileId

public Analytics.Management.Experiments.Get setProfileId(String profileId)

Profile ID to retrieve the experiment for.

getExperimentId

public String getExperimentId()

Experiment ID to retrieve the experiment for.

setExperimentId

public Analytics.Management.Experiments.Get setExperimentId(String experimentId)

Experiment ID to retrieve the experiment for.

set

public Analytics.Management.Experiments.Get set(String parameterName,
                                                Object value)

Overrides:

set in class AnalyticsRequest<Experiment>