PlaylistImages: list

  • Retrieves playlist images for specified playlists or image IDs using the YouTube Data API.

  • Requires authorization with a YouTube scope like youtubepartner, youtube, or youtube.force-ssl.

  • Allows filtering by playlist ID (playlistId) or image ID (id), but one is mandatory.

  • Supports pagination for retrieving large result sets using pageToken, nextPageToken, and prevPageToken.

  • Has a quota cost of 1 unit per call.

Returns a collection of playlist images that match the API request parameters. You can retrieve the playlist image of a specified playlist or retrieve one or more playlist images by their unique IDs.

Quota impact: A call to this method has a quota cost of 1 unit.

Request

HTTP request

GET https://www.googleapis.com/youtube/v3/playlistImages

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
part string

The part parameter specifies a comma-separated list of one or more playlistImage 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.
Filters (specify exactly one of the following parameters)
id string
The id parameter specifies a comma-separated list of one or more unique playlist image IDs.
playlistId string
The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist images. Note that even though this is an optional parameter, every request to retrieve playlist images must specify a value for either the id parameter or the playlistId parameter.
Optional parameters
maxResults unsigned integer
The maxResults parameter specifies the maximum number of images that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.
onBehalfOfContentOwner string
This parameter can only be used in a properly authorized request. 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.
onBehalfOfContentOwnerChannel string
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.
pageToken string
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.

Request body

Do not provide a request body when calling this method.

Response

If successful, this method returns a response body with the following structure:

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

Properties

The following table defines the properties that appear in this resource:

Properties
kind string
Identifies the API resource's type. The value will be youtube#playlistImageListResponse.
nextPageToken string
The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
prevPageToken string
The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
pageInfo object
The pageInfo object encapsulates paging information for the result set.
pageInfo.totalResults integer
The total number of results in the result set.
pageInfo.resultsPerPage integer
The number of results included in the API response.
items[] list
A list of playlist images that match the request criteria.