Event Properties - Airbridge Help Center

Airbridge only collects event data that is defined as an Airbridge event. Learn about the properties you need to define an Airbridge event. We recommend reading this guide alongside the Event Types guide.

Event properties at a glance

An Airbridge event is made up of the following properties: Event Category, Event Action, Event Label, Event Value, Attribute, and Trigger.

Property	Required	Data type	Where to view	Description
Event Category	Required	string	- Airbridge reports - Raw data exports	- Used as the Airbridge event name. - Determines the postbacks sent to ad channels. - Available in Airbridge reports and raw data exports.
Event Action, Event Label	Optional	string	- Airbridge reports - Raw data exports	- Additional details related to the event. Up to 2 can be collected. - Available in Airbridge reports.
Event Value	Optional	float	- Airbridge reports - Raw data exports	- A numeric detail related to the event. - Only numbers collected as the Event Value can be used in calculations.
Attribute	Optional		- Raw data exports	- Additional details related to the event beyond the Event Action and Event Label. - Available only in raw data exports.
Trigger	Required		-	- The point at which the Airbridge event is collected.

Event Category

The Event Category is a required property that you must define for every Airbridge event. It serves as the Airbridge event name. The Event Category also determines which events are sent to ad channels as postbacks. Airbridge events fall into Standard Events and Custom Events, depending on whether the Event Category is predefined. Standard Events use an Event Category predefined by Airbridge, and the dashboard shows the event name based on that Event Category. Custom Events use an Event Category that you create.

Naming rules and limitations for Event Category

An Event Category must follow these rules:

It is case-sensitive.
Standard Event names use an Event Category predefined by Airbridge.
Custom Event names can contain only letters, numbers, and underscores (_), and cannot begin with airbridge.. The maximum length is 128 characters.
An Event Category that contains : cannot be used.

The following limitations apply to data collected as the Event Category:

Events that don’t match the data type aren’t collected. The Event Category data type is string.
If the collected data exceeds the maximum length of 128 characters, only data up to the limit is collected.

View data by Event Category

To view data collected as the Event Category, select the metric with the same name as the Event Category, or select Event Category as a GroupBy, filter, or property. The data is available in Airbridge reports and raw data exports.

Event Action and Event Label

Event Action and Event Label are additional details collected as strings in an Airbridge event. You can define up to two.

Collect any detail with Event Action and Event LabelThe event details are not related to the literal definitions of the words action and label. This means that you can use the Event Action to collect event details that are not related to user actions.

Naming rules and limitations for Event Action and Event Label

Event Action and Event Label must follow these rules:

They can contain letters, Korean characters, and numbers. The maximum length is 128 characters.
They are case-sensitive. Spaces and special characters (?, !, ,, ., /, &, (, ), -, _) are supported. We recommend using only the underscore (_).

The following limitations apply to data collected as the Event Action and Event Label:

Events that don’t match the data type aren’t collected. The Event Action and Event Label data type is string.
If the collected data exceeds the maximum length of 128 characters, only data up to the limit is collected.

View data by Event Action and Event Label

To view data collected as the Event Action and Event Label, select Event Action and Event Label as a GroupBy. The data is available in Airbridge reports and raw data exports.

airbridge-event-property-event-action-label

Event Value

The Event Value is an additional detail collected as a number in an Airbridge event. For example, to collect the revenue from events that generate revenue, such as Order Complete or an ad click, include the Event Value in the event.

Event Value use case

Let’s say you have collected data for the “Order Complete” event as shown in the following table:

Event Category	Event Action	Event Label	Event Value
`airbridge.ecommerce.order.completed`	Apparel	Top	10,000
`airbridge.ecommerce.order.completed`	Apparel	Bottom	20,000

The Event Action “Apparel” occurred twice in the Order Complete event.
The Event Labels “Top” and “Bottom” each occurred once in the Order Complete event.
The Event Value of the Order Complete event totaled 30,000 KRW, which is the total revenue from the Order Complete event.

Limitations for Event Value

The following limitations apply to data collected as the Event Value:

Events that don’t match the data type aren’t collected. The Event Value data type is float.
If the collected data exceeds the maximum of 9 decimal places, only data up to 9 decimal places is collected.

Attribute

An Attribute is an additional detail collected in an Airbridge event beyond the Event Action and Event Label. Depending on the Attribute type, it’s collected as a string, a number, and so on.

AttentionData collected as the Attribute cannot be viewed in Airbridge reports. If you want to collect event details and view them in Airbridge reports, use the Event Action and the Event Label.

There are two types of Attributes: Semantic Attributes and Custom Attributes.

Semantic Attribute: an Attribute predefined by Airbridge.
Custom Attribute: an Attribute that you define.

Semantic Attribute

A Semantic Attribute is an Attribute predefined by Airbridge.

List of Semantic Attributes

Find the Semantic Attributes supported by Airbridge below.

Name	Data Type	Key	Description
Currency	string	`currency`	The 3-letter currency code of the standard currency set in Airbridge
Product List	array	`products`	The list of products; Refer to this example
Product ID	string	`products.$0.productID`	The ID of the first product in the product list
Product Name	string	`products.$0.name`	The name of the first product in the product list
Product Price	float	`products.$0.price`	The price of the first product in the product list; Negative numbers are supported for refunds and exchanges
Product Quantity	int	`products.$0.quantity`	The quantity of the first product in the product list
Product Currency	string	`products.$0.currency`	The 3-letter currency code for the price of the first product in the product list
Product Position	int	`products.$0.position`	The placement of the first product in the product list
Product Category ID	string	`products.$0.categoryID`	The ID of the product category that includes the first product in the product list
Product Category Name	string	`products.$0.categoryName`	The name of the product category that includes the first product in the product list
Product Brand ID	string	`products.$0.brandID`	The ID of the brand of the first product in the product list
Product Brand Name	string	`products.$0.brandName`	The name of the brand of the first product in the product list
Period	string	`period`	The duration in ISO 8601 format Example values: P7D, P1M, P6M, P1Y
Is Renewal Event	boolean	`isRenewal`	The renewal status
Renewal Count	int	`renewalCount`	The number of renewals
Product List ID	string	`productListID`	The product list ID
Cart ID	string	`cartID`	The cart ID
Transaction ID	string	`transactionID`	The transaction ID
Transaction Type	string	`transactionType`	The type of transaction, following the convention set by each Airbridge user; Cancelled transactions are always recorded as “cancel”
Transaction Paired Event Category	string	`transactionPairedEventCategory`	The Event Category of the transaction-related event; Event details are available in case of the “Order Cancel” event
Transaction Paired Event Timestamp	int	`transactionPairedEventTimestamp`	The time of occurrence of the transaction-related event in a 13-digit timestamp in milliseconds
Total Quantity	int	`totalQuantity`	The total quantity; The sum of the product quantities is automatically collected even when the total quantity is not defined
Search Query	string	`query`	The query requested by the user
In App Purchased	boolean	`inAppPurchased`	Whether or not it is an in-app purchase - true: Is an in-app purchase - false: Is not an in-app purchase
Contribution Margin	float	`contributionMargin`	Contribution margin, or the revenue left after covering the variable costs, in the standard currency set in Airbridge; Not calculated by Airbridge
List ID	string	`listID`	The list ID
Rate ID	string	`rateID`	The rate ID
Rate	float	`rate`	The rating
Max Rate	float	`maxRate`	The highest rating
Achievement ID	string	`achievementID`	The achievement ID
Shared Channel	string	`sharedChannel`	The shared channel
Date Time	string	`datetime`	The date and time in ISO-8601 format
Description	string	`description`	The description
Is Revenue Event	boolean	`isRevenue`	Whether or not it is a revenue-related event - true: Is a revenue-related event - false: Is not a revenue-related event
Place	string	`place`	The place
Schedule ID	string	`scheduleID`	The schedule ID
Type	string	`type`	The type
Level	string	`level`	The level
Score	float	`score`	The score

Example code for sending Semantic Attributes - Android

Android SDK

Airbridge.trackEvent(
    "purchase_card",
    mapOf(
        AirbridgeAttribute.TRANSACTION_ID to "1458132a-0d09-4944-a686-fcbee81b74f7",
        AirbridgeAttribute.PRODUCTS to listOf(
            mapOf(
                AirbridgeAttribute.PRODUCT_ID to "1234",
                AirbridgeAttribute.PRODUCT_NAME to "Nike 1",
                AirbridgeAttribute.PRODUCT_PRICE to 55,
                AirbridgeAttribute.PRODUCT_CURRENCY to "USD",
                AirbridgeAttribute.PRODUCT_QUANTITY to 1,
            ),
            mapOf(
                AirbridgeAttribute.PRODUCT_ID to "1235",
                AirbridgeAttribute.PRODUCT_NAME to "Nike 2",
                AirbridgeAttribute.PRODUCT_PRICE to 44,
                AirbridgeAttribute.PRODUCT_CURRENCY to "USD",
                AirbridgeAttribute.PRODUCT_QUANTITY to 1,
            ),
        ),
        AirbridgeAttribute.CURRENCY to "USD",
    )
)

Airbridge.trackEvent(
    "purchase_card",
    new HashMap() {{
        put(AirbridgeAttribute.TRANSACTION_ID, "1458132a-0d09-4944-a686-fcbee81b74f7");
        put(AirbridgeAttribute.PRODUCTS, Arrays.asList(
            new HashMap() {{
                put(AirbridgeAttribute.PRODUCT_ID, "1234");
                put(AirbridgeAttribute.PRODUCT_NAME, "Nike 1");
                put(AirbridgeAttribute.PRODUCT_PRICE, 55);
                put(AirbridgeAttribute.PRODUCT_CURRENCY, "USD");
                put(AirbridgeAttribute.PRODUCT_QUANTITY, 1);
            }},
            new HashMap() {{
                put(AirbridgeAttribute.PRODUCT_ID, "1235");
                put(AirbridgeAttribute.PRODUCT_NAME, "Nike 2");
                put(AirbridgeAttribute.PRODUCT_PRICE, 44);
                put(AirbridgeAttribute.PRODUCT_CURRENCY, "USD");
                put(AirbridgeAttribute.PRODUCT_QUANTITY, 1);
            }}
        ));
        put(AirbridgeAttribute.CURRENCY, "USD");
    }}
);

Android SDK (Deprecated)

Airbridge.trackEvent(
    category = "purchase_card",
    semanticAttributes = mapOf(
        SemanticAttributes.KEY_TRANSACTION_ID to "1458132a-0d09-4944-a686-fcbee81b74f7",
        SemanticAttributes.KEY_PRODUCTS to listOf(
            mapOf(
                Product.KEY_ID to "1234",
                Product.KEY_NAME to "Nike 1",
                Product.KEY_PRICE to 55,
                Product.KEY_CURRENCY to "USD",
                Product.KEY_QUANTITY to 1
            ),
            mapOf(
                Product.KEY_ID to "1235",
                Product.KEY_NAME to "Nike 2",
                Product.KEY_PRICE to 44,
                Product.KEY_CURRENCY to "USD",
                Product.KEY_QUANTITY to 1
            )
        ),
        SemanticAttributes.KEY_CURRENCY to "USD"
    )
)

Map<String, Object> product1 = new HashMap<>();
product1.put(Product.KEY_ID, "1234");
product1.put(Product.KEY_NAME, "Nike 1");
product1.put(Product.KEY_PRICE, 55);
product1.put(Product.KEY_CURRENCY, "USD");
product1.put(Product.KEY_QUANTITY, 1);

Map<String, Object> product2 = new HashMap<>();
product2.put(Product.KEY_ID, "1235");
product2.put(Product.KEY_NAME, "Nike 2");
product2.put(Product.KEY_PRICE, 44);
product2.put(Product.KEY_CURRENCY, "USD");
product2.put(Product.KEY_QUANTITY, 1);

List<Map<String, Object>> products = new ArrayList<>();
products.add(product1);
products.add(product2);

Map<String, Object> semanticAttributes = new HashMap<>();
semanticAttributes.put(SemanticAttributes.KEY_TRANSACTION_ID, "1458132a-0d09-4944-a686-fcbee81b74f7");
semanticAttributes.put(SemanticAttributes.KEY_PRODUCTS, products);
semanticAttributes.put(SemanticAttributes.KEY_CURRENCY, "USD");

Airbridge.trackEvent(
    "purchase_card", // Category
    null, // Action
    null, // Label
    null, // Value
    null, // Custom Attributes
    semanticAttributes // Semantic Attributes
);

Example code for sending Semantic Attributes - iOS

iOS SDK

Airbridge.trackEvent(
    category: "purchase_card",
    semanticAttributes: [
        AirbridgeAttribute.TRANSACTION_ID: "1458132a-0d09-4944-a686-fcbee81b74f7",
        AirbridgeAttribute.PRODUCTS: [
            [
                AirbridgeAttribute.PRODUCT_ID: "1234",
                AirbridgeAttribute.PRODUCT_NAME: "Nike 1",
                AirbridgeAttribute.PRODUCT_PRICE: 55,
                AirbridgeAttribute.PRODUCT_CURRENCY: "USD",
                AirbridgeAttribute.PRODUCT_QUANTITY: 1,
            ],
            [
                AirbridgeAttribute.PRODUCT_ID: "1235",
                AirbridgeAttribute.PRODUCT_NAME: "Nike 2",
                AirbridgeAttribute.PRODUCT_PRICE: 44,
                AirbridgeAttribute.PRODUCT_CURRENCY: "USD",
                AirbridgeAttribute.PRODUCT_QUANTITY: 1,
            ],
        ],
        AirbridgeAttribute.CURRENCY: "USD",
    ]
)

[Airbridge trackEventWithCategory:@"purchase_card"
    semanticAttributes:@{
        AirbridgeAttribute.TRANSACTION_ID : @"1458132a-0d09-4944-a686-fcbee81b74f7",
        AirbridgeAttribute.PRODUCTS : @[
            @{
                AirbridgeAttribute.PRODUCT_ID : @"1234",
                AirbridgeAttribute.PRODUCT_NAME : @"Nike 1",
                AirbridgeAttribute.PRODUCT_PRICE : @(55),
                AirbridgeAttribute.PRODUCT_CURRENCY : @"USD",
                AirbridgeAttribute.PRODUCT_QUANTITY : @(1),
            },
            @{
                AirbridgeAttribute.PRODUCT_ID : @"1235",
                AirbridgeAttribute.PRODUCT_NAME : @"Nike 2",
                AirbridgeAttribute.PRODUCT_PRICE : @(44),
                AirbridgeAttribute.PRODUCT_CURRENCY : @"USD",
                AirbridgeAttribute.PRODUCT_QUANTITY : @(1),
            },
        ],
        AirbridgeAttribute.CURRENCY : @"USD",
}];

iOS SDK (Deprecated)

let event = ABInAppEvent()

event?.setCategory("purchase_card")

let semantics: [String: Any] = [
    ABSemanticsKey.transactionID: "1458132a-0d09-4944-a686-fcbee81b74f7",
    ABSemanticsKey.products: [
        [
            ABProductKey.productID: "1234",
            ABProductKey.name: "Nike 1",
            ABProductKey.price: 55,
            ABProductKey.currency: "USD",
            ABProductKey.quantity: 1,
        ],
        [
            ABProductKey.productID: "1235",
            ABProductKey.name: "Nike 2",
            ABProductKey.price: 44,
            ABProductKey.currency: "USD",
            ABProductKey.quantity: 1,
        ],
    ],
    ABSemanticsKey.currency: "USD",
]
event?.setSemantics(semantics)

event?.send()

ABInAppEvent* event = [[ABInAppEvent alloc] init];
    
[event setCategory:@"purchase_card"];
    
NSDictionary* semantics = @{
    ABSemanticsKey.transactionID: @"1458132a-0d09-4944-a686-fcbee81b74f7",
    ABSemanticsKey.products: @[@{
            ABProductKey.productID: @"1234",
            ABProductKey.name: @"Nike 1",
            ABProductKey.price: @(55),
            ABProductKey.currency: @"USD",
            ABProductKey.quantity: @(1),
        }, @{
            ABProductKey.productID: @"1235",
            ABProductKey.name: @"Nike 2",
            ABProductKey.price: @(44),
            ABProductKey.currency: @"USD",
            ABProductKey.quantity: @(1),
    }],
    ABSemanticsKey.currency: @"USD"
};
[event setSemantics:semantics];
    
[event send];

Example code for sending Semantic Attributes - Web

airbridge.events.send("purchase_card", {
  semanticAttributes: {
    transactionID: '1458132a-0d09-4944-a686-fcbee81b74f7',
    products: [{
      productID: "1234",
      name: "Nike 1",
      price: 55,
      currency: "USD",
      quantity: 1
    }, {
      productID: "1235",
      name: "Nike 2",
      price: 44,
      currency: "USD",
      quantity: 1
    }],
    currency: "USD"
  }
});

Custom Attribute

A Custom Attribute is an Attribute that you define. All data collected as Custom Attributes is contained in a single column in raw data exports. For example, if you define an item type and quantity as Custom Attributes, both sword and 1 are contained in a single column.

Example code for Custom Attributes - Android

Android SDK

Airbridge.trackEvent(
    category = "purchase_card",
    customAttributes = mapOf(
        "userRank" to "1",
        "itemType" to "sword"
    )
)

Airbridge.trackEvent(
    "purchase_card",    // Category
    null,               // Semantic Attributes
    new HashMap() {{    // Custom Attributes
        put("userRank", "1");
        put("itemType", "sword");
    }}
);

Android SDK (Deprecated)

Airbridge.trackEvent(
    category = "purchase_card",
    customAttributes = mapOf(
        "userRank" to "1",
        "itemType" to "sword"
    )
)

Map<String, Object> customAttributes = new HashMap<>();
customAttributes.put("userRank", "1");
customAttributes.put("itemType", "sword");

Airbridge.trackEvent(
    "purchase_card",    // Category
    null,               // Action
    null,               // Label
    null,               // Value
    customAttributes,   // Custom Attributes
    null                // Semantic Attributes
);

Example code for Custom Attributes - iOS

iOS SDK (v4)

Airbridge.trackEvent(
    category: "purchase_card",
    semanticAttributes: [:],
    customAttributes: [
        "userRank": "1",
        "itemType": "sword",
    ]
)

[Airbridge
    trackEventWithCategory:@"purchase_card"
    semanticAttributes:@{}
    customAttributes:@{@"userRank" : @"1", @"itemType" : @"sword"}];

iOS SDK (Previous)

let event = ABInAppEvent()

event?.setCategory("purchase_card")

let customs: [String: Any] = [
    "userRank": "1",
    "itemType": "sword",
]
event?.setCustoms(customs)

event?.send()

ABInAppEvent *event = [[ABInAppEvent alloc] init];

[event setCategory:@"purchase_card"];
NSDictionary *customs = @{@"userRank" : @"1", @"itemType" : @"sword"};
[event setCustoms:customs];

[event send];

Example code for Custom Attributes - Web

airbridge.events.send("purchase_card", {
  "customAttributes": {
    "userRank": "1",
    "itemType": "sword"
  }
})

Limitations for Attribute

The following limitations apply to data collected as the Attribute:

Events that don’t match the Semantic Attribute data type aren’t collected. Be careful, as the data type differs for each Semantic Attribute.
If data collected as a Semantic Attribute exceeds the maximum length, only data up to the limit is collected. The maximum length is 1,024 characters for string and 64 bits for integer or float.
The maximum length for a Custom Attribute is 2,048. If it exceeds this length, it’s recorded as ERROR_MAX_LENGTH_EXCEEDED.

Trigger

The Trigger is the point at which an Airbridge event is collected. The same Airbridge event can be counted differently depending on when it’s collected. For example, if you collect the Order Complete event when the purchase button is selected, the event is counted even when the purchase fails for reasons such as insufficient funds. If you collect the Order Complete event when the order confirmation page appears, you can collect the Order Complete event more accurately.

​Event properties at a glance

​Event Category

​Naming rules and limitations for Event Category

​View data by Event Category

​Event Action and Event Label

​Naming rules and limitations for Event Action and Event Label

​View data by Event Action and Event Label

​Event Value

​Limitations for Event Value

​Attribute

​Semantic Attribute

​Android SDK

​Android SDK (Deprecated)

​iOS SDK

​iOS SDK (Deprecated)

​Custom Attribute

​Android SDK

​Android SDK (Deprecated)

​iOS SDK (v4)

​iOS SDK (Previous)

​Limitations for Attribute

​Trigger

Event properties at a glance

Event Category

Naming rules and limitations for Event Category

View data by Event Category

Event Action and Event Label

Naming rules and limitations for Event Action and Event Label

View data by Event Action and Event Label

Event Value

Limitations for Event Value

Attribute

Semantic Attribute

Android SDK

Android SDK (Deprecated)

iOS SDK

iOS SDK (Deprecated)

Custom Attribute

Android SDK

Android SDK (Deprecated)

iOS SDK (v4)

iOS SDK (Previous)

Limitations for Attribute

Trigger