概要：Social Syndication API

エラーメッセージ

APIリクエストが失敗した場合、エラーメッセージが返されます。エラー応答は次のようになります。

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

シンジケーションを作成する

方法: POST

エンドポイント: /accounts/{account_id}/mrss/syndications

リクエスト本文の例:

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

注意してくださいnameそしてtypeフィールドは必須です。その他はオプションです。

シンジケーションを更新する

方法: PATCH

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}

リクエスト本文の例:

  {
    "name": "my new name"
  }

PATCHリクエストのリクエスト本文はないフィールドを含める（type、idそしてsyndication_url）。

シンジケーションを削除する

方法: DELETE

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}

アカウントのすべてのシンジケートを取得する

方法: GET

エンドポイント: /accounts/{account_id}/mrss/syndications

特定のシンジケーションを取得する

方法: GET

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}

ユニバーサルシンジケーションのテンプレートを設定する

方法: PUT

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

リクエスト本文の例:

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

上記のテンプレートは、次のようなフィードを生成します。

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

ユニバーサルシンジケーションのテンプレートを入手する

方法: GET

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

シンジケーションに関連付けられたフィードを取得する

フィードのURLは、シンジケーションのsyndication_urlフィールド、または手動で構築されます。注意してくださいSyndication Feed API認証なしでフィードを取得するためにも使用できます。

方法: GET

エンドポイント: /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

トップレベルのプロパティ

シンジケーションフィールドから派生

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

ビデオクラウドアカウントID

• account_id

VideoCloudのデフォルトのプレーヤーページのURLプレフィックス

このように使用します：

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

• player_url

フィードの次のページのURL

• next_page

カタログから取得したビデオアセットのコレクション（詳細は以下を参照）

• assets

資産プロパティ

アセットコレクションのリソースは、CMS Get Videos APIメソッドによって返されるビデオリソースから派生し、以下を含むがこれらに限定されないすべての同じプロパティがサポートされます。

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

アセットリソースは、次のプロパティもサポートします。

• sources（ビデオのソースのコレクション-ソースのプロパティについては次のセクションを参照してください）
• digital_master（デジタルマスターが存在しない場合は空になります。デジタルマスターのプロパティについては、以下を参照してください）
• best_mp4_source（最高品質のMP4ソース-MP4ソースがない場合は空になる可能性があります。プロパティは、で返されるアイテムと同じになりますsources）
• hls_source（HLSソースを返します-存在しない場合は空になります）
• best_dynamic_rendition_quality（動的レンディションメタデータがビデオに対してフェッチされている場合、最大のフレームサイズを持つビデオの動的レンディションのビデオ品質を返します。許容値は「SD」、「HD」、「FHD」、「UHD」です。）

ソースプロパティ

アセットのソースコレクション内のリソースは、CMS Get Video SourcesAPIメソッドによって返されるビデオソースリソースから取得されます。次のプロパティがサポートされています。

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

デジタルマスタープロパティ

ザ・digital_masterアセットのリソースは、CMS Get Digital Master InfoAPIメソッドによって返されるデジタルマスターリソースから派生します。次のプロパティがサポートされています。

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

動的レンディションプロパティ

ザ・dynamic_renditionsアセットのリソースは、CMS Get Digital Master InfoAPIメソッドによって返される動的レンディションから取得されます。次のプロパティがサポートされています。

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

Liquidの拡張

toUTCフィルター

Liquidパーサーを拡張して、ほとんどの標準ISO-8601日時文字列形式を解析し、それらを標準UTC日時文字列に変換するtoUTCフィルターをサポートします。この形式は、Liquidの日付フィルターで使用できます。このフィルターを使用して、タイムスタンプを任意の形式の日時文字列に再形式化できます。例は次のとおりです。

  <pubDate></pubDate>

これにより、asset.published_atの値が2019-08-09T13：32：52.031Z ::の場合、次のような出力が生成されます。

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

toEpochフィルター

使用するLiquidパーサーは、日付をUnixエポックタイムスタンプに変換するための日付フィルターの「％s」トークンをサポートしていません。これに対処するために、有効な日付仕様をエポック形式に変換するために使用できるtoEpochカスタムフィルターが提供されています。フィルタは、数学フィルタへの入力に適したエポックからのミリ秒を表す数値データ値を返します。例は次のとおりです。

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

は、次のような出力を生成します。

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

fromEpochフィルター

fromEpochフィルターは、エポックからのミリ秒を表す数値をUTC日付文字列に変換します。フィルタは、エポック値の数字を含む文字列も入力として受け入れます。必要に応じて、出力を日付フィルターに渡して再フォーマットすることができます。

例は次のとおりです。

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

は、次のような出力を生成します。

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