Verwalten von Wiedergabelisten mithilfe der CMS-API

In diesem Thema wird beschrieben, wie Sie Wiedergabelisten mithilfe der CMS-API erstellen, aktualisieren oder löschen können.

Einleitung

Mit Playlists können Sie eine Reihe verwandter Videos gruppieren, damit sie in einen Player geladen und als Gruppe angesehen werden können. Das CMS API enthält eine Reihe von Schreibmethoden, mit denen Sie Wiedergabelisten erstellen, aktualisieren oder löschen können:

Erstellen Sie eine Wiedergabeliste
Aktualisieren Sie eine Wiedergabeliste
Eine Wiedergabeliste löschen

Authentifizierung

Anfragen an die CMS API benötigen einen Autorisierungsheader, der Ihre Zugriffstoken enthält. Ausführliche Informationen zum Abrufen von Client-Anmeldeinformationen und deren Verwendung zum Abrufen von Zugriffstoken finden Sie im Übersicht über Brightcove OAuth.

Wiedergabelisten abrufen

Bevor wir mit dem Erstellen von Playlists beginnen, sehen wir uns an, wie wir Daten für vorhandene Playlists in Ihrem Video Cloud-Konto abrufen können.

Anfrage

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

Antwort

(Wir setzen die limit auf diese Anfrage an 1 um die Antwort klein zu halten.)

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

Beachten Sie, dass Sie auch hinzufügen können Suchkriterium um einen bestimmten Satz von Wiedergabelisten zu erhalten, und verwenden Sie die /counts/playlists endpoint, um zu zählen, wie viele Playlists sich im Konto befinden. Siehe die API-Referenz um alle Optionen zu sehen.

Playlist-Typen

Da ist einer EXPLICIT (manueller) Playlist-Typ, für den Sie die aufzunehmenden Videos als Array von Video-IDs angeben. Es gibt auch sieben intelligente Wiedergabelistentypen – die intelligenten Wiedergabelistentypen unterscheiden sich darin, wie sie eine Reihe von Videos anordnen, die dynamisch mithilfe einer Suchzeichenfolge ausgewählt werden. Die folgende Tabelle zeigt alle Playlist-Typen.

Playlist-Typen
Typ	Beschreibung
`EXPLICIT`	Eine manuelle Wiedergabeliste. Die enthaltenen Videos und die Reihenfolge ihres Erscheinens werden durch ein Array von Video-IDs definiert.
`ACTIVATED_OLDEST_TO_NEWEST`	Eine intelligente Playlist, in der die ausgewählten Videos nach Aktivierungsdatum (aufsteigend) sortiert sind.
`ACTIVATED_NEWEST_TO_OLDEST`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach Aktivierungsdatum (absteigend) sortiert sind.
`ALPHABETICAL`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos in alphabetischer Reihenfolge nach Namen angezeigt werden.
`PLAYS_TOTAL`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach der Anzahl der Wiedergaben aller Zeiten (absteigend) sortiert sind.
`PLAYS_TRAILING_WEEK`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach der Anzahl der Wiedergaben in der Vorwoche (absteigend) sortiert sind.
`START_DATE_OLDEST_TO_NEWEST`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach dem geplanten Startdatum (aufsteigend) sortiert sind.
`START_DATE_NEWEST_TO_OLDEST`	Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach dem geplanten Startdatum (absteigend) sortiert sind.

Feld „Suchen“

Für alle Smart-Playlist-Typen wird die Sammlung von Videos dynamisch basierend auf den search Feldwert für die Wiedergabeliste. Der Wert des Suchfeldes muss ein für die CMS-API gültiger Wert für eine Suchzeichenfolge sein. Diese Überprüfung hängt vom für die Playlist festgelegten search_syntax Wert (entweder v1[Standard] oder v2) ab. v2-Playlisten ermöglichen die v2-Suchsyntax, während v1-Playlisten nur Tag-Suchzeichenfolgen akzeptieren. Nachfolgend finden Sie einige Beispiele mit Erläuterungen zu den Videos, die zurückgegeben werden.

Mustersuchstrings - v1 Wiedergabelisten
Suchbegriff	Beschreibung
`+tags:bird`	Gibt Videos mit dem Tag "Vogel" zurück
`+tags:bird,woodland`	Gibt Videos zurück, die sowohl die Tags "bird" als auch "woodland" aufweisen
`tags:bird,woodland`	Gibt Videos zurück, die entweder der Tags "Vogel" oder "Wald" (Achtung: Verlassen der `+` Abmelden aus der Suchzeichenfolge macht den Unterschied)

Mustersuchstränge - v2 Wiedergabelisten
Suchbegriff	Beschreibung
`+tags:bird`	Gibt Videos mit dem Tag "Vogel" zurück
`+name:bird`	Gibt Videos zurück, die "Vogel" im Titel haben
`(+custom_fields:bird)%20AND%20(NOT%20tags:woodland)`	Gibt Videos zurück, die den Wert "Vogel" für ein benutzerdefiniertes Feld haben, aber NICHT das Tag "woodland" haben

Videos in einer Wiedergabeliste abrufen

Sie können die Anzahl der Videos in einer Wiedergabeliste (entweder intelligent oder manuell) mithilfe der counts Endpunkt:

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

Sie können die Videos selbst mit einer Anforderung "Videos in Wiedergabeliste ab rufen" abrufen. Beachten Sie, dass für eine Anfrage maximal 100 Videos zurückgegeben werden können. Um also mehr als 100 zu erhalten, müssen Sie die Ergebnisse mithilfe von seitenweise anzeigen limit Und offset Parameter. Um die zweite 100 zu erhalten, würden Sie zum Beispiel verwenden:

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

Erstellen Sie eine Wiedergabeliste

Um eine neue Playlist zu erstellen, machen Sie ein POST Anfrage zu:

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

Anfragetext

Sie können viele (aber nicht alle!) Videometadatenfelder in Ihre Anfrage aufnehmen. Du muss enthalten mindestens a name und type für die Playliste. Unten sind zwei Beispiele, eines erstellt eine EXPLICIT-Playlist, das zweite erstellt eine intelligente Playlist vom Typ ACTICATED_NEWEST_TO_OLDEST, einschließlich Videos mit zwei Tags:

Für EXPLICIT Playlist

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

Für die intelligente v1-Wiedergabeliste

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

Für smart v2 Wiedergabeliste

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

Beachten Sie, dass für alle Playlisten ein Limit von 1000 Videos gilt. Sie können dieses Limit jedoch für intelligente Playlisten mithilfe des limit Felds senken.

Siehe die API-Referenz für alle Felder, die beim Erstellen von Wiedergabelisten verwendet werden können.

Aktualisieren Sie eine Wiedergabeliste

Das Aktualisieren einer Playlist ist dem Erstellen einer Playlist sehr ähnlich. Die einzigen Unterschiede sind die Anforderungsmethode ( PATCH anstelle von POST) und die an die URL angehängte Playlist-ID. Die Felder für den Anforderungstext sind genau gleich.

Beachten Sie, dass Sie kann nicht ändern EXPLICIT Playlist in einen anderen Typ oder ändern Sie einen anderen Playlist-Typ in EXPLICIT.

Anfrage-URL

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

Die vollständigen Details finden Sie im API-Referenz.

Eine Wiedergabeliste löschen

Um eine Playlist zu löschen, stelle eine Anfrage mit dem DELETE Methode zu:

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

(Dies ist dieselbe URL, die zum Aktualisieren einer Playlist verwendet wird.)

Die vollständigen Details finden Sie im API-Referenz.