SKAdNetwork (SKAN) is Apple’s privacy-preserving framework for attributing iOS app installs without relying on user information or device information. Airbridge’s SKAdNetwork Configuration API provides ad channels with conversion values and the event mapped to each conversion value. Ad channels can then decode the postbacks they receive. The API returns as a nested JSON.
Marketers can modify the mapping of conversion values and events at any time. Therefore, ad channels are recommended to call the SKAdNetwork Configuration API on a daily basis and keep the conversion value schema up to date.
https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key=/{API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}
The following table describes the information a SKAN postback may contain, and how the information is structured and labelled.
Note that Airbridge has two versions of [SKAN Conversion Value Rule] page, one of which supports all versions of SKAN, including both 3.0 or 4.0. The following table and the SKAdNetwork Configuration API are only applicable to the all-version page. For more information the [SKAN Conversion Value Rule] page, refer to this article.
You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.
Represents the media type of the resource. Defaults to application/json.
ex) 1370724782
The names of Integrated Channels are shown using the Airbridge display name.
ex) tiktok, facebook.business
API key that Airbridge provides to authenticated ad channels.
curl -X GET 'https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}' \
-H 'Accept-Language: ko' \
-H 'Content-Type: application/json'Not Found: URL.
{
"postbacks": [
{
"conversion_schema": {
"fine": {
"schema": [
{
"events": [],
"is_overlapped": false,
"conversion_value": "0"
},
{
"events": [
{
"values": {
"max_amount": 1,
"min_amount": 0
},
"event_name": "airbridge.ecommerce.order.completed",
"measurement_type": "engagement",
"partner_event_name": "adnetwork_mobile_purchase"
},
{
"values": {
"max_amount": 10000,
"min_amount": 0
},
"event_name": "airbridge.ecommerce.order.completed",
"measurement_type": "revenue",
"partner_event_name": "adnetwork_mobile_purchase"
}
],
"is_overlapped": false,
"conversion_value": "1"
}
],
"lock_window": null
},
"coarse": {
"schema": [
{
"events": [
{
"values": {
"max_amount": 4,
"min_amount": 3
},
"event_name": "app_open",
"measurement_type": "retention",
"partner_event_name": null
}
],
"is_overlapped": null,
"conversion_value": "low"
}
]
}
},
"postback_sequence_index": 0
}
],
"config_type": "SKAN 4.0",
"default_currency": "KRW",
"last_update_time": 1700000000
}{
"type": "about:blank",
"title": "UNAUTHORIZED",
"detail": "Unauthorized.",
"status": 401,
"traceId": "1-000000-000000000000000",
"instance": null
}{
"type": "about:blank",
"title": "url_disabled_by_toggle",
"detail": "URL has been disabled. Turn on the toggle button to reactivate.",
"status": 404,
"traceId": "1-000000-000000000000000",
"instance": null
}{
"type": "about:blank",
"title": "NOT_FOUND",
"detail": "There is no such app. Please check.",
"status": 404,
"traceId": "1-000000-000000000000000",
"instance": null
}https://api.airbridge.io/skadnetwork/conversion-bit-config/v4?api_key=/{API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}
Get SKAN 3.0 Conversion Value Schema.
You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.
Represents the media type of the resource. Defaults to application/json.
Itunes App ID (ex. 1370724782)
The names of Integrated Channels are shown using the Airbridge display name.
ex) tiktok, facebook.business
API key that Airbridge provides to authenticated ad channels.
curl -X GET 'https://api.airbridge.io/skadnetwork/conversion-bit-config/v4?api_key={API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}' \
-H 'Accept-Language: ko' \
-H 'Content-Type: application/json'
Query Parameters |
Type |
Description |
|---|---|---|
| string | The three-letter code for the app’s standard currency set within Airbridge. |
| number | The Unix timestamp corresponding to the last update time of SKAN settings in Airbridge. |
| object | The conversion value schema. |
| string | The conversion value, which is an integer between |
| array | Information about the event mapped to the conversion value. |
| string | The Event Category of the event mapped to the conversion value; Is different from the event name set by ad channels. |
| object | Information about the ranges for the selected measurement type. |
| number | The lower value of the range; Is included in the range. |
| number | The upper value of the range; Is not included in the range. |
{
"default_currency": "USD",
"last_update_time": 1700000000,
"conversion_bits_rules": [
{
"events": [
{
"values": {
"amount": 1,
"max_amount": 10000
},
"event_name": "adnetwork_purchase"
}
],
"conversion_value": 1
},
{
"events": [
{
"values": {
"amount": 1,
"max_amount": 10000
},
"event_name": "adnetwork_purchase"
},
{
"event_name": "adnetwork_signup"
}
],
"conversion_value": 2
}
]
}Was this page helpful?