Cette page a été traduite par l'API Cloud Translation.

Playlists: list

Renvoie un ensemble de playlists qui correspondent aux paramètres de requête de l'API. Par exemple, vous pouvez récupérer toutes les playlists dont l'utilisateur authentifié est propriétaire, ou une ou plusieurs playlists par leur ID unique.

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

Cas d'utilisation courants

Demande

Requête HTTP :

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

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
Réglages obligatoires
`part`	`string` Le paramètre `part` spécifie une liste d'une ou de plusieurs propriétés de ressources `playlist` qui seront incluses dans la réponse de l'API. Si le paramètre identifie une propriété contenant des propriétés enfants, celles-ci seront incluses dans la réponse. Par exemple, dans une ressource `playlist`, la propriété `snippet` contient des propriétés telles que `author`, `title`, `description` et `timeCreated`. Par conséquent, si vous définissez `part=snippet`, la réponse de l'API contiendra toutes ces propriétés. La liste suivante contient les noms `part` que vous pouvez inclure dans la valeur du paramètre: `contentDetails` `id` `localizations` `player` `snippet` `status`
Filtres (spécifier exactement l'un des paramètres suivants)
`channelId`	`string` Cette valeur indique que l'API ne doit renvoyer que les playlists de la chaîne spécifiée.
`id`	`string` Le paramètre `id` spécifie une liste d'ID de playlist YouTube séparés par une virgule pour les ressources récupérées. Dans une ressource `playlist`, la propriété `id` spécifie l'ID de la playlist YouTube.
`mine`	`boolean` Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur `true` pour indiquer à l'API de ne renvoyer que les playlists appartenant à l'utilisateur authentifié.
Paramètres facultatifs
`hl`	`string` Le paramètre `hl` indique à l'API de récupérer les métadonnées de ressources localisées pour une langue d'application spécifique compatible avec le site Web YouTube. La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode `i18nLanguages.list`. Si des détails de ressource localisés sont disponibles dans cette langue, l'objet `snippet.localized` de la ressource contiendra les valeurs localisées. Toutefois, si les détails localisés ne sont pas disponibles, l'objet `snippet.localized` contient les détails de la ressource dans la langue par défaut de la ressource.
`maxResults`	`unsigned integer` Le paramètre `maxResults` spécifie le nombre maximal d'éléments à 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 requête correctement autorisée. Remarque:Ce paramètre est réservé aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwner` indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom 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 différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants 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 requête correctement autorisée. Remarque:Ce paramètre est réservé aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwnerChannel` spécifie l'ID de la chaîne à laquelle une vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre `onBehalfOfContentOwner`. Il ne peut être utilisé qu'avec ce paramètre. En outre, la demande doit être autorisée via un compte CMS associé au propriétaire de contenu indiqué par le paramètre `onBehalfOfContentOwner`. Enfin, la chaîne spécifiée par le paramètre `onBehalfOfContentOwnerChannel` doit être associée au propriétaire de contenu indiqué par le paramètre `onBehalfOfContentOwner`. 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'effectuer des actions pour le compte de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants pour chaque chaîne.
`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 d'autres pages qui pourraient être récupérées.

Corps de la requête

Ne fournissez 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#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist 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 de l'API. La valeur sera `youtube#playlistListResponse`.
`etag`	`etag` ETag de cette ressource.
`nextPageToken`	`string` Jeton pouvant être utilisé comme valeur du paramètre `pageToken` pour extraire la page suivante de l'ensemble de résultats.
`prevPageToken`	`string` Jeton pouvant ê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 de playlists correspondant aux critères de demande.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur	Détails de l'erreur	Description
`forbidden (403)`	`channelClosed`	Le canal spécifié dans le paramètre `channelId` a été clôturé.
`forbidden (403)`	`channelSuspended`	La chaîne indiquée dans le paramètre `channelId` a été suspendue.
`forbidden (403)`	`playlistForbidden`	La playlist identifiée avec le paramètre `id` de la demande n'est pas compatible avec cette dernière, ou celle-ci n'est pas correctement autorisée.
`notFound (404)`	`channelNotFound`	Le canal spécifié dans le paramètre `channelId` est introuvable.
`notFound (404)`	`playlistNotFound`	La playlist identifiée avec le paramètre `id` de la requête est introuvable.
`invalidValue (400)`	`playlistOperationUnsupported`	L'API ne permet pas de répertorier la playlist spécifiée. Par exemple, vous ne pouvez pas répertorier votre playlist "À regarder plus tard".

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.