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

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

Créer une liste de lecture
Mettre à jour une liste de lecture
Supprimer une liste de lecture

Authentification

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

OBTENIR des listes de lecture

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

Requête

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

Réponse

(Nous fixons 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"
        ]
      }
    ]

Notez que vous pouvez également ajouter critères de recherche pour obtenir un ensemble spécifique de listes de lecture et utilisez le /counts/playlists point de terminaison pour obtenir le décompte du nombre de listes de lecture dans le compte. Voir le Référence API pour voir toutes les options.

Types de listes de lecture

Il existe une EXPLICIT type de liste de lecture (manuelle) pour lequel vous spécifiez les vidéos à inclure en tant que tableau d'identifiants vidéo. Il existe également sept types de listes de lecture intelligentes - les types de listes de lecture intelligentes diffèrent dans la façon dont ils classent 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 listes de lecture.

Types de listes de lecture
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 (croissante).
`ACTIVATED_NEWEST_TO_OLDEST`	Une playlist intelligente dans laquelle les vidéos sélectionnées sont classées par date d'activation (décroissante).
`ALPHABETICAL`	Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont présentées par ordre alphabétique de nom.
`PLAYS_TOTAL`	Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées par 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 par nombre de lectures de la semaine précédente (décroissant).
`START_DATE_OLDEST_TO_NEWEST`	Une liste de lecture intelligente dans laquelle les vidéos sélectionnées sont classées par date de début prévue (croissante).
`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 prévue (décroissante).

Champ de recherche

Pour tous les types de playlists intelligentes, la collection de vidéos est assemblée dynamiquement en fonction du search valeur du champ pour la liste de lecture. La valeur du champ de recherche doit être une chaîne de recherche valide pour l'API CMS. Cette validation dépend de la search_syntax valeur ( v1[par défaut] ou v2) définie pour la liste de lecture ; les listes de lecture v2 autorisent la syntaxe de recherche v2, tandis que les listes de lecture v1 n'acceptent que les chaînes de recherche par tag. Vous trouverez ci-dessous quelques exemples avec des explications sur les vidéos qu'ils retourneront.

Cordes de recherche d'échantillons - listes de lecture v1
Chaîne de recherche	Description
`+tags:bird`	Renvoie les vidéos qui ont le tag "oiseau"
`+tags:bird,woodland`	Renvoie les vidéos qui ont à la fois les balises « oiseau » et « bois »
`tags:bird,woodland`	Renvoie les vidéos qui ont Soit des balises « oiseau » ou « boisé » (remarque : en laissant le `+` se déconnecter de la chaîne de recherche fait la différence)

Recherche d'échantillons de cordes - v2 Listes de lecture
Chaîne de recherche	Description
`+tags:bird`	Renvoie les vidéos qui ont le tag "oiseau"
`+name:bird`	Retourne les vidéos dont le titre contient "bird"
`(+custom_fields:bird)%20AND%20(NOT%20tags:woodland)`	Renvoie les vidéos qui ont la valeur "bird" pour un champ personnalisé, mais qui n'ont PAS la balise "woodland"

Obtenir des vidéos dans une liste de lecture

Vous pouvez obtenir le décompte des vidéos d'une liste de lecture (soit intelligente, soit manuelle) en utilisant le counts point final :

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

Vous pouvez récupérer les vidéos elles-mêmes à l'aide d'une requête Get Videos in Playlist . Notez qu'un maximum de 100 vidéos peuvent être renvoyées pour une demande. Par conséquent, pour en obtenir plus de 100, vous devrez afficher les résultats à l'aide des offset paramètres limit et. Par exemple, pour obtenir le deuxième 100, vous devez utiliser :

https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists/videos?limit=100&offset=100

Créer une liste de lecture

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

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

Corps de la demande

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

Pour la liste de lecture EXPLICITE

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

Pour une liste de lecture smart v1

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

Pour la playlist smart v2

{ 
  "type": "ACTIVATED_NEWEST_TO_OLDEST", 
  "name": "My smart playlist", 
  "search": "+name:bird", 
  "search_syntax": "v2" 
}

Notez que toutes les listes de lecture ont une limite de 1 000 vidéos, mais vous pouvez réduire cette limite pour les listes de lecture intelligentes en utilisant le limit champ.

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

Mettre à jour une liste de lecture

La mise à jour d'une liste de lecture est très similaire à la création d'une. 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 requête sont exactement les mêmes.

Notez que vous ne peut pas changer un EXPLICIT liste de lecture à un autre type, ou modifiez un autre type de liste de lecture pour EXPLICIT.

URL de demande

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

Retrouvez tous les détails dans le Référence API.

Supprimer une liste de lecture

Pour supprimer une liste de lecture, faites une demande en utilisant le 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.)

Retrouvez tous les détails dans le Référence API.