Server To Server Event

Headers

Accept-Language

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

Content-Type

string

Represents the media type of the resource. Defaults to application/json.

Authorization

string

The key value to use for API requests. Instructions for getting API keys are in "how to generate API Keys".

X-Forwarded-For

必須string

You can send the user's IP in the X-Forwarded-For header. Without X-Forwarded-For, user behavior is logged with the IP of the server that requested the Server To Server API, not the user's IP (client request IP).

We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

Path Params

app_name

必須string

Airbridge App Name. (Unique ID)

Body Params

eventUUID

string

Random UUID v4 string.

Accepts a random string in UUID4 format.

The event uuid is used for duplication as a unique ID for the event, and will be generated automatically by the event api if not provided.

eventTimestamp

number

The time the event occurred. (default: current timestamp)

A Unix timestamp in milliseconds (13 digits in Unixtime).

If the eventTimestamp is older than 24 hours from the time the event was sent, it will not be processed by the server.

user

object

User information.

user.externalUserID

条件付き必須string

User ID.

^{*required if device.deviceUUID is not sent.}

user.externalUserEmail

string

User email.

user.externalUserPhone

string

User phone number.

user.attributes

object

Custom user attributes.

Accepts data in JSON format.

{ "age_group": "30", "brand": "Nike" }

device

条件付き必須object

デバイス情報が含まれます。

^{*required if user.ExternalUserID is not sent}

device.deviceUUID

条件付き必須stringnullable

AirbridgeのデバイスID

GAID、IDFA、IDFV、Random Generated UUIDを取得します。

^{*required if user.ExternalUserID is not sent}

device.gaid

stringnullable

Googleから提供する広告ID

device.ifa

stringnullable

Appleから提供する広告ID

device.appSetID

stringnullable

AppSetId provided by Google.

device.ifv

stringnullable

Appleから提供するIFV

device.limitAdTracking

boolean

デバイスの広告トラッキング制限に関する設定値

true : 広告トラッキングを制限
false : 広告トラッキングを許容

device.deviceModel

stringnullable

デバイスのモデル名

device.appTrackingTransparency

integer

デバイスの位置

device.deviceIdentifier

string

iPhone11,2といった具体的なデバイス識別子(iPhoneのみ可能)

device.manufacturer

string

デバイスのメーカー

device.osName

条件付き必須enum

デバイスのOS名

^{*required if device.deviceUUID is sent.}

ENUM VALUES

Android

Android OS

iOS

iOS

device.osVersion

条件付き必須string

デバイスのOSバージョン

^{*required if device.deviceUUID is sent.}

device.locale

string

デバイスの位置

device.timezone

string

デバイスのタイムゾーン

device.orientation

string

デバイスの向き

device.screen

string

デバイスのスクリーン情報

device.screen.density

string

デバイスの解像度

device.screen.height

number

デバイスのスクリーンの高さ

device.screen.width

number

デバイスのスクリーンの横幅

device.alias

object

ユーザーのアプリ情報が含まれます。

device.alias.eea

string

Google Play ストアに登録されたアプリのパッケージ名(Androidのみ)

device.alias.adPersonalization

string

ユーザーが使用しているアプリのバージョン

device.alias.adUserData

string

Airbridgeに送信するイベントを定義するオブジェクトです。

app

必須object

イベント情報を含められるオブジェクトです。カテゴリー、アクション、ラベル、バリュー、セマンティックアトリビュート(Semantic Attributes)を含めることができます。

app.packageName

必須string

Airbridgeのイベントカテゴリ

app.version

string

イベントアクション

eventData

必須object

Event information.

eventData.goal

必須object

An object that can contain information about an event. It can contain categories, actions, labels, values, and semantic attributes. (Related Guide)

eventData.goal.category

必須string

The name of the Airbridge event

eventData.goal.value

number

Event's value.

This may represent the product value of purchase events, or revenue for ad impressions etc.

eventData.goal.customAttributes

object

Custom event attribute.

{ "color": "red" }

eventData.goal.semanticAttributes

object

Semantic Attributes. Predefined attributes for which Airbridge is supposed to collect data.

eventData.goal.semanticAttributes.currency

string

The currency for the payment event. You can use the currency used for the actual payment, as it will be converted to the currency set in your dashboard during event processing.

eventData.goal.semanticAttributes.action

string

Airbridge event property 1

eventData.goal.semanticAttributes.label

string

Airbridge event property 2

eventData.goal.semanticAttributes.productListID

string

Product list ID.

eventData.goal.semanticAttributes.cartID

string

Cart ID.

eventData.goal.semanticAttributes.transactionID

string

Transaction ID.

eventData.goal.semanticAttributes.inAppPurchased

boolean

In-app purchases or not.

true for in-app purchase, false for not an in-app purchase.

eventData.goal.semanticAttributes.products

object[]

Product list.

eventData.goal.semanticAttributes.products[0].currency

string

Currency.

eventData.goal.semanticAttributes.products[0].productID

string

Product ID.

eventData.goal.semanticAttributes.products[0].price

number

Product Price.

eventData.goal.semanticAttributes.products[0].name

string

Product name.

eventData.goal.semanticAttributes.products[0].position

string

Product position.

eventData.goal.semanticAttributes.products[0].quantity

integer

Product quantity.

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","limitAdTracking":true,"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}},"app":{"packageName":"com.ab180.co","version":"1.2.3"},"eventData":{"goal":{"category":"airbridge.ecommerce.product.addedToCart","value":159990,"semanticAttributes":{"currency":"KRW","action":"shoes","label":"nike","transactionID":"12939172","inAppPurchased":true,"products":[{"currency":"KRW","productID":"30372425","price":10990,"name":"나이키 커스텀","position":"1","quantity":1}]}}}}'
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","limitAdTracking":true,"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}},"app":{"packageName":"com.ab180.co","version":"1.2.3"},"eventData":{"goal":{"category":"airbridge.ecommerce.product.addedToCart","value":159990,"semanticAttributes":{"currency":"KRW","action":"shoes","label":"nike","transactionID":"12939172","inAppPurchased":true,"products":[{"currency":"KRW","productID":"30372425","price":10990,"name":"나이키 커스텀","position":"1","quantity":1}]}}}}'

Payload

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
{
  "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",
    "limitAdTracking": true,
    "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
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "value": 159990,
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "productID": "30372425",
            "price": 10990,
            "name": "나이키 커스텀",
            "position": "1",
            "quantity": 1
          }
        ]
      }
    }
  }
}
{
  "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",
    "limitAdTracking": true,
    "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
    }
  },
  "app": {
    "packageName": "com.ab180.co",
    "version": "1.2.3"
  },
  "eventData": {
    "goal": {
      "category": "airbridge.ecommerce.product.addedToCart",
      "value": 159990,
      "semanticAttributes": {
        "currency": "KRW",
        "action": "shoes",
        "label": "nike",
        "transactionID": "12939172",
        "inAppPurchased": true,
        "products": [
          {
            "currency": "KRW",
            "productID": "30372425",
            "price": 10990,
            "name": "나이키 커스텀",
            "position": "1",
            "quantity": 1
          }
        ]
      }
    }
  }
}

Request Body Key	Data Fetching Field	Description
eventData.shortID	Attribution Short ID	Campaign Parameter ID
eventData.trackingData.channel	Default Attribution Channel	Campaign Channel
eventData.trackingData.params	Default Attribution Parameters	Campaign Parameters

Request Body Key

Data Fetching Field

Description

eventData.shortID

Attribution Short ID

Campaign Parameter ID

eventData.trackingData.channel

Default Attribution Channel

Campaign Channel

eventData.trackingData.params

Default Attribution Parameters

Campaign Parameters

{ ... "browser": { "clientID": "05609013-bb5a-4594-bbc3-832cb1b87072" }, "eventData": { "shortID": "aef04", "trackingData": { "channel": "blog", "params": { "ad_creative": "ad_creative", "ad_group": "ad_group", "campaign": "ad_campaign", "content": "ad_content", "medium": "ad_medium", "tracking_template_id": "ad_tracking_template_id" } } }, "user": { "externalUserID": "19443", "externalUserEmail": "example@ab180.co", "externalUserPhone": "821012341234" } ... }

Headers

Accept-Language

string

You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.

Content-Type

string

Represents the media type of the resource. Defaults to application/json.

Authorization

string

The key value to use for API requests. Instructions for getting API keys are in "how to generate API Keys".

X-Forwarded-For

必須string

We accept values in the form of ipv4 (123.123.123.123), ipv6 (2001:e60:87e3:81d4:cd57:5d52:ee2e:ff8d).

Path Params

app_name

必須string

Airbridge App Name. (Unique ID)

Body Params

eventUUID

string

Random UUID v4 string.

Accepts a random string in UUID4 format.

The event uuid is used for duplication as a unique ID for the event, and will be generated automatically by the event api if not provided.

eventTimestamp

number

The time the event occurred. (default: current timestamp)

A Unix timestamp in milliseconds (13 digits in Unixtime).

If the eventTimestamp is older than 24 hours from the time the event was sent, it will not be processed by the server.

user

object

User information.

user.externalUserID

条件付き必須string

User ID.

^{*required if device.deviceUUID is not sent.}

user.externalUserEmail

string

User email.

user.externalUserPhone

string

User phone number.

user.attributes

object

Custom user attributes.

Accepts data in JSON format.

{ "age_group": "30", "brand": "Nike" }

browser

object

Browser Information.

browser.clientID

必須string

Browser cookie ID. The values fetched from the SDK are required. [Docs]

If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.

browser.userAgent

string

Browser's user agent.

eventData

必須object

Event information.

eventData.shortID

必須string

Attribution campaign parameter Short ID. Provide the value fetched from the Airbridge SDK(Android iOS).

NOTE: This value must be sent to the Airbridge server without processing or filtering.

If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.

eventData.trackingData

必須object

Tracking data from SDK.

eventData.trackingData.channel

必須string

Attribution campaign channel. Provide the value fetched from the Airbridge SDK(Android iOS).

NOTE: This value must be sent to the Airbridge server without processing or filtering. (eg. values such as airbridge.websdk must also be sent)

If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.

eventData.trackingData.params

必須object

Attribution campaign parameters. Accepts data in JSON format.

Provide the value fetched from the Airbridge SDK(Android iOS).

NOTE: This value must be sent to the Airbridge server without processing or filtering.

If data fetching is not an option, sending the User ID(user.externalUserID) will make this field optional.

eventData.goal

必須object

An object that can contain information about an event. It can contain categories, actions, labels, values, and semantic attributes. (Related Guide)

eventData.goal.category

必須string

The name of the Airbridge event

eventData.goal.value

number

Event's value.

This may represent the product value of purchase events, or revenue for ad impressions etc.

eventData.goal.customAttributes

object

Custom event attribute.

{ "color": "red" }

eventData.goal.semanticAttributes

object

Semantic Attributes. Predefined attributes for which Airbridge is supposed to collect data.

eventData.goal.semanticAttributes.action

string

Airbridge event property 1

eventData.goal.semanticAttributes.label

string

Airbridge event property 2

eventData.goal.semanticAttributes.query

string

User search query.

eventData.goal.semanticAttributes.productListID

string

Product list ID.

eventData.goal.semanticAttributes.cartID

string

Cart ID.

eventData.goal.semanticAttributes.transactionID

string

Transaction ID.

eventData.goal.semanticAttributes.inAppPurchased

boolean

In-app purchases or not.

true for in-app purchase, false for not an in-app purchase.

eventData.goal.semanticAttributes.currency

string

The currency for the payment event. You can use the currency used for the actual payment, as it will be converted to the currency set in your dashboard during event processing.

eventData.goal.semanticAttributes.products

object[]

Product list.

eventData.goal.semanticAttributes.products[0].position

string

Product position.

eventData.goal.semanticAttributes.products[0].productID

string

Product ID.

eventData.goal.semanticAttributes.products[0].name

string

Product name.

eventData.goal.semanticAttributes.products[0].price

number

Product Price.

eventData.goal.semanticAttributes.products[0].quantity

integer

Product quantity.

eventData.goal.semanticAttributes.products[0].currency

string

Currency.

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","value":159990,"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", "value": 159990, "semanticAttributes": { "action": "shoes", "label": "nike", "query": "나이키", "transactionID": "12939172", "inAppPurchased": true, "currency": "KRW", "products": [ { "position": "1", "productID": "30372425", "name": "나이키 커스텀", "price": 10990, "quantity": 1, "currency": "KRW" } ] } } } }

アプリ内イベントを送信する

送信方法

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Send In-web Events

User Identifiers

Attention

Request Example

2. User ID(`user.externalUserID`)

Request Example

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server To Server Eventself.__wrap_n!=1&&self.__wrap_b("_R_4ilubt5upfcqbsnjb_",0.5)

アプリ内イベントを送信する

送信方法

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Send In-web Events

User Identifiers

Attention

1. Cookie ID(browser.clientID)

Request Example

2. User ID(user.externalUserID)

Request Example

Request

Headers

Path Params

Body Params

Response

200SUCCESS

400ERROR

401ERROR

Server To Server Event

1. Cookie ID(`browser.clientID`)

2. User ID(`user.externalUserID`)