provider playlistItems GET /youtube/v3/playlistItems
@utdk/google/youtube /youtube/v3/playlistItems
playlistItems.list
Retrieves a list of resources, possibly filtered.
$.xgafv query
V1 error format.
enum: 1, 2
access_token query
OAuth access token.
string
alt query
Data format for response.
enum: json, media, proto
callback query
JSONP
string
fields query
Selector specifying which fields to include in a partial response.
string
key query
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.
string
oauth_token query
OAuth 2.0 token for the current user.
string
prettyPrint query
Returns response with indentations and line breaks.
boolean
quotaUser query
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.
string
upload_protocol query
Upload protocol for media (e.g. "raw", "multipart").
string
uploadType query
Legacy upload protocol for media (e.g. "media", "multipart").
string
part query required
The *part* parameter specifies a comma-separated list of one or more playlistItem 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 playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.
array
id query
array
maxResults query
The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
integer
onBehalfOfContentOwner query
*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.
string
pageToken query
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.
string
playlistId query
Return the playlist items within the given playlist.
string
videoId query
Return the playlist items associated with the given video ID.
string

Try it

Authentication
Configure credentials for YouTube Data API v3
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

playlistitemsList
GET/youtube/v3/playlistItems
Retrieves a list of resources, possibly filtered.

V1 error format.

OAuth access token.

Data format for response.

JSONP

Selector specifying which fields to include in a partial response.

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.

OAuth 2.0 token for the current user.

Returns response with indentations and line breaks.

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.

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

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

required

The *part* parameter specifies a comma-separated list of one or more playlistItem 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 playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set *part=snippet*, the API response will contain all of those properties.

The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.

*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.

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.

Return the playlist items within the given playlist.

Return the playlist items associated with the given video ID.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import google_youtube from '@utdk/google/youtube';

await google_youtube.playlistitemsList()