Une ressource playlist représente une playlist YouTube. Une playlist est un ensemble de vidéos qui peuvent être regardées de manière séquentielle et partagées avec d'autres utilisateurs. Par défaut, les playlists sont visibles publiquement par les autres utilisateurs, mais elles peuvent être publiques ou privées.
YouTube utilise également les playlists pour identifier des collections spéciales de vidéos pour une chaîne, par exemple :
- vidéos mises en ligne
- les vidéos ayant reçu un avis positif (mention "J'aime") ;
channel resource pour une chaîne donnée.Vous pouvez ensuite utiliser la méthode
playlistItems.list pour récupérer l'une de ces listes. Vous pouvez également ajouter ou supprimer des éléments de ces listes en appelant les méthodes playlistItems.insert et playlistItems.delete.
Méthodes
L'API accepte les méthodes suivantes pour les ressources playlists :
- liste
- 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 ID uniques. Essayer
- insérer
- Crée une playlist. Essayer
- update
- Modifie une playlist. Par exemple, vous pouvez modifier le titre, la description ou l'état de confidentialité d'une playlist. Essayer
- supprimer
- Supprime une playlist. Essayer
Représentation de la ressource
La structure JSON suivante montre le format d'une ressource playlists :
{
"kind": "youtube#playlist",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource :
| Propriétés | |
|---|---|
kind |
stringIdentifie le type de ressource de l'API. La valeur sera youtube#playlist. |
etag |
etagEtag de cette ressource. |
id |
stringID utilisé par YouTube pour identifier de manière unique la playlist. |
snippet |
objectL'objet snippet contient des informations de base sur la playlist, comme son titre et sa description. |
snippet.publishedAt |
datetimeDate et heure de création de la playlist. La valeur est spécifiée au format ISO 8601. |
snippet.channelId |
stringID utilisé par YouTube pour identifier de manière unique la chaîne qui a publié la playlist. |
snippet.title |
stringTitre de la playlist. |
snippet.description |
stringDescription de la playlist. |
snippet.thumbnails |
objectCarte des miniatures associées à la playlist. Pour chaque objet de la carte, la clé correspond au nom de la miniature et la valeur est un objet contenant d'autres informations sur la miniature. |
snippet.thumbnails.(key) |
objectLes valeurs de clé valides sont les suivantes :
|
snippet.thumbnails.(key).url |
stringURL de l'image. |
snippet.thumbnails.(key).width |
unsigned integerLargeur de l'image. |
snippet.thumbnails.(key).height |
unsigned integerHauteur de l'image. |
snippet.channelTitle |
stringTitre de la chaîne à laquelle appartient la vidéo. |
snippet.tags[] |
listCette propriété est obsolète. Tags de mots clés associés à la playlist. |
snippet.defaultLanguage |
stringLangue du texte dans les propriétés snippet.title et snippet.description de la ressource playlist. |
snippet.localized |
objectL'objet snippet.localized contient un titre et une description localisés pour la playlist, ou le titre dans la langue par défaut pour les métadonnées de la playlist.
localizations pour ajouter, modifier ou supprimer des titres localisés. |
snippet.localized.title |
stringTitre localisé de la playlist. |
snippet.localized.description |
stringDescription localisée de la playlist. |
status |
objectL'objet status contient des informations sur l'état de la playlist. |
status.privacyStatus |
stringÉtat de confidentialité de la playlist. Les valeurs valides pour cette propriété sont les suivantes :
|
status.podcastStatus |
stringÉtat de la playlist en tant que podcast. Si la valeur est enabled, la playlist est marquée comme émission de podcast. Pour définir l'état d'une playlist sur enabled, elle doit comporter une image.Les valeurs valides pour cette propriété sont les suivantes :
|
contentDetails |
objectL'objet contentDetails contient des informations sur le contenu de la playlist, y compris le nombre de vidéos qu'elle contient. |
contentDetails.itemCount |
unsigned integerNombre de vidéos dans la playlist. |
player |
objectL'objet player contient les informations que vous utiliserez pour lire la playlist dans un lecteur intégré. |
player.embedHtml |
stringBalise <iframe> qui intègre un lecteur pour lire la playlist. |
localizations |
objectL'objet localizations encapsule les traductions des métadonnées de la playlist. |
localizations.(key) |
objectLangue du texte localisé associé à la valeur clé. La valeur est une chaîne contenant un code de langue BCP-47. |
localizations.(key).title |
stringTitre localisé de la playlist. |
localizations.(key).description |
stringDescription localisée de la playlist. |