com.google.api.services.analyticsadmin.v1beta

Class GoogleAnalyticsAdmin.Accounts.List

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.analyticsadmin.v1beta.GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

com.google.api.services.analyticsadmin.v1beta.GoogleAnalyticsAdmin.Accounts.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

GoogleAnalyticsAdmin.Accounts

public class GoogleAnalyticsAdmin.Accounts.List
extends GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

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	List() Returns all accounts accessible by the caller.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() The maximum number of resources to return.
String	getPageToken() A page token, received from a previous `ListAccounts` call.
Boolean	getShowDeleted() Whether to include soft-deleted (ie: "trashed") Accounts in the results.
GoogleAnalyticsAdmin.Accounts.List	set(String parameterName, Object value)
GoogleAnalyticsAdmin.Accounts.List	set$Xgafv(String $Xgafv) V1 error format.
GoogleAnalyticsAdmin.Accounts.List	setAccessToken(String accessToken) OAuth access token.
GoogleAnalyticsAdmin.Accounts.List	setAlt(String alt) Data format for response.
GoogleAnalyticsAdmin.Accounts.List	setCallback(String callback) JSONP
GoogleAnalyticsAdmin.Accounts.List	setFields(String fields) Selector specifying which fields to include in a partial response.
GoogleAnalyticsAdmin.Accounts.List	setKey(String key) API key.
GoogleAnalyticsAdmin.Accounts.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
GoogleAnalyticsAdmin.Accounts.List	setPageSize(Integer pageSize) The maximum number of resources to return.
GoogleAnalyticsAdmin.Accounts.List	setPageToken(String pageToken) A page token, received from a previous `ListAccounts` call.
GoogleAnalyticsAdmin.Accounts.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
GoogleAnalyticsAdmin.Accounts.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
GoogleAnalyticsAdmin.Accounts.List	setShowDeleted(Boolean showDeleted) Whether to include soft-deleted (ie: "trashed") Accounts in the results.
GoogleAnalyticsAdmin.Accounts.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
GoogleAnalyticsAdmin.Accounts.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.analyticsadmin.v1beta.GoogleAnalyticsAdminRequest

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

List

protected List()

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Create a request for the method "accounts.list". This request holds the parameters needed by the the analyticsadmin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

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<GoogleAnalyticsAdminV1betaListAccountsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public GoogleAnalyticsAdmin.Accounts.List set$Xgafv(String $Xgafv)

Description copied from class: GoogleAnalyticsAdminRequest

V1 error format.

Overrides:

set$Xgafv in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setAccessToken

public GoogleAnalyticsAdmin.Accounts.List setAccessToken(String accessToken)

Description copied from class: GoogleAnalyticsAdminRequest

OAuth access token.

Overrides:

setAccessToken in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setAlt

public GoogleAnalyticsAdmin.Accounts.List setAlt(String alt)

Description copied from class: GoogleAnalyticsAdminRequest

Data format for response.

Overrides:

setAlt in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setCallback

public GoogleAnalyticsAdmin.Accounts.List setCallback(String callback)

Description copied from class: GoogleAnalyticsAdminRequest

JSONP

Overrides:

setCallback in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setFields

public GoogleAnalyticsAdmin.Accounts.List setFields(String fields)

Description copied from class: GoogleAnalyticsAdminRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setKey

public GoogleAnalyticsAdmin.Accounts.List setKey(String key)

Description copied from class: GoogleAnalyticsAdminRequest

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 GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setOauthToken

public GoogleAnalyticsAdmin.Accounts.List setOauthToken(String oauthToken)

Description copied from class: GoogleAnalyticsAdminRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setPrettyPrint

public GoogleAnalyticsAdmin.Accounts.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: GoogleAnalyticsAdminRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setQuotaUser

public GoogleAnalyticsAdmin.Accounts.List setQuotaUser(String quotaUser)

Description copied from class: GoogleAnalyticsAdminRequest

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 GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setUploadType

public GoogleAnalyticsAdmin.Accounts.List setUploadType(String uploadType)

Description copied from class: GoogleAnalyticsAdminRequest

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

Overrides:

setUploadType in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

setUploadProtocol

public GoogleAnalyticsAdmin.Accounts.List setUploadProtocol(String uploadProtocol)

Description copied from class: GoogleAnalyticsAdminRequest

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

Overrides:

setUploadProtocol in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>

getPageSize

public Integer getPageSize()

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

setPageSize

public GoogleAnalyticsAdmin.Accounts.List setPageSize(Integer pageSize)

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

getPageToken

public String getPageToken()

A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.

setPageToken

public GoogleAnalyticsAdmin.Accounts.List setPageToken(String pageToken)

A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.

getShowDeleted

public Boolean getShowDeleted()

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

setShowDeleted

public GoogleAnalyticsAdmin.Accounts.List setShowDeleted(Boolean showDeleted)

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

set

public GoogleAnalyticsAdmin.Accounts.List set(String parameterName,
                                              Object value)

Overrides:

set in class GoogleAnalyticsAdminRequest<GoogleAnalyticsAdminV1betaListAccountsResponse>