target.apidocs.com.google.api.services.youtube.YouTube.Subscriptions.List.html Maven / Gradle / Ivy
YouTube.Subscriptions.List (YouTube Data API v3 v3-rev20240303-2.0.0)
com.google.api.services.youtube
Class YouTube.Subscriptions.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.youtube.YouTubeRequest<SubscriptionListResponse>
-
- com.google.api.services.youtube.YouTube.Subscriptions.List
-
- Enclosing class:
- YouTube.Subscriptions
public class YouTube.Subscriptions.List
extends YouTubeRequest<SubscriptionListResponse>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
List(List<String> part)
Retrieves a list of resources, possibly filtered.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getChannelId()
Return the subscriptions of the given channel owner.
String
getForChannelId()
Return the subscriptions to the subset of these channels that the authenticated user is subscribed
to.
List<String>
getId()
Return the subscriptions with the given IDs for Stubby or Apiary.
Long
getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
result set.
Boolean
getMine()
Flag for returning the subscriptions of the authenticated user.
Boolean
getMyRecentSubscribers()
Boolean
getMySubscribers()
Return the subscribers of the given channel owner.
String
getOnBehalfOfContentOwner()
Note:* This parameter is intended exclusively for YouTube content partners.
String
getOnBehalfOfContentOwnerChannel()
This parameter can only be used in a properly authorized request.
String
getOrder()
The order of the returned subscriptions [default: relevance]
String
getPageToken()
The *pageToken* parameter identifies a specific page in the result set that should be returned.
List<String>
getPart()
The *part* parameter specifies a comma-separated list of one or more subscription resource
properties that the API response will include.
YouTube.Subscriptions.List
set(String parameterName,
Object value)
YouTube.Subscriptions.List
set$Xgafv(String $Xgafv)
V1 error format.
YouTube.Subscriptions.List
setAccessToken(String accessToken)
OAuth access token.
YouTube.Subscriptions.List
setAlt(String alt)
Data format for response.
YouTube.Subscriptions.List
setCallback(String callback)
JSONP
YouTube.Subscriptions.List
setChannelId(String channelId)
Return the subscriptions of the given channel owner.
YouTube.Subscriptions.List
setFields(String fields)
Selector specifying which fields to include in a partial response.
YouTube.Subscriptions.List
setForChannelId(String forChannelId)
Return the subscriptions to the subset of these channels that the authenticated user is
subscribed to.
YouTube.Subscriptions.List
setId(List<String> id)
Return the subscriptions with the given IDs for Stubby or Apiary.
YouTube.Subscriptions.List
setKey(String key)
API key.
YouTube.Subscriptions.List
setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
the result set.
YouTube.Subscriptions.List
setMine(Boolean mine)
Flag for returning the subscriptions of the authenticated user.
YouTube.Subscriptions.List
setMyRecentSubscribers(Boolean myRecentSubscribers)
YouTube.Subscriptions.List
setMySubscribers(Boolean mySubscribers)
Return the subscribers of the given channel owner.
YouTube.Subscriptions.List
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
YouTube.Subscriptions.List
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
*Note:* This parameter is intended exclusively for YouTube content partners.
YouTube.Subscriptions.List
setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
This parameter can only be used in a properly authorized request.
YouTube.Subscriptions.List
setOrder(String order)
The order of the returned subscriptions
YouTube.Subscriptions.List
setPageToken(String pageToken)
The *pageToken* parameter identifies a specific page in the result set that should be
returned.
YouTube.Subscriptions.List
setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more subscription resource
properties that the API response will include.
YouTube.Subscriptions.List
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
YouTube.Subscriptions.List
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
YouTube.Subscriptions.List
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
YouTube.Subscriptions.List
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.youtube.YouTubeRequest
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(List<String> part)
Retrieves a list of resources, possibly filtered.
Create a request for the method "subscriptions.list".
This request holds the parameters needed by the the youtube server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation. YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be
called to initialize this instance immediately after invoking the constructor.
- Parameters:
part
- The *part* parameter specifies a comma-separated list of one or more subscription resource
properties that the API response will include. If the parameter identifies a property that
contains child properties, the child properties will be included in the response. For
example, in a subscription resource, the snippet property contains other properties, such
as a display title for the subscription. If you set *part=snippet*, the API response will
also contain all of those nested properties.
- 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<SubscriptionListResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SubscriptionListResponse>
- Throws:
IOException
-
set$Xgafv
public YouTube.Subscriptions.List set$Xgafv(String $Xgafv)
Description copied from class: YouTubeRequest
V1 error format.
- Overrides:
set$Xgafv
in class YouTubeRequest<SubscriptionListResponse>
-
setAccessToken
public YouTube.Subscriptions.List setAccessToken(String accessToken)
Description copied from class: YouTubeRequest
OAuth access token.
- Overrides:
setAccessToken
in class YouTubeRequest<SubscriptionListResponse>
-
setAlt
public YouTube.Subscriptions.List setAlt(String alt)
Description copied from class: YouTubeRequest
Data format for response.
- Overrides:
setAlt
in class YouTubeRequest<SubscriptionListResponse>
-
setCallback
public YouTube.Subscriptions.List setCallback(String callback)
Description copied from class: YouTubeRequest
JSONP
- Overrides:
setCallback
in class YouTubeRequest<SubscriptionListResponse>
-
setFields
public YouTube.Subscriptions.List setFields(String fields)
Description copied from class: YouTubeRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class YouTubeRequest<SubscriptionListResponse>
-
setKey
public YouTube.Subscriptions.List setKey(String key)
Description copied from class: YouTubeRequest
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 YouTubeRequest<SubscriptionListResponse>
-
setOauthToken
public YouTube.Subscriptions.List setOauthToken(String oauthToken)
Description copied from class: YouTubeRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class YouTubeRequest<SubscriptionListResponse>
-
setPrettyPrint
public YouTube.Subscriptions.List setPrettyPrint(Boolean prettyPrint)
Description copied from class: YouTubeRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class YouTubeRequest<SubscriptionListResponse>
-
setQuotaUser
public YouTube.Subscriptions.List setQuotaUser(String quotaUser)
Description copied from class: YouTubeRequest
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 YouTubeRequest<SubscriptionListResponse>
-
setUploadType
public YouTube.Subscriptions.List setUploadType(String uploadType)
Description copied from class: YouTubeRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class YouTubeRequest<SubscriptionListResponse>
-
setUploadProtocol
public YouTube.Subscriptions.List setUploadProtocol(String uploadProtocol)
Description copied from class: YouTubeRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class YouTubeRequest<SubscriptionListResponse>
-
getPart
public List<String> getPart()
The *part* parameter specifies a comma-separated list of one or more subscription resource
properties that the API response will include. If the parameter identifies a property that contains
child properties, the child properties will be included in the response. For example, in a
subscription resource, the snippet property contains other properties, such as a display title for
the subscription. If you set *part=snippet*, the API response will also contain all of those nested
properties.
-
setPart
public YouTube.Subscriptions.List setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more subscription resource
properties that the API response will include. If the parameter identifies a property that
contains child properties, the child properties will be included in the response. For
example, in a subscription resource, the snippet property contains other properties, such
as a display title for the subscription. If you set *part=snippet*, the API response will
also contain all of those nested properties.
-
getChannelId
public String getChannelId()
Return the subscriptions of the given channel owner.
-
setChannelId
public YouTube.Subscriptions.List setChannelId(String channelId)
Return the subscriptions of the given channel owner.
-
getForChannelId
public String getForChannelId()
Return the subscriptions to the subset of these channels that the authenticated user is subscribed
to.
-
setForChannelId
public YouTube.Subscriptions.List setForChannelId(String forChannelId)
Return the subscriptions to the subset of these channels that the authenticated user is
subscribed to.
-
setId
public YouTube.Subscriptions.List setId(List<String> id)
Return the subscriptions with the given IDs for Stubby or Apiary.
-
getMaxResults
public Long getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
result set. [default: 5] [minimum: 0] [maximum: 50]
-
setMaxResults
public YouTube.Subscriptions.List setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
the result set.
-
getMine
public Boolean getMine()
Flag for returning the subscriptions of the authenticated user.
-
setMine
public YouTube.Subscriptions.List setMine(Boolean mine)
Flag for returning the subscriptions of the authenticated user.
-
getMyRecentSubscribers
public Boolean getMyRecentSubscribers()
-
setMyRecentSubscribers
public YouTube.Subscriptions.List setMyRecentSubscribers(Boolean myRecentSubscribers)
-
getMySubscribers
public Boolean getMySubscribers()
Return the subscribers of the given channel owner.
-
setMySubscribers
public YouTube.Subscriptions.List setMySubscribers(Boolean mySubscribers)
Return the subscribers of the given channel owner.
-
getOnBehalfOfContentOwner
public String getOnBehalfOfContentOwner()
Note:* This parameter is intended exclusively for YouTube content partners. The
*onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value.
This parameter is intended for YouTube content partners that own and manage many different YouTube
channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content
owner.
-
setOnBehalfOfContentOwner
public YouTube.Subscriptions.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
*Note:* This parameter is intended exclusively for YouTube content partners. The
*onBehalfOfContentOwner* parameter indicates that the request's authorization credentials
identify a YouTube CMS user who is acting on behalf of the content owner specified in the
parameter value. This parameter is intended for YouTube content partners that own and
manage many different YouTube channels. 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 CMS account that the user authenticates with
must be linked to the specified YouTube content owner.
-
getOnBehalfOfContentOwnerChannel
public String getOnBehalfOfContentOwnerChannel()
This parameter can only be used in a properly authorized request. *Note:* This parameter is
intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter
specifies the YouTube channel ID of the channel to which a video is being added. This parameter is
required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only
be used in conjunction with that parameter. In addition, the request must be authorized using a CMS
account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies.
Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be
linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is
intended for YouTube content partners that own and manage many different YouTube channels. It
allows content owners to authenticate once and perform actions on behalf of the channel specified
in the parameter value, without having to provide authentication credentials for each separate
channel.
-
setOnBehalfOfContentOwnerChannel
public YouTube.Subscriptions.List setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
This parameter can only be used in a properly authorized request. *Note:* This parameter is
intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
parameter specifies the YouTube channel ID of the channel to which a video is being added.
This parameter is required when a request specifies a value for the onBehalfOfContentOwner
parameter, and it can only be used in conjunction with that parameter. In addition, the
request must be authorized using a CMS account that is linked to the content owner that the
onBehalfOfContentOwner parameter specifies. Finally, the channel that the
onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner
that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube
content partners that own and manage many different YouTube channels. It allows content
owners to authenticate once and perform actions on behalf of the channel specified in the
parameter value, without having to provide authentication credentials for each separate
channel.
-
getOrder
public String getOrder()
The order of the returned subscriptions [default: relevance]
-
setOrder
public YouTube.Subscriptions.List setOrder(String order)
The order of the returned subscriptions
-
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 and prevPageToken properties identify other pages that could be
retrieved.
-
setPageToken
public YouTube.Subscriptions.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 and prevPageToken properties identify other
pages that could be retrieved.
-
set
public YouTube.Subscriptions.List set(String parameterName,
Object value)
- Overrides:
set
in class YouTubeRequest<SubscriptionListResponse>
Copyright © 2011–2024 Google. All rights reserved.