Identify API

地域

ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。

このAPIでは、イベント取り込みのホストとしてapi2.amplitude.com（デフォルト）またはapi.eu.amplitude.com（EU）が使用されます。他のAmplitude APIでは、別のホスト名（api.amplitude.com、core.amplitude.com、data-api.amplitude.com、experiment.amplitude.comなど）が使用されます。https://analytics.amplitude.comのホスト名は、アナリティクスWebアプリ（ブラウザーUI）であり、取り込みのエンドポイントではありません。

考慮事項

• まだ追跡していないユーザープロパティを更新できます。 プロパティ値は、ユーザーの次のイベントが発生するまでプラットフォームに適用または表示されません。 詳細については、「ユーザープロパティの適用」を参照してください。
• 更新は遡及的ではなく、将来のイベントにのみ適用されます。
• Amplitudeでは、1秒あたりのイベント数のしきい値を超過するdevice_idsやuser_idsのリクエストをスロットリングします。リクエストがスロットリングされると、HTTPステータスコード「429」が返されます。リクエスト内のすべてのデバイスに対するイベント送信を15秒間停止してからリトライしてください。ステータスコード「429」が表示されなくなるまでリトライを続けます。同じuser_idを使用して複数のデバイスからイベントを同時送信すると、Amplitudeではすべてのデバイスがスロットリングされます。AmplitudeのHTTP V2 APIからのすべてのスロットリングとステータスコードガイダンスは、Identify APIにも適用されます。
• Amplitudeでは、日付を文字列として比較するため、ISO 8601形式（YYYY-MM-DDTHH:mm:ss）を使用します。この形式を使用すると、Webアプリで日付比較を実行できます。たとえば、'2016-01-31' > '2016-01-01'です。 この形式は、'2017-08-07T10:09:08' > '2017-08-07T01:07:00'などの日時値にも適用されます。
• 更新はイベントとしてカウントされないため、Redshiftに表示されません。
• Identify API呼び出しはイベントとしてカウントされないため、APIは「アクティブユーザー」や「新規ユーザー」の定義に影響を与えません。また、呼び出しはAmplitudeの月間イベント数に追加されません。
• 既存の値からuser_idフィールドを変更した場合、Amplitudeでは新規ユーザーが作成されます。 user_idの現行値が「null」の場合、AmplitudeではAmplitudeユーザーが新規作成されません。

リクエスト

POST https://api2.amplitude.com/identify

curl --location --request POST 'https://api2.amplitude.com/identify' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'api_key=<API-KEY>' \
--data-urlencode 'identification=[{"user_id":"value", "user_properties":{"propertyNameToUpdate":"newValue"}}]'

必要なパラメータ

これらのパラメータは、GETリクエスト内のクエリパラメータとして送信するか、POSTリクエスト内の本文パラメータとして送信してください。本文は、form-dataまたはx-www-form-urlencodedにする必要があります。

識別のパラメータキー

「user_properties」でサポートされる操作

user_propertiesフィールドは次の操作をサポートしています。

{
  "$set": {
    "cohort": "Test A"
  },
  "$setOnce": {
    "startDate": "2015-10-01"
  },
  "$add": {
    "friendCount": 3
  },
  "$append": {
    "interests": "Music"
  },
  "$prepend": {
    "sports": "Tennis"
  },
  "$unset": {
    "oldProperty": "-"
  }
}

ステータスコード