Intégration: Playlists

Les exemples suivants montrent comment utiliser l'API YouTube Data (v3) pour exécuter des fonctions liées aux playlists et aux éléments de playlist.

Récupérer les playlists de l'utilisateur actuel

Appelez la méthode playlists.list pour récupérer les playlists de l'utilisateur actuellement authentifié. Dans votre requête, définissez la valeur du paramètre mine sur true. Notez qu'une requête utilisant le paramètre mine doit être autorisée à l'aide d'OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Récupérer les playlists d'un utilisateur

Cet exemple permet de récupérer les playlists créées par une chaîne spécifique. Cet exemple comporte deux étapes:

Récupérer des informations sur une playlist spécifique

Pour obtenir des informations sur une ou plusieurs playlists spécifiques, appelez la méthode playlists.list et définissez le paramètre id sur une liste d'ID de playlists YouTube séparés par des virgules, qui identifient les ressources souhaitées. Cette fonctionnalité est souvent utilisée pour demander des informations supplémentaires sur un groupe de playlists renvoyées dans un ensemble de résultats de recherche. Par exemple, vous pouvez récupérer le nombre d'éléments dans chaque playlist.

La requête ci-dessous appelle la méthode playlists.list pour récupérer le nombre d'éléments dans deux playlists correspondant au terme de requête "GoogleDevelopers". Étant donné que ces informations se trouvent dans la propriété contentDetails.itemCount de la ressource playlist, la requête définit la valeur du paramètre part sur contentDetails. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Ajouter une playlist

Cet exemple appelle la méthode playlists.insert pour créer une playlist privée sur la chaîne de l'utilisateur authentifié. Toute requête API adressée à cette méthode doit être autorisée à l'aide d'OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

Le lien vers l'explorateur des API définit également un paramètre qui spécifie le corps de la requête API. Le corps de la requête contient une ressource playlist qui définit des informations telles que le titre, la description et le niveau de confidentialité de la playlist. Dans cet exemple, le corps de la requête est:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

Exemples de code associés: Java, JavaScript, .NET, PHP, Python

Modifier une playlist

Dans cet exemple, l'état de confidentialité d'une playlist passe de private à public. Cet exemple comporte deux étapes:

  • Étape 1: Récupérez l'ID de la playlist

    Appelez la méthode playlist.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus permettant de récupérer les playlists de l'utilisateur actuel le montre. L'application appelant l'API peut traiter la réponse de l'API pour afficher une liste de playlists, en utilisant l'ID de chaque playlist comme clé.

  • Étape 2: Modifiez une playlist

    Appelez la méthode playlists.update pour modifier une playlist spécifique. Cette méthode nécessite un jeton d'autorisation OAuth 2.0 valide.

    Le corps de la requête doit inclure la partie snippet de la ressource playlist, car la propriété snippet.title est requise lors de l'appel de cette méthode. En outre, si la ressource de playlist en cours de mise à jour spécifie des valeurs pour les propriétés snippet.description ou snippet.tags, ces valeurs doivent être spécifiées à nouveau dans la requête de mise à jour. Sinon, elles seront supprimées.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    Comme dans l'exemple ci-dessus pour ajouter une playlist, le lien vers APIs Explorer définit un paramètre qui spécifie le corps de la requête API. Le corps de la requête contient une ressource playlist qui définit des informations telles que le titre, la description et le niveau de confidentialité de la playlist. Le corps de requête suivant est utilisé dans cet exemple:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    Remarque : Si vous testez cette requête dans APIs Explorer, vous devez remplacer un ID de playlist valide dans le corps de la ressource. Pour obtenir un ID de playlist, nous vous recommandons d'exécuter d'abord la demande ci-dessus pour ajouter une playlist. Extrayez l'ID de la playlist de la réponse de l'API et utilisez cette valeur pour la playlist que vous souhaitez modifier. Le titre et la description de playlist utilisés dans cet exemple sont identiques à ceux utilisés dans cet exemple.

Ajouter un élément de playlist

Cet exemple ajoute un élément à une playlist. Cette requête doit être autorisée à l'aide d'OAuth 2.0. Cet exemple comporte deux étapes:

  • Étape 1: Récupérez l'ID de la playlist appropriée

    Appelez la méthode playlist.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus permettant de récupérer les playlists de l'utilisateur actuel le montre. L'application appelant l'API peut traiter la réponse de l'API pour afficher une liste de playlists, en utilisant l'ID de chaque playlist comme clé.

  • Étape 2: Ajoutez une vidéo à la playlist

    Appelez la méthode playlistItems.insert pour ajouter une vidéo à la playlist. Cette requête doit être autorisée à l'aide d'OAuth 2.0. Le corps de la requête est une ressource playlistItem qui spécifie au moins les valeurs suivantes:

    • snippet.playlistId identifie la playlist à laquelle vous ajoutez la vidéo. Il s'agit de l'ID de playlist obtenu à l'étape 1.
    • snippet.resourceId.kind contient la valeur youtube#video.
    • L'snippet.resourceId.videoId identifie la vidéo que vous ajoutez à la playlist. La valeur de la propriété correspond à un ID vidéo YouTube unique.

    La requête API ci-dessous ajoute une vidéo à une playlist. Le corps de la requête est le suivant :

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Pour terminer la requête dans APIs Explorer, vous devez définir des valeurs pour les propriétés snippet.playlistId et snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    Remarque:La documentation de la méthode playlistItems.insert identifie les autres valeurs de propriété que vous pouvez définir lorsque vous ajoutez un élément de playlist.

Modifier un élément de playlist

Dans cet exemple, un élément de playlist est modifié pour devenir le premier élément d'une playlist. Cette requête doit être autorisée à l'aide d'OAuth 2.0. Cet exemple comporte trois étapes:

  • Étape 1: Récupérez l'ID de la playlist appropriée

    Appelez la méthode playlist.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus permettant de récupérer les playlists de l'utilisateur actuel le montre. L'application appelant l'API peut traiter la réponse de l'API pour afficher une liste de playlists, en utilisant l'ID de chaque playlist comme clé.

  • Étape 2: Récupérez les éléments de la playlist sélectionnée

    Appelez la méthode playlistItems.list pour récupérer la liste des vidéos de la playlist sélectionnée. Définissez la valeur du paramètre playlistId sur l'ID de la playlist obtenue à l'étape 1.

    Chaque ressource dans la réponse de l'API contient une propriété id, qui identifie l'ID de l'élément de la playlist qui identifie cet élément de manière unique. Vous utiliserez cette valeur pour supprimer un article de la liste à l'étape suivante.

  • Étape 3: Modifiez l'élément de playlist sélectionné

    Appelez la méthode playlistItems.update pour modifier la position de la vidéo dans la playlist. Définissez la valeur du paramètre part sur snippet. Le corps de la requête doit être une ressource playlistItem qui définit au moins les valeurs suivantes:

    • Définissez la propriété id sur l'ID d'élément de playlist obtenu à l'étape 2.
    • Définissez la propriété snippet.playlistId sur l'ID de playlist obtenu à l'étape 1.
    • Définissez la propriété snippet.resourceId.kind sur youtube#video.
    • Définissez la propriété snippet.resourceId.videoId sur l'ID vidéo qui identifie de manière unique la vidéo incluse dans la playlist.
    • Définissez la propriété snippet.position sur 0 ou à la position souhaitée pour l'élément (en utilisant un index basé sur 0).

    La requête API ci-dessous met à jour un élément de la playlist en tant que premier élément d'une playlist. Le corps de la requête est le suivant :

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Pour terminer la requête dans APIs Explorer, vous devez définir des valeurs pour les propriétés id, snippet.playlistId et snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Supprimer un élément de la playlist

Cet exemple supprime une vidéo d'une playlist. Cette requête doit être autorisée à l'aide d'OAuth 2.0. Cet exemple comporte trois étapes. Les deux premières étapes sont les mêmes que celles de l'exemple ci-dessus permettant de mettre à jour un élément de playlist.

Une fois ces étapes terminées, appelez la méthode playlistItems.delete pour supprimer une vidéo de la playlist. Définissez le paramètre id de la demande sur l'ID de l'élément de playlist à supprimer. Cette requête doit être autorisée à l'aide d'OAuth 2.0.

Sachez que l'ID de l'élément de playlist utilisé pour identifier une vidéo dans une playlist est différent de l'ID vidéo YouTube qui identifie la vidéo de manière unique. L'ID de l'élément de playlist identifie la vidéo comme un élément d'une playlist spécifique.

Pour terminer la requête dans APIs Explorer, vous devez définir la valeur de la propriété id.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Supprimer une playlist

Cet exemple supprime une playlist. Cet exemple comporte deux étapes:

  • Étape 1: Récupérez l'ID de la playlist

    Appelez la méthode playlist.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus permettant de récupérer les playlists de l'utilisateur actuel le montre. L'application appelant l'API peut traiter la réponse de l'API pour afficher une liste de playlists, en utilisant l'ID de chaque playlist comme clé.

  • Étape 2: Supprimer une playlist

    Appelez la méthode playlists.delete pour supprimer une playlist spécifique. Dans la requête, le paramètre id spécifie l'ID de la playlist en cours de suppression. Cette méthode nécessite un jeton d'autorisation OAuth 2.0 valide. Si vous testez cette requête dans APIs Explorer, vous devez remplacer la valeur du paramètre id par un ID de playlist valide.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    Remarque : Si vous testez cette requête dans APIs Explorer, vous devez remplacer la valeur du paramètre id par un ID de playlist valide. Pour obtenir un ID de playlist, nous vous recommandons d'exécuter d'abord la demande ci-dessus pour ajouter une playlist. Extrayez l'ID de playlist de la réponse de l'API et utilisez cette valeur pour la playlist à supprimer.