Implementación: Listas de reproducción

Los siguientes ejemplos muestran cómo utilizar la API de datos de YouTube (v3) para realizar funciones relacionadas con las listas de reproducción y los elementos de las listas de reproducción.

Recuperar las listas de reproducción del usuario actual

Llama al método playlists.list para recuperar las listas de reproducción del usuario autenticado actualmente. En tu solicitud, establece el valor del parámetro mine en true. Ten en cuenta que una solicitud que use el parámetro mine debe autorizarse mediante OAuth 2.0.

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

Recuperar las listas de reproducción de un usuario

En este ejemplo se recuperan las listas de reproducción creadas por un canal en particular. El ejemplo tiene dos pasos:

Recuperar información sobre una lista de reproducción específica

Para recuperar información sobre una o más listas de reproducción específicas, invoca el método playlists.list y establece el parámetro id en una lista separada por comas de ID de listas de reproducción 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 listas de reproducción en un conjunto de resultados de búsqueda. Por ejemplo, tal vez quieras recuperar la cantidad de elementos en cada lista de reproducción.

La siguiente solicitud llama al método playlists.list para recuperar la cantidad de elementos de dos listas de reproducción 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

Agregar una lista de reproducción

En este ejemplo, se llama al método playlists.insert para crear una lista de reproducción privada en el canal del usuario autenticado. Cualquier solicitud a la API a este método debe autorizarse mediante OAuth 2.0.

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

El vínculo al Explorador de API 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 lista de reproducción. En este ejemplo, el cuerpo de la solicitud es el siguiente:

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

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

Cómo actualizar una lista de reproducción

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

  • Paso 1: Recupera el ID de la lista de reproducción

    Llama al método playlist.list para recuperar las listas de reproducción en el canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las listas de reproducción 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 listas de reproducción, utilizando el ID de cada lista de reproducción como clave.

  • Paso 2: Cómo actualizar una lista de reproducción

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

    El cuerpo de la solicitud debe incluir la parte snippet del recurso playlist porque se requiere la propiedad snippet.title cuando se llama a este método. Además, si el recurso de la lista de reproducción 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; de lo contrario, 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 lista de reproducción, el vínculo al Explorador de API 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 lista de reproducción. En este ejemplo, se usa el siguiente cuerpo de solicitud:

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

    Nota: Si pruebas esta consulta en el Explorador de API, deberás sustituir el ID de la lista de reproducción válida en el cuerpo del recurso. Si quieres obtener un ID de lista de reproducción, te recomendamos que primero ejecutes la solicitud anterior para agregar una lista de reproducción. Extrae el ID de la lista de reproducción de la respuesta de la API y usa ese valor para la lista de reproducción que deseas actualizar. El título y la descripción de la lista de reproducción que se usan en este ejemplo son los mismos que en este ejemplo.

Agregar un elemento de una lista de reproducción

En este ejemplo, se agrega un elemento a una lista de reproducción. Esta solicitud debe autorizarse con OAuth 2.0. Este ejemplo tiene dos pasos:

  • Paso 1: Recupera el ID apropiado de la lista de reproducción

    Llama al método playlist.list para recuperar las listas de reproducción en el canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las listas de reproducción 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 listas de reproducción, utilizando el ID de cada lista de reproducción como clave.

  • Paso 2: Agrega un video a la lista de reproducción

    Invoca el método playlistItems.insert para agregar un video a la lista de reproducción. Esta solicitud debe autorizarse con OAuth 2.0. El cuerpo de la solicitud es un recurso playlistItem que especifica al menos los siguientes valores:

    • El elemento snippet.playlistId identifica la lista de reproducción a la que agregarás el video. Este es el ID de la lista de reproducción que obtuviste en el paso 1.
    • snippet.resourceId.kind contiene el valor youtube#video.
    • El elemento snippet.resourceId.videoId identifica el video que estás agregando a la lista de reproducción. El valor de propiedad es un ID de video de YouTube único.

    La solicitud de la API a continuación agrega un video a una lista de reproducción. El cuerpo de la solicitud es el siguiente:

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

    A fin de completar la solicitud en el Explorador de API, 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 la lista de reproducción.

Actualizar un elemento de una lista de reproducción

En este ejemplo se actualiza un elemento de la lista de reproducción para que sea el primero de la lista. Esta solicitud debe autorizarse con OAuth 2.0. Este ejemplo consta de tres pasos:

  • Paso 1: Recupera el ID apropiado de la lista de reproducción

    Llama al método playlist.list para recuperar las listas de reproducción en el canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las listas de reproducción 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 listas de reproducción, utilizando el ID de cada lista de reproducción como clave.

  • Paso 2: Recupera los elementos de la lista de reproducción seleccionada

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

    Cada recurso en la respuesta de la API contiene una propiedad id, que identifica el ID del elemento de la lista de reproducción que identifica ese elemento de forma única. Usarás ese valor para quitar un elemento de la lista en el paso siguiente.

  • Paso 3: Actualiza el elemento de la lista de reproducción seleccionada

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

    • Establece la propiedad id en el ID del elemento de la lista de reproducción que obtuviste en el paso 2.
    • Establece la propiedad snippet.playlistId en el ID de la lista de reproducción 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 única el video incluido en la lista de reproducción.
    • Establece la propiedad snippet.position en 0 o en la posición en la que deseas que aparezca el elemento (con un índice basado en 0).

    La solicitud de API que aparece a continuación actualiza un elemento de la lista de reproducción para que sea el primero de la lista. 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
  }
}

    A fin de completar la solicitud en el Explorador de API, 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 quitar un elemento de una lista de reproducción

En este ejemplo se borra un video de una lista de reproducción. Esta solicitud debe autorizarse 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 lista de reproducción.

Después de completar esos pasos, llama al método playlistItems.delete para quitar un video de la lista de reproducción. Establece el parámetro id de la solicitud en el ID del elemento de la lista de reproducción del elemento que deseas quitar. Esta solicitud debe autorizarse con OAuth 2.0.

Ten en cuenta que el ID de elemento de la lista de reproducción que se usa para identificar un video de una lista de reproducción es diferente del ID del video de YouTube que identifica exclusivamente el video. El ID de elemento de la lista de reproducción identifica el video como un elemento de una lista de reproducción en particular.

Para completar la solicitud en el Explorador de API, debes configurar 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 una lista de reproducción

En este ejemplo se borra una lista de reproducción. El ejemplo tiene dos pasos:

  • Paso 1: Recupera el ID de la lista de reproducción

    Llama al método playlist.list para recuperar las listas de reproducción en el canal del usuario autenticado actualmente. La solicitud de ejemplo anterior para recuperar las listas de reproducción 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 listas de reproducción, utilizando el ID de cada lista de reproducción como clave.

  • Paso 2: Borra una lista de reproducción

    Llama al método playlists.delete para borrar una lista de reproducción específica. En la solicitud, el parámetro id especifica el ID de la lista de reproducción que se borrará. Este método requiere un token de autorización OAuth 2.0 válido. Si pruebas esta consulta en el Explorador de API, deberás reemplazar el valor del parámetro id por un ID de lista de reproducción 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 API, deberás reemplazar el valor del parámetro id por un ID de lista de reproducción válido. Si quieres obtener un ID de lista de reproducción, te recomendamos que primero ejecutes la solicitud anterior para agregar una lista de reproducción. Extrae el ID de la lista de reproducción de la respuesta de la API y usa ese valor para la lista de reproducción que deseas borrar.