S2S 事件

Request Body Key	数据获取字段名	OS
device.deviceUUID	Airbridge Device ID	所有 OS
device.gaid	GAID (Google Advertising ID)	Android
device.appSetID	App Set ID	Android
device.ifa	IDFA	iOS、iPadOS
device.ifv	IDFV	iOS、iPadOS

Request Body Key

数据获取字段名

device.deviceUUID

Airbridge Device ID

所有 OS

device.gaid

GAID (Google Advertising ID)

Android

device.appSetID

App Set ID

Android

device.ifa

IDFA

iOS、iPadOS

device.ifv

IDFV

iOS、iPadOS

Headers

Accept-Language

string

可以指定用于 API 请求和结果返回的语言。遵守 ISO-639-1 格式。

Content-Type

string

表示资源的媒体类型。默认使用 application/json。

Authorization

string

用于 API 请求的键值。参阅密钥的生成及查询方法来获取该键值。

X-Forwarded-For

Requiredstring

可以使用 X-Forwarded-For 请求头发送用户 IP。如果没有 X-Forwarded-For，用户的行为中将记录请求 S2S API 的服务器 IP，而不是用户的 IP（客户端请求 IP）。

接收 ipv4(123.123.123.123)、ipv6(2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d) 格式。

Path Params

app_name

Requiredstring

Airbridge App 名称（App Name）。

Body Params

eventUUID

string

事件唯一 ID。

uuid4 格式的 event uuid 作为事件的唯一 ID 来用于去重。如果未提供，将由事件 API 自动生成。

eventTimestamp

number

事件发生时间。

以毫秒（Millisecond）为单位的 Unix 时间戳（13 位）。

如果 eventTimestamp 距离事件发送时刻超过 24 小时，则服务器将不会处理该事件。确保使用距离发送时刻不超过 24 小时的时间戳。

user

object

可存储用户相关信息。

device

object

存储设备相关信息。

device.deviceUUID

stringnullable

Airbridge Device ID（设备 ID）。

接收 GAID、IDFA、IDFV、Random Generated UUID 以及 App Set ID。

device.gaid

stringnullable

Google 提供的广告 ID。

device.ifa

stringnullable

Apple 提供的广告 ID（IDFA）。

device.appSetID

stringnullable

Google 提供的 App Set ID。

device.ifv

stringnullable

Apple 提供的 IDFV。

device.limitAdTracking

boolean

设备的限制广告跟踪（Limit Ad Tracking) 设置值。

true：限制广告跟踪
false：允许广告跟踪

device.deviceModel

stringnullable

设备模型名称。

device.appTrackingTransparency

integer

ATT（App Tracking Transparency，应用跟踪透明度）

值	ATT 状态
0	Not Determined（未决定）
1	Restricted（受限）
2	Denied（拒绝）
3	Authorized（允许）

device.deviceIdentifier

string

具体的设备型号标识符，如 iPhone 11,2。（仅限 iPhone）

device.manufacturer

string

设备制造商。

device.osName

Requiredenum

设备 OS 名称。

ENUM VALUES

Android

Android

iOS

iOS

device.osVersion

Requiredstring

设备 OS 版本。

device.locale

string

设备 Locale。

device.timezone

string

设备时区。

device.orientation

string

设备方向。

device.screen

string

设备屏幕信息。

device.location

object

设备位置。

device.network

object

设备网络信息。

device.alias

object

向 Airbridge 发送遵守《数字市场法案》（Digital Markets Act, 简称 DMA）所需的用户同意信息。有关 DMA 的更多信息，请参阅本指南。

app

Requiredobject

存储用户的 App 相关信息。

eventData

Requiredobject

用于定义要发送至 Airbridge 的事件的对象。

Request

123456
curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/mobile-app/9360' \
  -H 'Accept-Language: ko' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
  -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \
  -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"device":{"deviceUUID":"2dfca632-86f3-4d22-9746-cdfe7985c471","gaid":"2dfca632-86f3-4d22-9746-cdfe7985c471","ifa":"542177F1-5C23-438B-8088-82D34C94F6D7","appSetID":"7c4681ef-97c6-4ebd-9c04-e22f584b3746","ifv":"37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F","deviceModel":"LG-H542","appTrackingTransparency":0,"deviceIdentifier":"iPhone11,2","manufacturer":"Samsung","osName":"Android","osVersion":"5.0.2","locale":"ko-KR","timezone":"Asia/Seoul","orientation":"portrait","screen":{"width":123},"location":{"latitude":120.103,"speed":"12"},"network":{"carrier":"SKTelecom","cellular":true,"wifi":true}},"app":{"packageName":"com.ab180.co","version":"1.2.3"},"eventData":{"goal":{"category":"airbridge.ecommerce.product.addedToCart","semanticAttributes":{"currency":"KRW","action":"shoes","label":"nike","transactionID":"12939172","inAppPurchased":true,"products":[{"currency":"KRW","name":"나이키 커스텀","price":10990}]}}}}'

Payload

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
{
  "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262",
  "user": {
    "externalUserID": "19443",
    "externalUserEmail": "example@ab180.co",
    "externalUserPhone": "821012341234"
  },
  "device": {
    "deviceUUID": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "gaid": "2dfca632-86f3-4d22-9746-cdfe7985c471",
    "ifa": "542177F1-5C23-438B-8088-82D34C94F6D7",
    "appSetID": "7c4681ef-97c6-4ebd-9c04-e22f584b3746",
    "ifv": "37EEC3E0-BF15-412E-ADBA-7D2E82E7A75F",
    "deviceModel": "LG-H542",
    "appTrackingTransparency": 0,
    "deviceIdentifier": "iPhone11,2",
    "manufacturer": "Samsung",
    "osName": "Android",
    "osVersion": "5.0.2",
    "locale": "ko-KR",
    "timezone": "Asia/Seoul",
    "orientation": "portrait",
    "screen": {
      "width": 123
    },
    "location": {
      "latitude": 120.103,
      "speed": "12"
    },
    "network": {
      "carrier": "SKTelecom",
      "cellular": true,
      "wifi": true
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "name": "나이키 커스텀",
            "price": 10990
          }
        ]
      }
    }
  }
}

参数	数据获取字段名	说明
eventData.shortID	Attribution Short ID	广告系列（Campaign）参数 ID
eventData.trackingData.channel	Default Attribution Channel	广告系列（Campaign）渠道
eventData.trackingData.params	Default Attribution Parameters	广告系列（Campaign）参数

参数

数据获取字段名

说明

eventData.shortID

Attribution Short ID

广告系列（Campaign）参数 ID

eventData.trackingData.channel

Default Attribution Channel

广告系列（Campaign）渠道

eventData.trackingData.params

Default Attribution Parameters

广告系列（Campaign）参数

Headers

Accept-Language

string

可以指定用于 API 请求和结果返回的语言。遵守 ISO-639-1 格式。

Content-Type

string

表示资源的媒体类型。默认使用 application/json。

Authorization

string

用于 API 请求的键值。参阅密钥的生成及查询方法来获取该键值。

X-Forwarded-For

Requiredstring

可以使用 X-Forwarded-For 请求头发送用户 IP。如果没有 X-Forwarded-For，用户的行为中将记录请求 S2S API 的服务器 IP，而不是用户的 IP（客户端请求 IP）。

接收 ipv4(123.123.123.123)、ipv6(2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d) 格式。

Path Params

app_name

Requiredstring

Airbridge App 名称（App Name）。

Body Params

eventUUID

string

事件唯一 ID。

uuid4 格式的 event uuid 作为事件的唯一 ID 来用于去重。如果未提供，将由事件 API 自动生成。

eventTimestamp

number

事件发生时间。

以毫秒（Millisecond）为单位的 Unix 时间戳（13 位）。

如果 eventTimestamp 距离事件发送时刻超过 24 小时，则服务器将不会处理该事件。确保使用距离发送时刻不超过 24 小时的时间戳。

user

object

可存储用户相关信息。

browser

object

可存储浏览器信息。

eventData

Requiredobject

用于定义要发送至 Airbridge 的事件的对象。

eventData.shortID

Requiredstring

广告系列（Campaign）参数 ID。需通过 SDK 数据获取（Data Fetching）获取并传输该值。

《注意》 该值必须未经处理或筛选，直接发送至 Airbridge 服务器。

若无法进行 SDK 数据获取，可在发送 User ID（user.externalUserID）的情况下省略此项。

eventData.trackingData

Requiredobject

可存储将应用于 Airbridge 归因的数据。

eventData.goal

Requiredobject

用于存储事件相关信息的对象。

可存储 Category、Action、Label、Value 以及 Semantic Attributes。相关指南

curl -X POST 'https://api.airbridge.io/events/v1/apps/{app_name}/web/9320' \ -H 'Accept-Language: ko' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \ -H 'X-Forwarded-For: 2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d' \ -d '{"eventUUID":"9b4b3e4e-2162-4ae6-8986-91ee84644262","user":{"externalUserID":"19443","externalUserEmail":"example@ab180.co","externalUserPhone":"821012341234"},"browser":{"clientID":"05609013-bb5a-4594-bbc3-832cb1b87072","userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302"},"eventData":{"shortID":"aef04","trackingData":{"channel":"blog"},"goal":{"category":"airbridge.ecommerce.product.addedToCart","semanticAttributes":{"action":"shoes","label":"nike","query":"나이키","transactionID":"12939172","inAppPurchased":true,"currency":"KRW","products":[{"position":"1","productID":"30372425","name":"나이키 커스텀","price":10990,"quantity":1,"currency":"KRW"}]}}}}'

{ "eventUUID": "9b4b3e4e-2162-4ae6-8986-91ee84644262", "user": { "externalUserID": "19443", "externalUserEmail": "example@ab180.co", "externalUserPhone": "821012341234" }, "browser": { "clientID": "05609013-bb5a-4594-bbc3-832cb1b87072", "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E302" }, "eventData": { "shortID": "aef04", "trackingData": { "channel": "blog" }, "goal": { "category": "airbridge.ecommerce.product.addedToCart", "semanticAttributes": { "action": "shoes", "label": "nike", "query": "나이키", "transactionID": "12939172", "inAppPurchased": true, "currency": "KRW", "products": [ { "position": "1", "productID": "30372425", "name": "나이키 커스텀", "price": 10990, "quantity": 1, "currency": "KRW" } ] } } } }

应用内事件发送

用户标识符类型

注意

1. Device ID

发送示例

2. User ID (`user.externalUserID`)

发送示例

事件示例

完成订单

Request

Headers

Path Params

Body Params

Response

200SUCCESS

网页内事件发送

用户标识符类型

注意

发送示例

2. User ID (`user.externalUserID`)

发送示例

Request

Headers

Path Params

Body Params

Response

200SUCCESS

S2S 事件self.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

应用内事件发送

用户标识符类型

注意

1. Device ID

发送示例

2. User ID (user.externalUserID)

发送示例

事件示例

完成订单

Request

Headers

Path Params

Body Params

Response

200SUCCESS

网页内事件发送

用户标识符类型

注意

1. Cookie ID (browser.clientID)

发送示例

2. User ID (user.externalUserID)

发送示例

Request

Headers

Path Params

Body Params

Response

200SUCCESS

S2S 事件

2. User ID (`user.externalUserID`)

1. Cookie ID (`browser.clientID`)

2. User ID (`user.externalUserID`)