com.google.api.services.analyticsdata.v1beta

Class AnalyticsData.Properties.GetMetadata

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.analyticsdata.v1beta.AnalyticsDataRequest<Metadata>

com.google.api.services.analyticsdata.v1beta.AnalyticsData.Properties.GetMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AnalyticsData.Properties

public class AnalyticsData.Properties.GetMetadata
extends AnalyticsDataRequest<Metadata>

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

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	GetMetadata(String name) Returns metadata for dimensions and metrics available in reporting methods.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getName() Required.
AnalyticsData.Properties.GetMetadata	set(String parameterName, Object value)
AnalyticsData.Properties.GetMetadata	set$Xgafv(String $Xgafv) V1 error format.
AnalyticsData.Properties.GetMetadata	setAccessToken(String accessToken) OAuth access token.
AnalyticsData.Properties.GetMetadata	setAlt(String alt) Data format for response.
AnalyticsData.Properties.GetMetadata	setCallback(String callback) JSONP
AnalyticsData.Properties.GetMetadata	setFields(String fields) Selector specifying which fields to include in a partial response.
AnalyticsData.Properties.GetMetadata	setKey(String key) API key.
AnalyticsData.Properties.GetMetadata	setName(String name) Required.
AnalyticsData.Properties.GetMetadata	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AnalyticsData.Properties.GetMetadata	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AnalyticsData.Properties.GetMetadata	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AnalyticsData.Properties.GetMetadata	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AnalyticsData.Properties.GetMetadata	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.analyticsdata.v1beta.AnalyticsDataRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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

GetMetadata

protected GetMetadata(String name)

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. Create a request for the method "properties.getMetadata". This request holds the parameters needed by the the analyticsdata server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AnalyticsData.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public AnalyticsData.Properties.GetMetadata set$Xgafv(String $Xgafv)

Description copied from class: AnalyticsDataRequest

V1 error format.

Overrides:

set$Xgafv in class AnalyticsDataRequest<Metadata>

setAccessToken

public AnalyticsData.Properties.GetMetadata setAccessToken(String accessToken)

Description copied from class: AnalyticsDataRequest

OAuth access token.

Overrides:

setAccessToken in class AnalyticsDataRequest<Metadata>

setAlt

public AnalyticsData.Properties.GetMetadata setAlt(String alt)

Description copied from class: AnalyticsDataRequest

Data format for response.

Overrides:

setAlt in class AnalyticsDataRequest<Metadata>

setCallback

public AnalyticsData.Properties.GetMetadata setCallback(String callback)

Description copied from class: AnalyticsDataRequest

JSONP

Overrides:

setCallback in class AnalyticsDataRequest<Metadata>

setFields

public AnalyticsData.Properties.GetMetadata setFields(String fields)

Description copied from class: AnalyticsDataRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AnalyticsDataRequest<Metadata>

setKey

public AnalyticsData.Properties.GetMetadata setKey(String key)

Description copied from class: AnalyticsDataRequest

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 AnalyticsDataRequest<Metadata>

setOauthToken

public AnalyticsData.Properties.GetMetadata setOauthToken(String oauthToken)

Description copied from class: AnalyticsDataRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AnalyticsDataRequest<Metadata>

setPrettyPrint

public AnalyticsData.Properties.GetMetadata setPrettyPrint(Boolean prettyPrint)

Description copied from class: AnalyticsDataRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AnalyticsDataRequest<Metadata>

setQuotaUser

public AnalyticsData.Properties.GetMetadata setQuotaUser(String quotaUser)

Description copied from class: AnalyticsDataRequest

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:

setQuotaUser in class AnalyticsDataRequest<Metadata>

setUploadType

public AnalyticsData.Properties.GetMetadata setUploadType(String uploadType)

Description copied from class: AnalyticsDataRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class AnalyticsDataRequest<Metadata>

setUploadProtocol

public AnalyticsData.Properties.GetMetadata setUploadProtocol(String uploadProtocol)

Description copied from class: AnalyticsDataRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class AnalyticsDataRequest<Metadata>

getName

public String getName()

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

setName

public AnalyticsData.Properties.GetMetadata setName(String name)

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

set

public AnalyticsData.Properties.GetMetadata set(String parameterName,
                                                Object value)

Overrides:

set in class AnalyticsDataRequest<Metadata>