assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Gestion des listes de lecture à l'aide de l'API CMS

    Cette rubrique décrit comment créer, mettre à jour ou supprimer des listes de lecture à l'aide de l'API CMS.

    Introduction

    Exemple de playlist

    Les playlists vous permettent de regrouper un ensemble de vidéos associées afin qu'elles puissent être chargées dans un lecteur et regardées en groupe. Le CMS API contient un ensemble de méthodes d'écriture que vous pouvez utiliser pour créer, mettre à jour ou supprimer des listes de lecture :

    Authentification

    Les demandes à l' CMS API exigent un en-tête d'autorisation qui contient vos jetons d'accès. Pour plus d'informations sur la façon d'obtenir des informations d'identification client et de les utiliser pour récupérer des jetons d'accès, consultez la présentation OAuth de Brightcove.

    GET playlists

    Avant de commencer à créer des listes de lecture, voyons comment nous pouvons récupérer les données des playlists existantes dans votre compte Video Cloud.

    Requête

        https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists

    Réponse

    (Nous avons défini le limit sur cette demande 1 pour garder la réponse petite.)

        [
          {
            "id": "5282200243001",
            "account_id": "1752604059001",
            "created_at": "2017-01-15T15:30:09.847Z",
            "description": "Do not delete",
            "favorite": true,
            "name": "Playlist for Alltime Views Sample",
            "reference_id": null,
            "type": "EXPLICIT",
            "updated_at": "2017-01-15T17:49:07.633Z",
            "video_ids": [
              "4825279519001",
              "4845831078001",
              "4825296720001",
              "4454620115001",
              "5141730843001",
              "4793962133001",
              "4454620113001",
              "4511340777001",
              "5045678909001"
            ]
          }
        ]

    Types de playlist

    Il existe un type de liste de lecture EXPLICIT (manuelle) pour lequel vous spécifiez les vidéos à inclure en tant que tableau d'identifiants vidéo. Il existe également sept types de playlist intelligentes - les types de playlist intelligentes diffèrent dans la façon dont ils commandent un ensemble de vidéos sélectionnées dynamiquement à l'aide d'une chaîne de recherche. Le tableau ci-dessous présente tous les types de playlist.

    Types de playlist
    Type Description
    EXPLICIT Une liste de lecture manuelle. Les vidéos incluses et l'ordre de leur apparition sont définis par un tableau d'identifiants vidéo.
    ACTIVATED_OLDEST_TO_NEWEST Une playlist intelligente dans laquelle les vidéos sélectionnées sont classées par date d'activation (croissant).
    ACTIVATED_NEWEST_TO_OLDEST Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées par date d'activation (décroissant).
    ALPHABETICAL Une playlist intelligente dans laquelle les vidéos sélectionnées sont présentées par ordre alphabétique par nom.
    PLAYS_TOTAL Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées en fonction du nombre de lectures de tous les temps (décroissant).
    PLAYS_TRAILING_WEEK Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées en fonction du nombre de lectures de la semaine précédente (décroissant).
    START_DATE_OLDEST_TO_NEWEST Liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées selon la date de début prévue (croissant).
    START_DATE_NEWEST_TO_OLDEST Liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées selon la date de début prévue (décroissant).

    Champ de recherche

    Pour tous les types de playlist intelligentes, la collection de vidéos est assemblée dynamiquement en fonction de la valeur du search champ de la liste de lecture. La valeur du champ de recherche doit être une chaîne de recherche valide pour une chaîne de recherche de balise pour l'API CMS. Voici quelques exemples avec des explications des vidéos qu'ils retourneront.

    Exemple de chaînes de recherche
    Chaîne de recherche Description
    +tags:bird Retourne les vidéos qui ont le tag « bird »
    +tags:bird,woodland Retourne les vidéos qui ont à la fois les balises « oiseau » et « forêt »
    tags:bird,woodland Retourne les vidéos qui ont l' une des balises « oiseau » ou « forêt » (note : laisser le + signe hors de la chaîne de recherche fait la différence)

    Recevez le nombre de vidéos

    Vous pouvez obtenir un nombre de vidéos dans une playlist (intelligente ou manuelle) à l'aide du counts point de terminaison :

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos

    Créer une sélection

    Pour créer une nouvelle liste de lecture, vous faites une POST demande à :

        https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists

    Corps de la requête

    Vous pouvez inclure beaucoup (mais pas tous !) des champs de métadonnées vidéo de votre demande. Vous devez inclure au moins un name et type pour la liste de lecture. Voici deux exemples, l'un créant une playlist EXPLICITE, l'autre la création d'une liste de lecture intelligente de type ACTIVATED_NEWEST_TO_VIEILLE, y compris les vidéos comportant deux balises :

    Pour la playlist EXPLICITE

        {
          "type": "EXPLICIT",
          "name": "My manual playlist",
          "video_ids": [
            "5289680419001",
            "5289693763001",
            "5289680417001",
            "5288472314001"
          ]
        }

    Pour une playlist intelligente

        {
          "type": "ACTIVATED_NEWEST_TO_OLDEST",
          "name": "My smart playlist",
          "search": "+tags:bird-tags:sea"
        }

    Reportez-vous à la référence de l'API pour tous les champs pouvant être utilisés pour créer des sélections.

    Mettre à jour une playlist

    La mise à jour d'une playlist est très similaire à la création d'une playlist. Les seules différences sont la méthode de requête ( PATCH au lieu de POST) et l'ID de liste de lecture ajouté à l'URL. Les champs du corps de la requête sont exactement les mêmes.

    URL de demande

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id

    Trouvez les détails complets dans la référence de l'API.

    Suppression d'une sélection

    Pour supprimer une liste de lecture, effectuez une demande à l'aide de la DELETE méthode pour :

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id

    (Il s'agit de la même URL que celle utilisée pour mettre à jour une liste de lecture.)

    Trouvez les détails complets dans la référence de l'API.