com.google.api.services.analytics

Class Analytics.Management.CustomDimensions.Get

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<CustomDimension>

com.google.api.services.analytics.Analytics.Management.CustomDimensions.Get

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Analytics.Management.CustomDimensions

public class Analytics.Management.CustomDimensions.Get
extends AnalyticsRequest<CustomDimension>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Analytics.Management.CustomDimensions.Get(java.lang.String accountId, java.lang.String webPropertyId, java.lang.String customDimensionId) Get a custom dimension to which the user has access.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getAccountId() Account ID for the custom dimension to retrieve.
java.lang.String	getCustomDimensionId() The ID of the custom dimension to retrieve.
java.lang.String	getWebPropertyId() Web property ID for the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	set(java.lang.String parameterName, java.lang.Object value)
Analytics.Management.CustomDimensions.Get	setAccountId(java.lang.String accountId) Account ID for the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	setAlt(java.lang.String alt) Data format for the response.
Analytics.Management.CustomDimensions.Get	setCustomDimensionId(java.lang.String customDimensionId) The ID of the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.CustomDimensions.Get	setKey(java.lang.String key) API key.
Analytics.Management.CustomDimensions.Get	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.CustomDimensions.Get	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.CustomDimensions.Get	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Management.CustomDimensions.Get	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
Analytics.Management.CustomDimensions.Get	setWebPropertyId(java.lang.String webPropertyId) Web property ID for the custom dimension 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, 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.CustomDimensions.Get

protected Analytics.Management.CustomDimensions.Get(java.lang.String accountId,
                                         java.lang.String webPropertyId,
                                         java.lang.String customDimensionId)

Get a custom dimension to which the user has access. Create a request for the method "customDimensions.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 for the custom dimension to retrieve.

webPropertyId - Web property ID for the custom dimension to retrieve.

customDimensionId - The ID of the custom dimension to retrieve.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CustomDimension>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CustomDimension>

Throws:

java.io.IOException

setAlt

public Analytics.Management.CustomDimensions.Get setAlt(java.lang.String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<CustomDimension>

setFields

public Analytics.Management.CustomDimensions.Get setFields(java.lang.String fields)

Description copied from class: AnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsRequest<CustomDimension>

setKey

public Analytics.Management.CustomDimensions.Get setKey(java.lang.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<CustomDimension>

setOauthToken

public Analytics.Management.CustomDimensions.Get setOauthToken(java.lang.String oauthToken)

Description copied from class: AnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsRequest<CustomDimension>

setPrettyPrint

public Analytics.Management.CustomDimensions.Get setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<CustomDimension>

setQuotaUser

public Analytics.Management.CustomDimensions.Get setQuotaUser(java.lang.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<CustomDimension>

setUserIp

public Analytics.Management.CustomDimensions.Get setUserIp(java.lang.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<CustomDimension>

getAccountId

public java.lang.String getAccountId()

Account ID for the custom dimension to retrieve.

setAccountId

public Analytics.Management.CustomDimensions.Get setAccountId(java.lang.String accountId)

Account ID for the custom dimension to retrieve.

getWebPropertyId

public java.lang.String getWebPropertyId()

Web property ID for the custom dimension to retrieve.

setWebPropertyId

public Analytics.Management.CustomDimensions.Get setWebPropertyId(java.lang.String webPropertyId)

Web property ID for the custom dimension to retrieve.

getCustomDimensionId

public java.lang.String getCustomDimensionId()

The ID of the custom dimension to retrieve.

setCustomDimensionId

public Analytics.Management.CustomDimensions.Get setCustomDimensionId(java.lang.String customDimensionId)

The ID of the custom dimension to retrieve.

set

public Analytics.Management.CustomDimensions.Get set(java.lang.String parameterName,
                                            java.lang.Object value)

Overrides:

set in class AnalyticsRequest<CustomDimension>