SKAdNetwork Configuration API

    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.


    Response for all versions of SKAN

    GET

    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.

    Request

    Query Params

    ios_app_store_id
    Requiredstring

    iOS App Store ID.

    ex) 1370724782

    response_format
    Requiredstring

    The names of Integrated Channels are shown using the Airbridge display name.

    ex) tiktok, facebook.business

    Guide) Ad Channels Integrated with Airbridge

    api_key
    Requiredstring

    API key that Airbridge provides to authenticated ad channels.

    Request
    1234
    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 'Aceept-Language: en' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

    Response

    200 SUCCESS

    #{"width":"60px"}

    Query Parameters

    #{"width":"20px"}

    Type

    #{"width":"180px"}

    Description

    config_type

    string

    Indicates whether the conversion values were set for SKAN 3.0 or SKAN 4.0 in the Airbridge dashboard.

    default_currency

    string

    The three-letter code for the app’s standard currency set within Airbridge.

    last_update_time

    number

    The Unix timestamp corresponding to the last update time of SKAN settings in Airbridge.

    postbacks

    array

    The entire configuration of SKAN postbacks in Airbridge.

    .$.postback_sequence_index

    number

    The postback data tier; Is 0, 1, 2, or 3.

    .$.conversion_schema

    object

    The type of the conversion value; Is either fine or coarse.

    .$.conversion_schema.fine

    object

    The entire configuration of all fine conversion values configured in Airbridge.

    .$.conversion_schema.fine.schema

    array

    The conversion value schema for the fine conversion value.

    .$.$.conversion_value

    string

    The fine conversion value, which is an integer between 0 and 63.

    .$.$.events

    array

    Information about the event mapped to the fine conversion value.

    .$.$.$.event_name

    string

    The Event Category of the event mapped to the fine conversion value; Is different from the event name set by ad channels.

    .$.$.$.partner_event_name

    string

    The event name set by you, namely, the ad channel.

    .$.$.$.measurement_type

    string

    The measurement type of the fine conversion valueIs one of the following:
    - engagement: The measurement type is In-app Events
    - revenue: The measurement type is Revenue

    .$.$.$.values

    object

    Information about the occurrence ranges or the revenue ranges for the selected measurement type

    .$.$.$.values.min_amount

    number

    The lower value of the range; Is not included in the range

    .$.$.$.values.max_amount

    number

    The upper value of the range; Is included in the range

    .$.$.is_overlapped

    boolean

    Information about the Attribution Overlap measurement type Is one of the following:
    - true: Attribution Overlap selected; App install double counted
    - false: Attribution Overlap selected; App install not double counted
    - null: Attribution Overlap not selected

    .$.conversion_schema.fine.lock_window

    object

    The lock window settings; Is always null for fine conversion values.

    .$.conversion_schema.coarse

    object

    The entire configuration of all coarse conversion values configured in Airbridge.

    .$.conversion_schema.coarse.schema

    array

    The conversion value schema for the coarse conversion value.

    .$.$.conversion_value

    string

    The coarse conversion value, which is low, medium, or high.

    .$.$.events

    array

    Information about the event mapped to the coarse conversion value.

    .$.$.$.event_name

    string

    The Event Category of the event mapped to the coarse conversion value; Is different from the event name set by ad channels.

    .$.$.partner_event_name

    string

    The event name set by you, namely, the ad channel.

    .$.$.$.measurement_type

    string

    The measurement type of the coarse conversion value; Is omitted if Attribution Overlap is selected Is one of the following:
    - engagement: The measurement type is In-app Events
    - revenue: The measurement type is Revenue
    - retention: The measurement type is Retention

    .$.$.$.values

    object

    Information about the occurrence ranges, revenue ranges, or retention ranges for the selected measurement type.

    .$.$.$.values.min_amount

    number

    The lower value of the range; Is not included in the range, except when the measurement type is Retention.

    .$.$.$.values.max_amount

    number

    The upper value of the range; Is included in the range.

    .$.$.is_overlapped

    boolean

    Information about the Attribution Overlap measurement type; Is omitted if other measurement type is selected Is one of the following:
    - true: Attribution Overlap selected; App install double counted
    - false: Attribution Overlap selected; App install not double counted
    - null: Attribution Overlap not selected

    .$.conversion_schema.coarse.lock_window

    object

    The lock window settings; Is only provided for the second and third postbacks.

    401 ERROR

    Unauthorized.

    404 ERROR

    Not Found: App.

    404 ERROR

    Not Found: URL.

    Response
    1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
    {
      "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
    }

    Get SKAN 3.0 Conversion Value Schema (Deprecated)

    GET

    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.

    Request

    Query Params

    itunes_app_id
    Requiredstring

    Itunes App ID (ex. 1370724782)

    response_format
    Requiredstring

    Channel Name (ex. tiktok, facebook.business, criteo)

    api_key
    Requiredstring

    Pre-shared API Key on Ad Network.

    Request
    1234
    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: en' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

    Response

    200 SUCCESS

    #{"width":"60px"}

    Query Parameters

    #{"width":"20px"}

    Type

    #{"width":"180px"}

    Description

    default_currency

    string

    The three-letter code for the app’s standard currency set within Airbridge.

    last_update_time

    number

    The Unix timestamp corresponding to the last update time of SKAN settings in Airbridge.

    conversion_bits_rules

    object

    The conversion value schema.

    .$.conversion_value

    string

    The conversion value, which is an integer between 0 and 63.

    .$.events

    array

    Information about the event mapped to the conversion value.

    .$.$.event_name

    string

    The Event Category of the event mapped to the conversion value; Is different from the event name set by ad channels.

    .$.$.values

    object

    Information about the ranges for the selected measurement type.

    .$.$.values.amount

    number

    The lower value of the range; Is included in the range.

    .$.$.values.max_amount

    number

    The upper value of the range; Is not included in the range.

    Response
    123456789101112131415161718192021222324252627282930313233
    {
      "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?

    Have any questions or suggestions?