Conversion APIを使用して、ウェブサイトのリード獲得(lead gen)イベントを送信します。AppLovinは、最適なキャンペーンパフォーマンスを達成するために、広告主様がAppLovin Pixelと併用してConversion APIを使用することを推奨しています。
AppLovin Event APIに1つ以上のイベントを送信するには、https://b.applovin.com/v1/event に HTTP POST リクエストを送信します。
| ヘッダー名 | 値 |
|---|---|
| Authorization | お客様のConversion API key |
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
pixel_id | string | true | お客様のAppLovin Event Key |
AppLovin Event KeyおよびConversion API Keyは、AppLovin dashboardのKeysセクションから取得してください。
| コード | 意味 |
|---|---|
| 200 | すべてのイベントが正常に処理されました |
| 400 | リクエストにエラーがあります。バッチ全体が破棄されます |
| 401 | 認証に失敗しました |
HTTPリクエストの POST ペイロードには、送信する1つまたは複数のイベントを記述します。
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
events | ServerEvent[] | true | 送信するイベントのリスト。すべてのイベントが有効である必要があります。無効なイベントが1つでもあると、バッチ全体が失敗します。最大バッチサイズは100です。 |
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
data | EventData | true | このイベントのデータ。各イベントで送信するデータについては、以下のEventDataを参照してください。 |
event_source_url | string | true | イベントが発生した完全なURL(例: https://example.com/product?product_name=widget ) |
event_time | number | true | ミリ秒単位の現在のUnixエポック時間 |
name | string | true | このイベントの名前。page_view または generate_lead のいずれかである必要があります。 ユーザーがサイト上の新しいページに移動したときに page_view をトリガーします。見込み客がフォームの送信などによって関心を示したとき(例: ユーザーが製品の詳細情報を取得するために問い合わせフォームを送信したとき)に generate_lead をトリガーします。 |
user_data | UserData | true | aleid、client_id、axwrt、alart などのデータフィールドを含む、以下のUser dataテーブルを参照してください。 |
dedupe_id | string | false | このイベントの一意の識別子。重複排除に使用されます。同一のpixelイベントとサーバー間(server-to-server)イベントは、同じ dedupe_id を持つ必要があります。これは以下の aleid とは異なることに注意してください。 |
data はすべてのイベントで必須です。
page_view の場合、data を null に設定します。
generate_lead の場合、常に { "currency": "«ISO-4217»", "value": «number» } を送信します。
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
currency | string | true | 通貨を表す3文字の ISO 4217 コード |
value | number | true | アクション of 金銭的価値。ビジネスに対する品質や真の価値を反映します。確度の高いリードには高い値を渡し、重複した送信や質の低いリードには0を渡します。値が0のリードは、最適化から割引または除外される場合があります。 |
app_open イベントは、モバイルアプリの連携専用です。
ユーザーがアプリを起動したときにこのイベントをトリガーします。
このイベントで渡すデータオブジェクトはありません。
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
alart | string | true* | クエリパラメータとして設定された alart。*詳細については、以下のユーザー識別子の送信を参照してください。 |
aleid | string | true† | 詳細については、以下のaleidの送信を参照してください。 †URLに存在する場合は必須(広告クリック後にAppLovinから送信されます) |
axwrt | string | true* | AppLovin Pixelに設定された axwrt。*詳細については、以下のユーザー識別子の送信を参照してください。 |
client_id | string | true* | 安定したファーストパーティユーザー識別子。 *詳細については、以下のユーザー識別子の送信を参照してください。 |
client_ip_address | string | true | イベントに対応するブラウザのIPアドレス(スペースなし)。IPv4またはIPv6アドレスのいずれかを使用できます。IPv4が推奨されます。 |
client_user_agent | string | true | デバイス/ブラウザのUser Agent |
email | string | true* | ユーザーのメールアドレス。AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。AppLovinのハッシュ化ガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。 *詳細については、以下のユーザー識別子の送信を参照してください。 |
esi | string | true | イベントソースインジケーター。モバイルアプリイベントの場合は "app"、ウェブサイトイベントの場合は "web" を使用します。 |
phone | string | true* | ユーザーの電話番号。AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。AppLovinのハッシュ化ガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。 *詳細については、以下のユーザー識別子の送信を参照してください。 |
user_id | string | true* | 顧客に対する一意の識別子。 *詳細については、以下のユーザー識別子の送信を参照してください。 |
country_code | string | false | ユーザーの請求先国コード。ISO 3166規格に従ってください。 |
idfv | string | false | ユーザーのidentifier for vendors |
ifa | string | false | ユーザーのidentifier for advertisers。idfa または gaid |
os | string | false | ユーザーのオペレーティングシステム: ios、android、または desktop_os |
sid | string | false | セッションID |
zip | string | false | ユーザーの請求先郵便番号。米国の郵便番号の場合は、最初の5桁のみを使用してください。 |
aleidの送信aleid は、ユーザーがAppLovin広告をクリックした後に、AppLovinがウェブサイトのURLに追加するクエリパラメータです。
このパラメータの存在を利用して、どのクリックがAppLovinからのものであるかを識別します。
aleid を送信するには、次のいずれかの方法を実行できます。
aleid クエリパラメータを検出すると、自動的にクッキー _axeid を設定します。
このクッキーが存在する場合は常にその値を読み取り、リクエストの aleid クエリパラメータの値として送信します。aleid URLクエリパラメータが存在することを確認したら、その値を取得します。
サーバーが aleid クエリパラメータを検出したら、サーバー側でそのパラメータを読み取ります。
AppLovinは、これをサイト上の _axeid という名前のHTTPクッキーとして設定することを推奨します。
このクッキーの有効期限は1年に設定してください。
前の方法と同様に、このクッキーが存在する場合は常にその値を読み取り、リクエストの aleid クエリパラメータの値として送信します。AppLovinでは、client_id、axwrt、alart、user_id、email、phone のうち、少なくとも1つのフィールドを渡す必要があります。
client_idaxwrt_axwrt を設定します。
alartalart URLクエリパラメータが存在することを確認したら、その値を取得します。
user_idemailphone{
"events": [
{
"event_time": 1741784485001,
"event_source_url": "https://applovin.com",
"name": "page_view",
"user_data": {
"client_ip_address": "172.59.8.172",
"client_user_agent": "chrome/123.456 android mobile",
"aleid": "_aleid-query-param",
"axwrt": "_axwrt-cookie-value",
"user_id": "_user_id",
"phone": "+1123456789",
"email": "user@example.com",
"client_id": "_first_party_identifier",
"sid": "sid",
"ifa": "idfa",
"idfv": "idfv",
"os": "macos",
"esi": "web",
"zip": "12345",
"country_code": "US"
},
"data": null
}
]
}
{
"events": [
{
"event_time": 1741784485001,
"event_source_url": "https://applovin.com",
"name": "generate_lead",
"user_data": {
"client_ip_address": "172.59.8.172",
"client_user_agent": "chrome/123.456 android mobile",
"aleid": "_aleid-query-param",
"axwrt": "_axwrt-cookie-value",
"user_id": "_user_id",
"phone": "+1123456789",
"email": "user@example.com",
"client_id": "_first_party_identifier",
"sid": "sid",
"ifa": "idfa",
"idfv": "idfv",
"os": "macos",
"esi": "web",
"zip": "12345",
"country_code": "US"
},
"data": {
"currency": "USD",
"value": 30
}
}
]
}