Roku 用 Mobile SDK v2.x のセットアップ

前提条件

  • Media Analytics 用の有効な設定パラメーターを取得する

    これらのパラメーターは、Media Analytics アカウントの設定後、Adobeの担当者から取得できます。

  • メディアプレーヤーに次の API を含めます

    • プレーヤーイベントをサブスクライブするための API - メディア SDK では、プレーヤーでイベントが発生する際に、シンプルな API のセットを呼び出す必要があります。
    • プレーヤー情報を提供する API - メディア名や再生ヘッドなどの情報がこれに該当します。

Experience Cloudソリューション用 Roku SDK 2.x を使用すると、BrightScript で記述された Roku アプリケーションを測定し、Audience Management を通じてオーディエンスデータを活用および収集し、ビデオイベントを通じてビデオエンゲージメントを測定できます。

モバイルライブラリ/SDK の実装

  1. ダウンロードした Roku ライブラリをプロジェクトに追加します。

    1. ダウンロードファイルの AdobeMobileLibrary-2.*-Roku.zip には、次のソフトウェアコンポーネントが含まれています。

      • adbmobile.brs:このライブラリファイルは、Roku アプリのソースフォルダーに含まれています。

      • ADBMobileConfig.json:アプリ用にカスタマイズされた SDK 設定ファイル。

    2. プロジェクトソースに、ライブラリファイルと JSON 設定ファイルを追加します。

      Mobile の設定に使用する JSON には、Adobe分析用の専用のキー ( mediaHeartbeat. メディア分析の設定パラメーターは、ここに属しています。

      ヒント

      サンプルの ADBMobileConfig JSON ファイルがパッケージに付属しています。設定については、アドビの担当者にお問い合わせください。

      次に例を示します。

      {
        "version":"1.0",
        "analytics":{
          "rsids":"",
          "server":"",
          "charset":"UTF-8",
          "ssl":true,
          "offlineEnabled":false,
          "lifecycleTimeout":30,
          "batchLimit":50,
          "privacyDefault":"optedin",
          "poi":[ ]
      },
      "marketingCloud":{
        "org":""
      },
      "target":{
        "clientCode":"",
        "timeout":5
      },
      "audienceManager":{
        "server":""
      },
      "acquisition":{
        "server":"example.com",
        "appid":"sample-app-id"
      },
      
      "mediaHeartbeat":{
         "server":"example.com",
         "publisher":"sample-publisher",
         "channel":"sample-channel",
         "ssl":true,
         "ovp":"sample-ovp",
         "sdkVersion":"sample-sdk",
         "playerName":"roku"
         }
      }
      
      設定パラメーター 説明
      server バックエンドのトラッキングエンドポイントの URL を表す文字列。
      publisher コンテンツパブリッシャーの一意の ID を表す文字列。
      channel コンテンツ配信チャネルの名前を表す文字列。
      ssl SSL をトラッキングコールに使用するかどうかを示すブール値。
      ovp ビデオプレーヤープロバイダーの名前を表す文字列。
      sdkversion 現在のアプリケーションまたは SDK のバージョンを表す文字列。
      playerName プレーヤーの名前を表す文字列。
      重要

      mediaHeartbeat を誤って設定した場合、メディアモジュール(VHL)がエラー状態になり、トラッキングコールの送信が中止されます。

  2. Experience Cloud 訪問者 ID を設定します。

    Experience Cloud 訪問者 ID サービスは、Experience Cloud ソリューション全体に汎用の訪問者 ID を提供します。訪問者 ID サービスは、ビデオイベントや他のイベント統合に必要なMarketing Cloudです。

    ADBMobileConfig 設定ファイルに marketingCloud 組織 ID が含まれていることを確認します。

    "marketingCloud": {
        "org": "YOUR-MCORG-ID"
    }
    

    Experience Cloud 組織 ID は、Adobe Experience Cloud 内の各クライアント企業を一意に識別するもので、016D5C175213CCA80A490D05@AdobeOrg のようになります。

    重要

    @AdobeOrg」が含まれている必要があります。

    設定が完了すると、Experience Cloud 訪問者 ID が生成され、すべてのヒットに含まれます。customautomatically-generated などの他の訪問者 ID は、引き続きヒットごとに送信されます。

    Experience Cloud 訪問者 ID サービスメソッド

    ヒント

    Experience Cloud 訪問者 ID メソッドのプレフィックスは visitor です。

    メソッド 説明
    visitorMarketingCloudID 訪問者 ID サービスから Experience Cloud 訪問者 ID を取得します。

    ADBMobile().visitorMarketingCloudID()
    visitorSyncIdentifiers Experience Cloud 訪問者 ID を使用して、各訪問者に関連付けることのできる追加の顧客 ID を設定できます。訪問者 API は、同じ訪問者に対して複数の顧客 ID と、異なる顧客 ID の範囲を区別するための顧客タイプ識別子を受け取ります。このメソッドは、setCustomerIDs に対応します。例:

    identifiers={}
    identifiers["idType"]="idValue"
    ADBMobile().visitorSyncIdentifiers(identifiers)
    setAdvertisingIdentifier SDK で広告(RIDA)用に Roku ID を設定するために使用されます。例:

    ADBMobile().setAdvertisingIdentifier(
      "<sample_roku_identifier_for_advertising>")


    Roku SDK getRIDA() API を使用して、広告(RIDA)用の Roku ID を取得します。
    getAllIdentifiers Analytics、訪問者、Audience Manager、カスタム識別情報など、SDK に保存されているすべての識別情報のリストを返します。

    identifiers = ADBMobile().getAllIdentifiers()

    その他のパブリック API

    DebugLogging

    メソッド 説明
    setDebugLogging SDK のデバッグログを有効または無効にするために使用します。

    ADBMobile().setDebugLogging(true)
    getDebugLogging デバッグログが有効になっている場合は true を返します。

    isDebugLoggingEnabled = ADBMobile().getDebugLogging()

    PrivacyStatus

    定数 説明
    PRIVACY_STATUS_OPT_IN setPrivacyStatus を呼び出してオプトインする際に渡す定数。

    optInString = ADBMobile().PRIVACY_STATUS_OPT_IN
    PRIVACY_STATUS_OPT_OUT setPrivacyStatus を呼び出してオプトアウトする際に渡す定数。

    optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUT
    メソッド 説明
    setPrivacyStatus SDK のプライバシーステータスを設定します。

    ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)
    getPrivacyStatus SDK に設定されている現在のプライバシーステータスを取得します。

    privacyStatus = ADBMobile().getPrivacyStatus()
    重要

    SDK が ping を正しく送信するよう、250 ミリ秒ごとにメインイベントループで processMessages 関数と processMediaMessages 関数を呼び出すようにします。

    メソッド 説明
    processMessages 処理する Analytics イベントを SDK に渡します。

    ADBMobile().processMessages()
    processMediaMessages 処理するメディアイベントを SDK に渡します。

    ADBMobile().processMediaMessages()

このページ