Get Treatments（トリートメント取得API）

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

API定義

POST https://apis.auxia.io/v1/GetTreatments

パスパラメーター

名前	型	説明
api_key	String	Auxiaを利用するプロジェクトまたは企業ごとに発行される、文字列形式のAPIキーです。リクエストパラメーターとヘッダーのどちらかに設定できます。

ヘッダー

名前	型	説明
x-api-key	String	Auxiaを利用するプロジェクトまたは企業ごとに発行される、文字列形式のAPIキーです。このAPIキーには、このAPIを呼び出す権限が必要です。リクエストパラメーターとヘッダーのどちらかに設定できます。

ステータスコード

200: OK。トリートメントが正常に返されます。
403: Forbidden。正しいAPIキー、projectId、その他のパラメーターがリクエストに含まれていることを確認してください。

エラーレスポンスの形式、すべてのステータスコード、リトライのガイダンスについてはエラーを参照してください。

リクエストボディ（Raw）

{
    "projectId": "1250",
    // This is an example user ID. Actual user ID can be obfuscated. See
    // documentation below
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "contextualAttributes": [
        {
            "key": "profile_id",
            "stringValue": "pr1234"
        },
        {
            "key": "last_action",
            "stringValue": "button_x_clicked"
        }
    ],
    "surfaces": [
        {
            "surface": "HOME_SCREEN",
            "maximumTreatmentCount": 1
        },
        {
            "surface": "CART_SCREEN",
            "maximumTreatmentCount": 3,
            "minimumTreatmentCount": 1
        }
    ],
    // Optional. Defaults to "en".
    "languageCode": "en"
}

curlの例

curl --location --request POST 'https://apis.auxia.io/v1/GetTreatments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk79JN284V",
    "contextualAttributes": [
        {
            "key": "profile_id",
            "integerValue": 10
        },
        {
            "key": "last_action",
            "stringValue": "button_x_clicked"
        }
    ],
    "surfaces": [
        {
            "surface": "HOME_SCREEN",
            "maximumTreatmentCount": 1
        },
        {
            "surface": "CART_SCREEN",
            "maximumTreatmentCount": 3,
            "minimumTreatmentCount": 1
        }
    ]
}'

レスポンス

{
   "responseId": "690e24d8-16a6-4518-bf37-09a8f0120dfb",
   "userTreatments": [
       {
           "treatmentId": "6",
           "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
           "rank": "1",
           "treatmentContent": "{ \"title\": \"You have a new message!\", \"description\": \"Learn how our product helps you\", \"cta_name\": \"Learn more\", \"cta_link\": \"/tabs/home/feed\"}",
           "treatmentType": "IN_APP_CONTENT_CARD",
           "surface": "HOME_SCREEN",
           "contentLanguageCode": "en",
       },
       {
           "treatmentId": "4",
           "treatmentTrackingId": "4_690e24d8-16a6-4518-bf37-09a8f0120dfb",
           "rank": "1",
           "treatmentContent": "{ \"title\": \"Check out your trends\", \"description\": \"87% of users found this feature useful\", \"cta_name\": \"View trends\", \"cta_link\": \"/actionscreen\"}",
           "treatmentType": "IN_APP_CONTENT_CARD",
           "surface": "CART_SCREEN",
           "contentLanguageCode": "en",
       },
       {
           "treatmentId": "3",
           "treatmentTrackingId": "3_690e24d8-16a6-4518-bf37-09a8f0120dfb",
           "rank": "2",
           "treatmentContent": "{ \"title\": \"Check leaderboard\", \"description\": \"See your global ranking\", \"cta_name\": \"View leaderboard\", \"cta_link\": \"/leaderboardscreen\"}",
           "treatmentType": "IN_APP_CONTENT_CARD",
           "surface": "HOME_SCREEN",
           "contentLanguageCode": "en",
       }
   ]
}

スキーマリファレンス

リクエスト

名前	データ型	必須／任意	説明
projectId	string	必須	特定のお客様のプロジェクトでは、常に同じ値を使用してください。
userId	string	必須	各ユーザーの一意のIDです。
contextualAttributes	json	任意	アプリのコンテキストから得られる追加属性のセットです（現在の画面、直近のアクション、ユーザーが選択したコンテキストなど）。各コンテキスト属性はキーと値のペアです。含めるべき内容 Auxiaが最後に受け取った値よりも新しい可能性のあるユーザー属性。これにより、最新のシグナルがトリートメント選択のルール処理やMLモデルに反映されます。アプリ内でのユーザーの現在のコンテキストを示すその他のシグナル（`last_button_clicked`や`current_screen_id`など）。同じキーを持つ属性が重複している場合は、例外がスローされます。例 { “key”: “profile_id”, “stringValue”: “pr1234” } { “key”: “profile_id”, “integerValue”: 10 }
surfaces	json	必須	リクエストには少なくとも1つのサーフェスを含める必要があります。各サーフェスには以下が含まれます。 `surface`は、特定のUIコンポーネント、画面（ホーム画面など）、またはユースケース（クーポンなど）に対してトリートメントをリクエストするための、クライアント側で設定するパラメーターです。サーフェス（表示面）の一般的な例は`HOME_SCREEN`や`PURCHASE_SCREEN`です。 `maximumTreatmentCount`（任意）は、指定したサーフェスについてクライアントに返されるトリートメントの最大数です。値が設定されていない場合、デフォルトは1です。 `minimumTreatmentCount`（任意）は、指定したサーフェスについてクライアントに返されるトリートメントの最小数です。このフィールドを設定すると、レスポンスに含まれるトリートメントは0件、または`minimumTreatmentCount`の値以上になることが保証されます。値が設定されていない場合、デフォルトは0です。例 { “surface”: “CAROUSEL”, “maximumTreatmentCount”: 10, “minimumTreatmentCount”: 1 }
languageCode	string	任意	トリートメントのコンテンツに求める言語コードです。形式はIETF BCP 47です。このフィールドを指定しない場合は、デフォルトの言語（en）が使用されます。リクエストされた言語の翻訳がないトリートメントは返されません。
maximumTreatmentCount	int64	任意	クライアントに返されるトリートメントの最大数です。値が設定されていない場合、デフォルトは1です。

レスポンス

名前	データ型	説明
responseId	string	`getTreatments`の呼び出しごとに生成される一意のIDです。レスポンス内の各トリートメントに固有の`UserTreatment.treatmentTrackingId`とは異なり、レスポンス全体に対するグローバルなIDです。十分なフィードバックループを確保するには、レスポンスでトリートメントが0件だった場合を除き、このグローバルなレスポンスIDではなくトリートメントIDが必要です。
userTreatments	json（下記の表を参照）	UIやメッセージ配信システムでレンダリングするために必要な情報を含む、トリートメント（施策）のリストです。

userTreatments

名前	データ型	説明
treatmentId	string	特定のトリートメントを識別する一意のIDです。AuxiaコンソールのOverview（概要）セクションにあるトリートメント（Treatments）でも確認できます。
treatmentTrackingId	string	特定のトリートメントに加えて、そのトリートメントが返されたRPC呼び出しも識別する一意のIDです。
surface	string	リクエストで指定したサーフェスの名前です。このトリートメントをレンダリングする、または使用するサーフェスを示します。
rank	int64	指定したサーフェスにおける、レスポンス内のトリートメントの順位です。Auxiaは、レスポンスを返す前に各ユーザーのトリートメントをランク付けして並べ替えます。
treatmentType	string	コンテンツのレンダリング方法を決めるための、クライアント側で設定するパラメーターです。例：タイトル、テキスト、画像を含むカードをレンダリングする「In App Content Card」や、別のUIコンポーネント用の「Banner」など。
treatmentContent	json	（アプリ内で）表示される、または（メッセージに）含まれるコンテンツです。コンテンツ内のプレースホルダーは、パーソナライズ用のシグナルで置き換えられます。コンテンツの形式は、Treatment Config UIを通じてお客様が管理します。プレーンテキスト、JSON、HTML、JSスニペットなど、クライアントのUIで直接使用できる任意の形式を使用できます。例 `{ “content”: ”{ title: ‘Check out your trends’, description: ‘87% of users found this feature useful’, cta_name: ‘View trends’, cta_link: ‘/actionscreen’ }” }`
contentLanguageCode	string	トリートメントのコンテンツの言語コードです。形式はIETF BCP 47です。

付録

言語と翻訳

in_app_content_cardなどのトリートメントのコンテンツは、他の言語に翻訳できます。翻訳を使用するには、以下のエンドポイントにPOSTする際に、JSONの「language_code」フィールドで言語コードを指定してください。

https://apis.auxia.io/v1/GetTreatments

例

curl --location --request POST 'https://apis.auxia.io/v1/GetTreatments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "contextualAttributes": [
        {
            "key": "profile_id",
            "stringValue": "pr1234"
        },
        {
            "key": "last_action",
            "stringValue": "button_x_clicked"
        }
    ],
    "surfaces": [
        {
            "surface": "HOME_SCREEN",
            "maximumTreatmentCount": 1
        }
    ],
    "languageCode": "vi"
}'

レスポンス

{
    "responseId": "18c7c4b3-2093-494a-9996-94989abac914",
    "userTreatments": [
        {
            "treatmentId": "4",
            "treatmentTrackingId": "4_18c7c4b3-2093-494a-9996-94989abac914",
            "rank": "1",
            "treatmentContent": "... translated content ...",
            "treatmentType": "IN_APP_CONTENT_CARD",
            "surface": "HOME_SCREEN",
            "contentLanguageCode": "vi",
        }
    ]
}

未翻訳の場合

リクエストした言語の翻訳がないトリートメントは返されません。

例

curl --location --request POST 'https://apis.auxia.io/v1/GetTreatments \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "contextualAttributes": [
        {
            "key": "profile_id",
            "stringValue": "pr1234"
        },
        {
            "key": "last_action",
            "stringValue": "button_x_clicked"
        }
    ],
    "surfaces": [
        {
            "surface": "HOME_SCREEN",
            "maximumTreatmentCount": 1
        }
    ],
    "languageCode": "eo"
}' # The language code `eo` is not supported.

レスポンス

{
    "responseId": "e9861c48-f8bf-42dd-a189-a471c35002ad"
}

​API定義

​パスパラメーター

​ヘッダー

​ステータスコード

​リクエストボディ（Raw）

​curlの例

​レスポンス

​スキーマリファレンス

​リクエスト

​レスポンス

​userTreatments

​付録

​言語と翻訳

​例

​レスポンス

​未翻訳の場合

​例

​レスポンス

API定義

パスパラメーター

ヘッダー

ステータスコード

リクエストボディ（Raw）

curlの例

レスポンス

スキーマリファレンス

リクエスト

レスポンス

userTreatments

付録

言語と翻訳

例

レスポンス

未翻訳の場合

例

レスポンス