Implementación: Playlists

En los siguientes ejemplos, se muestra cómo usar la API de YouTube Data (v3) para realizar funciones relacionadas con las playlists y los elementos de las playlists.

Recupera las playlists del usuario actual

Llama al método playlists.list para recuperar las playlists del usuario autenticado actualmente. En tu solicitud, establece el valor del parámetro mine en true. Ten en cuenta que una solicitud que usa el parámetro mine debe estar autorizada con OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Cómo recuperar las playlists de un usuario

En este ejemplo, se recuperan las playlists creadas por un canal en particular. El ejemplo tiene dos pasos:

Cómo recuperar información sobre una playlist específica

Para recuperar información sobre una o más playlists específicas, llama al método playlists.list y establece el parámetro id en una lista separada por comas de IDs de playlists de YouTube que identifiquen los recursos deseados. Un caso de uso común para esta funcionalidad es una solicitud para recuperar información adicional sobre un grupo de playlists que se muestra en un conjunto de resultados de la búsqueda. Por ejemplo, es posible que desees recuperar la cantidad de elementos de cada playlist.

La siguiente solicitud llama al método playlists.list para recuperar la cantidad de elementos en dos playlists que coinciden con el término de búsqueda "GoogleDevelopers". Esta información se encuentra en la propiedad contentDetails.itemCount del recurso playlist, por lo que la solicitud establece el valor del parámetro part en contentDetails. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Cómo agregar una playlist

En este ejemplo, se llama al método playlists.insert para crear una playlist privada en el canal del usuario autenticado. Cualquier solicitud a la API a este método debe estar autorizada con OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

El vínculo al Explorador de APIs también establece un parámetro que especifica el cuerpo de la solicitud a la API. El cuerpo de la solicitud contiene un recurso playlist, que define información como el título, la descripción y el estado de privacidad de la playlist. En este ejemplo, el cuerpo de la solicitud es el siguiente:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

En el siguiente ejemplo, se marca la playlist nueva como un programa de podcast:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

Muestras de código relacionadas: Java, JavaScript, .NET, PHP, Python

Cómo actualizar una playlist

En este ejemplo, se actualiza el estado de privacidad de una playlist de private a public. El ejemplo tiene dos pasos:

  • Paso 1: Recupera el ID de la playlist

    Llama al método playlists.list para recuperar las playlists del canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las playlists del usuario actual demuestra esta solicitud. La aplicación que llama a la API podría procesar la respuesta de la API para mostrar una lista de playlists, usando el ID de cada playlist como clave.

  • Paso 2: Actualiza una playlist

    Llama al método playlists.update para modificar una playlist específica. Este método requiere un token de autorización de OAuth 2.0 válido.

    El cuerpo de la solicitud debe incluir la parte snippet del recurso playlist porque la propiedad snippet.title es obligatoria cuando se llama a este método. Además, si el recurso de playlist que se actualiza especifica valores para las propiedades snippet.description o snippet.tags, esos valores se deben volver a especificar en la solicitud de actualización o se borrarán.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    Al igual que en el ejemplo anterior para agregar una playlist, el vínculo al Explorador de APIs establece un parámetro que especifica el cuerpo de la solicitud a la API. El cuerpo de la solicitud contiene un recurso playlist, que define información como el título, la descripción y el estado de privacidad de la playlist. En este ejemplo, se usa el siguiente cuerpo de la solicitud:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    En el siguiente ejemplo, se marca la playlist como un programa de podcast:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    Nota: Si pruebas esta consulta en el Explorador de APIs, deberás reemplazar un ID de playlist válido en el cuerpo del recurso. Para obtener un ID de playlist, te recomendamos que primero ejecutes la solicitud que se muestra más arriba para agregar una playlist. Extrae el ID de la playlist de la respuesta de la API y usa ese valor para la playlist que deseas actualizar. El título y la descripción de la playlist que se usan en este ejemplo son los mismos que en ese ejemplo.

Cómo agregar un elemento a una playlist

En este ejemplo, se agrega un elemento a una playlist. Esta solicitud se debe autorizar con OAuth 2.0. Este ejemplo tiene dos pasos:

  • Paso 1: Recupera el ID de la playlist correspondiente

    Llama al método playlists.list para recuperar las playlists del canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las playlists del usuario actual demuestra esta solicitud. La aplicación que llama a la API podría procesar la respuesta de la API para mostrar una lista de playlists, usando el ID de cada playlist como clave.

  • Paso 2: Agrega un video a la playlist

    Llama al método playlistItems.insert para agregar un video a la playlist. Esta solicitud se debe autorizar con OAuth 2.0. El cuerpo de la solicitud es un recurso playlistItem que especifica, al menos, los siguientes valores:

    La siguiente solicitud a la API agrega un video a una playlist. El cuerpo de la solicitud es el siguiente:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Para completar la solicitud en el Explorador de APIs, debes establecer valores para las propiedades snippet.playlistId y snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    Nota: En la documentación del método playlistItems.insert, se identifican los otros valores de propiedad que puedes establecer cuando agregas un elemento de playlist.

Cómo agregar una imagen a una playlist

Puedes usar el método playlistImages.insert de la API de v3 para subir una imagen de miniatura personalizada y configurarla para una playlist. En tu solicitud, el valor del parámetro playlistId identifica la playlist para la que se usará la miniatura.

Esta consulta no se puede probar con el Explorador de APIs porque no admite la carga de archivos multimedia, lo cual es un requisito para este método.

Cómo actualizar un elemento de una playlist

En este ejemplo, se actualiza un elemento de una playlist para que sea el primero. Esta solicitud se debe autorizar con OAuth 2.0. Este ejemplo tiene tres pasos:

  • Paso 1: Recupera el ID de la playlist correspondiente

    Llama al método playlists.list para recuperar las playlists del canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las playlists del usuario actual demuestra esta solicitud. La aplicación que llama a la API podría procesar la respuesta de la API para mostrar una lista de playlists, usando el ID de cada playlist como clave.

  • Paso 2: Recupera los elementos de la playlist seleccionada

    Llama al método playlistItems.list para recuperar la lista de videos de la playlist seleccionada. Establece el valor del parámetro playlistId en el ID de la playlist que obtuviste en el paso 1.

    Cada recurso de la respuesta de la API contiene una propiedad id, que identifica el ID del elemento de la playlist que lo identifica de forma exclusiva. Usarás ese valor para quitar un elemento de la lista en el siguiente paso.

  • Paso 3: Actualiza el elemento de la playlist seleccionado

    Llama al método playlistItems.update para cambiar la posición del video en la playlist. Establece el valor del parámetro part en snippet. El cuerpo de la solicitud debe ser un recurso playlistItem que, al menos, establezca los siguientes valores:

    • Establece la propiedad id en el ID del elemento de la playlist que obtuviste en el paso 2.
    • Establece la propiedad snippet.playlistId en el ID de la playlist que obtuviste en el paso 1.
    • Establece la propiedad snippet.resourceId.kind en youtube#video.
    • Establece la propiedad snippet.resourceId.videoId en el ID de video que identifica de forma exclusiva el video incluido en la playlist.
    • Establece la propiedad snippet.position en 0 o en la posición que quieras que aparezca el elemento (con un índice basado en 0).

    La siguiente solicitud a la API actualiza un elemento de una playlist para que sea el primero. El cuerpo de la solicitud es el siguiente:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Para completar la solicitud en el Explorador de APIs, debes establecer valores para las propiedades id, snippet.playlistId y snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Cómo actualizar la imagen de una playlist

Puedes usar el método playlistImages.update de la API de v3 para actualizar la imagen de miniatura de una playlist. En tu solicitud, el valor del parámetro playlistId identifica la playlist para la que se usará la miniatura.

Esta consulta no se puede probar con el Explorador de APIs porque no admite la carga de archivos multimedia, lo cual es un requisito para este método.

Cómo quitar un elemento de una playlist

En este ejemplo, se borra un video de una playlist. Esta solicitud se debe autorizar con OAuth 2.0. Este ejemplo tiene tres pasos. Los dos primeros pasos son los mismos que los del ejemplo anterior para actualizar un elemento de una playlist.

Después de completar esos pasos, llama al método playlistItems.delete para quitar un video de la playlist. Establece el parámetro id de la solicitud en el ID del elemento de la playlist que quieres quitar. Esta solicitud se debe autorizar con OAuth 2.0.

Ten en cuenta que el ID de elemento de playlist que se usa para identificar un video en una playlist es diferente del ID de video de YouTube que identifica el video de forma inequívoca. El ID del elemento de la playlist identifica el video como un elemento de una playlist en particular.

Para completar la solicitud en el Explorador de APIs, debes establecer el valor de la propiedad id.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Cómo quitar la imagen de una playlist

En este ejemplo, se borra la imagen de una playlist. El ejemplo tiene dos pasos:

  • Paso 1: Recupera la playlist

    Llama al método playlists.list para recuperar las playlists del canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las playlists del usuario actual demuestra esta solicitud. La aplicación que llama a la API podría procesar la respuesta de la API para mostrar una lista de playlists, usando el ID de cada playlist como clave.

  • Paso 2: Recupera el ID de la imagen de la playlist

    Llama al método playlistImages.list para recuperar la imagen de miniatura de una playlist. Usa el ID de la playlist que quieres cambiar.

  • Paso 3: Borra la imagen de una playlist

    Llama al método playlistImages.delete para borrar una imagen de playlist específica. En la solicitud, el parámetro id especifica el ID de la imagen de la playlist que se borrará. Este método requiere un token de autorización de OAuth 2.0 válido. Si pruebas esta consulta en el Explorador de APIs, deberás reemplazar el valor del parámetro id por un ID de playlist válido.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

    Nota: Si pruebas esta consulta en el Explorador de APIs, deberás reemplazar el valor del parámetro id por un ID de imagen de playlist válido.

Cómo quitar una playlist

En este ejemplo, se borra una playlist. El ejemplo tiene dos pasos:

  • Paso 1: Recupera el ID de la playlist

    Llama al método playlists.list para recuperar las playlists del canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las playlists del usuario actual demuestra esta solicitud. La aplicación que llama a la API podría procesar la respuesta de la API para mostrar una lista de playlists, usando el ID de cada playlist como clave.

  • Paso 2: Borra una playlist

    Llama al método playlists.delete para borrar una playlist específica. En la solicitud, el parámetro id especifica el ID de la playlist que se borrará. Este método requiere un token de autorización de OAuth 2.0 válido. Si pruebas esta consulta en el Explorador de APIs, deberás reemplazar el valor del parámetro id por un ID de playlist válido.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    Nota: Si pruebas esta consulta en el Explorador de APIs, deberás reemplazar el valor del parámetro id por un ID de playlist válido. Para obtener un ID de playlist, te recomendamos que primero ejecutes la solicitud que se muestra más arriba para agregar una playlist. Extrae el ID de la playlist de la respuesta de la API y usa ese valor para la playlist que quieres borrar.