Un recurso playlistItem
identifica otro recurso, como un video, que se incluye en una lista de reproducción. Además, el recurso playlistItem
contiene detalles sobre el recurso incluido que se refiere específicamente a cómo se usa ese recurso en esa lista de reproducción.
YouTube también usa una lista de reproducción 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 lista de reproducción 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 de playlistItems
:
- list
- Muestra una colección de elementos de la lista de reproducción 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 lista de reproducción. Pruébala ahora.
- actualizar
- Modifica un elemento de la lista de reproducción. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción. Pruébala ahora.
- borrar
- Borra un elemento de la lista de reproducción. Pruébala ahora.
Representación de recursos
La siguiente estructura JSON 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 API. El valor será youtube#playlistItem . |
etag |
etag Es la Etag de este recurso. |
id |
string Indica el ID que YouTube usa para identificar de forma exclusiva el elemento de la lista de reproducción. |
snippet |
object El objeto snippet contiene detalles básicos sobre el elemento de la lista de reproducción, como el título y la posición en la lista. |
snippet.publishedAt |
datetime La fecha y hora en que se agregó el elemento a la lista de reproducción El valor se especifica en el formato ISO 8601. |
snippet.channelId |
string Corresponde al ID que YouTube usa para identificar de forma exclusiva al usuario que agregó el elemento a la lista de reproducción. |
snippet.title |
string Es el título del artículo. |
snippet.description |
string Es la descripción del elemento. |
snippet.thumbnails |
object Mapa de imágenes en miniatura asociadas con el elemento de la lista de reproducción 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 Estos son los valores clave válidos:
|
snippet.thumbnails.(key).url |
string Es la URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer Ancho de la imagen |
snippet.thumbnails.(key).height |
unsigned integer Es la altura de la imagen. |
snippet.channelTitle |
string Título del canal al que pertenece el elemento de la lista de reproducción |
snippet.videoOwnerChannelTitle |
string Es el título del canal que subió este video. |
snippet.videoOwnerChannelId |
string El ID del canal que subió este video. |
snippet.playlistId |
string Indica el ID que YouTube usa para identificar de forma exclusiva la lista de reproducción en la que se encuentra el elemento de la lista de reproducción. |
snippet.position |
unsigned integer Orden en el que aparece el elemento en la lista de reproducción. 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 |
object El objeto id contiene información que se puede usar para identificar de forma exclusiva el recurso que se incluye en la lista de reproducción como el elemento de esta. |
snippet.resourceId.kind |
string El tipo 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 usa para identificar de forma exclusiva el video en la lista de reproducción. |
contentDetails |
object Si el elemento incluido es un video de YouTube, se incluirá el objeto contentDetails en el recurso. El objeto contiene información adicional sobre el video. |
contentDetails.videoId |
string ID que YouTube utiliza para identificar de forma exclusiva 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 configura, se ignora su valor. Es la hora, medida en segundos, desde el inicio del video, en que debe comenzar a reproducirse el video. (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 configura, se ignora su valor. El tiempo, medido en segundos, desde el inicio del video, en el que se debe detener la reproducción del video. (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 Es una nota generada por el usuario para este elemento. El valor de la propiedad tiene una longitud máxima de 280 caracteres. |
contentDetails.videoPublishedAt |
datetime La fecha y hora en que se publicó el video 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 lista de reproducción. |
status.privacyStatus |
string Corresponde al estado de privacidad del elemento de la lista de reproducción. El canal que subió el video que representa el elemento de la lista de reproducción puede establecer este valor mediante el método videos.insert o videos.update . |