target.apidocs.com.google.api.services.analytics.AnalyticsRequest.html Maven / Gradle / Ivy
AnalyticsRequest (Google Analytics API v2.4-rev20180622-1.29.2)
com.google.api.services.analytics
Class AnalyticsRequest<T>
- 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<T>
-
- Direct Known Subclasses:
- Analytics.Data.Get, Analytics.Management.Accounts.List, Analytics.Management.Goals.List, Analytics.Management.Profiles.List, Analytics.Management.Segments.List, Analytics.Management.Webproperties.List
public abstract class AnalyticsRequest<T>
extends AbstractGoogleJsonClientRequest<T>
Analytics request.
- Since:
- 1.3
-
-
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Constructor and Description
AnalyticsRequest(Analytics client,
String method,
String uriTemplate,
Object content,
Class<T> responseClass)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Analytics
getAbstractGoogleClient()
String
getAlt()
Data format for the response.
String
getFields()
Selector specifying which fields to include in a partial response.
String
getKey()
API key.
String
getOauthToken()
OAuth 2.0 token for the current user.
Boolean
getPrettyPrint()
Returns response with indentations and line breaks.
String
getQuotaUser()
An opaque string that represents a user for quota purposes.
String
getUserIp()
Deprecated.
AnalyticsRequest<T>
set(String parameterName,
Object value)
AnalyticsRequest<T>
setAlt(String alt)
Data format for the response.
AnalyticsRequest<T>
setDisableGZipContent(boolean disableGZipContent)
AnalyticsRequest<T>
setFields(String fields)
Selector specifying which fields to include in a partial response.
AnalyticsRequest<T>
setKey(String key)
API key.
AnalyticsRequest<T>
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
AnalyticsRequest<T>
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
AnalyticsRequest<T>
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
AnalyticsRequest<T>
setRequestHeaders(HttpHeaders headers)
AnalyticsRequest<T>
setUserIp(String userIp)
Deprecated.
-
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, 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
-
AnalyticsRequest
public AnalyticsRequest(Analytics client,
String method,
String uriTemplate,
Object content,
Class<T> responseClass)
- Parameters:
client
- Google client
method
- HTTP Method
uriTemplate
- URI template for the path relative to the base URL. If it starts with a "/"
the base path from the base URL will be stripped out. The URI template can also be a
full URL. URI template expansion is done using
UriTemplate.expand(String, String, Object, boolean)
content
- A POJO that can be serialized into JSON or null
for none
responseClass
- response class to parse into
-
Method Detail
-
getAlt
public String getAlt()
Data format for the response. [default: atom]
-
setAlt
public AnalyticsRequest<T> setAlt(String alt)
Data format for the response.
-
getFields
public String getFields()
Selector specifying which fields to include in a partial response.
-
setFields
public AnalyticsRequest<T> setFields(String fields)
Selector specifying which fields to include in a partial response.
-
getKey
public String getKey()
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.
-
setKey
public AnalyticsRequest<T> setKey(String key)
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.
-
getOauthToken
public String getOauthToken()
OAuth 2.0 token for the current user.
-
setOauthToken
public AnalyticsRequest<T> setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
-
getPrettyPrint
public Boolean getPrettyPrint()
Returns response with indentations and line breaks. [default: false]
-
setPrettyPrint
public AnalyticsRequest<T> setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
-
getQuotaUser
public String getQuotaUser()
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
-
setQuotaUser
public AnalyticsRequest<T> setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
-
getUserIp
public String getUserIp()
Deprecated. Please use quotaUser instead.
-
setUserIp
public AnalyticsRequest<T> setUserIp(String userIp)
Deprecated. Please use quotaUser instead.
-
getAbstractGoogleClient
public final Analytics getAbstractGoogleClient()
- Overrides:
getAbstractGoogleClient
in class AbstractGoogleJsonClientRequest<T>
-
setDisableGZipContent
public AnalyticsRequest<T> setDisableGZipContent(boolean disableGZipContent)
- Overrides:
setDisableGZipContent
in class AbstractGoogleJsonClientRequest<T>
-
setRequestHeaders
public AnalyticsRequest<T> setRequestHeaders(HttpHeaders headers)
- Overrides:
setRequestHeaders
in class AbstractGoogleJsonClientRequest<T>
-
set
public AnalyticsRequest<T> set(String parameterName,
Object value)
- Overrides:
set
in class AbstractGoogleJsonClientRequest<T>
Copyright © 2011–2019 Google. All rights reserved.