Note
This article is a guide for media partners.
SKAN integration is required per ad channel to view SKAN data in Airbridge. It is a different integration module from the integration using tracking links.
Below is the general SKAN data flow.
1. The advertiser provides the conversion values from the iOS device to the ad channel.
2. The ad channel sends the conversion values to Airbridge.
3. Airbridge sends the event data as per conversion value mapping to the ad channel.
SKAN integration is required to support the second and third steps of the above process.
The ad channel needs to forward the received SKAN postbacks to the Airbridge SKAN Postback API. Choose one of the following methods for transmission.
The data transmission method differs by parameter. If the source is SKAdNetwork Postback, it needs to be forwarded as is without any additional processing. If the source is an ad network, it needs to be decoded by the ad channel, or additional information needs to be added before transmission.
The SKAN postbacks can be sent to Airbridge using the POST method.
Method | POST |
|---|---|
Endpoint |
|
Content-Type | application/json |
Response | 200: OK |
The body must include the information listed below. Campaign parameters are optional.
All information included in the SKAN postback
The channel name that received the attribution credit (attributed-channel)
IP address and postback timestamp provided by the iOS device
Refer to the table below for details about the required parameters.
Parameter | Is it required? | Description | Source | Type |
|---|---|---|---|---|
version | true | SKAdNetwork Documentation (* Send NULL for versions earlier than 2.0) | SKAdNetwork Postback | string (nullable) |
ad-network-id | true | SKAdNetwork Postback | string | |
campaign-id | true | SKAdNetwork Postback | integer | |
source-identifier | true | SKAdNetwork (* Send NULL for versions earlier than 4.0) | SKAdNetwork Postback | string |
transaction-id | true | SKAdNetwork Postback | string | |
app-id | true | SKAdNetwork Postback | integer | |
attribution-signature | true | SKAdNetwork Postback | string | |
redownload | true | SKAdNetwork Documentation (* Send NULL for versions earlier than 2.0) | SKAdNetwork Postback | boolean |
fidelity-type | true | SKAdNetwork Documentation (* Send NULL for versions earlier than 2.2) | SKAdNetwork Postback | Integer |
did-win | true | SKAdNetwork Documentation (* Send NULL for versions earlier than 3.0) | SKAdNetwork Postback | boolean |
postback-sequence-index | true | SKAdNetwork (* Send NULL for versions earlier than 4.0) | SKAdNetwork Postback | integer |
source-app-id | false | SKAdNetwork Postback | integer | |
conversion-value | false | SKAdNetwork Postback | integer | |
coarse-conversion-value | false | SKAdNetwork Postback | string | |
attributed-channel | true | Ad channel that received the attribution credit(Ad channel name registered with Airbridge) | Ad Network | string |
attributed-campaign | false | Attributed Campaign | Ad Network | string |
attributed-campaign-id | false | Attributed Campaign ID | Ad Network | string |
attributed-ad-group | false | Attributed Ad Group | Ad Network | string |
attributed-ad-group-id | false | Attributed Ad Group ID | Ad Network | string |
attributed-ad-creative | false | Attributed Ad Creative | Ad Network | string |
attributed-ad-creative-id | false | Attributed Ad Creative ID | Ad Network | string |
attributed-sub-publisher | false | Attributed Sub Publisher | Ad Network | string |
attributed-sub-sub-publisher-1 | false | Attributed Sub Sub Publisher 1 | Ad Network | string |
attributed-sub-sub-publisher-2 | false | Attributed Sub Sub Publisher 2 | Ad Network | string |
attributed-sub-sub-publisher-3 | false | Attributed Sub Sub Publisher 3 | Ad Network | string |
ip | false | Device Public IP | Ad Network | string |
timestamp | true | The time the ad network received the postback in the iOS device. Provide a 13-digit UNIX timestamp. | Ad Network | integer |
curl --location --request POST 'https://postback.airbridge.io/skadnetwork/v1' \
--header 'Content-type: application/json' \
--data-raw '{
"version":"2.0",
"ad-network-id": "abcabcabc.skadnetwork",
"campaign-id": 99,
"transaction-id": "68eb3d91-15f5-44ee-9267-25c7655c20b6",
"app-id": 888707086,
"attribution-signature": "MDYCGQCsQ4y8d4BlYU9b8Qb9BPWPi+ixk/OiRysCGQDZZ8fpJnuqs9my8iSQVbJO/oU1AXUROYU=",
"redownload": false,
"source-app-id": 888707074,
"conversion-value": 63,
"attributed-channel": "adnetwork_abc",
"attributed-campaign": "test_campaign",
"attributed-campaign-id": "test_campaign_id",
"ip": "192.0.2.0",
"timestamp": 1607678183995
}'The SKAN postbacks can be sent to Airbridge using the 307 Redirect method.
Checklist for Ad Networks
Transmit the payload containing the required parameters and parameters related to the ad campaign that received the attribution credit to the Airbridge postback server (
postback.airbridge.io). Upon successful transmission, a 200 response is expected.
Method | 307 Redirect |
|---|---|
Endpoint |
|
Response | 200: OK |
Refer to the table below and add information to the GET parameter in the Redirect URL. The ad channel that received the attribution credit (attributed-channel) must be included. Campaign parameters are optional.
Parameter | Is it required? | Description | Source |
|---|---|---|---|
attributed-channel | true | Ad channel that received the attribution credit (Ad channel name registered with Airbridge) | Ad Network |
attributed-campaign | false | Attributed Campaign | Ad Network |
attributed-campaign-id | false | Attributed Campaign ID | Ad Network |
attributed-ad-group | false | Attributed Ad Group | Ad Network |
attributed-ad-group-id | false | Attributed Ad Group ID | Ad Network |
attributed-ad-creative | false | Attributed Ad Creative | Ad Network |
attributed-ad-creative-id | false | Attributed Ad Creative ID | Ad Network |
attributed-sub-publisher | false | Attributed Sub Publisher | Ad Network |
attributed-sub-sub-publisher-1 | false | Attributed Sub Sub Publisher 1 | Ad Network |
attributed-sub-sub-publisher-2 | false | Attributed Sub Sub Publisher 2 | Ad Network |
attributed-sub-sub-publisher-3 | false | Attributed Sub Sub Publisher 3 | Ad Network |
https://postback.airbridge.io/skadnetwork/v1?attributed-channel=adnetwork_abc&attributed-campaign=test_campaign&attributed-campaign-id=test_campaign_id
The ad channel utilizes the SKAdNetwork Conversion Value Config API to retrieve the advertiser-provided conversion value settings and subsequently decodes the conversion value using those settings.
Was this page helpful?