PlaylistImages: list

Renvoie une collection d'images de playlists qui correspondent aux paramètres de requête de l'API. Vous pouvez récupérer l'image d'une playlist spécifique ou une ou plusieurs images de playlist en fonction de leur identifiant unique.

Impact sur le quota:un appel à cette méthode a un coût de quota de 1 unité.

Requête

Requête HTTP

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Champ d'application
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string

Le paramètre part spécifie liste d'une ou plusieurs ressources playlistImage séparées par une virgule que la réponse de l'API inclue.

Si le paramètre identifie une propriété qui contient les propriétés enfants, les propriétés enfants sera incluse dans la réponse.
Filtres (spécifiez exactement un des paramètres suivants)
id
string Le paramètre id spécifie une liste d'ID d'image de playlist uniques séparés par une virgule.
playlistId
string Le paramètre playlistId indique l'identifiant unique de la playlist pour laquelle vous souhaitez récupérer les images. Notez que même s'il s'agit d'un paramètre facultatif, chaque demande de récupération d'images de playlist doit spécifier une valeur pour le paramètre id ou playlistId.
Paramètres facultatifs
maxResults
unsigned integer Le paramètre maxResults spécifie le nombre maximal d'images à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 0 à 50, inclus. La valeur par défaut est 5.
onBehalfOfContentOwner
string Ce paramètre ne peut être utilisé que dans une demande correctement autorisée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube agissant pour le compte du propriétaire de contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Elle permet aux propriétaires de contenu de s'authentifier une fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
onBehalfOfContentOwnerChannel
string Ce paramètre ne peut être utilisé que dans une demande correctement autorisée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Les Paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne YouTube sur laquelle la vidéo est diffusée. ajouté. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre onBehalfOfContentOwner, qui ne peut être utilisé que dans conjointement avec ce paramètre. De plus, la demande doit être autorisé à l'aide d'un compte CMS associé au propriétaire de contenu spécifie le paramètre onBehalfOfContentOwner. Enfin, la fonction canal auquel la valeur du paramètre onBehalfOfContentOwnerChannel a été définie spécifie doit être associée au propriétaire de contenu onBehalfOfContentOwner est spécifié.

Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent différentes chaînes YouTube. Il permet aux propriétaires de contenu de s'authentifier une fois et effectuer des actions pour le compte de la chaîne spécifiée dans le paramètre sans avoir à fournir d'identifiants d'authentification pour chaque canal distinct.
pageToken
string Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, les propriétés nextPageToken et prevPageToken identifient les autres pages pouvant être récupérées.

Corps de la requête

N'indiquez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind
string Identifie le type de ressource d'API. La valeur sera youtube#playlistImageListResponse.
nextPageToken
string Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
prevPageToken
string Jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans l'ensemble de résultats.
pageInfo
object L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults
integer Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage
integer Nombre de résultats inclus dans la réponse de l'API.
items[]
list Liste d'images de playlist qui correspondent aux critères de la demande.