Intégration: playlists

Les exemples suivants montrent comment utiliser l'API YouTube Data (v3) pour effectuer 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 qui utilise 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 récupère les playlists créées par une chaîne spécifique. L'exemple comporte deux étapes:

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

Pour récupérer 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 playlist YouTube séparés par une virgule qui identifient les ressources souhaitées. Un cas d'utilisation courant de cette fonctionnalité est une requête visant à récupérer 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 de chaque playlist.

La requête ci-dessous appelle la méthode playlists.list pour récupérer le nombre d'éléments de deux playlists correspondant au terme de requête "GoogleDevelopers". Ces informations se trouvent dans la propriété contentDetails.itemCount de la ressource playlist. La requête définit donc 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 dans la chaîne de l'utilisateur authentifié. Toute requête API envoyé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 APIs Explorer 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 l'état de confidentialité de la playlist. Dans cet exemple, le corps de la requête est le suivant:

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

L'exemple suivant marque la nouvelle playlist comme une émission de podcast:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

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

Modifier une playlist

Cet exemple met à jour l'état de confidentialité d'une playlist, qui passe de private à public. L'exemple comporte deux étapes:

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

    Appelez la méthode playlists.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus pour récupérer les playlists de l'utilisateur actuel illustre cette requête. L'application qui appelle 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: Modifier 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 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 API 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 l'état de confidentialité de la playlist. Le corps de la requête suivant est utilisé dans cet exemple:

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

    L'exemple suivant marque la playlist comme une émission de podcast:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    Remarque:Si vous testez cette requête dans l'explorateur d'API, vous devrez remplacer l'ID de playlist valide dans le corps de la ressource. Pour obtenir un ID de playlist, nous vous recommandons d'abord d'exécuter la requête 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 mettre à jour. Le titre et la description de la playlist utilisés dans cet exemple sont les mêmes que ceux utilisés dans cet exemple.

Ajouter un élément à une 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 playlist approprié

    Appelez la méthode playlists.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus pour récupérer les playlists de l'utilisateur actuel illustre cette requête. L'application qui appelle 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: Ajouter 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 la playlist que vous avez obtenu à l'étape 1.
    • Le snippet.resourceId.kind contient la valeur youtube#video.
    • snippet.resourceId.videoId identifie la vidéo que vous ajoutez à la playlist. La valeur de la propriété est 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 effectuer 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.

Ajouter une image de playlist

Vous pouvez utiliser la méthode playlistImages.insert de l'API v3 pour importer une image de vignette personnalisée et la définir pour une playlist. Dans votre requête, la valeur du paramètre playlistId identifie la playlist pour laquelle la vignette sera utilisée.

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car cet outil ne permet pas d'importer des fichiers multimédias, ce qui est obligatoire pour cette méthode.

Modifier un élément de playlist

Cet exemple met à jour un élément de playlist afin qu'il soit le premier de la 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 playlist approprié

    Appelez la méthode playlists.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus pour récupérer les playlists de l'utilisateur actuel illustre cette requête. L'application qui appelle 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 que vous avez obtenu à l'étape 1.

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

  • Étape 3: Mettre à jour 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 de l'élément de la playlist obtenu à l'étape 2.
    • Définissez la propriété snippet.playlistId sur l'ID de la 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 sur la position à laquelle vous souhaitez que l'élément s'affiche (à l'aide d'un indice de base 0).

    La requête API ci-dessous met à jour un élément de playlist pour qu'il soit le premier de la 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 effectuer 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

Modifier l'image d'une playlist

Vous pouvez utiliser la méthode playlistImages.update de l'API v3 pour mettre à jour l'image miniature d'une playlist. Dans votre requête, la valeur du paramètre playlistId identifie la playlist pour laquelle la vignette sera utilisée.

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car cet outil ne permet pas d'importer des fichiers multimédias, ce qui est obligatoire pour cette méthode.

Supprimer un élément de 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 pour 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 requête sur l'ID de l'élément de la playlist que vous souhaitez supprimer. Cette requête doit être autorisée à l'aide d'OAuth 2.0.

Notez 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 permet de l'identifier de manière unique. L'ID de l'élément de playlist identifie la vidéo en tant qu'élément d'une playlist spécifique.

Pour terminer la requête dans l'explorateur d'API, 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 image de playlist

Cet exemple supprime une image de playlist. L'exemple comporte deux étapes:

  • Étape 1: Récupérer la playlist

    Appelez la méthode playlists.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus pour récupérer les playlists de l'utilisateur actuel illustre cette requête. L'application qui appelle 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 l'ID de l'image de la playlist

    Appelez la méthode playlistImages.list pour récupérer l'image miniature d'une playlist. Utilisez l'ID de la playlist que vous souhaitez modifier.

  • Étape 3: Supprimer une image de playlist

    Appelez la méthode playlistImages.delete pour supprimer une image de playlist spécifique. Dans la requête, le paramètre id spécifie l'ID de l'image de la playlist supprimée. Cette méthode nécessite un jeton d'autorisation OAuth 2.0 valide. Si vous testez cette requête dans l'explorateur d'API, 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.playlistImages.delete?
        id=ID

    Remarque:Si vous testez cette requête dans APIs Explorer, vous devez remplacer la valeur du paramètre id par un ID d'image de playlist valide.

Supprimer une playlist

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

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

    Appelez la méthode playlists.list pour récupérer les playlists de la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus pour récupérer les playlists de l'utilisateur actuel illustre cette requête. L'application qui appelle 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 à supprimer. Cette méthode nécessite un jeton d'autorisation OAuth 2.0 valide. Si vous testez cette requête dans l'explorateur d'API, 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'abord d'exécuter la requête 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 supprimer.