setAudience
setAudience メソッドを使用して、訪問者のオーディエンス ID とレベルを設定できます。
function callSetAudience(commandsToExecute, callback) {
var ssId = document.getElementById('sa_sessionId').value;
var audId = document.getElementById('sa_audienceId').value;
var audLevel = document.getElementById('sa_audienceLevel').value;
var params = document.getElementById('sa_parameters').value;
InteractAPI.setAudience(ssId, getNameValuePairs(audId),audLevel,
getNameValuePairs(params), callback);
}
sessionID - セッション ID を識別する文字列。
audienceID: オーディエンス ID を定義する NameValuePairImpl オブジェクトの配列。
audienceLevel - オーディエンス・レベルを定義する文字列。
parameters: setAudience を使用して渡す必要のあるパラメーターを識別する NameValuePairImpl オブジェクト。これらの値はセッション・データに格納され、セグメンテーションに使用できます。
プロファイルのすべての列に値が必要です。これは、対話式チャネルおよびリアルタイム・データ用に定義されたすべてのテーブルのすべての列のスーパーセットです。startSession または postEvent を使用してすべてのセッション・データを既に追加済みの場合は、新しいパラメーターを送信する必要はありません。
- callback - メソッドが成功した場合、コールバック関数は onSuccess を呼び出します。メソッドが失敗した場合、コールバック関数は onError を呼び出します。
setAudience メソッドは、再セグメンテーションをトリガーします。getOffers メソッドは、実行する前に、再セグメンテーションが完了するまで待機します。したがって、getOffers 呼び出しの直前に setAudience メソッドを呼び出す場合は、遅延が生じる可能性があります。
setAudience メソッドは、オーディエンス ID のプロファイル・データもロードします。setAudience メソッドを使用して、startSession メソッドでロードされる同じプロファイル・データを強制的に再ロードすることができます。
setAudience メソッドは、既存のセッションでホワイトリストとブラックリストのテーブルを再ロードします。既存のセッションでホワイトリスト・テーブルとブラックリスト・テーブルを再ロードするには、setAudience メソッドに UACIPurgePriorWhiteListOnLoad パラメーターおよび UACIPurgePriorBlackListOnLoad パラメーターを指定して使用します。
デフォルトでは、setAudience メソッドが呼び出されると、ブラックリストのすべての内容が削除されます。次に示すように、UACIPurgePriorWhiteListOnLoad および UACIPurgePriorBlackListOnLoad パラメーターを setAudience 呼び出しに設定することができます。
UACIPurgePriorBlackListOnLoad= 0 を設定すると、ホワイトリスト・テーブルのすべての内容が保持されます。
- UACIPurgePriorWhiteListOnLoad= 1 を設定すると、そのテーブルの内容は削除され、そのオーディエンス ID のホワイトリストまたはブラックリストの内容がデータベースから読み込まれます。読み込みが完了すると、再セグメンテーションが開始します。
戻り値
ランタイム・サーバーは、以下の属性が設定されたレスポンス・オブジェクトを使用して setAudience に応答します。
- AdvisoryMessages
- ApiVersion
- OfferList
- プロファイル
- セッション ID
- StatusCode