PlaylistItems

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 l'utilisation de cette ressource dans cette playlist.

YouTube utilise également une playlist pour identifier la liste des vidéos mises en ligne sur une chaîne, chaque playlistItem représentant une vidéo mise en ligne. Vous pouvez récupérer l'ID de la playlist de cette liste à partir de channel resource pour une chaîne donnée. Vous pouvez ensuite utiliser la méthode playlistItems.list pour ajouter à la liste.

Méthodes

L'API accepte les méthodes suivantes pour les ressources playlistItems:

list
Renvoie une collection d'éléments de la playlist qui correspondent aux paramètres de la requête API. Vous pouvez récupérer tous les éléments d'une playlist donnée ou en extraire un ou plusieurs par ID. Essayer
insérer
Ajoute une ressource à une playlist. Essayer
mettre à jour
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 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 de l'API. La valeur sera youtube#playlistItem.
etag etag
ETag de cette ressource.
id string
ID que YouTube utilise pour identifier l'élément de la playlist de façon unique.
snippet object
L'objet snippet contient des informations de base sur l'élément de la playlist, comme son titre et sa position dans la playlist.
snippet.publishedAt datetime
Date et heure auxquelles l'élément a été ajouté à la playlist. La valeur est spécifiée au format ISO 8601.
snippet.channelId string
ID que YouTube utilise de manière unique pour identifier l'utilisateur qui a ajouté l'élément à la playlist.
snippet.title string
Titre de l'article.
snippet.description string
Description de l'élément.
snippet.thumbnails object
Vignette associée à 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:
  • default : vignette par défaut. La miniature par défaut d'une vidéo, ou une ressource faisant référence à une vidéo, telle qu'un élément de playlist ou un résultat de recherche, fait 120 x 90 pixels de haut. La miniature par défaut d'une chaîne fait 88 x 88 pixels.
  • medium : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 320 x 180 pixels. Pour une chaîne, cette image fait 240 px de large et 240 px de haut.
  • high : version haute résolution de la vignette. Pour une vidéo (ou une ressource faisant référence à une vidéo), cette image mesure 480 x 360 pixels. Pour une chaîne, cette image fait 800 x 800 pixels.
  • standard : version de résolution d'image miniature encore plus élevée que l'image de résolution high. Cette image est disponible pour certaines vidéos et autres ressources faisant référence à des vidéos, comme les playlists ou les résultats de recherche. Elle mesure 640 pixels de large et 480 pixels de haut.
  • maxres : version la plus haute résolution de la vignette. Cette taille d'image est disponible pour certaines vidéos et autres ressources faisant référence à des vidéos, telles que des éléments de playlist ou des résultats de recherche. Elle mesure 1 280 pixels de large sur 720 pixels de haut.
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 sur laquelle cette vidéo a été mise en ligne.
snippet.videoOwnerChannelId string
ID de la chaîne qui a mis en ligne cette vidéo.
snippet.playlistId string
ID que YouTube utilise pour identifier de façon unique la playlist contenant l'élément.
snippet.position unsigned integer
Ordre dans lequel l'élément apparaît dans la playlist. La valeur utilise un index de base zéro. Ainsi, le premier élément a une position de 0, le deuxième élément a 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 parrainée.
snippet.resourceId.videoId string
Si la propriété de la propriété snippet.resourceId.kind est définie sur youtube#video, cette propriété sera présente et sa valeur contiendra l'ID utilisé par YouTube pour identifier 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 que YouTube utilise pour identifier une vidéo de façon unique. 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, exprimée en secondes à partir du début de la vidéo, lorsque la lecture de la vidéo doit commencer. (Le propriétaire de la playlist peut indiquer les moments où la vidéo doit démarrer et s'arrêter pendant la lecture 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, exprimée en secondes à partir du début de la vidéo, lorsque la lecture de la vidéo doit s'arrêter. (Le propriétaire de la playlist peut indiquer les moments où la vidéo doit démarrer et s'arrêter pendant la lecture dans le cadre de la playlist.) Par défaut, supposons que video.endTime soit 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 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 le niveau de confidentialité de l'élément de la playlist.
status.privacyStatus string
État de confidentialité de l'élément de 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.