Log Treatment Interactions（トリートメントインタラクションの記録） - Auxia Docs

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

このAPIを使用すると、Auxiaを通じて配信するタッチポイントにユーザーがどのように反応しているかを把握できます。

API定義

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

パスパラメーター

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

ヘッダー

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

リクエストボディ（Raw）

{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
    "treatmentId": "1250",
    "surface": "HOME_SCREEN",
    "interactionType": "CLICKED",
    "interactionTimeMicros": 1667829258250000,
    "actionName": "Buy Now"
}

curlの例

curl --location --request POST 'https://apis.auxia.io/v1/LogTreatmentInteraction' \
--header 'Content-Type: application/json, x-api-key: ****************' \
--data-raw '{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
    "treatmentId": "1250",
    "surface": "HOME_SCREEN"
    "interactionType": "CLICKED",
    "interactionTimeMicros": 1667829258250000,
    "actionName": "Buy Now"
}'

レスポンス

{ }

スキーマリファレンス

リクエスト

このAPIは、異なるインタラクションや繰り返し発生するインタラクションについて、同じtreatment_tracking_idで複数回呼び出せます。

名前	データ型	必須／任意	説明
projectId	String	必須	特定のお客様のプロジェクトでは、常に同じ値を使用してください。
userId	string	必須	インタラクションを記録するユーザーの一意のIDです。このフィールドは新しく追加されたもので、クライアントが使用を開始するまでは任意です。
treatmentTrackingId	String	必須	getTreatments APIから返される各トリートメント（施策）に付与される一意のIDです。フィードバックループを完結させるために、このAPIに渡します。
treatmentId	string	必須	getTreatments APIから返された、インタラクションを記録するトリートメントの一意のIDです。フィードバックループを完結させるために、このAPIに渡します。トリートメントIDは、GetTreatments APIから返されたトリートメントとの効率的な照合に使用されます。ただし、このIDの受け渡しが難しい場合は、Auxiaにご相談いただくと任意項目にできます。このフィールドは新しく追加されたもので、クライアントが使用を開始するまでは任意です。
surface	string	必須	トリートメントがレンダリングされるサーフェス（表示面）の名前です。このフィールドは新しく追加されたもので、クライアントが使用を開始するまでは任意です。
interactionType	String	必須	インタラクションの種類を指定します。サポートされる値はVIEWED、CLICKED、SNOOZED、DISMISSED、CTA_COMPLETED、SWIPEです。メールのトリートメントでは、次の配信結果の値も使用できます：DELIVERY_SENT、DELIVERED、BOUNCED、HARD_BOUNCED、SOFT_BOUNCED、DROPPED、SPAM_REPORTED、UNSUBSCRIBED、GROUP_UNSUBSCRIBED、GROUP_RESUBSCRIBED。
interactionTimeMicros	Int64	必須	インタラクションが発生した時刻です。アナリティクスのイベント（Amplitude、Firebaseなど）で記録されたタイムスタンプと一致していることを確認してください。値は、Unixエポック（UTC）からの経過マイクロ秒数です。
actionName	String	任意	ユーザーのタップ／クリック／スワイプに関連するアクションを示します。

レスポンス

空のレスポンスは、RPCが正常に完了したことを示します。