Attribution API
モバイル測定パートナーまたはマーケティングプラットフォームから、アトリビューション・キャンペーン・イベントをAmplitudeに送信するには、Attribution APIを使用します。各イベントで、ユーザーはidfa、idfv、adidまたはandroid_app_set_idで識別されるため、Amplitudeはアトリビューションデータを正しいユーザーと照合し、分析全体にそのデータを表示できます。
地域
ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。
このAPIは、api.amplitude.com(デフォルト)またはapi.eu.amplitude.com(EU)を使用します。イベント取り込みでは、多くの場合api2.amplitude.comが使用されます。他のAmplitude APIでは、各プロダクトのドキュメントに記載のとおりcore.amplitude.com``data-api.amplitude.com、またはexperiment.amplitude.comを使用します。https://analytics.amplitude.comのホスト名は、アナリティクスWebアプリ(ブラウザーUI)であり、このエンドポイントではありません。
| データのレジデンシー | ベースURL |
|---|---|
| デフォルト | https://api.amplitude.com |
| 欧州連合 | https://api.eu.amplitude.com |
マッチングと識別子の要件
- Amplitudeでアトリビューションイベントを既存のユーザーと一致させることができない場合、Amplitudeはイベントを最長72時間保持します。一致するユーザーに対して72時間以内にイベントが記録されない場合、Amplitudeはアトリビューションデータを破棄します。
- ほとんどのAmplitudeパートナーにおいて、Amplitudeは広告ID(IDFAまたはADID)またはベンダーID(IDFVまたはアプリセットID)を使用してユーザーとイベントのアトリビューションを行います。これらの識別子をアトリビューションリクエストで送信し、Amplitudeの
idfa、idfv、adidおよびandroid_app_set_idフィールドをアトリビューションIDとして設定します。 - iOS SDKまたはAndroid SDKを使用している場合は、iOS Swift SDKの手順に従って広告IDトラッキングを有効にしてください。JavaScript SDKとReact Native SDKは、広告IDとウェブトラッキングに関して定められたGoogleとAppleのプライバシー規則により、広告IDを自動的に収集することはできません。HTTP APIエンドポイント経由で広告IDを送信することで、Amplitudeはアトリビューションイベントを紐付けることができます。HTTP API V2ドキュメントのキーを参照してください。
アトリビューションイベントを送信する
2つの引数api_keyおよびeventを指定して、POSTリクエストを{{standard_endpoint}}に送信します。
必須引数
| 名前 | 概要 | 例 |
|---|---|---|
api_key | 必須です。 プロジェクトのAPIキーです。 | api_key |
event | 必須です。 イベントを表すリクエストパラメータ(JSON形式)。 | {"event_type":"[YOUR COMPANY] Install", "idfa": "AEBE52E7-03EE-455A-B3C4-E57283966239", "user_properties": {"[YOUR COMPANY] media source": "facebook", "[YOUR COMPANY] campaign": "refer-a-friend"}, "platform": "ios"} |
イベント引数のキー
| キー | 概要 | 例 |
|---|---|---|
event_type | 必須です。 文字列です。 イベント情報です。 [YOUR COMPANY]のように括弧を付けます。 | [YOUR COMPANY] Install |
platform | 必須です。 文字列です。 iosまたはandroidのいずれかです。 | ios |
idfaまたはidfv | iOSでは必須です。 文字列です。 広告主の識別子またはベンダーの識別子です。 iOSデバイス用に少なくとも1つを含める必要があります。 | AEBE52E7-03EE-455A-B3C4-E57283966239 |
adidまたはandroid_app_set_id | Androidには必須です。 文字列です。 Google ADID、アプリセットID、またはAmazonデバイスの場合はAmazon広告ID。Androidデバイス用に少なくとも1つを含める必要があります。 | AEBE52E7-03EE-455A-B3C4-E57283966239 |
android_id | オプションです。文字列です。 (Android)Android ID | AEBE52E7-03EE-455A-B3C4-E57283966239 |
android_app_set_id | オプションです。文字列です。 (Android)AndroidアプリセットID | AEBE52E7-03EE-455A-B3C4-E57283966239 |
user_properties | オプションです。辞書。 アトリビューションプロパティの辞書。[YOUR COMPANY]のように括弧を付けます。 | {"[YOUR COMPANY] media source": "Facebook"} |
time | オプションです。Long型。エポックからのイベントのタイムスタンプ(ミリ秒単位)。 | 1396381378123。 デフォルトはアップロード時刻です。 |
リクエスト例
以下のコードは、iOSでのアトリビューションを示しています。
curl --location --request POST 'https://api.amplitude.com/attribution' \
--data-urlencode 'api_key=123456789' \
--data-urlencode 'event={"event_type":"[YOUR COMPANY] Install", "idfa": "AEBE52E7-03EE-455A-B3C4-E57283966239", "user_properties": {"[YOUR COMPANY] media source": "facebook", "[YOUR COMPANY] campaign": "refer-a-friend"}, "platform": "ios"}'
次のコードは、Androidでのアトリビューションを示しています。
curl --location -g --request POST 'https://api2.amplitude.com/attribution?api_key=123456789&event={"event_type":"[YOUR COMPANY] Install","adid": "AEBE52E7-03EE-455A-B3C4-E57283966239", "user_properties": {"[YOUR COMPANY] media source": "facebook", "[YOUR COMPANY] campaign": "refer-a-friend"}, "platform": "android"}'
レスポンス
| コード | メッセージ |
|---|---|
| 200 | 成功 |
| 400 | 期待されるJSONの形式が正しくありません。 |
これは役に立ちましたか?