public class YouTube.Channels.List extends YouTubeRequest<ChannelListResponse>
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Modifier | Constructor and Description |
---|---|
protected |
List(String part)
Returns a collection of zero or more channel resources that match the request criteria.
|
Modifier and Type | Method and Description |
---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
String |
getCategoryId()
The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels
associated with that category.
|
String |
getForUsername()
The forUsername parameter specifies a YouTube username, thereby requesting the channel associated
with that username.
|
String |
getHl()
The hl parameter should be used for filter out the properties that are not in the given language.
|
String |
getId()
The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s)
that are being retrieved.
|
Boolean |
getManagedByMe()
Note: This parameter is intended exclusively for YouTube content partners.
|
Long |
getMaxResults()
The maxResults parameter specifies the maximum number of items that should be returned in the
result set.
|
Boolean |
getMine()
Set this parameter's value to true to instruct the API to only return channels owned by the
authenticated user.
|
Boolean |
getMySubscribers()
Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers
to the authenticated user's channel.
|
String |
getOnBehalfOfContentOwner()
Note: This parameter is intended exclusively for YouTube content partners.
|
String |
getPageToken()
The pageToken parameter identifies a specific page in the result set that should be returned.
|
String |
getPart()
The part parameter specifies a comma-separated list of one or more channel resource properties that
the API response will include.
|
YouTube.Channels.List |
set(String parameterName,
Object value) |
YouTube.Channels.List |
setAlt(String alt)
Data format for the response.
|
YouTube.Channels.List |
setCategoryId(String categoryId)
The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube
channels associated with that category.
|
YouTube.Channels.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
YouTube.Channels.List |
setForUsername(String forUsername)
The forUsername parameter specifies a YouTube username, thereby requesting the channel
associated with that username.
|
YouTube.Channels.List |
setHl(String hl)
The hl parameter should be used for filter out the properties that are not in the given
language.
|
YouTube.Channels.List |
setId(String id)
The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the
resource(s) that are being retrieved.
|
YouTube.Channels.List |
setKey(String key)
API key.
|
YouTube.Channels.List |
setManagedByMe(Boolean managedByMe)
Note: This parameter is intended exclusively for YouTube content partners.
|
YouTube.Channels.List |
setMaxResults(Long maxResults)
The maxResults parameter specifies the maximum number of items that should be returned in
the result set.
|
YouTube.Channels.List |
setMine(Boolean mine)
Set this parameter's value to true to instruct the API to only return channels owned by the
authenticated user.
|
YouTube.Channels.List |
setMySubscribers(Boolean mySubscribers)
Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of
subscribers to the authenticated user's channel.
|
YouTube.Channels.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
YouTube.Channels.List |
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
Note: This parameter is intended exclusively for YouTube content partners.
|
YouTube.Channels.List |
setPageToken(String pageToken)
The pageToken parameter identifies a specific page in the result set that should be
returned.
|
YouTube.Channels.List |
setPart(String part)
The part parameter specifies a comma-separated list of one or more channel resource
properties that the API response will include.
|
YouTube.Channels.List |
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
|
YouTube.Channels.List |
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
|
YouTube.Channels.List |
setUserIp(String userIp)
Deprecated.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
protected List(String part)
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.
part
- The part parameter specifies a comma-separated list of one or more channel 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
channel resource, the contentDetails property contains other properties, such as the
uploads properties. As such, if you set part=contentDetails, the API response will also
contain all of those nested properties.public com.google.api.client.http.HttpResponse executeUsingHead() throws IOException
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChannelListResponse>
IOException
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws IOException
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ChannelListResponse>
IOException
public YouTube.Channels.List setAlt(String alt)
YouTubeRequest
setAlt
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setFields(String fields)
YouTubeRequest
setFields
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setKey(String key)
YouTubeRequest
setKey
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setOauthToken(String oauthToken)
YouTubeRequest
setOauthToken
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setPrettyPrint(Boolean prettyPrint)
YouTubeRequest
setPrettyPrint
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setQuotaUser(String quotaUser)
YouTubeRequest
setQuotaUser
in class YouTubeRequest<ChannelListResponse>
public YouTube.Channels.List setUserIp(String userIp)
YouTubeRequest
setUserIp
in class YouTubeRequest<ChannelListResponse>
public String getPart()
public YouTube.Channels.List setPart(String part)
public String getCategoryId()
public YouTube.Channels.List setCategoryId(String categoryId)
public String getForUsername()
public YouTube.Channels.List setForUsername(String forUsername)
public String getHl()
public YouTube.Channels.List setHl(String hl)
public String getId()
public YouTube.Channels.List setId(String id)
public Boolean getManagedByMe()
public YouTube.Channels.List setManagedByMe(Boolean managedByMe)
public Long getMaxResults()
public YouTube.Channels.List setMaxResults(Long maxResults)
public Boolean getMine()
public YouTube.Channels.List setMine(Boolean mine)
public Boolean getMySubscribers()
public YouTube.Channels.List setMySubscribers(Boolean mySubscribers)
public String getOnBehalfOfContentOwner()
public YouTube.Channels.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
public String getPageToken()
public YouTube.Channels.List setPageToken(String pageToken)
public YouTube.Channels.List set(String parameterName, Object value)
set
in class YouTubeRequest<ChannelListResponse>
Copyright © 2011–2019 Google. All rights reserved.