メインコンテンツへスキップ
POST
/
event
イベント送信
curl --request POST \
  --url https://api-v2.adrop.io/event \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "uid": "<string>",
  "eventName": "<string>",
  "platform": "<string>"
}
'
{
    "message": "ok"
}
ユーザー行動イベントを送信して、イベントベースのオーディエンスターゲティングを構築できます。イベントデータはオーディエンスセグメンテーションおよびコンバージョントラッキングに活用されます。

リクエストパラメータ

ヘッダー

Authorization
string
必須
App Key(adrop_service.jsonで確認)
Content-Type
string
必須
application/json

ボディパラメータ

uid
string
必須
ユーザー固有識別子
eventName
string
必須
イベント名(1〜64文字)
platform
string
プラットフォーム。例:webandroidios
イベント固有の追加パラメータはリクエストボディのトップレベルフィールドとして渡します。マルチアイテムイベント(begin_checkoutpurchase)の場合はitems配列を渡します。

レスポンス

message
string
成功時"ok"、バリデーションエラー時"!invalid"
{
    "message": "ok"
}

サポートされるイベント

共通イベント

イベント名説明パラメータ
app_openアプリ起動
sign_up会員登録method(必須)
push_clicksプッシュ通知クリックcampaign_id(必須)
page_viewページ閲覧page_id(必須)、page_categorypage_url
click要素クリックelement_id(必須)、element_typetarget_url

オンライン販売イベント

イベント名説明パラメータ
view_itemアイテム閲覧item_id(必須)、item_nameitem_categorybrandprice
add_to_wishlistウィッシュリストに追加item_id(必須)、item_nameitem_categorybrandprice
add_to_cartカートに追加item_id(必須)、item_nameitem_categorybrandprice(必須)、quantity(必須)、valuecurrency
begin_checkoutチェックアウト開始currencyitems(配列、アイテムごとにitem_id必須)
purchase購入完了tx_id(必須)、currencyitems(配列、アイテムごとにitem_id必須)

リード生成イベント

イベント名説明パラメータ
view_contentコンテンツ閲覧content_id(必須)、content_namecontent_type
begin_lead_formリードフォーム開始form_id(必須)、form_nameform_typeform_destination
generate_leadリード生成form_id(必須)、form_nameform_typeform_destinationvaluecurrency

シンプルなイベント

const axios = require('axios');

axios.post('https://api-v2.adrop.io/event', {
    uid: 'USER_ID',
    eventName: 'app_open'
}, {
    headers: {
        'Authorization': 'YOUR_APP_KEY',
        'Content-Type': 'application/json'
    }
});

パラメータ付きイベント

const axios = require('axios');

axios.post('https://api-v2.adrop.io/event', {
    uid: 'USER_ID',
    eventName: 'view_item',
    platform: 'web',
    item_id: 'SKU-123',
    item_name: 'Widget',
    item_category: 'Electronics',
    brand: 'BrandX',
    price: 29900
}, {
    headers: {
        'Authorization': 'YOUR_APP_KEY',
        'Content-Type': 'application/json'
    }
});

マルチアイテムイベント(購入)

const axios = require('axios');

axios.post('https://api-v2.adrop.io/event', {
    uid: 'USER_ID',
    eventName: 'purchase',
    platform: 'web',
    tx_id: 'TXN-20240101-001',
    currency: 'KRW',
    items: [
        {
            item_id: 'SKU-001',
            item_name: 'Product A',
            item_category: 'Electronics',
            brand: 'BrandX',
            price: 29900,
            quantity: 1
        },
        {
            item_id: 'SKU-002',
            item_name: 'Product B',
            price: 15000,
            quantity: 2
        }
    ]
}, {
    headers: {
        'Authorization': 'YOUR_APP_KEY',
        'Content-Type': 'application/json'
    }
});

リード生成イベント

const axios = require('axios');

axios.post('https://api-v2.adrop.io/event', {
    uid: 'USER_ID',
    eventName: 'generate_lead',
    platform: 'web',
    form_id: 'contact-form-01',
    form_name: 'Contact Us',
    form_type: 'contact',
    form_destination: '/thank-you',
    value: 50000,
    currency: 'KRW'
}, {
    headers: {
        'Authorization': 'YOUR_APP_KEY',
        'Content-Type': 'application/json'
    }
});

注意事項

  • 不明なイベント名や必須パラメータが欠落したイベントは無視されます(HTTP 200を返却)。
  • マルチアイテムイベントはリクエストあたり最大100アイテムをサポートします。
  • 文字列パラメータ値は最大1024文字までです。
  • uidは保存前にSHA-256でハッシュ処理されます。

関連ドキュメント