Home/Log Treatment Interactions

Log Treatment Interactions

このAPIを使用すると、Auxiaを通じて配信するタッチポイントに対してユーザーがどのようにエンゲージメントしているかをチームで監視できます。

API定義

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

Path Parameters

Name	Type	Description
api-key	String	Auxiaを使用する各プロジェクトまたは企業に発行される文字列のAPIキーです。このキーには、このAPIを呼び出す権限が必要です。リクエストパラメータまたはヘッダーのいずれかに設定できます。

Headers

Name	Type	Description
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で複数回呼び出すことができます。

Name	Data Type	Required?	Description
projectId	String	Required	特定の顧客のプロジェクトに対して、常に同じ値を使用してください。
userId	string	Required	インタラクションを記録するユーザーの一意のIDです。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。
treatmentTrackingId	String	Required	getTreatments APIから返された各トリートメントに対して取得される一意のIDです。フィードバックループを完成させるために、このAPIに渡すことができます。
treatmentId	string	Required	getTreatments APIから返された、インタラクションを記録するトリートメントの一意のIDです。フィードバックループを完成させるために、このAPIに渡すことができます。Treatment IDはGetTreatments APIから返されたトリートメントとの効率的なマッチングに使用されます。ただし、このIDの受け渡しが複雑になる場合は、Auxiaに相談してオプションにすることも可能です。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。
surface	string	Required	トリートメントがレンダリングされるサーフェスの名前です。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。
interactionType	String	Required	インタラクションの種類を指定します。サポートされる値: VIEWED、CLICKED、SNOOZED、DISMISSED、CTA_COMPLETED、SWIPE
interactionTimeMicros	Int64	Required	インタラクションが発生した時刻を示します。タイムスタンプがアナリティクスイベント（例: Amplitude、Firebaseなど）で記録されたタイムスタンプと一致していることを確認してください。これはUnixエポック後のUTC時間のマイクロ秒数を表します。
actionName	String	Optional	ユーザーのタップ/クリック/スワイプに関連するアクションを示します。

レスポンス

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