Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    Verwalten von Playlists mit der CMS-API

    In diesem Thema wird beschrieben, wie Sie Playlists mit der CMS-API erstellen, aktualisieren oder löschen.

    Einführung

    Beispiel Playlist

    Playlists ermöglichen es dir, eine Reihe verwandter Videos zu gruppieren, damit sie in einen Player geladen und als Gruppe angesehen werden können. Die CMS API enthält eine Reihe von Schreibmethoden, die Sie zum Erstellen, Aktualisieren oder Löschen von Wiedergabelisten verwenden können:

    Authentifizierung

    Anfragen an den CMS API erfordern einen Autorisierungs-Header, der Ihre Zugriffstoken enthält. Weitere Informationen zum Abrufen von Client-Anmeldeinformationen und zum Abrufen von Zugriffstoken finden Sie in der Brightcove OAuth Overview.

    Wiedergabelisten erhalten

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

    Anforderung

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

    REAKTION

    (Wir setzen die limit auf diese Anfrage, 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"
            ]
          }
        ]

    Wiedergabelisten-Typen

    Es gibt einen EXPLICIT (manuellen) Playlist-Typ, für den Sie die Videos angeben, die als Array von Video-IDs enthalten sein sollen. Es gibt auch sieben Smart-Playlist-Typen - die Smart-Playlist-Typen unterscheiden sich darin, wie sie eine Reihe von Videos bestellen, die dynamisch mithilfe einer Suchzeichenfolge ausgewählt werden. Die folgende Tabelle zeigt alle Arten von Wiedergabelisten.

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

    Suchfeld

    Für alle Smart-Playlist-Typen wird die Sammlung von Videos dynamisch basierend auf dem search Feldwert für die Wiedergabeliste zusammengestellt. Der Wert des Suchfelds muss eine gültige Suchzeichenfolge für eine Tag-Suchzeichenfolge für die CMS-API sein. Im Folgenden finden Sie einige Beispiele mit Erklärungen zu den Videos, die sie zurückgeben werden.

    Sample Suche Strings
    Suche String Beschreibung
    +tags:bird Gibt Videos mit dem Stichwort „bird“ zurück
    +tags:bird,woodland Gibt Videos zurück, die sowohl die Stichworte „Vogel“ als auch „Waldland“ enthalten
    tags:bird,woodland Gibt Videos zurück, die haben entweder der Tags "Vogel" oder "Wald" (Hinweis: Verlassen der + Abmelden von der Suchzeichenfolge macht den Unterschied)

    Anzahl der Videos abrufen

    Sie können die Anzahl der Videos in einer Wiedergabeliste (entweder intelligent oder manuell) über den counts Endpoint abrufen:

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

    Erstellen einer Wiedergabeliste

    Um eine neue Playlist zu erstellen, stellen Sie eine POST Anfrage an:

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

    Anfrage Body

    Sie können viele (aber nicht alle!) der Video-Metadaten-Felder in Ihrer Anfrage. Sie müssen mindestens ein name und type für die Playlist angeben. Im Folgenden finden Sie zwei Beispiele, von denen eines eine EXPLIZITE Wiedergabeliste erstellt, das zweite erstellt eine intelligente Wiedergabeliste vom Typ ACTIVATED_NEWEST_TO_ALEVESTE, einschließlich Videos mit zwei Tags:

    Für EXPLIZITE Playlist

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

    Für smarte Playlist

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

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

    Aktualisieren einer Playlist

    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 Wiedergabelisten-ID. Die Felder für den Anfragetext sind genau gleich.

    Anfrage-URL

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

    Die vollständigen Details finden Sie in der API-Referenz.

    Löschen einer Wiedergabeliste

    Um eine Playlist zu löschen, stellen Sie eine Anfrage mit der DELETE Methode an:

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

    (Dies ist dieselbe URL, die zum Aktualisieren einer Wiedergabeliste verwendet wurde.)

    Die vollständigen Details finden Sie in der API-Referenz.


    Seite zuletzt aktualisiert am 28 Sep 2020