服務器端廣告 (SSAI) 和 Brightcove Player 的開放式衡量

在本主題中，您將了解如何將 iab Open Measurement SDK 與 Brightcove Player 的服務器端廣告插入 (SSAI) 插件結合使用。

概覽

這打開測量SDK對於網絡視頻可以與videojs-ssai允許 IAB 合作夥伴和廣告供應商“第三方”使用標準化 API 訪問創意績效衡量數據的插件。

SSAI 插件包括一個選擇加入功能集，該功能集使用用戶導入的 VAST 廣告驗證數據和 Open Measurement (OM) 服務/客戶端腳本來管理實時或 VOD 內容播放期間的客戶端會話和 OM 廣告生命週期事件。

需求

SSAI 的 Open Measurement 會話功能需要以下內容：

  • 積極加入IAB 技術實驗室用於組織名稱空間註冊和訪問 OM SDK 文件
  • 訪問和直接託管以下內容的能力：
    • omweb-v1.js服務腳本
    • omid-session-client-v1.js session client（IAB提供的部分Web Video OM SDK文件）
    • 可選地，如果使用域訪問模式，omloader-v1.html也需要
  • 必須使用所需選項在播放器上初始化 SSAI 插件
  • VMAP/VAST XML 必須包含AdVerifications標籤和嵌套內容
  • Brightcove Player SSAI 插件 v1.14.0 或更高版本
  • Brightcove Player v6.57.2 或更高版本

入門

啟用 OM 功能videojs-ssai插件與常規 SSAI 實現幾乎相同（並積極利用）。

要啟用 OM 功能，請執行以下步驟：

  1. 回顧使用 Brightcove Player 實施服務器端廣告文檔。

  2. 初始化 SSAI 插件時，必須按如下方式設置 OM 選項：

    • SSAI enableOM選項必須設置為 true。
    • omParams.partnerName必須作為組織的 IAB 名稱空間提供。
    • omParams.partnerName必須作為應用程序版本提供。
    • omParams.accessMode是可選的，但如果未提供，會話客戶端將默認為受限訪問模式。

    有關詳細信息，請參閱開放測量的 SSAI 選項部分。

    可以使用以下任一方法使用 Brightcove Player 配置將這些選項傳遞給插件：

  3. 添加domain訪問模式。（選修的）

    這domain訪問模式參數將導致導入的 OM 服務腳本查找omloader-v1.html文件在以下相對目錄路徑中：

    .well-known/omid/omloader-v1.html

    如果該特定路徑中缺少該文件，則 OM 會話客戶端將無法啟動。

    有關詳細信息，請參閱針對發布商的有關訪問模式的 IAB 文檔 .

使用 Studio 實施 OM

使用 SSAI 為 Open Measurements 配置播放器的最簡單方法是使用 Video Cloud Studio。配置播放器如下：

  1. 在 Video Cloud Studio 中，導航到玩家模塊並創建一個新播放器或找到您要添加插件的播放器。
  2. 按一下播放程式的連結以開啟播放程式的屬性。
  3. 在左側導航中，單擊插件 .

  4. 來自添加插件下拉菜單，選擇自定義插件。

    自訂外掛程式
  5. 在「外掛程式名稱」中輸入ssai。
  6. 在這個網址中，輸入： 
    https://players.brightcove.net/videojs-ssai/1/videojs-ssai.js
  7. 對於 CSS 網址，請輸入： 
    https://players.brightcove.net/videojs-ssai/1/videojs-ssai.css

  8. 在選項 (JSON) 部分中，為 OM 選項添加您的值。

    {
  "enableOM": true,
  "omParams": {
    "partnerName": "IAB Partner Name",
    "partnerVersion": "1.0.0",
    "accessMode": "full"
  }
}
  9. 按一下「儲存」。
  10. 要發布播放器，請點擊發布和嵌入>發布更改。

  11. 導入 OM 腳本。

    這omweb-v1.js和omid-session-client-v1.js文件必須在頁面 DOM 中的任何其他腳本標記之前導入。這些可以在本地或通過 CDN 託管。

    範例

    <script src="./omweb-v1.js"></script>
<script src="./omid-session-client-v1.js"></script>
<script src="./video.core.js"></script>
...

使用 JSON 編輯器

或者，您可以使用 Studio 的 JSON 編輯器將 OM 選項添加到已配置 SSAI 插件的播放器。

  1. 在 Video Cloud Studio 中，導航到玩家模塊。
  2. 在左側導航中，單擊JSON 編輯器 .
  3. 在裡面plugins數組，將 OM 選項添加到選項對象。
    4. "options": {
  "enableOM": true,
  "omParams": {
    "partnerName": "IAB Partner Name",
    "partnerVersion": "1.0.0",
    "accessMode": "full"
  }
}
  4. 按一下「儲存」。
  5. 要發布播放器，請點擊發布和嵌入>發布更改。

  6. 導入 OM 腳本。

    這omweb-v1.js和omid-session-client-v1.js文件必須在頁面 DOM 中的任何其他腳本標記之前導入。這些可以在本地或通過 CDN 託管。

    範例

    <script src="./omweb-v1.js"></script>
<script src="./omid-session-client-v1.js"></script>
<script src="./video.core.js"></script>
...

以編程方式實現 OM

您可以使用 Video Cloud Studio 輕鬆地將 OM 功能添加到您的播放器，如上一節所示。如果您喜歡以編程方式執行此操作，請按照下列步驟操作：

  1. 在 Studio 中，導航到媒體模塊並選擇一個視頻。
  2. 在頂部菜單中，單擊發布和嵌入 .
  3. 在裡面複製代碼部分，複製先進的播放器嵌入代碼。

  4. 修改高級播放器嵌入代碼以包含 SSAI 插件和 OM 選項。

    <script>
  videojs.getPlayer('myPlayerID').ready(function() {
    var myPlayer = this;
    myPlayer.ssai({
      enableOM: true,
      omParams: {
        partnerName: 'IAB Partner Name',
        partnerVersion: '1.0.0',
        accessMode: 'full'
      });
  });
</script>

  5. 導入 OM 腳本。

    這omweb-v1.js和omid-session-client-v1.js文件必須在頁面 DOM 中的任何其他腳本標記之前導入。這些可以在本地或通過 CDN 託管。

    範例

    <script src="./omweb-v1.js"></script>
<script src="./omid-session-client-v1.js"></script>
<script src="./video.core.js"></script>
...

開放測量的 SSAI 選項

選項可以在初始化時傳遞給 SSAI 插件。這倆enableOM和omParams啟動 OM 會話需要選項。

enableOM

如果true（並且已成功導入必要的 Open Measurement SDK 腳本），該插件將使用來自omParams對象啟動 OM 管理器並創建新的 OM 會話客戶端。

範例

"enableOM": true

omParams

描述啟動 Open Measurement 會話客戶端和 OM 廣告/媒體事件調用所需參數的對象。

  • omParams.partnerName

    合作夥伴名稱字符串。這是基於 IAB 合作夥伴關係的組織名稱空間。

  • omParams.partnerVersion

    semver 格式的合作夥伴應用程序版本字符串。

  • omParams.accessMode

    首選訪問模式字符串。值：

    • limited
    • domain
    • creative

    • full

    此處缺少或無法識別的值將導致 OM 客戶端默認為limited /

範例

"omParams": {
  "partnerName": "IAB Partner Name",
  "partnerVersion": "1.0.0",
  "accessMode": "full"
}

播放器和擴展支持

Open Measurement (OM) 管理器使用來自 VAST 的數據AdVerifications通過 OM 會話客戶端在內容播放之前和期間傳達播放器、廣告和媒體事件信息的標籤。

AdVerifications通過提供使用 VAST 3.0 的標籤支持Extensions . AdVerifications標籤應該嵌套在InLine VAST 4.0 及更高版本的元素。

龐大 3.0

VAST/Ad/InLine/Extensions/AdVerifications/...

浩瀚4.0+

VAST/Ad/InLine/AdVerifications/...

樣本AdVerifications標籤和子元素

<AdVerifications>
  <Verification vendor="sample-vendor">
    <JavaScriptResource apiFramework="omid" browserOptional="false">
      <![CDATA[vendor-defined-url/omid-script.js]]>
    </JavaScriptResource>
    <VerificationParameters>
      <![CDATA[vendor-defined-content]]>
    </VerificationParameters>
  </Verification>
</AdVerifications>

SSAI OM 管理器對會話上下文定義的以下項目特別感興趣：

  • vendor屬性
  • JavascriptResource內容
  • VerificationParameters內容

OM 廣告事件

OM 管理器當前監聽並調解以下 Brightcove Player 廣告事件：

Brightcove 玩家活動
事件 描述
ads-ad-started 開始
ads-first-quartile 第一個四分位數
ads-midpoint 中點
ads-third-quartile 第三個四分位數
ads-ad-ended 完成
ads-pause 暫停
ads-play 恢復
adwaiting 緩衝區開始
adplaying 緩衝結束
advolumechange 播放器音量變化
ads-ad-skipped 跳過

注意事項

以下說明適用於 Open Measurement 集成：

  • OM 服務和管理器都希望 VAST 數據包含AdVerifications元素。如果內聯廣告的元素不存在，則 OM 會話客戶端將跳過它。
  • OM 經理將印像類型設置為loaded（“集成正在使用依賴下載的標準”）以匹配廣告展示的預期玩家定義。
  • IAB 建議不要嘗試將omweb服務腳本。它必須使用腳本標籤導入。

變更記錄檔

見SSAI 插件發行說明 .

有關歷史發行說明，請參閱更新日誌在這裡 .