SKAdNetwork Configuration API

    SKAdNetwork(SKAN)는 iOS 환경에서 개인정보를 보호하며 유저 또는 디바이스 정보없이 iOS 앱 설치 캠페인 성과를 측정할 수 있는 애플의 프레임워크입니다. 에어브릿지는 SKAdNetwork Configuration API를 통해 인증된 광고 채널에 전환값과 광고주가 전환값에 매핑한 이벤트를 제공합니다. 이를 활용하면 광고 채널은 광고주의 SKAN 포스트백을 디코딩할 수 있습니다. API는 중첩된 JSON 형태로 반환됩니다.

    광고주는 언제든 전환값과 매핑된 이벤트를 변경할 수 있습니다. 광고 채널은 SKAdNetwork Configuration API를 매일 호출해 최신 구성으로 업데이트하는 것을 권장합니다.

    알립니다

    SKAdNetwork Configuration API는 인증된 광고 채널에만 사용할 수 있는 API입니다.

    전환값 가져오기 (SKAN 3, SKAN 4)

    GET

    https://api.airbridge.io/skadnetwork/v1/conversion-value-schema?api_key=/{API_KEY}&response_format={RESPONSE_FORMAT}&itunes_app_id={ITUNES_APP_ID}

    에어브릿지는 전환값(Conversion Value) 설정 대시보드를 2가지 지원합니다. 아래 API를 사용하면 고객사가 설정한 전환값 정보를 대시보드 종류와 관계없이 가져갈 수 있습니다.

    모든 SKAN 버전과 모든 대시보드를 제공하기 때문에 해당 API로 전환값 정보를 가져가는 것을 권장합니다.

    연관 가이드) 모든 SKAN 전환값 설정하기

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Query Params

    itunes_app_id
    필수string

    iOS App Store ID를 입력해 주세요.

    예시) 1370724782

    response_format
    필수string

    광고 채널의 에어브릿지 표시 이름. 광고 채널 이름과 다릅니다.

    예시) tiktok, facebook.business

    연관 가이드) 에어브릿지와 연동된 광고 채널 목록

    api_key
    필수string

    에어브릿지가 인증된 광고 채널에 제공하는 API 키입니다. 에어브릿지에 요청해 주세요.

    Request
    123
    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'

    Response

    200SUCCESS

    config_type
    string

    전환값을 설정한 SKAN 버전

    default_currency
    string

    에어브릿지에 설정한 3자리 앱 기준 통화

    last_update_time
    number

    SKAN 설정이 에어브릿지에서 마지막으로 업데이트된 시각. 8자리 유닉스 시간

    postbacks
    object[]

    SKAN 포스트백 설정

    postbacks[0].postback_sequence_index
    number

    포스트백 티어. 0, 1, 2 또는 3입니다.

    postbacks[0].conversion_schema
    object

    전환값 종류. 상세 전환값 또는 단순 전환값입니다.

    postbacks[0].conversion_schema.fine
    object

    전체 상세 전환값 설정. 여러 개의 상세 전환값 설정으로 구성됩니다.

    postbacks[0].conversion_schema.fine.schema
    object[]

    단일 상세 전환값의 구성

    postbacks[0].conversion_schema.fine.schema[0].conversion_value
    string

    상세 전환값. 0부터 63까지 정수 중에서 하나입니다

    postbacks[0].conversion_schema.fine.schema[0].events
    object[]

    상세 전환값에 매핑된 이벤트에 대한 정보

    postbacks[0].conversion_schema.fine.schema[0].events[0].event_name
    string

    상세 전환값에 매핑된 에어브릿지 이벤트 카테고리. 광고 채널 이벤트 이름과 다릅니다.

    postbacks[0].conversion_schema.fine.schema[0].events[0].partner_event_name
    string

    에어브릿지 이벤트와 매핑된 광고 채널 이벤트 이름

    postbacks[0].conversion_schema.fine.schema[0].events[0].measurement_type
    string

    상세 전환값의 측정타입. 인앱이벤트(engagement) 또는 이벤트 금액(revenue)이 제공됩니다.

    postbacks[0].conversion_schema.fine.schema[0].events[0].values
    object

    설정한 측정타입에 적용되는 측정 범위에 대한 정보

    postbacks[0].conversion_schema.fine.schema[0].events[0].values.min_amount
    number

    측정 범위의 시작값. 시작값을 초과한 범위를 측정합니다.

    postbacks[0].conversion_schema.fine.schema[0].events[0].values.max_amount
    number

    측정 범위의 종료값. 종료값까지 측정합니다.

    postbacks[0].conversion_schema.fine.schema[0].is_overlapped
    string

    중복 기여 판별에 대한 정보입니다.

    • true: 중복으로 기여됐습니다

    • false: 중복으로 기여되지 않았습니다

    • 빈칸: 중복 기여 판별을 사용하지 않습니다

    postbacks[0].conversion_schema.fine.lock_window
    string

    락 윈도우 설정.
    상세 전환값의 락 윈도우는 항상 null입니다.

    postbacks[0].conversion_schema.coarse
    string

    전체 단순 전환값 설정. 여러 개의 전환값으로 구성됩니다

    postbacks[0].conversion_schema.coarse.schema
    object[]

    단일 단순 전환값 설정

    postbacks[0].conversion_schema.coarse.schema[0].conversion_value
    string

    단순 전환값. low, medium, high 중 하나입니다

    postbacks[0].conversion_schema.coarse.schema[0].events
    object[]

    단순 전환값에 매핑된 이벤트에 대한 정보

    postbacks[0].conversion_schema.coarse.schema[0].events[0].event_name
    string

    단순 전환값에 매핑된 에어브릿지 이벤트 카테고리. 광고 채널 이벤트 이름과 다릅니다.

    postbacks[0].conversion_schema.coarse.schema[0].events[0].partner_event_name
    string

    에어브릿지 이벤트와 매핑된 광고 채널 이벤트 이름

    postbacks[0].conversion_schema.coarse.schema[0].events[0].measurement_type
    string

    단순 전환값의 측정타입.
    인앱이벤트(engagement) 이벤트 금액(revenue), 또는 리텐션(retention) 중에서 1개만 제공됩니다. 중복 기여 판별을 사용하면 제공되지 않습니다

    postbacks[0].conversion_schema.coarse.schema[0].events[0].values
    object[]

    설정한 측정타입에 적용되는 측정 범위에 대한 정보

    postbacks[0].conversion_schema.coarse.schema[0].events[0].values.min_count
    string

    측정 범위의 시작값. 시작값을 초과한 범위를 측정합니다.

    측정타입이 리텐션이면 시작값부터 측정합니다.

    postbacks[0].conversion_schema.coarse.schema[0].events[0].values.max_count
    string

    측정 범위의 종료값. 종료값까지 측정합니다

    postbacks[0].conversion_schema.coarse.schema[0].is_overlapped
    string

    중복 기여 판별에 대한 정보입니다.

    • true: 중복으로 기여됐습니다

    • false: 중복으로 기여되지 않았습니다

    • 빈칸: 중복 기여 판별을 사용하지 않습니다

    postbacks[0].conversion_schema.coarse.lock_window
    string

    락 윈도우 설정.
    2번째, 3번째 포스트백에서만 제공됩니다.

    401ERROR

    인증된 광고 채널이 아닙니다

    404ERROR

    해당 주소(URL)를 찾을 수 없습니다.

    404ERROR

    해당하는 앱 또는 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
}
    Response
    12345678
    {
  "type": "about:blank",
  "title": "UNAUTHORIZED",
  "detail": "Unauthorized.",
  "status": 401,
  "traceId": "1-000000-000000000000000",
  "instance": null
}
    Response
    12345678
    {
  "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
}
    Response
    12345678
    {
  "type": "about:blank",
  "title": "NOT_FOUND",
  "detail": "There is no such app. Please check.",
  "status": 404,
  "traceId": "1-000000-000000000000000",
  "instance": null
}

    전환값 설정 가져오기 (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}

    에어브릿지는 전환값(Conversion Value) 설정 대시보드를 2가지 지원합니다. 아래 API를 사용하면 고객사가 SKAN 3만 지원하는 대시보드에 설정한 정보를 가져갈 수 있습니다.

    해당 대시보드에 대한 자세한 내용은 아래 에어브릿지 가이드를 참고해 주세요.

    연관 가이드) 기본 SKAN 전환값 설정하기

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Query Params

    ios_app_store_id
    필수string

    iOS App Store ID를 입력해 주세요.

    예시) 1370724782

    response_format
    필수string

    광고 채널의 에어브릿지 표시 이름. 광고 채널 이름과 다릅니다.

    예시) tiktok, facebook.business

    연관 가이드) 에어브릿지와 연동된 광고 채널 목록

    api_key
    필수string

    에어브릿지가 인증된 광고 채널에 제공하는 API 키입니다. 에어브릿지에 요청해 주세요.

    Request
    123
    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'

    Response

    200SUCCESS

    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
    }
  ]
}