Get Offers (Node.js)
最終更新日: 2024年7月22日
- トピック:
- APIs/SDKs
作成対象:
- 開発者
説明
getOffers()
を使用して、決定を実行し、Adobe Target からエクスペリエンスを取得します。
メソッド
getOffers
TargetClient.getOffers(options: Object): Promise
パラメーター
options
オブジェクトの構造は次のとおりです。
名前 | タイプ | 必須 | デフォルト | 説明 |
---|---|---|---|---|
リクエスト | オブジェクト | ○ | None | Target 配信 API リクエストに準拠 |
visitorCookie | 文字列 | × | None | ECID (VisitorId) cookie |
targetCookie | 文字列 | × | None | Target cookie |
targetLocationHint | 文字列 | × | None | Target location hint |
consumerId | 文字列 | × | None | Analytics for Target (A4T)ステッチの consumerIds |
CustomerIds | 配列 | × | None | VisitorId 互換フォーマットの顧客 ID |
sessionId | 文字列 | × | None | 複数の Target リクエストのリンクに使用 |
訪問者 | オブジェクト | × | new VisitorId | 外部 VisitorId インスタンスの指定 |
約束
返される Promise
は次の構造になっています。
名前 | タイプ | 説明 |
---|---|---|
request | オブジェクト | Target Delivery API リクエスト |
response | オブジェクト | Target Delivery API response |
visitorState | オブジェクト | Visitor API getInstance() に渡す必要があるオブジェクト |
targetCookie | オブジェクト | Target cookie |
targetLocationHintCookie | オブジェクト | Target location hint cookie |
analyticsDetails | 配列 | Analytics ペイロード(クライアントサイド Analytics を使用する場合) |
responseTokens | 配列 | 応答トークンのリスト。 |
trace | 配列 | すべてのリクエスト mbox/ビューの集計トレースデータ |
status | オブジェクト | 応答のステータスを含むオブジェクト。 |
decisioningMethod | 文字列 | 使用する判定方法を決定します( オンデバイス、サーバーサイド、ハイブリッド) |
データをブラウザーに戻すために使用される targetCookie
および targetLocationHintCookie
オブジェクトは、次の構造を持っています。
名前 | タイプ | 説明 |
---|---|---|
name | 文字列 | cookie 名 |
value | 任意 | Cookie の値。は文字列に変換されます |
maxAge | 数値 | maxAge オプションは、現在の時刻(秒)を基準に有効期限を設定する場合に便利です |
ターゲット応答のステータスを示すために使用される status
オブジェクトは、次の構造を持ちます。
名前 | タイプ | 説明 |
---|---|---|
status | 数値 | HTTP ステータスコード |
message | 文字列 | 応答に関するメッセージ。 例えば、応答が決定されたかどうか オンデバイスまたはサーバーサイドか)を示します |
remoteMbox | 配列 | Decisioning メソッドが on-device の場合、オンデバイスで完全に決定できなかった mbox 名の配列が提供されます。 つまり、Target Delivery API リクエストが必要です。 |
例
Node.js
const TargetClient = require("@adobe/target-nodejs-sdk");
const CONFIG = {
client: "acmeclient",
organizationId: "1234567890@AdobeOrg"
};
const targetClient = TargetClient.create(CONFIG);
const request = {
context: {channel: "web"},
execute: {
mboxes: [{
name: "a1-serverside-ab",
index: 1
}]
}};
const response = await targetClient.getOffers({ request });
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3