com.google.api.services.analytics

Class Analytics.Management.CustomMetrics.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<CustomMetric>

com.google.api.services.analytics.Analytics.Management.CustomMetrics.Update

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Analytics.Management.CustomMetrics

public class Analytics.Management.CustomMetrics.Update
extends AnalyticsRequest<CustomMetric>

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	Update(String accountId, String webPropertyId, String customMetricId, CustomMetric content) Updates an existing custom metric.

Method Summary

Modifier and Type	Method and Description
String	getAccountId() Account ID for the custom metric to update.
String	getCustomMetricId() Custom metric ID for the custom metric to update.
Boolean	getIgnoreCustomDataSourceLinks() Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
String	getWebPropertyId() Web property ID for the custom metric to update.
boolean	isIgnoreCustomDataSourceLinks() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Analytics.Management.CustomMetrics.Update	set(String parameterName, Object value)
Analytics.Management.CustomMetrics.Update	setAccountId(String accountId) Account ID for the custom metric to update.
Analytics.Management.CustomMetrics.Update	setAlt(String alt) Data format for the response.
Analytics.Management.CustomMetrics.Update	setCustomMetricId(String customMetricId) Custom metric ID for the custom metric to update.
Analytics.Management.CustomMetrics.Update	setFields(String fields) Selector specifying which fields to include in a partial response.
Analytics.Management.CustomMetrics.Update	setIgnoreCustomDataSourceLinks(Boolean ignoreCustomDataSourceLinks) Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
Analytics.Management.CustomMetrics.Update	setKey(String key) API key.
Analytics.Management.CustomMetrics.Update	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Analytics.Management.CustomMetrics.Update	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Analytics.Management.CustomMetrics.Update	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Analytics.Management.CustomMetrics.Update	setUserIp(String userIp) Deprecated.
Analytics.Management.CustomMetrics.Update	setWebPropertyId(String webPropertyId) Web property ID for the custom metric 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, 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

Update

protected Update(String accountId,
                 String webPropertyId,
                 String customMetricId,
                 CustomMetric content)

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

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

customMetricId - Custom metric ID for the custom metric to update.

content - the CustomMetric

Since:

1.13

Method Detail

setAlt

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

Description copied from class: AnalyticsRequest

Data format for the response.

Overrides:

setAlt in class AnalyticsRequest<CustomMetric>

setFields

public Analytics.Management.CustomMetrics.Update setFields(String fields)

Description copied from class: AnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsRequest<CustomMetric>

setKey

public Analytics.Management.CustomMetrics.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<CustomMetric>

setOauthToken

public Analytics.Management.CustomMetrics.Update setOauthToken(String oauthToken)

Description copied from class: AnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsRequest<CustomMetric>

setPrettyPrint

public Analytics.Management.CustomMetrics.Update setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsRequest<CustomMetric>

setQuotaUser

public Analytics.Management.CustomMetrics.Update 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<CustomMetric>

setUserIp

public Analytics.Management.CustomMetrics.Update setUserIp(String userIp)

Description copied from class: AnalyticsRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class AnalyticsRequest<CustomMetric>

getAccountId

public String getAccountId()

Account ID for the custom metric to update.

setAccountId

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

Account ID for the custom metric to update.

getWebPropertyId

public String getWebPropertyId()

Web property ID for the custom metric to update.

setWebPropertyId

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

Web property ID for the custom metric to update.

getCustomMetricId

public String getCustomMetricId()

Custom metric ID for the custom metric to update.

setCustomMetricId

public Analytics.Management.CustomMetrics.Update setCustomMetricId(String customMetricId)

Custom metric ID for the custom metric to update.

getIgnoreCustomDataSourceLinks

public Boolean getIgnoreCustomDataSourceLinks()

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

setIgnoreCustomDataSourceLinks

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

Force the update and ignore any warnings related to the custom metric 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 metric being linked to a custom data source / data set.

set

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

Overrides:

set in class AnalyticsRequest<CustomMetric>