com.google.api.services.analytics

Class Analytics.Management.CustomDimensions.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<CustomDimension>

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

All Implemented Interfaces:

Cloneable, Map<String,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

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getAccountId() Account ID for the custom dimension to retrieve.
String	getCustomDimensionId() The ID of the custom dimension to retrieve.
String	getWebPropertyId() Web property ID for the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	set(String parameterName, Object value)
Analytics.Management.CustomDimensions.Get	setAccountId(String accountId) Account ID for the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	setAlt(String alt) Data format for the response.
Analytics.Management.CustomDimensions.Get	setCustomDimensionId(String customDimensionId) The ID of the custom dimension to retrieve.
Analytics.Management.CustomDimensions.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.CustomDimensions.Get	setKey(String key) API key.
Analytics.Management.CustomDimensions.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.CustomDimensions.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.CustomDimensions.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Analytics.Management.CustomDimensions.Get	setUserIp(String userIp) Deprecated.
Analytics.Management.CustomDimensions.Get	setWebPropertyId(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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Get

protected Get(String accountId,
              String webPropertyId,
              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 HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<CustomDimension>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<CustomDimension>

Throws:

IOException

setAlt

public Analytics.Management.CustomDimensions.Get setAlt(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(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(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(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(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(String quotaUser)

Description copied from class: AnalyticsRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class AnalyticsRequest<CustomDimension>

setUserIp

public Analytics.Management.CustomDimensions.Get setUserIp(String userIp)

Description copied from class: AnalyticsRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class AnalyticsRequest<CustomDimension>

getAccountId

public String getAccountId()

Account ID for the custom dimension to retrieve.

setAccountId

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

Account ID for the custom dimension to retrieve.

getWebPropertyId

public String getWebPropertyId()

Web property ID for the custom dimension to retrieve.

setWebPropertyId

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

Web property ID for the custom dimension to retrieve.

getCustomDimensionId

public String getCustomDimensionId()

The ID of the custom dimension to retrieve.

setCustomDimensionId

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

The ID of the custom dimension to retrieve.

set

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

Overrides:

set in class AnalyticsRequest<CustomDimension>