Playlists: list

Renvoie une collection de playlists correspondant aux paramètres de la requête API. Par exemple, vous pouvez récupérer toutes les playlists appartenant à l'utilisateur authentifié ou une ou plusieurs playlists à l'aide de leurs identifiants uniques.

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

Cas d'utilisation courants

Requête

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
Paramètres obligatoires
part string
Le paramètre part spécifie une liste de une ou plusieurs propriétés de ressource playlist séparées par une virgule que la réponse de l'API inclura.

Si le paramètre identifie une propriété contenant des propriétés enfants, ces dernières 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 part noms que vous pouvez inclure dans la valeur du paramètre :
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtres (spécifiez 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 playlists 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 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 demander à l'API de ne renvoyer que les playlists appartenant à l'utilisateur authentifié.
Paramètres facultatifs
hl string
Le paramètre hl demande à 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 i18nLanguages.list méthode.

Si des informations sur les ressources localisées sont disponibles dans cette langue, l'objet snippet.localized de la ressource contiendra les valeurs localisées. Toutefois, si aucune information localisée n'est disponible, l'objet snippet.localized contiendra des informations sur les ressources 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 acceptables sont comprises entre 0 et 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 destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube CMS agissant au nom du propriétaire du 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. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données de vidéos et de chaînes, 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 du 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 destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne YouTube à 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, et il ne peut être utilisé qu'avec ce paramètre. De plus, la requête doit être autorisée à l'aide d'un compte CMS associé au propriétaire du contenu spécifié par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par la valeur du paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire du contenu spécifié 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. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'effectuer des actions au nom de la chaîne spécifiée dans la valeur de paramètre, sans avoir à fournir d'identifiants d'authentification 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 de l'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
L'Etag de cette ressource.
nextPageToken string
Le jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
prevPageToken string
Le 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
Le nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Le nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des playlists correspondant aux critères de la requête.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel à cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
forbidden (403) channelClosed La chaîne spécifiée dans le paramètre channelId a été fermée.
forbidden (403) channelSuspended La chaîne spécifiée dans le paramètre channelId a été suspendue.
forbidden (403) playlistForbidden La playlist identifiée avec le paramètre id de la requête n'est pas compatible avec la requête ou la requête n'est pas correctement autorisée.
notFound (404) channelNotFound Impossible de trouver la chaîne spécifiée dans le paramètre channelId.
notFound (404) playlistNotFound Impossible de trouver la playlist identifiée avec le paramètre id de la requête.
invalidValue (400) playlistOperationUnsupported L'API n'est pas compatible avec la possibilité de lister la playlist spécifiée. Par exemple, vous ne pouvez pas lister votre playlist "À regarder plus tard".

Essayer

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