PlaylistItems

Une ressource playlistItem identifie une autre ressource, comme une vidéo, qui est incluse dans une playlist. De plus, la ressource playlistItem contient des informations sur la ressource incluse qui concernent spécifiquement la façon dont elle est utilisée dans la playlist.

YouTube utilise également une playlist pour identifier la liste des vidéos mises en ligne sur 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 accepte les méthodes suivantes pour les ressources playlistItems :

liste
Renvoie une collection d'éléments de playlist correspondant aux paramètres de la requête API. Vous pouvez récupérer tous les éléments d'une playlist spécifiée ou un ou plusieurs éléments de playlist à l'aide de leurs ID uniques. 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 ressource de l'API. La valeur sera youtube#playlistItem.
etag etag
Etag de cette ressource.
id string
ID utilisé par YouTube pour identifier de manière unique l'élément de playlist.
snippet object
L'objet snippet contient des informations de base sur l'élément de playlist, comme 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 utilisé par YouTube pour identifier de manière 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'article.
snippet.thumbnails object
Carte des miniatures associées à l'élément de 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) object
Les valeurs de clé valides sont les suivantes :
  • default : image miniature par défaut. La vignette par défaut d'une vidéo (ou d'une ressource qui fait référence à une vidéo, comme un élément de playlist ou un résultat de recherche) mesure 120 pixels de large et 90 pixels de haut. La miniature par défaut d'une chaîne mesure 88 x 88 pixels.
  • medium : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 320 px de large et 180 px de haut. Pour une chaîne, cette image doit mesurer 240 x 240 pixels.
  • high : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 480 px de large et 360 px de haut. Pour une chaîne, cette image doit avoir une largeur et une hauteur de 800 px.
  • standard : version de la miniature avec une résolution encore plus élevée que celle de l'image high. Cette image est disponible pour certaines vidéos et d'autres ressources qui font référence à des vidéos, comme les éléments de playlist ou les résultats de recherche. Cette image mesure 640 pixels de large et 480 pixels de haut.
  • maxres : version de la miniature avec la résolution la plus élevée. Cette taille d'image est disponible pour certaines vidéos et d'autres ressources qui font référence à des vidéos, comme les éléments de playlist ou les résultats de recherche. Cette image mesure 1 280 px de large et 720 px 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 qui a mis en ligne cette vidéo.
snippet.videoOwnerChannelId string
ID de la chaîne sur laquelle cette vidéo a été mise en ligne.
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 index à base zéro. Le premier élément a donc une position de 0, le deuxième 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
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é a été abandonnée. Si elle est définie, sa valeur est ignorée.

Heure (en secondes) à laquelle la lecture de la vidéo doit commencer. (Le propriétaire de la playlist peut spécifier les moments où la lecture de 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 depuis le début de la vidéo, à laquelle la lecture de la vidéo doit s'arrêter. (Le propriétaire de la playlist peut spécifier les moments où la lecture de la vidéo doit commencer et s'arrêter lorsqu'elle est lue dans le contexte de la playlist.) Par défaut, supposez 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 peut 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 la confidentialité de l'élément de 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.