public class YouTube.Playlists.List extends YouTubeRequest<PlaylistListResponse>
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 playlists that match the API request parameters.
|
Modifier and Type | Method and Description |
---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
String |
getChannelId()
This value indicates that the API should only return the specified channel's playlists.
|
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 playlist ID(s) for the resource(s)
that are being retrieved.
|
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 playlists owned by the
authenticated user.
|
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 |
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 playlist resource properties
that the API response will include.
|
YouTube.Playlists.List |
set(String parameterName,
Object value) |
YouTube.Playlists.List |
setAlt(String alt)
Data format for the response.
|
YouTube.Playlists.List |
setChannelId(String channelId)
This value indicates that the API should only return the specified channel's playlists.
|
YouTube.Playlists.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
YouTube.Playlists.List |
setHl(String hl)
The hl parameter should be used for filter out the properties that are not in the given
language.
|
YouTube.Playlists.List |
setId(String id)
The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the
resource(s) that are being retrieved.
|
YouTube.Playlists.List |
setKey(String key)
API key.
|
YouTube.Playlists.List |
setMaxResults(Long maxResults)
The maxResults parameter specifies the maximum number of items that should be returned in
the result set.
|
YouTube.Playlists.List |
setMine(Boolean mine)
Set this parameter's value to true to instruct the API to only return playlists owned by
the authenticated user.
|
YouTube.Playlists.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
YouTube.Playlists.List |
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
Note: This parameter is intended exclusively for YouTube content partners.
|
YouTube.Playlists.List |
setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
This parameter can only be used in a properly authorized request.
|
YouTube.Playlists.List |
setPageToken(String pageToken)
The pageToken parameter identifies a specific page in the result set that should be
returned.
|
YouTube.Playlists.List |
setPart(String part)
The part parameter specifies a comma-separated list of one or more playlist resource
properties that the API response will include.
|
YouTube.Playlists.List |
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
|
YouTube.Playlists.List |
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
|
YouTube.Playlists.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 playlist 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
playlist resource, the snippet property contains properties like author, title,
description, tags, and timeCreated. As such, if you set part=snippet, the API response
will contain all of those properties.public com.google.api.client.http.HttpResponse executeUsingHead() throws IOException
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlaylistListResponse>
IOException
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws IOException
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlaylistListResponse>
IOException
public YouTube.Playlists.List setAlt(String alt)
YouTubeRequest
setAlt
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setFields(String fields)
YouTubeRequest
setFields
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setKey(String key)
YouTubeRequest
setKey
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setOauthToken(String oauthToken)
YouTubeRequest
setOauthToken
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setPrettyPrint(Boolean prettyPrint)
YouTubeRequest
setPrettyPrint
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setQuotaUser(String quotaUser)
YouTubeRequest
setQuotaUser
in class YouTubeRequest<PlaylistListResponse>
public YouTube.Playlists.List setUserIp(String userIp)
YouTubeRequest
setUserIp
in class YouTubeRequest<PlaylistListResponse>
public String getPart()
public YouTube.Playlists.List setPart(String part)
public String getChannelId()
public YouTube.Playlists.List setChannelId(String channelId)
public String getHl()
public YouTube.Playlists.List setHl(String hl)
public String getId()
public YouTube.Playlists.List setId(String id)
public Long getMaxResults()
public YouTube.Playlists.List setMaxResults(Long maxResults)
public Boolean getMine()
public YouTube.Playlists.List setMine(Boolean mine)
public String getOnBehalfOfContentOwner()
public YouTube.Playlists.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
public String getOnBehalfOfContentOwnerChannel()
public YouTube.Playlists.List setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
public String getPageToken()
public YouTube.Playlists.List setPageToken(String pageToken)
public YouTube.Playlists.List set(String parameterName, Object value)
set
in class YouTubeRequest<PlaylistListResponse>
Copyright © 2011–2019 Google. All rights reserved.