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 ensembles de vidéos spécifiques pour une chaîne, par exemple:
- vidéos mises en ligne
- vidéos avec une note positive (mention "J'aime")
channel resource
d'une chaîne donnée.Vous pouvez ensuite utiliser la méthode
playlistItems.list
pour récupérer n'importe laquelle 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 qui correspondent aux paramètres de requête de l'API. Par exemple, vous pouvez récupérer toutes les playlists appartenant à l'utilisateur authentifié, ou récupérer une ou plusieurs playlists en fonction de leur ID unique. Essayer
- insérer
- Crée une playlist. Essayer
- mise à jour
- 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 des ressources
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 |
string
Identifie le type de ressource d'API. La valeur sera youtube#playlist . |
etag |
etag
ETag de cette ressource. |
id |
string
ID utilisé par YouTube pour identifier la playlist de façon unique. |
snippet |
object
L'objet snippet contient les informations de base de la playlist, telles que son titre et sa description. |
snippet.publishedAt |
datetime
Date et heure de création de la playlist. La valeur est spécifiée au format ISO 8601. |
snippet.channelId |
string
ID utilisé par YouTube pour identifier de façon unique la chaîne sur laquelle la playlist a été mise en ligne. |
snippet.title |
string
Titre de la playlist. |
snippet.description |
string
Description de la playlist. |
snippet.thumbnails |
object
Carte des miniatures associées à la playlist. Pour chaque objet de la carte, la clé correspond au nom de la vignette, et la valeur à un objet contenant d'autres informations sur la vignette. |
snippet.thumbnails.(key) |
object
Les valeurs des clés valides sont les suivantes:
|
snippet.thumbnails.(key).url |
string
URL de l'image. |
snippet.thumbnails.(key).width |
unsigned integer
Largeur de l'image. |
snippet.thumbnails.(key).height |
unsigned integer
Hauteur de l'image. |
snippet.channelTitle |
string
Titre de la chaîne à laquelle appartient la vidéo. |
snippet.tags[] |
list
Cette propriété est obsolète.Tags de mot clé associés à la playlist. |
snippet.defaultLanguage |
string
Langue du texte dans les propriétés snippet.title et snippet.description de la ressource playlist . |
snippet.localized |
object
L'objet snippet.localized contient soit un titre localisé et une description pour la playlist, soit le titre dans la langue par défaut des métadonnées de la playlist.
localizations pour ajouter, mettre à jour ou supprimer des titres localisés. |
snippet.localized.title |
string
Titre de la playlist localisée. |
snippet.localized.description |
string
Description de la playlist localisée. |
status |
object
L'objet status contient des informations sur l'état de la playlist. |
status.privacyStatus |
string
État de confidentialité de la playlist.Les valeurs acceptées pour cette propriété sont: <ph type="x-smartling-placeholder">
|
status.podcastStatus |
string
État du podcast de la playlist Si la valeur est enabled , la playlist est marquée comme émission de podcasts. Pour définir l'état du podcast d'une playlist sur enabled , celle-ci doit comporter une image de playlist.Les valeurs valides pour cette propriété sont les suivantes: <ph type="x-smartling-placeholder">
|
contentDetails |
object
L'objet contentDetails contient des informations sur le contenu de la playlist, y compris le nombre de vidéos qu'elle contient. |
contentDetails.itemCount |
unsigned integer
Nombre de vidéos dans la playlist. |
player |
object
L'objet player contient les informations que vous pouvez utiliser pour lire la playlist dans un lecteur intégré. |
player.embedHtml |
string
Balise <iframe> intégrant un lecteur qui lit la playlist. |
localizations |
object
L'objet localizations encapsule les traductions des métadonnées de la playlist. |
localizations.(key) |
object
Langue du texte localisé associé à la valeur de clé. La valeur est une chaîne contenant un code de langue BCP-47. |
localizations.(key).title |
string
Titre de la playlist localisée. |
localizations.(key).description |
string
Description de la playlist localisée. |