com.google.api.services.analytics

Class Analytics.Management.CustomDimensions.Update

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.Update

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Management.CustomDimensions

public class Analytics.Management.CustomDimensions.Update
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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Analytics.Management.CustomDimensions.Update(String accountId, String webPropertyId, String customDimensionId, CustomDimension content) Updates an existing custom dimension.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccountId() Account ID for the custom dimension to update.
String	getCustomDimensionId() Custom dimension ID for the custom dimension to update.
Boolean	getIgnoreCustomDataSourceLinks() Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
String	getWebPropertyId() Web property ID for the custom dimension to update.
boolean	isIgnoreCustomDataSourceLinks() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Analytics.Management.CustomDimensions.Update	set(String parameterName, Object value)
Analytics.Management.CustomDimensions.Update	setAccountId(String accountId) Account ID for the custom dimension to update.
Analytics.Management.CustomDimensions.Update	setAlt(String alt) Data format for the response.
Analytics.Management.CustomDimensions.Update	setCustomDimensionId(String customDimensionId) Custom dimension ID for the custom dimension to update.
Analytics.Management.CustomDimensions.Update	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.CustomDimensions.Update	setIgnoreCustomDataSourceLinks(Boolean ignoreCustomDataSourceLinks) Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
Analytics.Management.CustomDimensions.Update	setKey(String key) API key.
Analytics.Management.CustomDimensions.Update	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.CustomDimensions.Update	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.CustomDimensions.Update	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Analytics.Management.CustomDimensions.Update	setUserIp(String userIp) IP address of the site where the request originates.
Analytics.Management.CustomDimensions.Update	setWebPropertyId(String webPropertyId) Web property ID for the custom dimension to update.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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.Update

protected Analytics.Management.CustomDimensions.Update(String accountId,
                                            String webPropertyId,
                                            String customDimensionId,
                                            CustomDimension content)

Updates an existing custom dimension. Create a request for the method "customDimensions.update". 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 update.

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

customDimensionId - Custom dimension ID for the custom dimension to update.

content - the CustomDimension

Since:

1.13

Method Detail

setAlt

public Analytics.Management.CustomDimensions.Update setAlt(String alt)

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<CustomDimension>

setFields

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

setUserIp

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

getAccountId

public String getAccountId()

Account ID for the custom dimension to update.

setAccountId

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

Account ID for the custom dimension to update.

getWebPropertyId

public String getWebPropertyId()

Web property ID for the custom dimension to update.

setWebPropertyId

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

Web property ID for the custom dimension to update.

getCustomDimensionId

public String getCustomDimensionId()

Custom dimension ID for the custom dimension to update.

setCustomDimensionId

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

Custom dimension ID for the custom dimension to update.

getIgnoreCustomDataSourceLinks

public Boolean getIgnoreCustomDataSourceLinks()

Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. [default: false]

setIgnoreCustomDataSourceLinks

public Analytics.Management.CustomDimensions.Update setIgnoreCustomDataSourceLinks(Boolean ignoreCustomDataSourceLinks)

Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

isIgnoreCustomDataSourceLinks

public boolean isIgnoreCustomDataSourceLinks()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

set

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

Overrides:

set in class AnalyticsRequest<CustomDimension>