Überblick: Social Syndication-API

Fehlermeldungen

Wenn eine API-Anfrage fehlschlägt, wird eine Fehlermeldung zurückgegeben. Fehlerantworten sehen wie folgt 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 Syndikation

Methode: POST

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

Beispiel-Anfragetext:

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

Notiere dass der name und type Felder sind notwendig. Andere sind optional.

Aktualisieren Sie eine Syndikation

Methode: PATCH

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

Beispiel-Anfragetext:

  {
    "name": "my new name"
  }

Beachten Sie, dass der Anforderungstext für PATCH-Anforderungen muss nicht schließen Sie die Felder ein (type , id Und syndication_url).

Eine Syndikation löschen

Methode: DELETE

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

Erhalten Sie alle Syndications für ein Konto

Methode: GET

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

Erhalten Sie eine bestimmte Syndication

Methode: GET

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

Legen Sie die Vorlage für eine universelle Syndikation fest

Methode: PUT

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

Beispiel-Anfragetext:

  <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 Syndication

Methode: GET

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

Holen Sie sich den Feed, der mit einer Syndication verknüpft ist

Die Feed-URL kann von der Syndication abgerufen werden syndication_url Feld, oder manuell konstruiert. 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

Top-Level-Eigenschaften

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, die aus dem Katalog abgerufen wurden (Details siehe unten)

• assets

Asset-Eigenschaften

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

• 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 existiert - siehe unten für die Eigenschaften des digitalen Masters)
• best_mp4_source(die MP4-Quelle mit der höchsten Qualität — kann leer sein, wenn keine MP4-Quellen vorhanden sind. Die Eigenschaften sind die gleichen wie die zurückgegebenen Artikel im sources)
• hls_source(gibt die HLS-Quelle zurück - ist leer, wenn keine existiert)
• best_dynamic_rendition_quality(gibt die Videoqualität der dynamischen Wiedergabeversion des Videos mit der größten Bildgröße zurück, wenn Metadaten der dynamischen Wiedergabeversion für das Video abgerufen wurden. Zulässige Werte sind "SD", "HD", "FHD" und "UHD".)

Quelleigenschaften

Die Ressourcen in der Quellensammlung für ein Asset werden aus den Videoquellenressourcen abgeleitet, die von der CMS-API-Methode Get Video Sources 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

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

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

Dynamische Wiedergabeeigenschaften

Die dynamic_renditions Ressource für ein Asset wird von den dynamischen Darstellungen 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 Standard-ISO-8601-Datumszeit-String-Formate parst und sie in Standard-UTC-Datumszeit-Strings umwandelt. Dieses Format ist für den Datumsfilter von Liquid akzeptabel, der dann verwendet werden kann, um die Zeitstempel in Datums-/Uhrzeit-Strings in jedem gewünschten Format umzuformatieren. Zum Beispiel:

  <pubDate>{{asset.published_at | toUTC | date: "%a, %d %b %Y %H:%M:%S %Z"}}</pubDate>

Dies erzeugt eine Ausgabe wie die folgende, wenn asset.published_at den Wert 2019-08-09T 13:32:52 .031Z hat::

  <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 Daten in Unix-Epochen-Zeitstempel nicht. Um dies zu beheben, wird ein benutzerdefinierter toEpoch-Filter bereitgestellt, mit dem gültige Datumsangaben in das Epochenformat konvertiert werden können. Der Filter gibt einen numerischen Datenwert zurück, der Millisekunden seit der Epoche darstellt, der für die Eingabe in mathematische Filter geeignet ist. Zum Beispiel:

  <toEpochMillis>{{"now" | toEpoch }}</toEpochMillis>
  <toEpochSeconds>{{"now" | toEpoch | divided_by : 1000 }}</toEpochSeconds>
  <thirtyDaysAgo>{{'now' | toEpoch | minus:2592000000 | fromEpoch }}</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 Ziffern des Epochenwerts enthält, als Eingabe. Die Ausgabe kann bei Bedarf zur Neuformatierung an den Datumsfilter übergeben werden.

Zum Beispiel:

  
  <fromEpochMillis>{{"now" | toEpoch | fromEpoch }}</fromEpochMillis>
  <thirtyDaysAgoAltFormat>{{1580917253024 | fromEpoch | date:"%Y-%m-%d" }}</thirtyDaysAgo>
  

erzeugt eine Ausgabe wie die folgende:

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