日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。 英語版を表示
メインコンテンツまでスキップ

Log Events

Log Events APIを使用すると、ユーザーイベントとプロパティをAuxiaにリアルタイムで送信できます。

このAPIを通じて送信されたイベントは、トリートメントのターゲティング、適格性評価、およびパーソナライゼーションに使用されます。

備考

Log Events用のAPIキーは、他のAuxia APIとは別のものです。Log Events APIキーを取得するには、Auxiaまでお問い合わせください。

API定義

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

Path Parameters

NameTypeDescription
api-keyString

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

Headers

NameTypeDescription
x-api-keyString

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

Content-TypeStringapplication/json

リクエストボディ(Raw)

{
"projectId": "1250",
"userId": "user_12345",
"events": [
{
"eventName": "button_click",
"insertId": "evt_67890",
"eventProperties": {
"button_name": {
"stringValue": "submit_button"
},
"clicks_count": {
"longValue": "1"
}
},
"userProperties": {
"subscription_tier": {
"stringValue": "premium"
},
"is_active": {
"booleanValue": true
}
},
"clientEventTimestamp": "2025-10-01T17:20:00Z",
"sessionId": "session_abc123",
"country": "US",
"region": "CA",
"city": "San Francisco",
"deviceId": "device_xyz789",
"appVersionId": "1.2.3"
}
]
}

curlの例

curl --location --request POST 'https://apis.auxia.io/v1/LogEvents' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
"projectId": "1250",
"userId": "user_12345",
"events": [
{
"eventName": "button_click",
"insertId": "evt_67890",
"eventProperties": {
"button_name": {
"stringValue": "submit_button"
}
},
"clientEventTimestamp": "2025-10-01T17:20:00Z"
}
]
}'

レスポンス

{ }

スキーマリファレンス

リクエスト

各リクエストには、単一ユーザーのイベントを含める必要があります。

NameData TypeRequired?Description
projectIdStringRequiredAuxiaのプロジェクトIDです。特定の顧客に対して、常に同じ値を使用してください。
userIdStringRequiredユーザーの一意の識別子です。このIDは、Auxia全体のイベントや属性と結合できます。
eventsArray of ExternalEventRequiredユーザーの1つ以上のイベントです。以下のExternalEventを参照してください。

ExternalEvent

NameData TypeRequired?Description
eventNameStringRequiredイベントの種類を識別する名前です(例: button_clickpage_viewpurchase)。
clientEventTimestampString (ISO 8601)Requiredクライアントでイベントが発生したタイムスタンプです。形式: 2025-10-01T17:20:00Z
insertIdStringOptionalこのイベントの一意の識別子です。Auxiaはこれを使用して同一ユーザーのイベントを重複排除します。正確に1回の処理を保証するために推奨されます。
eventPropertiesMap<String, PropertyValue>Optionalイベントに関連するデータを表すキーと値のペアです。サポートされる値の型については、以下のPropertyValueを参照してください。
userPropertiesMap<String, PropertyValue>Optionalユーザーに関連するデータを表すキーと値のペアです。これらはAuxia内のユーザーのプロファイル属性を更新します。
serverReceivedTimestampString (ISO 8601)Optionalサーバーがイベントを受信したタイムスタンプです。バックエンドからイベントが転送される場合に有用です。
preLoginTempUserIdStringOptionalサインアウト状態のユーザーの識別子です。サインアウトとサインイン間のユーザーアクティビティを統合するために使用されます。
sessionIdStringOptional単一ユーザーセッションの一意の識別子です。
countryStringOptionalユーザーの国です(例: USJP)。
regionStringOptionalユーザーの地域です(例: CANY)。
cityStringOptionalユーザーの都市です(例: San Francisco)。
ipAddressStringOptionalユーザーのIPアドレスです。
deviceIdStringOptionalユーザーのデバイスの一意の識別子です。
appVersionIdStringOptionalイベントを生成したアプリのバージョンです(例: 1.2.3)。

PropertyValue

各プロパティ値には、以下のいずれか1つの型を正確に含める必要があります:

注記

longValueは、精度を保持するためにJSONでは文字列としてシリアライズされます(例: 1ではなく"1")。これは64ビット整数に対する標準的なprotobuf JSONシリアライゼーションの動作です。

NameData TypeDescription
longValueInt64整数値です。
doubleValueDouble浮動小数点値です。
stringValueString文字列値です。
booleanValueBooleanブール値です(trueまたはfalse)。
timestampValueString (ISO 8601)タイムスタンプ値です。

レスポンス

空のレスポンス({ })は、リクエストが正常に完了したことを示します。

失敗した場合、標準のHTTPステータスコードとエラーの説明が返されます。

Status CodeDescription
400Bad Request -- 必須フィールドが不足しているか、データ形式が無効です。
401Unauthorized -- APIキーが無効または未設定です。
500Internal Server Error -- 予期しないエラーが発生しました。リクエストを再試行してください。

使用上の注意

  • このAPIはリアルタイムのユーザー単位イベント取り込み用に設計されています。各リクエストには、単一ユーザーのイベントを含める必要があります。
  • 最良の結果を得るために、できるだけリアルタイムに近い形でイベントを送信してください。
  • 失敗したリクエストを再試行する際に、べき等なイベント配信を保証するためにinsertIdを使用してください。
  • イベントと共に送信されたuserPropertiesは、Auxia内のユーザーのプロファイルを更新し、トリートメントのターゲティングやパーソナライゼーションに利用できるようになります。