Überblick: Social Syndication API

Fehlermeldungen

Wenn API-Anforderungen fehlschlagen, wird eine Fehlermeldung zurückgegeben. Fehlerantworten sehen folgendermaßen aus:

  [
    {
      "error_code" : "Application error code 1",
      "message" : "Application error message 1"
    }, {
      "error_code" : "Application error code 2",
      "message" : "Application error message 2"
    }
  ]

Erstellen Sie eine Syndizierung

Methode: POST

Endpunkt: /accounts/{account_id}/mrss/syndications

Beispielanfragetext:

  {
    "name": "my mp4 feed",
    "type": "mp4"
  }

Beachten Sie, dass die name und type Felder sind Pflichtfelder. Andere sind optional.

Aktualisieren Sie eine Syndizierung

Methode: PATCH

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}

Beispielanfragetext:

  {
    "name": "my new name"
  }

Beachten Sie, dass der Anforderungshauptteil für PATCH-Anforderungen muss Fügen Sie die Felder hinzu (type, id und syndication_url).

Löschen Sie eine Syndizierung

Methode: DELETE

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}

Holen Sie sich alle Syndizierungen für ein Konto

Methode: GET

Endpunkt: /accounts/{account_id}/mrss/syndications

Holen Sie sich eine bestimmte Syndication

Methode: GET

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}

Legen Sie die Vorlage für eine universelle Syndizierung fest

Methode: PUT

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Beispielanfragetext:

  <feed header>My Feed Header</feed header>
  

Die obige Vorlage würde einen Feed ähnlich dem folgenden generieren:

  <feed header>My Feed Header</feed header>
    <item>
      <title>Title for Video 1</title>
      <video_info>Description for Video 1</video_info>
    </item>
    <item>
      <title>Title for Video 2</title>
      <video_info>Description for Video 2</video_info>
    </item>

Holen Sie sich die Vorlage für eine universelle Syndizierung

Methode: GET

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Holen Sie sich den Feed, der einer Syndizierung zugeordnet ist

Die Feed-URL kann von der Syndication abgerufen werden syndication_url Feld oder manuell erstellt. Notiere dass der Syndication Feed API kann auch verwendet werden, um einen Feed ohne Authentifizierung abzurufen.

Methode: GET

Endpunkt: /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

Eigenschaften der obersten Ebene

Abgeleitet von Syndication-Feldern

• album_art_url
• author
• category
• description
• destination_url
• explicit
• keywords
• name
• owner_name
• owner_email
• subtitle
• syndication_id
• syndication_url
• title

Video Cloud Konto-ID

• account_id

VideoCloud Standard player Seiten-URL-Präfix

Verwenden Sie wie folgt:

  <media:player url="//default_default/index.html?videoId=">

• player_url

URL der nächsten Seite des Feeds

• next_page

Sammlung von Video-Assets aus dem Katalog (Details siehe unten)

• assets

Asset-Eigenschaften

Die Ressourcen in der Assets-Sammlung werden von den Videoressourcen abgeleitet, die von der CMS Get Videos API-Methode zurückgegeben werden, und alle gleichen Eigenschaften werden unterstützt, einschließlich, aber nicht beschränkt auf Folgendes:

• created_at
• description
• duration
• id
• images
• images.thumbnail
• images.poster
• long_description
• name
• original_filename
• published_at
• schedule
• state
• tags
• text_tracks
• updated_at

Asset-Ressourcen unterstützen auch die folgenden Eigenschaften:

• sources (Sammlung von Quellen für das Video - Quelleneigenschaften finden Sie im nächsten Abschnitt)
• digital_master (ist leer, wenn kein digitaler Master vorhanden ist - siehe unten für die Eigenschaften des digitalen Masters)
• best_mp4_source (Die MP4-Quelle mit der höchsten Qualität - ist möglicherweise leer, wenn keine MP4-Quellen vorhanden sind. Die Eigenschaften entsprechen denen, die in der zurückgegeben werden sources)
• hls_source (gibt die HLS-Quelle zurück - ist leer, wenn keine vorhanden ist)
• best_dynamic_rendition_quality (Gibt die Videoqualität der dynamischen Wiedergabe des Videos mit der größten Bildgröße zurück, wenn für das Video Metadaten für die dynamische Wiedergabe abgerufen wurden. Zulässige Werte sind "SD", "HD", "FHD" und "UHD".)

Quelleneigenschaften

Die Ressourcen in der Quellensammlung für ein Asset werden aus den Videoquellenressourcen abgeleitet, die von der CMS Get API Sources API-Methode zurückgegeben werden. Die folgenden Eigenschaften werden unterstützt:

• app_name
• asset_id
• codec
• container
• created_at
• duration
• encoding_rate
• height
• size
• src
• stream_name
• type
• uploaded_at
• width

Digitale Master-Eigenschaften

Das digital_master Die Ressource für ein Asset wird aus der digitalen Masterressource abgeleitet, die von der CMS-API-Methode Get Digital Master Info zurückgegeben wird. Die folgenden Eigenschaften werden unterstützt:

• duration
• encoding_rate
• height
• size
• url
• width

Dynamische Wiedergabeeigenschaften

Das dynamic_renditions Die Ressource für ein Asset wird aus den dynamischen Wiedergaben abgeleitet, die von der CMS Get Digital Master Info API-Methode zurückgegeben werden. Die folgenden Eigenschaften werden unterstützt:

• rendition_id
• frame_height
• frame_width
• media_type
• encoding_rate
• created_at
• updated_at
• size
• duration
• audio_configuration
• language
• variant

Erweiterungen zu Liquid

toUTC Filter

Wir haben unseren Liquid-Parser erweitert, um einen toUTC-Filter zu unterstützen, der die meisten Standardformate für ISO-8601-Datums- und Uhrzeitzeichenfolgen analysiert und sie in Standard-UTC-Datums- und Uhrzeitzeichenfolgen umwandelt. Dieses Format ist für den Datumsfilter von Liquid akzeptabel, mit dem die Zeitstempel in Datums- / Uhrzeitzeichenfolgen in einem beliebigen Format neu formatiert werden können. Zum Beispiel:

  <pubDate></pubDate>

Dies erzeugt eine Ausgabe wie die folgende, wenn asset.published_at den Wert 2019-08-09T13 hat: 32: 52.031Z ::

  <pubDate>Fri, 09 Aug 2019 09:32:52 +0000</pubDate>

toEpoch Filter

Der von uns verwendete Liquid-Parser unterstützt das Token "% s" in Datumsfiltern zum Konvertieren von Datumsangaben in Zeitstempel der Unix-Epoche nicht. Um dies zu beheben, wird ein benutzerdefinierter toEpoch-Filter bereitgestellt, mit dem gültige Datumsspezifikationen in das Epochenformat konvertiert werden können. Der Filter gibt einen numerischen Datenwert zurück, der Millisekunden seit der Epoche darstellt, die für die Eingabe in mathematische Filter geeignet ist. Zum Beispiel:

  <toEpochMillis>now</toEpochMillis>
  <toEpochSeconds>0</toEpochSeconds>
  <thirtyDaysAgo>-2592000000</thirtyDaysAgo>

erzeugt eine Ausgabe wie die folgende:

  <toEpochMillis>1580917253024</toEpochMillis>
  <toEpochSeconds>1580917253</toEpochSeconds>
  <thirtyDaysAgo>2020-01-06T15:40:53.055Z</thirtyDaysAgo>

fromEpoch Filter

Der fromEpoch-Filter konvertiert Zahlen, die Millisekunden seit der Epoche darstellen, in UTC-Datumszeichenfolgen. Der Filter akzeptiert auch eine Zeichenfolge, die die Epochenwertziffern enthält, als Eingabe. Die Ausgabe kann bei Bedarf zur Neuformatierung an den Datumsfilter übergeben werden.

Beispielsweise:

  
  <fromEpochMillis>now</fromEpochMillis>
  <thirtyDaysAgoAltFormat>52067-04-10</thirtyDaysAgo>
  

erzeugt eine Ausgabe wie die folgende:

  
  <fromEpochMillis>2020-02-05T16:09:37.809Z</fromEpochMillis>
  <thirtyDaysAgoAltFormat>2020-02-05</thirtyDaysAgo>