Muestra una colección de imágenes de listas de reproducción que coinciden con los parámetros de solicitud de la API. Puedes recuperar la imagen de la playlist de una playlist especificada o recuperar una o más imágenes de playlist mediante sus ID únicos.
Impacto de 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 indican 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 |
|
Filtros (especifica exactamente uno de los siguientes parámetros) | ||
id |
string de El parámetro id especifica una lista separada por comas de uno o más ID de imagen de playlist exclusivos. |
|
playlistId |
string de El parámetro playlistId especifica el ID único de la playlist para la cual quieres recuperar imágenes de playlists. Ten en cuenta que, aunque este es un parámetro opcional, cada solicitud para recuperar imágenes de playlists debe especificar un valor para los parámetros id o playlistId . |
|
Parámetros opcionales | ||
maxResults |
unsigned integer de El parámetro maxResults especifica la cantidad máxima de imágenes que se deben mostrar en el conjunto de resultados. Los valores aceptables son 0 a 50 , ambos incluidos. El valor predeterminado es 5 . |
|
onBehalfOfContentOwner |
string de Este parámetro solo se puede utilizar 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 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 de Este parámetro solo se puede utilizar 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 del canal al que se dirige un video.
agregado. Este parámetro es obligatorio cuando una solicitud especifica un valor para el
parámetro onBehalfOfContentOwner y solo se puede usar en
con ese parámetro. Además, la solicitud debe estar
autorizado mediante una cuenta de CMS que esté vinculada al propietario del contenido que
El parámetro onBehalfOfContentOwner especifica. Por último, la
canal que el valor del parámetro onBehalfOfContentOwnerChannel
especifica que se deben vincular con el propietario del contenido que
que especifica el parámetro onBehalfOfContentOwner .Este está diseñado para socios de contenido de YouTube que poseen y administran muchos diferentes canales de YouTube. Permite que los propietarios del contenido se autentiquen una vez y realizar acciones en nombre del canal especificado en el parámetro sin tener que proporcionar credenciales de autenticación para cada canal separado. |
|
pageToken |
string de 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#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 de Identifica el tipo de recurso de la API. El valor será youtube#playlistImageListResponse . |
nextPageToken |
string de Token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente del conjunto de resultados. |
prevPageToken |
string de Token que se puede usar como valor del parámetro pageToken para recuperar la página anterior del conjunto de resultados. |
pageInfo |
object de El objeto pageInfo encapsula información de paginación para el conjunto de resultados. |
pageInfo.totalResults |
integer de La cantidad total de resultados en el conjunto de resultados. |
pageInfo.resultsPerPage |
integer de La cantidad de resultados incluidos en la respuesta de la API. |
items[] |
list de Lista de imágenes de playlists que coinciden con los criterios de la solicitud. |