RankRequest interface
プロパティ
| actions | Personalizer サービスが選択できる一連のアクション。 セットには、50 個を超えるアクションを含めてはなりません。 アクションの順序はランクの結果には影響しませんが、順序は、アプリケーションがそれらを表示するために使用したシーケンスと一致する必要があります。 配列内の最初の項目は、オフライン評価の基準項目として使用されます。 |
| context |
辞書の辞書として Personalizer に使用されるコンテキストの機能。 これはアプリケーションによって決定され、通常は現在のユーザー、デバイス、プロファイル情報、時間と日付に関する集計データなどに関する機能が含まれます。機能には、個人を特定できる情報 (PII)、一意の UserID、または正確なタイムスタンプを含めてはなりません。 |
| defer |
ランク結果の rewardActionId がユーザーに表示されていることが確実な場合は false を送信します。したがって、Personalizer は Reward 呼び出しを受け取ります。それ以外の場合は、既定の Reward がイベントに割り当てられます。 ユーザーがランク結果に指定されたアクションを表示しない可能性がある場合は true を送信します (たとえば、ページが後でレンダリングされるため、またはランクの結果が後でコードによってオーバーライドされる可能性があります)。 イベント出力がユーザーに表示される場合は、Activate イベント API を呼び出す必要があります。それ以外の場合、Rewards は無視されます。 |
| event |
必要に応じて、この Rank イベントを一意に識別する eventId を渡します。 null の場合、サービスは一意の eventId を生成します。 eventId は、この要求を報酬に関連付けるだけでなく、Personalizer 呼び出しを行うときに擬似ランダム ジェネレーターをシード処理するために使用されます。 |
| excluded |
ランク付けから除外するアクション ID のセット。 Personalizer は、オフライン評価を実行するときに、配列内の最初の除外されていない項目をベースライン アクションと見なします。 |
プロパティの詳細
actions
Personalizer サービスが選択できる一連のアクション。 セットには、50 個を超えるアクションを含めてはなりません。 アクションの順序はランクの結果には影響しませんが、順序は、アプリケーションがそれらを表示するために使用したシーケンスと一致する必要があります。 配列内の最初の項目は、オフライン評価の基準項目として使用されます。
actions: RankableAction[]プロパティ値
contextFeatures
辞書の辞書として Personalizer に使用されるコンテキストの機能。 これはアプリケーションによって決定され、通常は現在のユーザー、デバイス、プロファイル情報、時間と日付に関する集計データなどに関する機能が含まれます。機能には、個人を特定できる情報 (PII)、一意の UserID、または正確なタイムスタンプを含めてはなりません。
contextFeatures?: Record<string, unknown>[]プロパティ値
Record<string, unknown>[]
deferActivation
ランク結果の rewardActionId がユーザーに表示されていることが確実な場合は false を送信します。したがって、Personalizer は Reward 呼び出しを受け取ります。それ以外の場合は、既定の Reward がイベントに割り当てられます。 ユーザーがランク結果に指定されたアクションを表示しない可能性がある場合は true を送信します (たとえば、ページが後でレンダリングされるため、またはランクの結果が後でコードによってオーバーライドされる可能性があります)。 イベント出力がユーザーに表示される場合は、Activate イベント API を呼び出す必要があります。それ以外の場合、Rewards は無視されます。
deferActivation?: booleanプロパティ値
boolean
eventId
必要に応じて、この Rank イベントを一意に識別する eventId を渡します。 null の場合、サービスは一意の eventId を生成します。 eventId は、この要求を報酬に関連付けるだけでなく、Personalizer 呼び出しを行うときに擬似ランダム ジェネレーターをシード処理するために使用されます。
eventId?: stringプロパティ値
string
excludedActions
ランク付けから除外するアクション ID のセット。 Personalizer は、オフライン評価を実行するときに、配列内の最初の除外されていない項目をベースライン アクションと見なします。
excludedActions?: string[]プロパティ値
string[]
