サーフェス - Auxia Docs

日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。

サーフェス とは、トリートメントが表示される場所を定義する概念である。ユーザーがトリートメントを受信する画面・ページ・接点を指定する。

サーフェスの識別とAPIでの利用方法

サーフェスはAPIリクエスト内で識別子として指定する。識別子は SCREAMING_SNAKE_CASE（例：HOME_SCREEN）で定義される。各トリートメントタイプは表示可能なサーフェスを定義する。APIリクエスト時にサーフェスを指定することで、配信対象のトリートメントが決定される。

{
    "userId": "USER_ID",
    "surfaces": [
        {
            "surface": "HOME_SCREEN",
            "maximumTreatmentCount": 1
        }
    ]
    // ... 追加フィールドについては Get Treatments API リファレンスの完全なリクエスト構造を参照してください
}

設定

サーフェスは「設定（Configuration）＞UIレイアウト（UI Layout）＞サーフェス（Surfaces）」で作成・管理する。設定には管理者権限が必要である。新規作成や変更が必要な場合は、管理者に問い合わせる。

サーフェスの例

サーフェス名	主な用途
`HOME_SCREEN`	ウェルカム表示、プロモーション
`PRODUCT_DETAIL_PAGE`	アップセル、レコメンド表示
`CHECKOUT_PAGE`	割引提示、カート回復
`SEARCH_RESULTS`	検索結果の強調表示
`SETTINGS`	アップグレード促進、機能案内

関連コンセプト

トリートメント — サーフェスに紐づいて配信される
トリートメントタイプ — 表示可能なサーフェスを定義
配信先 — アプリ外チャネルの配信を担当

操作ガイド： Configuration