Une ressource playlistItem
identifie une autre ressource, telle qu'une vidéo, qui est incluse dans une playlist. En outre, la ressource playlistItem
contient des informations sur la ressource incluse qui concernent spécifiquement son utilisation dans la 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 cette liste dans le fichier channel resource
d'une chaîne donnée. Vous pouvez ensuite utiliser la méthode playlistItems.list
pour la liste.
Méthodes
L'API est compatible avec 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écifique, ou un ou plusieurs éléments d'une playlist en fonction de leur ID unique. Essayer
- insérer
- Ajoute une ressource à une playlist. Essayer
- mise à jour
- Modifie un élément de la playlist. Vous pouvez, par exemple, modifier la position de l'élément dans la playlist. Essayer
- supprimer
- Supprime un élément de la playlist. Essayer
Représentation des ressources
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 ressource d'API. La valeur est youtube#playlistItem . |
etag |
etag Etag de cette ressource. |
id |
string ID utilisé par YouTube pour identifier de façon unique l'élément de la playlist. |
snippet |
object L'objet snippet contient des informations de base sur l'élément de la playlist, tels que son titre et sa position dans la playlist. |
snippet.publishedAt |
datetime Date et heure de l'ajout de l'élément à 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 l'utilisateur qui a ajouté l'élément à la playlist. |
snippet.title |
string Titre de l'élément. |
snippet.description |
string Description de l'élément. |
snippet.thumbnails |
object Carte des miniatures associées à l'élément de la playlist. Pour chaque objet de la carte, la clé est le nom de la vignette et la valeur est un objet contenant d'autres informations sur la vignette. |
snippet.thumbnails.(key) |
object Les clés-valeurs 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 la playlist. |
snippet.videoOwnerChannelTitle |
string Titre de la chaîne sur laquelle la vidéo a été mise en ligne. |
snippet.videoOwnerChannelId |
string L'ID de la chaîne qui a mis en ligne cette vidéo. |
snippet.playlistId |
string ID utilisé par YouTube pour identifier de façon unique la playlist à laquelle appartient l'élément de la playlist. |
snippet.position |
unsigned integer Ordre d'affichage de l'élément dans la playlist. La valeur utilise un index basé sur zéro. Ainsi, le premier élément a la position 0 , le deuxième élément a la position 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 utilisé par YouTube pour identifier la vidéo de la playlist de façon unique. |
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 façon 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 et, si elle est définie, sa valeur est ignorée. Durée mesurée en secondes à partir du début de la vidéo jusqu'au moment où la lecture doit commencer. (Le propriétaire de la playlist peut spécifier les moments auxquels la lecture de la vidéo doit être lancée et arrêtée dans le cadre de la playlist.) La valeur par défaut est 0 . |
contentDetails.endAt |
string Remarque:Cette propriété est obsolète et, si elle est définie, sa valeur est ignorée. Durée, mesurée en secondes à partir du début de la vidéo, pendant laquelle la lecture de la vidéo doit s'arrêter. (Le propriétaire de la playlist peut spécifier les moments auxquels la lecture de la vidéo doit être lancée et arrêtée dans le cadre de la playlist.) Par défaut, partez du principe que video.endTime correspond à la fin de la vidéo. |
contentDetails.note |
string Note générée par l'utilisateur pour cet élément. La valeur de la propriété ne doit pas comporter plus de 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 la playlist peut définir cette valeur à l'aide de la méthode videos.insert ou videos.update . |