com.google.api.services.youtubeAnalytics.v2

Class YouTubeAnalytics.Groups.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.youtubeAnalytics.v2.YouTubeAnalyticsRequest<ListGroupsResponse>

com.google.api.services.youtubeAnalytics.v2.YouTubeAnalytics.Groups.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTubeAnalytics.Groups

public class YouTubeAnalytics.Groups.List
extends YouTubeAnalyticsRequest<ListGroupsResponse>

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	List() Returns a collection of groups that match the API request parameters.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getId() The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved.
Boolean	getMine() This parameter can only be used in a properly authorized request.
String	getOnBehalfOfContentOwner() This parameter can only be used in a properly authorized request.
String	getPageToken() The `pageToken` parameter identifies a specific page in the result set that should be returned.
YouTubeAnalytics.Groups.List	set(String parameterName, Object value)
YouTubeAnalytics.Groups.List	set$Xgafv(String $Xgafv) V1 error format.
YouTubeAnalytics.Groups.List	setAccessToken(String accessToken) OAuth access token.
YouTubeAnalytics.Groups.List	setAlt(String alt) Data format for response.
YouTubeAnalytics.Groups.List	setCallback(String callback) JSONP
YouTubeAnalytics.Groups.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTubeAnalytics.Groups.List	setId(String id) The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved.
YouTubeAnalytics.Groups.List	setKey(String key) API key.
YouTubeAnalytics.Groups.List	setMine(Boolean mine) This parameter can only be used in a properly authorized request.
YouTubeAnalytics.Groups.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTubeAnalytics.Groups.List	setOnBehalfOfContentOwner(String onBehalfOfContentOwner) This parameter can only be used in a properly authorized request.
YouTubeAnalytics.Groups.List	setPageToken(String pageToken) The `pageToken` parameter identifies a specific page in the result set that should be returned.
YouTubeAnalytics.Groups.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTubeAnalytics.Groups.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTubeAnalytics.Groups.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTubeAnalytics.Groups.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.youtubeAnalytics.v2.YouTubeAnalyticsRequest

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

List

protected List()

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs. Create a request for the method "groups.list". This request holds the parameters needed by the the youtubeAnalytics server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTubeAnalytics.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 HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListGroupsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListGroupsResponse>

Throws:

IOException

set$Xgafv

public YouTubeAnalytics.Groups.List set$Xgafv(String $Xgafv)

Description copied from class: YouTubeAnalyticsRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeAnalyticsRequest<ListGroupsResponse>

setAccessToken

public YouTubeAnalytics.Groups.List setAccessToken(String accessToken)

Description copied from class: YouTubeAnalyticsRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeAnalyticsRequest<ListGroupsResponse>

setAlt

public YouTubeAnalytics.Groups.List setAlt(String alt)

Description copied from class: YouTubeAnalyticsRequest

Data format for response.

Overrides:

setAlt in class YouTubeAnalyticsRequest<ListGroupsResponse>

setCallback

public YouTubeAnalytics.Groups.List setCallback(String callback)

Description copied from class: YouTubeAnalyticsRequest

JSONP

Overrides:

setCallback in class YouTubeAnalyticsRequest<ListGroupsResponse>

setFields

public YouTubeAnalytics.Groups.List setFields(String fields)

Description copied from class: YouTubeAnalyticsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeAnalyticsRequest<ListGroupsResponse>

setKey

public YouTubeAnalytics.Groups.List setKey(String key)

Description copied from class: YouTubeAnalyticsRequest

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 YouTubeAnalyticsRequest<ListGroupsResponse>

setOauthToken

public YouTubeAnalytics.Groups.List setOauthToken(String oauthToken)

Description copied from class: YouTubeAnalyticsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeAnalyticsRequest<ListGroupsResponse>

setPrettyPrint

public YouTubeAnalytics.Groups.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeAnalyticsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeAnalyticsRequest<ListGroupsResponse>

setQuotaUser

public YouTubeAnalytics.Groups.List setQuotaUser(String quotaUser)

Description copied from class: YouTubeAnalyticsRequest

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 YouTubeAnalyticsRequest<ListGroupsResponse>

setUploadType

public YouTubeAnalytics.Groups.List setUploadType(String uploadType)

Description copied from class: YouTubeAnalyticsRequest

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

Overrides:

setUploadType in class YouTubeAnalyticsRequest<ListGroupsResponse>

setUploadProtocol

public YouTubeAnalytics.Groups.List setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeAnalyticsRequest

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

Overrides:

setUploadProtocol in class YouTubeAnalyticsRequest<ListGroupsResponse>

getId

public String getId()

The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.

setId

public YouTubeAnalytics.Groups.List setId(String id)

The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.

getMine

public Boolean getMine()

This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.

setMine

public YouTubeAnalytics.Groups.List setMine(Boolean mine)

This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.

getOnBehalfOfContentOwner

public String getOnBehalfOfContentOwner()

This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTubeAnalytics.Groups.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)

This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

getPageToken

public String getPageToken()

The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.

setPageToken

public YouTubeAnalytics.Groups.List setPageToken(String pageToken)

The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.

set

public YouTubeAnalytics.Groups.List set(String parameterName,
                                        Object value)

Overrides:

set in class YouTubeAnalyticsRequest<ListGroupsResponse>