Playlists: list

Muestra una colección de listas de reproducción que coinciden con los parámetros de solicitud de la API. Por ejemplo, puedes recuperar todas las listas de reproducción pertenecientes al usuario autenticado o puedes recuperar una o varias listas de reproducción con sus ID únicos.

Impacto de la cuota: Una llamada a este método tiene un costo de cuota de 1 unidad.

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/playlists

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part especifica una lista separada por comas de una o más propiedades de recursos de playlist que la respuesta de la API incluirá.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso playlist, la propiedad snippet contiene propiedades como author, title, description y timeCreated. Por lo tanto, si configuras part=snippet, la respuesta de la API contendrá todas esas propiedades.

La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtros (especifica exactamente uno de los siguientes parámetros)
channelId string
Este valor indica que la API solo debe mostrar las playlists del canal especificado.
id string
El parámetro id especifica una lista separada por comas de ID de playlists de YouTube para los recursos que se están recuperando. En un recurso playlist, la propiedad id especifica el ID de la playlist de YouTube de la playlist.
mine boolean
Este parámetro solo se puede usar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para indicarle a la API que muestre solo las playlists que pertenecen al usuario autenticado.
Parámetros opcionales
hl string
El parámetro hl le indica a la API que recupere metadatos de recursos localizados para un idioma de aplicación específico compatible con el sitio web de YouTube. El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list.

Si los detalles de los recursos localizados están disponibles en ese idioma, el objeto snippet.localized del recurso contendrá los valores localizados. Sin embargo, si los detalles localizados no están disponibles, el objeto snippet.localized contendrá los detalles del recurso en el idioma predeterminado del recurso.
maxResults unsigned integer
El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados. Los valores aceptables son 0 a 50, ambos inclusive. El valor predeterminado es 5.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran varios canales de YouTube diferentes. Permite a los propietarios del contenido autenticarse una vez y tener acceso a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.
onBehalfOfContentOwnerChannel string
Este parámetro solo se puede usar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwnerChannel especifica el ID del canal de YouTube al que se agrega un video. Este parámetro es obligatorio cuando una solicitud especifica un valor para el parámetro onBehalfOfContentOwner y solo se puede usar junto con ese parámetro. Además, la solicitud debe autorizarse con una cuenta de CMS que esté vinculada al propietario del contenido que especifica el parámetro onBehalfOfContentOwner. Por último, el canal que especifica el valor del parámetro onBehalfOfContentOwnerChannel debe estar vinculado al propietario del contenido especificado en el parámetro onBehalfOfContentOwner.

Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios de contenido autenticarse una vez y llevar a cabo acciones en nombre del canal especificado en el valor del parámetro, sin tener que proporcionar credenciales de autenticación para cada canal por separado.
pageToken string
El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, las propiedades nextPageToken y prevPageToken identifican otras páginas que se podrían recuperar.

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud cuando invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

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#playlistListResponse.
etag etag
La Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados.
prevPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados.
pageInfo object
El objeto pageInfo contiene información de paginación para el conjunto de resultados.
pageInfo.totalResults integer
Es la cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Cantidad de resultados incluidos en la respuesta de la API.
items[] list
Lista de playlists que coinciden con los criterios de la solicitud.

Errores

En la siguiente tabla se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación sobre mensajes de error para obtener más información.

Tipo de error Detalle del error Descripción
forbidden (403) channelClosed Se cerró el canal especificado en el parámetro channelId.
forbidden (403) channelSuspended El canal especificado en el parámetro channelId se suspendió.
forbidden (403) playlistForbidden La playlist identificada con el parámetro id de la solicitud no admite la solicitud o esta no está debidamente autorizada.
notFound (404) channelNotFound No se puede encontrar el canal especificado en el parámetro channelId.
notFound (404) playlistNotFound No se puede encontrar la playlist identificada con el parámetro id de la solicitud.
invalidValue (400) playlistOperationUnsupported La API no admite la capacidad de mostrar la lista de reproducción especificada. Por ejemplo, no puedes agregar la playlist Ver más tarde.

Pruébalo

Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.