Un recurso playlist representa una playlist de YouTube. Una lista de reproducción es una colección de videos que se pueden ver de manera sucesiva y compartir con otros usuarios. Gracias a una configuración predeterminada, las listas de reproducción son visibles públicamente a otros usuarios; sin embargo, pueden ser públicas o privadas.
YouTube también usa playlists para identificar colecciones especiales de videos de un canal, como las siguientes:
- videos subidos
- videos con calificación positiva (me gusta)
channel resource para un canal determinado.Luego, puedes usar el método
playlistItems.list para recuperar cualquiera de esas listas. También puedes agregar o quitar elementos de esas listas llamando a los métodos playlistItems.insert y playlistItems.delete.
Métodos
La API admite los siguientes métodos para los recursos playlists:
- list
- Devuelve una colección de playlists que coinciden con los parámetros de la solicitud a la API. Por ejemplo, puedes recuperar todas las listas de reproducción pertenecientes al usuario autenticado o puedes recuperar una o varias listas de reproducción con sus ID únicos. Pruébala ahora.
- insertar
- Crea una playlist. Pruébala ahora.
- actualizar
- Modifica una playlist. Por ejemplo, puede cambiar el título, la descripción o el estado de la privacidad. Pruébala ahora.
- borrar
- Borra una playlist. Pruébala ahora.
Representación de recursos
En la siguiente estructura JSON, se muestra el formato de un recurso playlists:
{
"kind": "youtube#playlist",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
| Propiedades | |
|---|---|
kind |
stringIdentifica el tipo de recurso de la API. El valor será youtube#playlist. |
etag |
etagEs el ETag de este recurso. |
id |
stringEs el ID que YouTube usa para identificar de forma única la playlist. |
snippet |
objectEl objeto snippet contiene detalles básicos sobre la playlist, como el título y la descripción. |
snippet.publishedAt |
datetimeFecha y hora en que se creó la playlist. El valor se especifica en formato ISO 8601. |
snippet.channelId |
stringEs el ID que YouTube usa para identificar de forma única el canal que publicó la playlist. |
snippet.title |
stringEs el título de la playlist. |
snippet.description |
stringEs la descripción de la playlist. |
snippet.thumbnails |
objectEs un mapa de imágenes en miniatura asociadas con la playlist. Para cada objeto en el mapa, la clave es el nombre de la imagen en miniatura, y el valor es un objeto que contiene otra información sobre la viñeta. |
snippet.thumbnails.(key) |
objectLos valores de clave válidos son los siguientes:
|
snippet.thumbnails.(key).url |
stringEs la URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integerAncho de la imagen. |
snippet.thumbnails.(key).height |
unsigned integerAltura de la imagen. |
snippet.channelTitle |
stringEs el título del canal al que pertenece el video. |
snippet.tags[] |
listEsta propiedad dejó de estar disponible. Son las etiquetas de palabras clave asociadas con la playlist. |
snippet.defaultLanguage |
stringIdioma del texto en las propiedades snippet.title y snippet.description del recurso playlist. |
snippet.localized |
objectEl objeto snippet.localized contiene un título y una descripción localizados para la playlist, o bien el título en el idioma predeterminado para los metadatos de la playlist.
localizations para agregar, actualizar o borrar títulos localizados. |
snippet.localized.title |
stringEs el título localizado de la playlist. |
snippet.localized.description |
stringEs la descripción localizada de la playlist. |
status |
objectEl objeto status contiene información de estado de la playlist. |
status.privacyStatus |
stringEs el estado de privacidad de la playlist. Los valores válidos para esta propiedad son los siguientes:
|
status.podcastStatus |
stringEs el estado de podcast de la playlist. Si el valor es enabled, la playlist se marca como programa de podcast. Para establecer el estado de podcast de una playlist en enabled, esta debe tener una imagen de playlist.Los valores válidos para esta propiedad son los siguientes:
|
contentDetails |
objectEl objeto contentDetails contiene información sobre el contenido de la playlist, incluida la cantidad de videos que contiene. |
contentDetails.itemCount |
unsigned integerEs la cantidad de videos en la playlist. |
player |
objectEl objeto player contiene información que usarías para reproducir la playlist en un reproductor integrado. |
player.embedHtml |
stringUna etiqueta <iframe> que incorpora un reproductor que reproducirá la playlist. |
localizations |
objectEl objeto localizations encapsula las traducciones de los metadatos de la playlist. |
localizations.(key) |
objectEs el idioma del texto localizado asociado con el valor de la clave. El valor es una cadena que contiene un código de idioma BCP-47. |
localizations.(key).title |
stringEs el título localizado de la playlist. |
localizations.(key).description |
stringEs la descripción localizada de la playlist. |