Mit Ordnern arbeiten

Einleitung

Ordner können erstellt werden, um Videos in Ihrer Videobibliothek zu organisieren. Sie können Videos nach Thema, Autor, Produkt, Region usw. organisieren. Wenn Sie Videos in Ordnern haben, können sie in einem Konto mit Hunderten oder Tausenden von Videos einfacher verwaltet werden.

Ordner erstellen

Hier sind die Informationen, die Sie benötigen, um einen neuen Ordner zu erstellen.

Anfrage-URL

Mach ein POST Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

Anfragetext

      {
        "name": folder_name
      }

Antwort

Die Antwort wird wie folgt aussehen:

      {
        "id": "5a183efb10ab344b53775441",
        "account_id": "57838016001",
        "created_at": "2017-11-24T15:47:07.867Z",
        "name": "places",
        "updated_at": "2017-11-24T15:47:07.867Z",
        "video_count": 0
      }

Der Ordner id und name (der Name, den Sie im Anfragetext festgelegt haben) sind wichtig, da Sie beides benötigen füge dem Ordner ein Video hinzu. Machen Sie sich jedoch keine Sorgen id, wenn Sie das vergessen, denn Sie können diese Informationen jederzeit erneut abrufen, indem Sie die Ordner für das Konto abrufen.

Ordner abrufen

Um ein Array der Ordner für ein Konto zu erhalten, machen Sie einfach a GET Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

Die Antwort wird wie folgt aussehen:

      [
        {
          "id": "5a17275782aca45b631295f9",
          "account_id": "57838016001",
          "created_at": "2017-11-23T19:53:59.687Z",
          "name": "birds",
          "updated_at": "2017-11-23T20:06:24.537Z",
          "video_count": 1
        },
        {
          "id": "560039e5e4b0e69e4b01cacd",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:09:57.260Z",
          "name": "fish",
          "updated_at": "2017-11-02T19:03:40.751Z",
          "video_count": 4
        },
        {
          "id": "5a183efb10ab344b53775441",
          "account_id": "57838016001",
          "created_at": "2017-11-24T15:47:07.867Z",
          "name": "places",
          "updated_at": "2017-11-24T15:47:07.867Z",
          "video_count": 0
        },
        {
          "id": "560039f1e4b0e69e4b01cad3",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:10:09.422Z",
          "name": "water",
          "updated_at": "2015-09-21T17:22:52.935Z",
          "video_count": 7
        }
      ]

Video zum Ordner hinzufügen

Um ein Video zu einem Ordner hinzuzufügen, machen Sie ein PUT Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

Anfragetext

Für diesen Vorgang gibt es keinen Anforderungstext.

Antwort

Die Antwort auf diese Anfrage lautet 204 NO CONTENT.

Video aus Ordner entfernen

Um ein Video aus einem Ordner zu entfernen, machen Sie ein DELETE Anfrage an dieselbe URL, die Sie zum Hinzufügen eines Videos verwenden:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

Anfragetext

Für diese Anfrage müssen Sie auch den Ordnernamen in den Anfragetext aufnehmen:

      {
        "name": folder_name
      }

Holen Sie sich Videos in einen Ordner

Um die Videos in einen Ordner zu laden, machen Sie ein GET Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos

Parameter anfordern

limit und offset

Standardmäßig gibt diese Anforderung die 20 Videos zurück, die dem Ordner zuletzt hinzugefügt wurden. Sie können dies ändern und die Ergebnisse für einen Ordner mit vielen Videos durchblättern, indem Sie einen oder beide dieser Parameter zur Anfrage hinzufügen:

• limit: die Anzahl der zurückzugebenden Videos (Standard: 20; Maximum: 100)
• offset: die Anzahl der zu überspringenden Videos (Standard: 0)

Diese Anfrage gibt beispielsweise Videos 21-30 der möglichen Ergebnisse zurück (vorausgesetzt, der Ordner enthält so viele Videos):

https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos?limit=10&offset=20

sort

Sie können die zurückgegebenen Videos auch mithilfe von sortieren sort Parameter, der einem dieser Felder entspricht:

• Name
• reference_id
• aktualisiert am
• hergestellt in
• veröffentlicht_at
• schedule_starts_at
• schedule_ends_at
• Bundesstaat
• spielt_total
• play_trailing_week

Um in absteigender Reihenfolge zu sortieren, stellen Sie dem Feldwert ein Minuszeichen (-created_at) vor.

Der Standardwert für sort ist -updated_at.