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 esa 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 channel resource
de 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
- Muestra una colección de elementos de listas de reproducción que coinciden con los parámetros de 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 una playlist. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción. Pruébala ahora.
- borrar
- Borra un elemento de una 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 |
string Identifica el tipo de recurso de la API. El valor será youtube#playlistItem . |
etag |
etag La Etag de este recurso. |
id |
string ID que YouTube usa para identificar de forma exclusiva el elemento de la playlist. |
snippet |
object El objeto snippet contiene información básica sobre el elemento de la playlist, como el título y la posición en ella. |
snippet.publishedAt |
datetime Fecha y hora en que se agregó el elemento a la playlist. El valor se especifica en el formato ISO 8601. |
snippet.channelId |
string ID que YouTube utiliza para identificar de forma exclusiva al usuario que agregó el elemento a la playlist. |
snippet.title |
string Es el título del elemento. |
snippet.description |
string Es la descripción del elemento. |
snippet.thumbnails |
object 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 información adicional sobre la viñeta. |
snippet.thumbnails.(key) |
object Los valores de clave válidos son los siguientes:
|
snippet.thumbnails.(key).url |
string La URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer El ancho de la imagen. |
snippet.thumbnails.(key).height |
unsigned integer La altura de la imagen. |
snippet.channelTitle |
string Corresponde al título del canal al que pertenece el elemento de la playlist. |
snippet.videoOwnerChannelTitle |
string Corresponde al título del canal que subió este video. |
snippet.videoOwnerChannelId |
string El ID del canal que subió este video. |
snippet.playlistId |
string ID que YouTube utiliza para identificar de forma exclusiva la playlist en la que se encuentra el elemento. |
snippet.position |
unsigned integer Es el orden en el que aparece el elemento en la playlist. El valor utiliza 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 |
object El objeto id contiene información que se puede usar para identificar de forma exclusiva el recurso que se incluye en la playlist como elemento de esta. |
snippet.resourceId.kind |
string La clase o el tipo del recurso al que se hace referencia. |
snippet.resourceId.videoId |
string Si el valor de la propiedad snippet.resourceId.kind es youtube#video , esta propiedad estará presente y su valor contendrá el ID que YouTube utiliza para identificar de forma exclusiva el video en la playlist. |
contentDetails |
object El 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 |
string ID que YouTube utiliza para identificar de forma única un video. Para recuperar el recurso video , establece el parámetro de consulta id en este valor en tu solicitud a la API. |
contentDetails.startAt |
string Nota: Esta propiedad dejó de estar disponible y, si se configuró, se ignora su valor. Es el tiempo, medido en segundos, desde el inicio del video, hasta que este debe comenzar a reproducirse. (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 |
string Nota: Esta propiedad dejó de estar disponible y, si se configuró, se ignora su valor. Es el tiempo, medido en segundos, desde el inicio del video, en el que el video debe dejar de reproducirse. (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, supongamos que video.endTime es el final del video. |
contentDetails.note |
string Nota generada por el usuario para este elemento. El valor de la propiedad tiene una longitud máxima de 280 caracteres. |
contentDetails.videoPublishedAt |
datetime Fecha y hora en que el video se publicó en YouTube. El valor se especifica en el formato ISO 8601. |
status |
object El objeto status contiene información sobre el estado de privacidad del elemento de la playlist. |
status.privacyStatus |
string 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 mediante el método videos.insert o videos.update . |