PlaylistItems

Un recurso playlistItem identifica otro recurso, como un video, que se incluye en una lista de reproducción. Además, el recurso playlistItem contiene información sobre el recurso incluido que se refiere específicamente a la forma en que se utiliza dicho recurso en esa lista de reproducción.

YouTube utiliza listas de reproducción para identificar colecciones especiales de videos para un canal, por ejemplo:

  • videos subidos
  • videos favoritos
  • videos con calificación positiva (me gusta)
  • historial de reproducciones
  • ver más tarde
Para ser más específicos, estas listas están asociadas a un canal, que es una colección de videos, listas de reproducción e información adicional de YouTube de una persona, un grupo o empresa.

Puedes recuperar los ID de listas de reproducción para cada una de estas listas de channel resource para un canal determinado. Luego, puedes utilizar el método playlistItems.list para recuperar cualquiera de esas listas. También puedes agregar o eliminar elementos de esas listas al invocar los métodos playlistItems.insert y playlistItems.delete. Por ejemplo, si un usuario marca un video como favorito, tú insertarías ese video en la lista de reproducción de videos favoritos del canal de ese usuario.

Métodos

La API admite los siguientes métodos para los recursos de playlistItems:

list
Muestra una colección de elementos de una lista de reproducción que coinciden con los parámetros de solicitud de 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ébalo ahora.
insert
Agrega un recurso a una lista de reproducción. Pruébalo ahora.
update
Modifica un elemento de una lista de reproducción. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción. Pruébalo ahora.
delete
Elimina un elemento de una lista de reproducción. Pruébalo ahora.

Representación de recursos

La estructura JSON a continuación muestra el formato de un recurso de 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,
    "playlistId": string,
    "position": unsigned integer,
    "resourceId": {
      "kind": string,
      "videoId": string,
    }
  },
  "contentDetails": {
    "videoId": string,
    "startAt": string,
    "endAt": string,
    "note": string
  },
  "status": {
    "privacyStatus": string
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Tipo de recurso de la API. El valor será youtube#playlistItem.
etag etag
Etag de este recurso.
id string
ID que YouTube utiliza para identificar de forma exclusiva el elemento de la lista de reproducción.
snippet object
El objeto snippet contiene información básica sobre el elemento de la lista de reproducción, como el título y la posición en la lista de reproducción.
snippet.publishedAt datetime
Fecha y hora en que el elemento se agregó a la lista de reproducción. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelId string
ID que YouTube utiliza para identificar de forma exclusiva el elemento que se agregó a la lista de reproducción.
snippet.title string
Título del elemento.
snippet.description string
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 otra información sobre la viñeta.
snippet.thumbnails.(key) object
Los valores de clave válidos son:
  • default: La imagen en miniatura predeterminada. La viñeta predeterminada de un video, o de un recurso que se refiere a un video, como un elemento de una lista de reproducción o el resultado de una búsqueda, es de 120 píxeles de ancho y 90 píxeles de alto. La viñeta predeterminada para un canal es de 88 píxeles de ancho y 88 píxeles de alto.
  • medium: Versión de mayor resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 320 píxeles de ancho y 180 píxeles de alto. Para un canal, esta imagen es de 240 píxeles de ancho y 240 píxeles de alto.
  • high: Versión de alta resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 480 píxeles de ancho y 360 píxeles de alto. Para un canal, esta imagen es de 800 píxeles de ancho y 800 píxeles de alto.
snippet.thumbnails.(key).url string
URL de la imagen.
snippet.thumbnails.(key).width unsigned integer
Ancho de la imagen.
snippet.thumbnails.(key).height unsigned integer
Altura de la imagen.
snippet.channelTitle string
Título del canal al que pertenece el elemento de la lista de reproducción.
snippet.playlistId string
ID que YouTube utiliza para identificar de forma exclusiva la lista de reproducción donde se encuentra el elemento de la misma.
snippet.position unsigned integer
Orden en el que el aparece el elemento en la lista de reproducción. 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 i­dentificar de forma exclusiva el recurso que se incluye en la lista de reproducción como el elemento de la misma.
snippet.resourceId.kind string
Clase o 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 lista de reproducción.
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 exclusiva un video. Para recuperar el recurso video, establece el parámetro de consulta id en este valor en tu solicitud de API.
contentDetails.startAt string
Tiempo, medido en segundos, desde el inicio del video, cuando el video debe empezar 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
Tiempo, medido en segundos, desde el inicio del video, cuando este debe detenerse. (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 manera predeterminada, deberías suponer que video.endTime es el final del video.
contentDetails.note string
Nota generada por el usuario para este elemento.
status object
El objeto status contiene información sobre el estado de privacidad del elemento de la lista de reproducción.
status.privacyStatus string
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 usando el método videos.insert o videos.update.