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 las playlists para identificar colecciones especiales de videos para un canal, como los 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
- Muestra una colección de playlists que coinciden con los parámetros de 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.
- actualización
- 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
La siguiente estructura JSON 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 |
string de Identifica el tipo de recurso de la API. El valor será youtube#playlist . |
etag |
etag de Etag de este recurso. |
id |
string de ID que YouTube utiliza para identificar de forma exclusiva la playlist. |
snippet |
object de El objeto snippet contiene información básica sobre la playlist, como el título y la descripción. |
snippet.publishedAt |
datetime de Fecha y hora en que se creó la playlist. El valor se especifica en el formato ISO 8601. |
snippet.channelId |
string de ID que YouTube utiliza para identificar de forma exclusiva el canal que publicó la playlist. |
snippet.title |
string de Título de la playlist. |
snippet.description |
string de Descripción de la playlist. |
snippet.thumbnails |
object de 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) |
object de Los pares clave-valor válidos son los siguientes:
|
snippet.thumbnails.(key).url |
string de URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer de El ancho de la imagen. |
snippet.thumbnails.(key).height |
unsigned integer de La altura de la imagen. |
snippet.channelTitle |
string de Título del canal al que pertenece el video. |
snippet.tags[] |
list de Esta propiedad dejó de estar disponible. Etiquetas de palabras clave asociadas con la playlist. |
snippet.defaultLanguage |
string de El idioma del texto en las propiedades snippet.title y snippet.description del recurso playlist . |
snippet.localized |
object de El objeto snippet.localized contiene un título y una descripción localizados para la playlist o un título en el idioma predeterminado para los metadatos de la playlist.
localizations para agregar, actualizar o borrar títulos localizados. |
snippet.localized.title |
string de Título localizado de la playlist. |
snippet.localized.description |
string de Descripción localizada de la playlist. |
status |
object de El objeto status contiene información sobre el estado de la playlist. |
status.privacyStatus |
string de El estado de privacidad de la playlist. Los valores válidos para esta propiedad son los siguientes:
|
status.podcastStatus |
string de El estado del podcast de la playlist. Si el valor es enabled , la playlist se marca como un programa de podcast. Para establecer el estado del podcast de una playlist en enabled , esta debe tener una imagen de playlist.Los valores válidos para esta propiedad son los siguientes:
|
contentDetails |
object de El objeto contentDetails contiene información sobre el contenido de la playlist, incluido el número de videos de la playlist. |
contentDetails.itemCount |
unsigned integer de La cantidad de videos de la playlist. |
player |
object de El objeto player contiene información que puedes utilizar para reproducir la playlist en un reproductor insertado. |
player.embedHtml |
string de Etiqueta <iframe> que inserta un reproductor que reproducirá la playlist. |
localizations |
object de El objeto localizations encapsula traducciones de los metadatos de la playlist. |
localizations.(key) |
object de El idioma del texto localizado asociado con el par clave-valor. El valor es una string que contiene un código de idioma BCP-47. |
localizations.(key).title |
string de Título localizado de la playlist. |
localizations.(key).description |
string de Descripción localizada de la playlist. |