ビデオクラウドSSAI広告タグ検証

概要

サーバーサイド広告のデバッグに役立つように、SSAI を使用した動的配信では、広告呼び出しを追跡する API エンドポイントが用意されています。

Video Cloud に保存されている動画コンテンツを使用してサーバーサイド広告をデバッグするには、次の手順に従います。

API パスと承認に関する一般情報を確認します。
広告構成のトレースを実行する

一般的な情報

以下の情報は、すべての SSAI API リクエストに関連します。

ベース URL

SSAI API のベース URL は次のとおりです。

  https://ssai.api.brightcove.com/v1

アカウントパス

いずれの場合も、特定の Video Cloud アカウントに対してリクエストが行われます。したがって、ベース URL には常に、アカウント ID accountsに続く語句を追加します。

  https://ssai.api.brightcove.com/v1/accounts/your account id

認可

API リクエストには、認証ヘッダーが必要です。

  Authorization: Bearer your access token

access_tokenは、Brightcove OAuth サービスから取得する必要がある一時的な OAuth2 アクセストークンです。クライアント資格情報を取得し、アクセストークンを取得する方法の詳細については、ブライトコーブ OAuth の概要を参照してください。

オペレーション

クライアントの資格情報を要求するときは、必要なアカウントアクセスの種類または操作を指定する必要があります。以下は、SSAI API に対して現在サポートされている操作の一覧です。

SSAI データ:
video-cloud/ssai/read
video-cloud/ssai/all

広告設定のトレースを実行する

広告設定のトレースを実行するには、次の手順に従います。

情報を収集する

API リクエストの本文について次の情報を収集します。

[パラメータ]	タイプ	説明
`account_id`	ストリング	ユーザーアカウント ID
`playback_config`	オブジェクト	フィールドは、SSAI API ドキュメントの「設定フィールド詳細」セクションで定義されます。
`title_metadata`	オブジェクト	正しい広告レスポンスを生成するために、コンテンツの長さをシステムに伝えます。たとえば、次のように、コンテンツの長さが1分であることをシステムに通知します。これは、それに応じて広告を挿入するために使用されます。 `"title_metadata": { "duration": "1m" }`
`videocloud_metadata`	オブジェクト	任意。メタデータフィールドを参照するテンプレート変数を使用している場合にのみ必要です。これらは SSAI API ドキュメントの「広告変数」セクションで定義されています。

リクエスト

SSAI 広告設定のトレースを作成します。

方法	役職
URL	https://ssai.api.brightcove.com/v1/accounts/ {account_id} /ssai_debug_vmap/debug.xml
ヘッダー	認証:ベアラaccess_token ( アクセストークンの取得を参照 )
ヘッダー	コンテンツタイプ:アプリケーション/json
サンプルボディ	`{ "playback_config":{ "name": "config_name", "vmap_response_namespace": "config_namespace", "account_id": "account_id", "ad_config": { "enable_ads": true, "expected_ad_response": "dfp_ad_rules", "disable_server_beacons": false, "round_up_cue_points": false, "template_url": { "template": "template_url" } }, "extend_beacon_guard_ttl": false }, "title_metadata":{ "duration": "39s" } }`

応答

レスポンスは、VAST bodyまたは広告サーバーと同等のレスポンスを含む広告サーバー応答で構成されます。

レスポンスの例:

  <?xml version="1.0" encoding="UTF-8" ?>
  <vmap:VMAP xmlns:bc="bc" xmlns:vmap="http://www.iab.net/vmap-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0">
    <vmap:Extensions>
      <bc:Brightcove ttl="1800" contenturi="https://ssaiplayback.us-east-1.prod.boltdns.net/playback/once/v1/hls/v5/clear/1752604059001/debug/debug/195b46a6-f71b-432d-af0a-60c7f2131a7e/debug.m3u8?bc_token=NWIxNmQ4YWFfMzMwMzllMzIwMmZlYjRkNmJhY2ZkMWZiN2Y2NGQwOWVkZTYxYTBiOThhZmEwMTdkZjc5NjEzNGFkZDdiYTFjYw%3D%3D"
      contentlength="39.0000" payloadlength="67.0000" contenttype="application/x-mpegURL"></bc:Brightcove>
      <bc:BrightcoveDebug sessionID="195b46a6-f71b-432d-af0a-60c7f2131a7e"></bc:BrightcoveDebug>
    </vmap:Extensions>
    <vmap:AdBreak breakType="linear" breakId="MidRoll_5_0" timeOffset="00:00:05.0000">
      <vmap:AdSource allowMultipleAds="true" followRedirects="true" id="0">
        <vmap:VASTData>
          <VAST xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <Ad id="2">
              <InLine>
                <AdSystem>Test Ad Server</AdSystem>
                <AdTitle>&#xA; Marketing&#xA;</AdTitle>
                <Description>&#xA; Demo ad number 4&#xA;</Description>
                <Error>&#xA; &#xA;</Error>
                <Creatives>
                  <Creative>
                    <Linear skipoffset="00:00:05">
                      <CreativeExtensions>
                        <CreativeExtension>
                          <BrightcoveForeignKey>2</BrightcoveForeignKey>
                        </CreativeExtension>
                      </CreativeExtensions>
                      <Duration>00:00:12.0000</Duration>
                      <AdParameters>&#xA; &lt;xml&gt;&lt;/xml&gt;&#xA;</AdParameters>
                      <VideoClicks></VideoClicks>
                    </Linear>
                  </Creative>
                </Creatives>
                <Extensions>
                  <Extension>
                    <xml>data</xml>
                  </Extension>
                </Extensions>
              </InLine>
            </Ad>
          </VAST>
        </vmap:VASTData>
      </vmap:AdSource>
    </vmap:AdBreak>
    ...// additional ad breaks
  </vmap:VMAP>

Request2-テンプレート変数を使用する

メタデータ項目を参照するテンプレート変数を使用する SSAI 広告トレースを作成します。

方法	役職
URL	https://ssai.api.brightcove.com/v1/accounts/ {account_id} /ssai_debug_vmap/debug.xml
ヘッダー	認証:ベアラaccess_token ( アクセストークンの取得を参照 )
ヘッダー	コンテンツタイプ:アプリケーション/json
サンプルボディ	{ "playback_config":{ "name": "config_name", "vmap_response_namespace": "config_namespace", "account_id": "account_id", "ad_config": { "enable_ads": true, "expected_ad_response": "dfp_ad_rules", "disable_server_beacons": false, "round_up_cue_points": false, "template_url": { "template": "template_url" } }, "extend_beacon_guard_ttl": false }, "title_metadata":{ "duration": "10s" }, "videocloud_metadata": { "name": "ad_name", "tags": [ "tag1:tag1_value", "tag2:tag2_value" ], "ad_keys":"a=1&b=2", "cue_points": [{ "name":"Pre-roll", "type":"AD", "time":0, "metadata":"type:pre-roll,a=b", }, { "name":"Mid-roll", "type":"AD", "time":10, "metadata":"type=mid-roll,x=y", }] } }

Response2