Intégration: playlists

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

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

Dans cet exemple, les playlists créées par une chaîne spécifique sont récupérées. 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, 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 une virgule 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 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 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 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"
  }
}

Dans l'exemple suivant, la nouvelle playlist est marquée comme 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

Dans cet exemple, l'état de confidentialité d'une playlist 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 sur 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 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 chacune d'elles comme clé.

  • Étape 2: Mettez à jour 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 obligatoire 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 respécifiées dans la requête de mise à jour, sans quoi 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 l'ajout d'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 l'état 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"
  }
}

    L'exemple suivant permet de marquer une playlist comme podcast:

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

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

Ajouter un élément à une playlist

Dans cet exemple, un article est ajouté à une playlist. Cette requête doit être autorisée à l'aide du protocole 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 sur la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus, qui permet de 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 chacune d'elles 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 du protocole OAuth 2.0. Le corps de la requête est une ressource playlistItem qui spécifie au moins les valeurs suivantes:

    La requête API ci-dessous permet d'ajouter 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 lors de l'ajout d'un élément à une playlist.

Ajouter une image de playlist

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

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

Modifier un élément de playlist

Dans cet exemple, un élément d'une playlist est modifié de sorte qu'il soit le premier élément d'une playlist. Cette requête doit être autorisée à l'aide du protocole 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 sur 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 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 chacune d'elles 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 playlist obtenu à l'étape 1.

    Chaque ressource de la réponse de l'API contient une propriété id, qui identifie l'élément de la playlist de manière unique. Vous l'utiliserez pour supprimer un élément 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 de l'é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 sur la position à laquelle vous souhaitez que l'élément apparaisse (à l'aide d'un index basé sur 0).

    La requête API ci-dessous met à jour un élément d'une playlist afin qu'il soit le 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

Modifier l'image d'une playlist

Vous pouvez utiliser la méthode playlistImages.update de l'API v3 pour modifier l'image miniature d'une playlist. Dans votre demande, la valeur du paramètre playlistId identifie la playlist pour laquelle la miniature sera utilisée.

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

Supprimer un élément de la playlist

Dans cet exemple, une vidéo est supprimée d'une playlist. Cette requête doit être autorisée à l'aide du protocole OAuth 2.0. Cet exemple comporte trois étapes. Les deux premières étapes sont les mêmes que dans l'exemple ci-dessus, qui permet de modifier un élément d'une playlist.

Une fois ces étapes effectué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 du protocole OAuth 2.0.

Notez que l'ID d'é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 la playlist identifie la vidéo en tant qu'é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 image de playlist

Dans cet exemple, une image de playlist est supprimée. L'exemple comporte deux étapes:

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

    Appelez la méthode playlists.list pour récupérer les playlists sur 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 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 chacune d'elles 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 à modifier.

  • Étape 3: Supprimez l'image d'une 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 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.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

Dans cet exemple, une playlist est supprimée. 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 sur la chaîne de l'utilisateur actuellement authentifié. L'exemple de requête ci-dessus, qui permet de 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 chacune d'elles comme clé.

  • Étape 2: Supprimez 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 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 l'ID d'une playlist, nous vous recommandons d'exécuter d'abord la demande ci-dessus permettant d'ajouter une playlist. Extrayez l'ID de la playlist de la réponse de l'API, puis utilisez cette valeur pour la playlist que vous souhaitez supprimer.