Une ressource playlistItem
identifie une autre ressource, telle qu'une vidéo, incluse dans une playlist. De plus, la ressource playlistItem
contient des informations sur la ressource incluse qui concernent spécifiquement la façon dont cette ressource est utilisée dans cette playlist.
YouTube utilise également une playlist pour identifier la liste des vidéos mises en ligne d'une chaîne. Chaque playlistItem
de cette liste représente une vidéo mise en ligne. Vous pouvez récupérer l'ID de la playlist pour cette liste à partir de la ressource channel
pour une chaîne donnée. Vous pouvez ensuite utiliser la méthode playlistItems.list
sur la liste.
Méthodes
L'API prend en charge les méthodes suivantes pour les ressources playlistItems
:
- liste
- Renvoie une collection d'éléments de playlist correspondant aux paramètres de requête de l'API. Vous pouvez récupérer tous les éléments d'une playlist spécifiée ou un ou plusieurs éléments par leur ID unique. Essayer
- insérer
- Ajoute une ressource à une playlist. Essayer
- update
- Modifie un élément de playlist. Par exemple, vous pouvez modifier la position de l'élément dans la playlist. Essayer
- supprimer
- Supprime un élément de playlist. Essayer
Représentation de la ressource
La structure JSON suivante montre le format d'une ressource playlistItems
:
{ "kind": "youtube#playlistItem", "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, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": 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 la ressource API. La valeur sera youtube#playlistItem . |
etag |
etag Etag de cette ressource. |
id |
string ID que YouTube utilise pour identifier de manière unique l'élément de la playlist. |
snippet |
object L'objet snippet contient des informations de base sur l'élément de la playlist, telles que son titre et sa position dans la playlist. |
snippet.publishedAt |
datetime Date et heure d'ajout de l'élément à la playlist. La valeur est spécifiée au format ISO 8601. |
snippet.channelId |
string ID que YouTube utilise pour identifier de manière unique l'utilisateur qui a ajouté l'élément à la playlist. |
snippet.title |
string Titre de l'article. |
snippet.description |
string Description de l'article. |
snippet.thumbnails |
object Carte des images miniatures associées à l'élément de la playlist. Pour chaque objet de la carte, la clé correspond au nom de l'image miniature, et la valeur à un objet contenant d'autres informations sur la miniature. |
snippet.thumbnails.(key) |
object Les valeurs de clé 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 l'élément de playlist. |
snippet.videoOwnerChannelTitle |
string Titre de la chaîne ayant mis en ligne cette vidéo. |
snippet.videoOwnerChannelId |
string ID de la chaîne qui a mis en ligne cette vidéo. |
snippet.playlistId |
string ID utilisé par YouTube pour identifier de manière unique la playlist dans laquelle se trouve l'élément de playlist. |
snippet.position |
unsigned integer Ordre dans lequel l'élément apparaît dans la playlist. La valeur utilise un indice à base 0. Par conséquent, le premier élément a une position de 0 , le deuxième élément une position de 1 , et ainsi de suite. |
snippet.resourceId |
object L'objet id contient des informations permettant d'identifier de manière unique la ressource incluse dans la playlist en tant qu'élément de playlist. |
snippet.resourceId.kind |
string Genre ou type de la ressource référencée. |
snippet.resourceId.videoId |
string Si la valeur de la propriété snippet.resourceId.kind est youtube#video , cette propriété sera présente et sa valeur contiendra l'ID que YouTube utilise pour identifier de manière unique la vidéo dans la playlist. |
contentDetails |
object L'objet contentDetails est inclus dans la ressource si l'élément inclus est une vidéo YouTube. L'objet contient des informations supplémentaires sur la vidéo. |
contentDetails.videoId |
string ID utilisé par YouTube pour identifier de manière unique une vidéo. Pour récupérer la ressource video , définissez le paramètre de requête id sur cette valeur dans votre requête API. |
contentDetails.startAt |
string Remarque:Cette propriété est obsolète. Si elle est définie, sa valeur est ignorée. Heure, mesurée en secondes à partir du début de la vidéo, à laquelle la vidéo doit commencer à être lue. (Le propriétaire de la playlist peut spécifier les heures auxquelles la vidéo doit commencer et s'arrêter lorsqu'elle est lue dans le contexte de la playlist.) La valeur par défaut est 0 . |
contentDetails.endAt |
string Remarque:Cette propriété est obsolète. Si elle est définie, sa valeur est ignorée. Heure, mesurée en secondes à partir du début de la vidéo, à laquelle la vidéo doit s'arrêter. (Le propriétaire de la playlist peut spécifier les heures auxquelles la vidéo doit commencer et s'arrêter lorsqu'elle est lue dans le contexte de la playlist.) Par défaut, considérez que video.endTime correspond à la fin de la vidéo. |
contentDetails.note |
string Remarque générée par l'utilisateur pour cet élément. La valeur de la propriété ne doit pas dépasser 280 caractères. |
contentDetails.videoPublishedAt |
datetime Date et heure de publication de la vidéo sur YouTube. La valeur est spécifiée au format ISO 8601. |
status |
object L'objet status contient des informations sur l'état de confidentialité de l'élément de la playlist. |
status.privacyStatus |
string État de confidentialité de l'élément de la playlist. La chaîne qui a mis en ligne la vidéo représentée par l'élément de playlist peut définir cette valeur à l'aide de la méthode videos.insert ou videos.update . |