TVML/TVJS 対応の Adobe Target

.xml ファイルを直接置き換えることで、TVML/TVJS アプリでAdobe Targetを活用できます。 カスタムの ADBTarget XML 要素を使用して、Target コンテンツで置き換えるページの領域を指定します。

重要

TVML ページで ADBTarget 要素を使用する前に、tvOS SDK を使用するように TVML/TVJS アプリを設定する必要があります。詳しくは、「tvOS を使用した Apple TV 実装」を参照してください。

はじめに

  1. Target ロケーションを使用する .xml ファイルを特定します。
  2. ADBTarget 要素を <document> 要素の子としてファイルに追加します。
  3. Target が Mbox ロケーションを見つけられなかったり、タイムアウトした場合は、<ADBTarget> タグと </ADBTarget> タグの間の値がデフォルトコンテンツとして使用されます。

Target の Mbox の設定

Target から返されたコンテンツで、<ADBTarget></ADBTarget> の間のすべてのコンテンツ(両方の ADBTarget タグを含む)を置き換えます。

ヒント

何を置き換えるかを適切に計画する必要があります。

ユースケースには、ラベルの文字列値を置き換えるくらいシンプルなものもあれば、ページ全体を置き換えるくらい複雑なものもあります。

ADBTarget 要素の設定

ADBTarget 要素内で、mbox プロパティに Mbox 名を指定する必要があります。オプションで、カスタムプロパティを customParameterName="customParameterValue" 形式でリクエストに追加できます。

  • mbox

    Mbox ロケーション名。

    • プロパティタイプ:文字列
    • このプロパティが必要です。
  • id

    注文 ID。

    • プロパティタイプ:文字列
    • このプロパティは必須では​ありません
  • total

    注文の合計。

    • プロパティタイプ:文字列
    • このプロパティは必須では​ありません
  • purchasedProductIds

    この注文で購入する製品の ID のコンマ区切りリスト。

    • このプロパティのコードサンプルを次に示します。

      purchasedProductIds="product1,product2,product3" 
      
    • プロパティタイプ:文字列

    • このプロパティは必須では​ありません

  • mboxParameters

    mboxParameters のキーと値のペアのリスト。この文字列の各エントリはセミコロンで区切り、キーと値はコロンで区切ります。

    • このプロパティのコードサンプルを次に示します。

      mboxParameters="mboxparameterKey:mboxParameterValue;mboxParameterKey1:mboxParameterValue1;mboxParameterKey2:mboxParameterValue2"
      
    • プロパティタイプ:文字列

    • このプロパティは必須では​ありません

  • customParameterName

    このプロパティの値は customParameterValue です。

    • プロパティタイプ:文字列
    • このプロパティは必須では​ありません

例 1

以下の例では、ADBTarget ページ内で LandingPage.xml.js 要素を使用して、アラートのコンテンツを置き換えています。

Target の設定

landingPage という名前の Mbox ロケーションがあり、オファーコンテンツが次のように設定されているとします。

<title>My cool landing page</title> 
<description>Thanks for coming to my page</description> 

landingPage.xml.js の設定

  • landingPage.xml.js の設定を次に示します。

    <alertTemplate> 
        <ADBTarget mbox="landingPage">  
            <title>TargetTestPage</title> 
            <description>Load fail or timeout (defaultContent)</description> 
        </ADBTarget>  
    </alertTemplate> 
    
  • Target へのリクエストが成功し、オファーコンテンツが返された場合、ページは次のようになります。

    <alertTemplate> 
        <title>My cool landing page</title> 
        <description>Thanks for coming to my page</description> 
    </alertTemplate>
    
  • Target サーバーに到達できない場合、またはリクエストがタイムアウトした場合、ページは次のようになります。

    <alertTemplate> 
        <title>TargetTestPage</title> 
        <description>Load fail or timeout (defaultContent)</description> 
    </alertTemplate>
    

例 2

以下の例は、カスタムデータを ADBTarget 要素に追加する方法を説明したものです。このメソッドを使用して、Target のこの Mbox ロケーションに対して、条件付きエクスペリエンスとオファーコンテンツを作成できます。

<alertTemplate> 
    <ADBTarget mbox="landingPage" customData="custom data" moreCustomData="more custom data"> 
        <title>TargetTestPage</title> 
        <description>Load fail or timeout (defaultContent)</description> 
    </ADBTarget>  
</alertTemplate>

このページ