リード獲得向けConversion API

Conversion APIを使用して、ウェブサイトのリード獲得(lead gen)イベントを送信します。AppLovinは、最適なキャンペーンパフォーマンスを達成するために、広告主様がAppLovin Pixelと併用してConversion APIを使用することを推奨しています。

Conversion API for Lead Generation

リクエスト形式

AppLovin Event APIに1つ以上のイベントを送信するには、https://b.applovin.com/v1/eventHTTP POST リクエストを送信します。

認証

ヘッダー名
Authorizationお客様のConversion API key

クエリパラメータ

名前タイプ必須説明
pixel_idstringtrueお客様のAppLovin Event Key

AppLovin Event KeyおよびConversion API Keyは、AppLovin dashboardKeysセクションから取得してください。

レスポンスコード

コード意味
200すべてのイベントが正常に処理されました
400リクエストにエラーがあります。バッチ全体が破棄されます
401認証に失敗しました

POSTペイロード

HTTPリクエストの POST ペイロードには、送信する1つまたは複数のイベントを記述します。

名前タイプ必須説明
eventsServerEvent[]true送信するイベントのリスト。すべてのイベントが有効である必要があります。無効なイベントが1つでもあると、バッチ全体が失敗します。最大バッチサイズは100です。

Server event

名前タイプ必須説明
dataEventDatatrueこのイベントのデータ。各イベントで送信するデータについては、以下のEventDataを参照してください。
event_source_urlstringtrueイベントが発生した完全なURL(例: https://example.com/product?product_name=widget
event_timenumbertrueミリ秒単位の現在のUnixエポック時間
namestringtrueこのイベントの名前。page_view または generate_lead のいずれかである必要があります。 ユーザーがサイト上の新しいページに移動したときに page_view をトリガーします。見込み客がフォームの送信などによって関心を示したとき(例: ユーザーが製品の詳細情報を取得するために問い合わせフォームを送信したとき)に generate_lead をトリガーします。
user_dataUserDatatruealeidclient_idaxwrtalart などのデータフィールドを含む、以下のUser dataテーブルを参照してください。
dedupe_idstringfalseこのイベントの一意の識別子。重複排除に使用されます。同一のpixelイベントとサーバー間(server-to-server)イベントは、同じ dedupe_id を持つ必要があります。これは以下の aleid とは異なることに注意してください。

Event data

dataすべてのイベントで必須です。

  • page_view の場合、datanull に設定します。

  • generate_lead の場合、常に { "currency": "«ISO-4217»", "value": «number» } を送信します。

名前タイプ必須説明
currencystringtrue通貨を表す3文字の ISO 4217 コード
valuenumbertrueアクション of 金銭的価値。ビジネスに対する品質や真の価値を反映します。確度の高いリードには高い値を渡し、重複した送信や質の低いリードには0を渡します。値が0のリードは、最適化から割引または除外される場合があります。

オプションのイベント

app_open イベントは、モバイルアプリの連携専用です。 ユーザーがアプリを起動したときにこのイベントをトリガーします。 このイベントで渡すデータオブジェクトはありません。

User data

名前タイプ必須説明
alartstringtrue*クエリパラメータとして設定された alart
*詳細については、以下のユーザー識別子の送信を参照してください。
aleidstringtrue詳細については、以下のaleidの送信を参照してください。
URLに存在する場合は必須(広告クリック後にAppLovinから送信されます)
axwrtstringtrue*AppLovin Pixelに設定された axwrt
*詳細については、以下のユーザー識別子の送信を参照してください。
client_idstringtrue*安定したファーストパーティユーザー識別子。
*詳細については、以下のユーザー識別子の送信を参照してください。
client_ip_addressstringtrueイベントに対応するブラウザのIPアドレス(スペースなし)。IPv4またはIPv6アドレスのいずれかを使用できます。IPv4が推奨されます。
client_user_agentstringtrueデバイス/ブラウザのUser Agent
emailstringtrue*ユーザーのメールアドレス。AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。AppLovinのハッシュ化ガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。
*詳細については、以下のユーザー識別子の送信を参照してください。
esistringtrueイベントソースインジケーター。モバイルアプリイベントの場合は "app"、ウェブサイトイベントの場合は "web" を使用します。
phonestringtrue*ユーザーの電話番号。AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。AppLovinのハッシュ化ガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。
*詳細については、以下のユーザー識別子の送信を参照してください。
user_idstringtrue*顧客に対する一意の識別子。
*詳細については、以下のユーザー識別子の送信を参照してください。
country_codestringfalseユーザーの請求先国コード。ISO 3166規格に従ってください。
idfvstringfalseユーザーのidentifier for vendors
ifastringfalseユーザーのidentifier for advertisers。idfa または gaid
osstringfalseユーザーのオペレーティングシステム: iosandroid、または desktop_os
sidstringfalseセッションID
zipstringfalseユーザーの請求先郵便番号。米国の郵便番号の場合は、最初の5桁のみを使用してください。

aleidの送信

aleid は、ユーザーがAppLovin広告をクリックした後に、AppLovinがウェブサイトのURLに追加するクエリパラメータです。

このパラメータの存在を利用して、どのクリックがAppLovinからのものであるかを識別します。

aleid を送信するには、次のいずれかの方法を実行できます。

  1. サイトにAppLovin Pixelがインストールされている場合、AppLovin Pixelは aleid クエリパラメータを検出すると、自動的にクッキー _axeid を設定します。 このクッキーが存在する場合は常にその値を読み取り、リクエストの aleid クエリパラメータの値として送信します。
  2. aleid URLクエリパラメータが存在することを確認したら、その値を取得します。 サーバーが aleid クエリパラメータを検出したら、サーバー側でそのパラメータを読み取ります。 AppLovinは、これをサイト上の _axeid という名前のHTTPクッキーとして設定することを推奨します。 このクッキーの有効期限は1年に設定してください。 前の方法と同様に、このクッキーが存在する場合は常にその値を読み取り、リクエストの aleid クエリパラメータの値として送信します。

ユーザー識別子の送信

AppLovinでは、client_idaxwrtalartuser_idemailphone のうち、少なくとも1つのフィールドを渡す必要があります。

client_id
サイトにAppLovin Pixelがインストールされていない場合は、訪問者を識別するために保存している別の安定したファーストパーティクッキーを渡します。 これはグローバルに一意であり、ユーザーのブラウジングセッション間で同一に維持される必要があります。
axwrt
サイトにAppLovin Pixelがインストールされている場合、AppLovin Pixelは自動的にクッキー _axwrt を設定します。
alart
アプリユーザーの場合、alart URLクエリパラメータが存在することを確認したら、その値を取得します。
user_id
システムにおける顧客の一意の識別子。 これは、ユーザーセッション間で一貫して維持される安定した識別子である必要があります。
email
ユーザーのメールアドレス。 AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。 AppLovinのガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。
phone
ユーザーの電話番号。 AppLovinは、プライバシー保護のためにこの値をSHA-256を使用して自動的にハッシュ化します。 AppLovinのガイドラインに従って識別子を前処理する場合は、独自のSHA-256ハッシュを提供することもできます。

ペイロードの例

ページビューイベント

{
  "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
      }
    }
  ]
}

search