PlaylistImages: list

Devuelve una colección de imágenes de playlists que coinciden con los parámetros de la solicitud de la API. Puedes recuperar la imagen de una playlist especificada o recuperar una o más imágenes de playlists por sus IDs únicos.

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

Solicitud

Solicitud HTTP

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

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta búsqueda. 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 del recurso playlistImage que se incluirán en la respuesta de la API.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta.
Filters (especifica exactamente uno de los siguientes parámetros)
id string
El parámetro id especifica una lista separada por comas de uno o más IDs únicos de imágenes de playlist.
playlistId string
El parámetro playlistId especifica el ID único de la playlist de la que deseas recuperar imágenes. Ten en cuenta que, si bien este es un parámetro opcional, cada solicitud para recuperar imágenes de playlists debe especificar un valor para el parámetro id o el parámetro playlistId.
Parámetros opcionales
maxResults unsigned integer
El parámetro maxResults especifica la cantidad máxima de imágenes que se deben devolver en el conjunto de resultados. Los valores aceptables son del 0 al 50, inclusive. El valor predeterminado es 5.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente. Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario del 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 muchos 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 correctamente. Nota: Este parámetro está destinado exclusivamente a los 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 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 que especifica el parámetro onBehalfOfContentOwner.

Este parámetro está destinado a los socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite que los propietarios de contenido se autentiquen una vez y realicen 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 devolver. 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#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages 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#playlistImageListResponse.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del 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 encapsula la información de paginación del conjunto de resultados.
pageInfo.totalResults integer
Es la cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Es la cantidad de resultados incluidos en la respuesta de la API.
items[] list
Es una lista de imágenes de playlists que coinciden con los criterios de la solicitud.