Un recurso playlistItem identifica otro recurso, como un video, que se incluye en una playlist. Además, el recurso playlistItem contiene detalles sobre el recurso incluido que se relacionan específicamente con la forma en que se usa ese recurso en la playlist.
YouTube también usa una playlist para identificar la lista de videos subidos de un canal, y cada
playlistItem de esa lista representa un video subido. Puedes recuperar el ID de la playlist de esa lista desde el recurso channel para un canal determinado. Luego, puedes usar el método playlistItems.list en la lista.
Métodos
La API admite los siguientes métodos para los recursos playlistItems:
- list
- Devuelve una colección de elementos de playlist que coinciden con los parámetros de la solicitud a la API. Puedes recuperar todos los elementos de una lista de reproducción en una lista de reproducción específica o recuperar uno o más elementos de una lista de reproducción mediante sus ID únicos. Pruébala ahora.
- insertar
- Agrega un recurso a una playlist. Pruébala ahora.
- actualizar
- Modifica un elemento de la playlist. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción. Pruébala ahora.
- borrar
- Borra un elemento de la playlist. Pruébala ahora.
Representación de recursos
En la siguiente estructura JSON, se muestra el formato de un recurso playlistItems:
{
"kind": "youtube#playlistItem",
"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,
"videoOwnerChannelTitle": string,
"videoOwnerChannelId": string,
"playlistId": string,
"position": unsigned integer,
"resourceId": {
"kind": string,
"videoId": string,
}
},
"contentDetails": {
"videoId": string,
"startAt": string,
"endAt": string,
"note": string,
"videoPublishedAt": datetime
},
"status": {
"privacyStatus": 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#playlistItem. |
etag |
etagEs el ETag de este recurso. |
id |
stringEs el ID que YouTube usa para identificar de forma única el elemento de la playlist. |
snippet |
objectEl objeto snippet contiene detalles básicos sobre el elemento de la playlist, como su título y posición en la playlist. |
snippet.publishedAt |
datetimeFecha y hora en que se agregó el elemento a la playlist. El valor se especifica en formato ISO 8601. |
snippet.channelId |
stringEs el ID que YouTube usa para identificar de forma única al usuario que agregó el elemento a la playlist. |
snippet.title |
stringEs el título del elemento. |
snippet.description |
stringEs la descripción del elemento. |
snippet.thumbnails |
objectEs un mapa de imágenes en miniatura asociadas con el elemento de 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 elemento de la playlist. |
snippet.videoOwnerChannelTitle |
stringEs el título del canal que subió este video. |
snippet.videoOwnerChannelId |
stringEs el ID del canal que subió este video. |
snippet.playlistId |
stringEs el ID que YouTube usa para identificar de forma única la playlist en la que se encuentra el elemento de la playlist. |
snippet.position |
unsigned integerOrden en el que aparece el elemento en la playlist. El valor usa un índice basado en cero, por lo que el primer elemento tiene una posición de 0, el segundo elemento tiene una posición de 1, y así sucesivamente. |
snippet.resourceId |
objectEl objeto id contiene información que se puede usar para identificar de forma única el recurso que se incluye en la playlist como elemento de la playlist. |
snippet.resourceId.kind |
stringEs el tipo del recurso al que se hace referencia. |
snippet.resourceId.videoId |
stringSi el valor de la propiedad snippet.resourceId.kind es youtube#video, esta propiedad estará presente y su valor contendrá el ID que YouTube usa para identificar de forma única el video en la playlist. |
contentDetails |
objectEl objeto contentDetails se incluye en el recurso si el elemento incluido es un video de YouTube. El objeto contiene información adicional sobre el video. |
contentDetails.videoId |
stringEs el ID que YouTube usa para identificar de forma única un video. Para recuperar el recurso video, establece el parámetro de búsqueda id en este valor en tu solicitud a la API. |
contentDetails.startAt |
stringNota: Esta propiedad dejó de estar disponible y, si se configura, se ignora su valor. Es el tiempo, medido en segundos desde el inicio del video, en el que debería comenzar la reproducción. (El propietario de la lista de reproducción puede especificar los tiempos en que el video debe empezar y detenerse cuando el video se reproduce en el contexto de la lista de reproducción). El valor predeterminado es 0. |
contentDetails.endAt |
stringNota: Esta propiedad dejó de estar disponible y, si se establece, se ignora su valor. Es el momento, medido en segundos desde el inicio del video, en el que debe detenerse la reproducción. (El propietario de la lista de reproducción puede especificar los tiempos en que el video debe empezar y detenerse cuando el video se reproduce en el contexto de la lista de reproducción). De forma predeterminada, se supone que video.endTime es el final del video. |
contentDetails.note |
stringNota generada por el usuario para este elemento. El valor de la propiedad tiene una longitud máxima de 280 caracteres. |
contentDetails.videoPublishedAt |
datetimeFecha y hora en que se publicó el video en YouTube. El valor se especifica en formato ISO 8601. |
status |
objectEl objeto status contiene información sobre el estado de privacidad del elemento de la playlist. |
status.privacyStatus |
stringEs el estado de privacidad del elemento de la playlist. El canal que subió el video que representa el elemento de la playlist puede establecer este valor con el método videos.insert o videos.update. |