日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。
ほとんどのサーフェス(表示面)では、この方法は不要です。Auxiaコンソールで見た目を管理するでは、サイト側のコードは
Auxia.initialize() のみです。どちらの方式も同じスクリプトを使用し、同じプロジェクト内でサーフェスごとに併用できます。目次
- クイックスタート
- インストール
- 初期化
- SDKメソッドの概要
- メソッド1:fetchAndRenderTreatments
- メソッド2:getTreatments
- コンテキスト属性
- 完全な例
- エラーハンドリング
クイックスタート
Auxiaのトリートメントをページにレンダリングするための最小限の例です。各部分の詳細は、以降のセクションで説明します。インストール、初期化、SDKメソッドの各要素については、以降のセクションで順を追って説明します。
インストール
HTMLページにAuxia SDKスクリプトを追加します。Auxiaオブジェクトが利用できるようになります。
前提条件
導入する前に、以下をご用意ください。- Auxiaから提供されたAPIキー
- Auxiaコンソールで確認できるプロジェクトID(Project ID)
- Auxiaコンソールで設定されたサーフェス(例:
HOME_PAGE、CHECKOUT_BANNER)
初期化
SDKメソッドを呼び出す前に、認証情報を使って初期化する必要があります。設定オプション
ユーザーIDの更新
初期化時にユーザーIDが利用できない場合(例:ページ読み込み後にユーザーがログインする場合)、後から更新できます。SDKメソッドの概要
Auxia SDKには、トリートメントを取得するための2つのメソッドが用意されています。
どちらのメソッドも、ほぼ同じパラメーターを受け付けます。主な違いは、
fetchAndRenderTreatments()では各トリートメントのレンダリング先を指定する必要があるのに対し、getTreatments()はトリートメントのデータを返すだけという点です。
メソッド1:fetchAndRenderTreatments
Auxiaからのトリートメントの取得とページへのレンダリングを、SDKに自動で行わせたい場合に使用します。このメソッドはPromise<void>を返し、トリートメントはDOMに直接レンダリングされます。
レンダラー設定各サーフェスのレンダラーはAuxiaが設定します。サーフェスのレンダラーの設定や変更については、Auxia担当者にお問い合わせください。
基本的な使い方
リクエストパラメーター
サーフェスリクエストパラメーター
surfaceRequests配列内の各オブジェクトには以下を含める必要があります。
ポップアップやモーダルとして設定されたサーフェスの場合、
surfaceHtmlElementIdにはプレースホルダーの値(例:"popup-surface")を使用できます。SDKが新しいDOM要素を作成し、既存のコンテンツの上にレンダリングするためです。サーフェスのポップアップまたはモーダルのレンダラーの設定については、Auxia担当者にお問い合わせください。HTMLの設定
ページには、surfaceHtmlElementIdの値と一致するIDを持つコンテナ要素が必要です。
複数サーフェスの取得
1回の呼び出しで複数のサーフェスのトリートメントをリクエストできます。コンテキスト属性の追加
パーソナライズの精度を高めるために、追加のコンテキストを渡せます。fetchAndRenderTreatmentsの完全な例
メソッド2:getTreatments
トリートメントのレンダリング方法を完全に制御したい場合に使用します。SDKはトリートメントを取得してデータとして返すため、独自のUIを構築できます。基本的な使い方
リクエストパラメーター
サーフェスリクエストパラメーター
fetchAndRenderTreatmentsとは異なり、レンダリングはサイト側で行うため、surfaceHtmlElementIdは不要です。レスポンスの構造
このメソッドは、以下の値で解決されるPromiseを返します。トリートメントオブジェクトのプロパティ
コンテンツフィールド
各トリートメントにはcontentFieldsが含まれます。これは、Auxiaコンソールで設定した名前と値のペアの配列です。主なフィールドは次のとおりです。
コンテンツフィールドの操作
カスタムレンダリングの例
getTreatments を使用する場合、インタラクションの記録はサイト側で行う必要があります。トリートメントが表示されたら VIEWED、クリックされたら CLICKED、閉じられたら DISMISSED を記録してください。
コンテキスト属性
コンテキスト属性を使用すると、ユーザー、セッション、ページのコンテキストに関する追加情報を渡して、トリートメントのパーソナライズの精度を高められます。これらの呼び出しでは、渡した
contextualAttributes 配列がそのまま送信され、setContextualAttributes() で設定した値はAuxiaコンソールで管理するサーフェスにのみ適用されます。Auxiaがキーを使用するのは、プロジェクトのデータフィールドとして登録されている場合のみです。サポートされる属性の型
タイムスタンプは
timestampValue に Date で指定します。SDKはISO-8601形式の文字列として送信します。ミリ秒のフィールドはありません。timestampMillisecondsValue で送信した値はサーバーで読み取られません。
よく使用されるコンテキスト属性
以下は、よく使用されるコンテキスト属性の例です。使用例
完全な例
例1: バナー付きの基本ページ
例1: バナー付きの基本ページ
例2: ユーザー認証フロー
例2: ユーザー認証フロー
例3: getTreatmentsによるカスタムレンダリング
例3: getTreatmentsによるカスタムレンダリング