Kontakt Support
Systemstatus
Einführung
Mit Wiedergabelisten können Sie eine Reihe zusammengehöriger Videos gruppieren, um sie in einen Player zu laden und als Gruppe anzusehen. Das CMS API enthält eine Reihe von Schreibmethoden, mit denen Sie Wiedergabelisten erstellen, aktualisieren oder löschen können:
Beglaubigung
Anfragen an die CMS API benötigen einen Berechtigungsheader, der Ihre Zugriffstoken enthält. Weitere Informationen zum Abrufen von Clientanmeldeinformationen und zum Abrufen von Zugriffstokens finden Sie unter Brightcove OAuth Übersicht.
Holen Sie sich Wiedergabelisten
Bevor wir mit dem Erstellen von Wiedergabelisten beginnen, sehen wir uns an, wie wir Daten für vorhandene Wiedergabelisten in Ihrem abrufen können Video Cloud Konto.
Ihre Preisanfrage
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"
]
}
]
Playlist-Typen
Da ist einer EXPLICIT (manueller) Playlist-Typ, für den Sie die Videos angeben, die als Array von Video-IDs enthalten sein sollen. Es gibt auch sieben intelligente Wiedergabelistentypen - die intelligenten Wiedergabelistentypen unterscheiden sich darin, wie sie einen Satz von Videos bestellen, die dynamisch mithilfe eines Suchstrings ausgewählt werden. Die folgende Tabelle zeigt alle Playlist-Typen.
| Typ | Beschreibung |
|---|---|
EXPLICIT |
Eine manuelle Wiedergabeliste Die enthaltenen Videos und die Reihenfolge ihres Aussehens werden durch ein Array von Video-IDs definiert. |
ACTIVATED_OLDEST_TO_NEWEST |
Eine intelligente Wiedergabeliste, 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 geordnet sind (absteigend). |
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 aller Spiele sortiert sind (absteigend). |
PLAYS_TRAILING_WEEK |
Eine intelligente Wiedergabeliste, in der die ausgewählten Videos nach Anzahl der Wiedergaben in der vorherigen Woche geordnet sind (absteigend). |
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 sortiert sind (absteigend). |
Suchfeld
Für alle Smart-Playlist-Typen wird die Sammlung von Videos dynamisch basierend auf den search Feldwert für die Wiedergabeliste. Der Suchfeldwert muss eine gültige Suchzeichenfolge für ein Tag sein Suchbegriff für die CMS API. Nachfolgend einige Beispiele mit Erklärungen zu den Videos, die sie zurückgeben werden.
| 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" haben |
tags:bird,woodland |
Gibt Videos zurück, die entweder der Tags "Vogel" oder "Wald" (Hinweis: Verlassen der + Ausloggen aus dem Suchstring macht den Unterschied) |
Zählen Sie Videos
Sie können die Anzahl der Videos in einer Wiedergabeliste (entweder intelligent oder manuell) mit Hilfe der counts Endpunkt:
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
Erstellen Sie eine Wiedergabeliste
Um eine neue Playlist zu erstellen, machst du eine POST Anfrage zu:
https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists
Anfrage Körper
Sie können viele (aber nicht alle!) Video-Metadatenfelder in Ihre Anfrage aufnehmen. Sie sollen enthalten mindestens a name und type für die Wiedergabeliste. Im Folgenden finden Sie zwei Beispiele, eines zum Erstellen einer EXPLICIT-Wiedergabeliste und eines zum Erstellen einer intelligenten Wiedergabeliste vom Typ ACTIVATED_NEWEST_TO_OLDEST, einschließlich Videos mit zwei Tags:
Für EXPLICIT-Wiedergabeliste
{
"type": "EXPLICIT",
"name": "My manual playlist",
"video_ids": [
"5289680419001",
"5289693763001",
"5289680417001",
"5288472314001"
]
}
Für eine intelligente Playlist
{
"type": "ACTIVATED_NEWEST_TO_OLDEST",
"name": "My smart playlist",
"search": "+tags:bird-tags:sea"
}
Siehe die API-Referenz für alle Felder, die beim Erstellen von Wiedergabelisten verwendet werden können.
Aktualisieren Sie eine Wiedergabeliste
Das Aktualisieren einer Wiedergabeliste ist der Erstellung einer Wiedergabeliste sehr ähnlich. Die einzigen Unterschiede sind die Anfrage-Methode ( PATCH anstelle von POST) und die Playlist-ID, die an die URL angehängt wurde. Die Felder für den Anfragetext sind genau gleich.
URL anfragen
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
Finden Sie die vollständigen Details in der API-Referenz.
Lösche eine Playlist
Um eine Playlist zu löschen, machen Sie eine Anfrage mit dem DELETE Methode zu:
https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
(Dies ist die gleiche URL, die zum Aktualisieren einer Wiedergabeliste verwendet wird.)
Finden Sie die vollständigen Details in der API-Referenz.