ライブAPI：SSAIを使用したキューポイントと広告ビーコン

概要

サーバー側の広告挿入（SSAI）ライブストリーミングイベント中に指定した時間に広告を表示できます。一般的な情報については、Live API を参照してください。サーバー側の広告挿入（SSAI）資料。

キューポイント

広告ブレイクはキューポイントによってトリガーされます。キューポイントは次の 2 つの方法で指定できます。

• エンコーダによってBrightcoveに送信
• を介して作成された即時キューポイントライブAPI

エンコーダから

Brightcoveのライブ配信システムは、エンコーダによって送信されたキューポイントを AMF 形式で解釈できます。

  AMFDataList
  [0]:onCuePoint
  [1]:{Obj[]:
    time: 1.9889, //Difference from PTS of THIS packet to the first PTS of the 1st video frame in the adbreak
    name: "scte35",
    type: "event",
    ad_server_data: "eyJrZXkiOiJ2YWx1ZSJ9",	// optional introduced by Brightcove. It is a base64 encoded json map of parameters e.g. {"key":"value"}
    parameters: {Obj[]:
      type: "avail_in",
      duration: 12.0
    }
  }

注意:

• のみavail_inタイプキューポイントは現在、RTMP入力でサポートされています。
• SCTE-35キューポイントは、RTPおよびSRT入力でサポートされています。

キューポイントの手動挿入

を使用して即時キューポイントを作成できますライブAPIを送信することによってPOSTリクエスト：

以下を指定するリクエスト本文を含めます。

デュレーションの例

挿入するキューポイントのデュレーションは、ジョブ内のセグメントの長さの 2 倍以上である必要があります。

たとえば、 10秒のキューポイントとの仕事で"segment_seconds"=4、正常に動作します。ただし、"segment_seconds"=6のジョブに同じキューポイントを挿入すると、次のエラーが発生します。

  "error": "The parameter duration should be greater than
    or equal to (2 * target duration) of the job"
 

リクエスト本文の例

  {
    "duration": 30,
    "timecode": "15:50:49:16",
    "ad_server_data" : {
    "adbreakid": 12312
    "breaktheme": "fitness"
    }
  }

注

1. Wirecast や OBS などのソフトウェアエンコーダは、RTMP OnFIストリーム内のパケット経由のタイムコードの送信をサポートしていません
2. 要素ハードウェアエンコーダは、RTMP OnFIストリーム内のパケットを介したタイムコードの送信をサポートする

レスポンスの例

  {
    "id": "Job_ID",
    "cue_point": {
      "id": "adBreak-2f58393ada1442d98eca0817fa565ba4",
      "duration": 30,
      "accuracy": "segment", [Can be segment or frame ]
      "inserted_at": "2017-07-21T09:30:46.307Z" [ Time when the cue point was inserted in the stream]
    },
  }

ビーコン

ビーコンは、再生時にサードパーティアナリティクスに送信されるデータポイントで、再生された広告の有無と量を追跡します。このセクションでは、を使用して設定できるビーコンタイプについて説明します。ライブAPI、およびデータを提供するために使用できる変数。次のセクションでは、ビーコンセットの作成と管理に使用する API リクエストについて詳しく説明します。

ビーコンの種類

ビーコン/広告変数

次の表は、ビーコン URL のデータを提供するために使用できる変数を示しています。変数を含めるには、次のように二重の中括弧で囲みます{{job.job_id}}。完全な例については、ビーコンセットの管理に関する次のセクションを参照してください。

SCTE-35 広告変数

ケーブル通信技術者協会 (SCTE) は、ライブストリームの動的広告挿入の標準を定義しています。次の表は、SCTE-35 広告の設定変数をまとめたものです。

ビーコンセットの管理

このセクションでは、ビーコンセットを管理するための API リクエストの詳細を示します。ビーコンの種類と変数については、前のセクションを参照してください。

ライブジョブにビーコンセットを追加するには、まずビーコンセットを作成し、次にジョブの作成時に ID を含めます。

  {
  "live_stream": true,
  "region": "us-west-2",
  "reconnect_time": 30,
  "ad_insertion": true,
  "beacon_set": "beacon_set_id", ...

ビーコンセットを作成する

ビーコンセットを作成するには、POSTリクエストを送信します。

リクエスト本文の例

  {
    "account_id": "User's Account ID [Optional]",
    "beacon_urls": [
      {
        "beacon_url": "https://myserver.com/beaconRX/{{job.job_id}}/load?position=load&sid={{session.session_id}}&jid={{job.job_id}}&app={{application_ad_configuration.description}}&rnd32={{random.int32}}&rnd64={{random.int64}}&bid={{random.uuid}}&t={{server.timestamputc}}&ua={{client.useragent}}&ip={{client.ipaddress}}&ref={{client.referrer}}&ref={{client.referer}}&ab={{live.adbreak}}&abd={{live.adbreakduration}}&abdi={{live.adbreakdurationint}}",
        "beacon_type": "Load"
      },
      {
        "beacon_url": "https://myserver.com/beaconRX/{{job.job_id}}/play?position=play&sid={{session.session_id}}&jid={{job.job_id}}&app={{application_ad_configuration.description}}&rnd32={{random.int32}}&rnd64={{random.int64}}&bid={{random.uuid}}&t={{server.timestamputc}}&ua={{client.useragent}}&ip={{client.ipaddress}}&ref={{client.referrer}}&ref={{client.referer}}&ab={{live.adbreak}}&abd={{live.adbreakduration}}&abdi={{live.adbreakdurationint}}",
        "beacon_type": "Play"
      }
    ]
  }

レスポンスの例

  {
    "beacon_set": {
      "beacon_urls": [{
      "beacon_url": "https://myserver.com/beaconRX/{{job.job_id}}/load?position=load&sid={{session.session_id}}&jid={{job.job_id}}&app={{application_ad_configuration.description}}&rnd32={{random.int32}}&rnd64={{random.int64}}&bid={{random.uuid}}&t={{server.timestamputc}}&ua={{client.useragent}}&ip={{client.ipaddress}}&ref={{client.referrer}}&ref={{client.referer}}&ab={{live.adbreak}}&abd={{live.adbreakduration}}&abdi={{live.adbreakdurationint}}",
      "beacon_type": "Load"
    },
    {
      "beacon_url": "https://myserver.com/beaconRX/{{job.job_id}}/play?position=play&sid={{session.session_id}}&jid={{job.job_id}}&app={{application_ad_configuration.description}}&rnd32={{random.int32}}&rnd64={{random.int64}}&bid={{random.uuid}}&t={{server.timestamputc}}&ua={{client.useragent}}&ip={{client.ipaddress}}&ref={{client.referrer}}&ref={{client.referer}}&ab={{live.adbreak}}&abd={{live.adbreakduration}}&abdi={{live.adbreakdurationint}}",
      "beacon_type": "Play"
    }],
    "beacon_set_id": "Inserted Beacon Set ID",
    "account_id": "USER's ACCOUNT ID"
    }
    "inserted": true
  }

ビーコンセットの更新

ビーコンセットの更新は、ビーコンセットの作成に似ています。PUTリクエストを送信:

リクエスト本文の例

  {
    "account_id": "User's Account ID [Optional]",
    "beacon_urls": [
      {
      "beacon_url": "https://myserver.com/beaconRX/load",
      "beacon_type": "Load"
      },
      {
      "beacon_url": "https://myserver.com/beaconRX/play",
      "beacon_type": "Play"
      }
    ]
  }

レスポンスの例

  {
    "beacon_set": {
      "account_id": "User's Account ID",
      "beacon_set_id": "Beacon set ID",
      "beacon_urls": [{
        "beacon_url": "https://myserver.com/beaconRX/load",
        "beacon_type": "Load"
        },
        {
        "beacon_url": "https://myserver.com/beaconRX/play",
        "beacon_type": "Play"
      }],
      "updated_beacon_set": {
        "beacon_set_id": "Beacon set ID",
        "beacon_urls": [{
          "beacon_url": "https://myserver.com/beaconRX/load",
          "beacon_type": "Load"
        },
        {
          "beacon_url": "https://myserver.com/beaconRX/play",
          "beacon_type": "Play"
        }],
        "account_id": "User's Account ID"
      }
    }
  }

ビーコンセットを取得する

アカウントのビーコンセットを取得するには、GET次のリクエストを送信します。

レスポンスの例

  [{
      "account_id": "User's Account ID",
      "beacon_set_id": "Beacon set ID1",
      "beacon_urls": [{
      "beacon_url": "https://myserver.com/beaconRX/load",
      "beacon_type": "Load"
    }]
    },
    {
      "account_id": "User's Account ID",
      "beacon_set_id": "Beacon set ID2",
      "beacon_urls": [{
      "beacon_url": "https://myserver.com/beaconRX2/load",
      "beacon_type": "Load"
      },
      {
      "beacon_url": "https://myserver.com/beaconRX2/play",
      "beacon_type": "Play"
      }]
  }]

要求しているユーザーのビーコンセットを取得する

リクエストURLにアカウント ID を含めずに、リクエストユーザーのアカウントのビーコンセットを取得することもできます。

レスポンスの例

  [{
      "account_id": "User's Account ID",
      "beacon_set_id": "Beacon set ID1",
      "beacon_urls": [{
      "beacon_url": "https://myserver.com/beaconRX/load",
      "beacon_type": "Load"
    }]
    },
    {
      "account_id": "User's Account ID",
      "beacon_set_id": "Beacon set ID2",
      "beacon_urls": [{
      "beacon_url": "https://myserver.com/beaconRX2/load",
      "beacon_type": "Load"
      },
      {
      "beacon_url": "https://myserver.com/beaconRX2/play",
      "beacon_type": "Play"
      }]
  }]

IDで設定されたビーコンを取得する

ID によって設定された単一のビーコンを取得するには、GETリクエストを送信します。

レスポンスの例

  {
      "account_id": "User account ID",
      "beacon_set_id": "Beacon set ID",
      "beacon_urls": [{
        "beacon_type": "Load",
        "beacon_url": "https://myserver.com/beaconRX2/load"
    },
    {
      "beacon_type": "Play",
      "beacon_url": "https://myserver.com/beaconRX2/play"
    }]
  }

ビーコンセットの削除

最後に、ビーコンセットを削除するには、DELETEリクエストを送信します。

レスポンスの例

レスポンスは次のようになります。

  {
    "beacon_set_id": "Beacon set ID",
    "deleted": true
  }

付録

以下に、Elemental エンコーダのキューポイント設定のサンプルを示すスクリーンショットを示します。