Paper Contacter le support | état du système L'état du système
Contenu de la page

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

    Cette rubrique explique comment créer, mettre à jour ou supprimer des listes de lecture à l’aide de la CMS API.

    Introduction

    Exemple de playlist

    Les listes de lecture vous permettent de regrouper un ensemble de vidéos connexes afin qu'elles puissent être chargées dans un player et regardé 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 playlists:

    Authentification

    Demandes à la CMS API nécessite un en-tête d'autorisation contenant vos jetons d'accès. Pour plus d'informations sur l'obtention des informations d'identification du client et leur utilisation pour récupérer les jetons d'accès, reportez-vous à la section Présentation de Brightcove OAuth.

    GET playlists

    Avant de créer des listes de lecture, voyons comment récupérer des données pour des listes de lecture existantes dans votre Video Cloud compte.

    Demande

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

    Réponse

    (Nous définissons 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 une EXPLICIT Type de sélection (manuel) pour lequel vous spécifiez les vidéos à inclure en tant que tableau d'identifiants de vidéos. Il existe également sept types de listes de lecture intelligentes - les types de liste de lecture intelligentes diffèrent par la façon dont ils ordonnent un ensemble de vidéos sélectionnées de manière dynamique à l'aide d'une chaîne de recherche. Le tableau ci-dessous montre tous les types de playlist.

    Types de playlist
    Type Description
    EXPLICIT Une playlist manuelle. Les vidéos incluses et leur ordre d'apparition sont définis par un tableau d'identifiants de vidéos.
    ACTIVATED_OLDEST_TO_NEWEST Une playlist intelligente dans laquelle les vidéos sélectionnées sont classées par date d'activation (ascendant).
    ACTIVATED_NEWEST_TO_OLDEST Une playlist 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.
    PLAYS_TOTAL Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées selon le nombre de lectures de tous les temps (décroissant).
    PLAYS_TRAILING_WEEK Une playlist intelligente dans laquelle les vidéos sélectionnées sont classées selon le nombre de lectures de la semaine précédente (en descendant).
    START_DATE_OLDEST_TO_NEWEST Une playlist intelligente dans laquelle les vidéos sélectionnées sont classées selon la date de début programmée (ascendante).
    START_DATE_NEWEST_TO_OLDEST Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées par date de début programmée (décroissant).

    Champ de recherche

    Pour tous les types de listes de lecture intelligentes, la collection de vidéos est assemblée dynamiquement en fonction de la search valeur de champ pour la liste de lecture. La valeur du champ de recherche doit être une chaîne de recherche valide pour un tag chaîne de recherche pour le CMS API. Ci-dessous quelques exemples avec des explications sur les vidéos qu’ils reviendront.

    Exemples de chaînes de recherche
    Chaîne de recherche Description
    +tags:bird Renvoie les vidéos portant l'étiquette "oiseau"
    +tags:bird,woodland Renvoie des vidéos contenant à la fois les tags "oiseau" et "bois"
    tags:bird,woodland Renvoie les vidéos qui ont non plus des étiquettes "oiseau" ou "bois" (note: laisser le + se déconnecter de la chaîne de recherche fait la différence)

    Obtenir le nombre de vidéos

    Vous pouvez obtenir le nombre de vidéos dans une liste de lecture (intelligente ou manuelle) en utilisant counts point final:

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

    Créer une liste de lecture

    Pour créer une nouvelle playlist, vous faites un POST demande à:

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

    Demander un corps

    Vous pouvez inclure de nombreux champs de métadonnées vidéo (mais pas tous!) Dans votre demande. Vous doivent inclure au moins un name et type pour la playlist. Vous trouverez ci-dessous deux exemples, l'un créant une liste de lecture EXPLICIT, le second créant une liste de lecture intelligente de type ACTIVATED_NEWEST_TO_OLDEST, y compris des vidéos comportant deux balises:

    Pour la liste de lecture EXPLICIT

        {
          "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"
        }

    Voir le Référence de l'API pour tous les champs pouvant être utilisés dans la création de listes de lecture.

    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’identifiant de la liste de lecture ajouté à l’URL. Les champs du corps de la demande sont exactement les mêmes.

    Demander une URL

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

    Trouvez les détails complets dans le Référence de l'API.

    Supprimer une playlist

    Pour supprimer une playlist, faites une demande en utilisant DELETE méthode pour:

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

    (C'est la même URL utilisée pour mettre à jour une liste de lecture.)

    Trouvez les détails complets dans le Référence de l'API.


    Dernière mise à jour de la page le 27 juin 2020