Playlists

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 collections spéciales de vidéos pour une chaîne, par exemple :

  • vidéos mises en ligne
  • les vidéos ayant reçu un avis positif (mention "J'aime") ;
 Plus précisément, ces listes sont associées à une chaîne, qui est une collection de vidéos, de playlists et d'autres informations YouTube d'une personne, d'un groupe ou d'une entreprise. Vous pouvez récupérer les ID de playlist pour chacune de ces listes à partir de channel resource pour une chaîne donnée.

 Vous pouvez ensuite utiliser la méthode playlistItems.list pour récupérer l'une 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 correspondant aux paramètres de la requête API. Par exemple, vous pouvez récupérer toutes les playlists appartenant à l'utilisateur authentifié ou une ou plusieurs playlists à l'aide de leurs ID uniques. Essayer
insérer
Crée une playlist. Essayer
update
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 de la ressource

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 de l'API. La valeur sera youtube#playlist.
etag etag
Etag de cette ressource.
id string
ID utilisé par YouTube pour identifier de manière unique la playlist.
snippet object
L'objet snippet contient des informations de base sur la playlist, comme 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 manière unique la chaîne qui a publié la playlist.
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 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 la vidéo.
snippet.tags[] list
Cette propriété est obsolète.

Tags de mots clés 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 un titre et une description localisés pour la playlist, ou le titre dans la langue par défaut pour les métadonnées de la playlist.
  • Le texte localisé est renvoyé dans l'extrait de ressource si la requête playlists.list a utilisé le paramètre hl pour spécifier une langue pour laquelle du texte localisé doit être renvoyé et si du texte localisé est disponible dans cette langue.
  • Les métadonnées de la langue par défaut sont renvoyées si aucune valeur de paramètre hl n'est spécifiée ou si une valeur est spécifiée, mais que les métadonnées localisées ne sont pas disponibles pour la langue spécifiée.
 La propriété contient une valeur en lecture seule. Utilisez l'objet localizations pour ajouter, modifier ou supprimer des titres localisés.
snippet.localized.title string
Titre localisé de la playlist.
snippet.localized.description string
Description localisée de la playlist.
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 valides pour cette propriété sont les suivantes :
  • private
  • public
  • unlisted
status.podcastStatus string
État de la playlist en tant que podcast. Si la valeur est enabled, la playlist est marquée comme émission de podcast. Pour définir l'état d'une playlist sur enabled, elle doit comporter une image.

Les valeurs valides pour cette propriété sont les suivantes :
  • enabled
  • disabled
  • unspecified
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 utiliserez pour lire la playlist dans un lecteur intégré.
player.embedHtml string
Balise <iframe> qui intègre un lecteur pour lire 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 clé. La valeur est une chaîne contenant un code de langue BCP-47.
localizations.(key).title string
Titre localisé de la playlist.
localizations.(key).description string
Description localisée de la playlist.