Tracking Link

    에어브릿지의 트래킹 링크는 다양한 환경에 대응하는 올인원 링크입니다.

    트래킹 링크를 통해 다양한 플랫폼, 채널, 상황에서 링크를 클릭하는 유저를 원하는 목적지에 도달시키며, 링크 클릭, 클릭 후 설치, 설치 후 구매 행동 등 유저들로부터 발생한 행동에 어떤 채널이 기여되었는지 분석할 수 있습니다.

    트래킹 링크 API 토큰 활용

    클라이언트에서 트래킹 링크를 생성하고자 하는 경우 '트래킹 링크 API 토큰' 활용을 권장합니다.


    생성하기

    POST

    https://api.airbridge.io/v1/tracking-links

    트래킹 링크를 생성합니다.

    Request

    Body Params

    channel
    필수string

    터치포인트와 컨버젼이 발생한 채널명.

    에어브릿지의 채널은 S2S 형태의 포스트백이 연동된 Integrated 채널과 직접 생성할 수 있는 Custom 채널로 나뉘어집니다.

    Integrated 채널은 [Integrated Channel] 에서 확인할 수 있습니다. Integrated 채널 이외에 모든 채널은 Custom 채널입니다.

    campaignParams
    object

    트래킹 링크에 들어갈 캠페인 파라미터.

    campaignParams.campaign
    string

    캠페인 이름.

    campaignParams.ad_group
    string

    광고 그룹.

    campaignParams.ad_creative
    string

    광고 소재.

    campaignParams.content
    string

    광고 콘텐츠.

    campaignParams.term
    string

    검색 광고 키워드.

    campaignParams.sub_id
    string

    하위 네트워크 혹은 제휴 매체사 등을 나타내는 아이디.

    campaignParams.sub_id_1
    string

    하위 네트워크 또다른 하위 네트워크 아이디.(sub-sub publisher)
    하위 매체 순서(계층)에 맞게 사용해야합니다.(sub_id_1 > sub_id_2 > sub_id_3)

    campaignParams.sub_id_2
    string

    하위 네트워크 또다른 하위 네트워크 아이디.(sub-sub publisher)
    하위 매체 순서(계층)에 맞게 사용해야합니다.(sub_id_1 > sub_id_2 > sub_id_3)

    campaignParams.sub_id_3
    string

    하위 네트워크 또다른 하위 네트워크 아이디.(sub-sub publisher)
    하위 매체 순서(계층)에 맞게 사용해야합니다.(sub_id_1 > sub_id_2 > sub_id_3)

    isReengagement
    enum

    Re-engagement 파라미터.

    ENUM VALUES
    OFF

    해당 트래킹링크에 발생한 터치포인트로 설치 및 인앱 이벤트를 기여합니다.

    ON-TRUE

    딥링크 오픈 및 그에 기인한 이벤트만 기여됩니다. Re-engagement 캠페인에 활용 가능합니다.

    ON-FALSE

    설치 이벤트 및 그에 기인한 인앱 이벤트만 기여됩니다. UA 캠페인에 활용 가능합니다.

    deeplinkUrl
    stringnullable

    리다이렉트할 딥링크 URL.

    deeplinkUrl이 없거나 null일 경우 deeplink가 설정되지 않습니다.

    fallbackPaths
    object

    플랫폼별 리다이렉트 경로.

    fallbackPaths.android
    enum

    안드로이드가 리다이렉트될 경로.

    ENUM VALUES
    google-play

    google play store로 랜딩합니다.

    airpage

    airpage로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    fallbackPaths.ios
    enum

    iOS에서 리다이렉트될 경로.

    ENUM VALUES
    itunes-appstore

    appstore로 랜딩합니다.

    airpage

    airpage로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    fallbackPaths.desktop
    enum

    데스크톱에서 리다이렉트될 경로.

    ENUM VALUES
    google-play

    google play store로 랜딩합니다.

    itunes-appstore

    appstore로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    fallbackPaths.option
    object
    fallbackPaths.option.iosCustomProductPageId
    string

    애플 앱 스토어의 맞춤형 제품 페이지(Custom Product Page)의 ppid.

    앱 스토어로 랜딩할 경우 맞춤형 제품 페이지를 보여줄 수 있도록 설정합니다.

    fallbackPaths.option.googlePlayCustomStoreListing
    string

    구글 플레이 스토어의 맞춤 스토어 등록정보(Custom Store Listing) listing 값.

    구글 플레이 스토어로 랜딩할 경우 맞춤 스토어 등록정보를 보여줄 수 있도록 설정합니다.

    ogTag
    object

    트래킹 링크를 공유 혹은 게시하면 노출되는 썸네일의 미리보기(Open Graph).

    ogTag.title
    string

    트래킹 링크의 og:title

    ogTag.description
    string

    트래킹 링크의 og:description

    ogTag.imageUrl
    string

    트래킹 링크의 og:image

    ogTag.websiteCrawl
    enumnullable

    fallbackPath에 지정된 url의 Open Graph를 트래킹 링크의 Open Graph로 타입.

    ENUM VALUES
    desktop

    fallbackPath에 지정된 desktop의 Open Graph를 크롤링해서 사용합니다. title, description, imageUrl으로 설정한 값은 무시됩니다.

    customShortId
    string

    Custom 채널의 트래킹 링크 생성시 축약된 링크 숏 아이디.

    입력하지 않으면 랜덤 아이디가 생성되며, 트래킹 링크 생성 완료 후에는 변경할 수 없습니다.

    Response

    200 SUCCESS

    파라미터

    설명

    trackingLink.id

    트래킹 링크의 ID

    trackingLink.channelType

    트래킹 링크의 채널 타입

    trackingLink.link.impression

    조회 이벤트를 발생시키는 트래킹 링크

    trackingLink.link.click

    클릭 이벤트를 발생시키는 트래킹 링크

    trackingLink.link.serverToServerClick

    S2S 이벤트를 발생시키는 트래킹 링크

    trackingLink.shortId

    단축 URL의 ID

    trackingLink.shortURL

    단축 URL

    trackingLink.trackingTemplateID

    트래킹 링크의 템플릿 ID

    404 ERROR

    입력한 필드에 오류가 있거나 해당하는 앱이 없습니다.

    422 ERROR

    필드가 누락되었거나 오류가 있습니다.


    세부 정보 가져오기

    GET

    https://api.airbridge.io/v1/tracking-links/{id}

    트래킹 링크의 세부 정보를 조회합니다.

    Request

    Path Params

    id
    필수string

    트래킹 링크 ID.

    Response

    200 SUCCESS

    400 ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

    422 ERROR

    필드가 누락되었거나 오류가 있습니다.


    미리보기(Open Graph) 수정하기

    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/og-tag

    트래킹 링크의 Open Graph를 수정합니다.

    Request

    Path Params

    id
    필수string

    트래킹 링크의 ID.

    Body Params

    title
    필수string

    트래킹 링크의 og:title

    description
    필수string

    트래킹 링크의 og:description

    imageUrl
    필수string

    트래킹 링크의 og:image

    Response

    200 SUCCESS

    404 ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.


    경로 수정하기

    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/routing

    트래킹 링크의 최종 목적지 및 Fallback 경로를 수정합니다.

    Request

    Path Params

    id
    필수string

    트래킹 링크의 ID.

    Body Params

    deeplinkUrl
    필수stringnullable

    리다이렉트할 Deeplink URL.

    deeplinkUrl이 없거나 null일 경우 deeplink가 설정되지 않습니다.

    fallbackPaths
    object

    플랫폼별 리다이렉트 경로.

    fallbackPaths.android
    필수enum

    안드로이드가 리다이렉트될 경로. google-play, airpage, HTTP(S) 형식의 URL이 가능합니다.

    ENUM VALUES
    google-play

    google play store로 랜딩합니다.

    airpage

    airpage로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    fallbackPaths.ios
    필수enum

    iOS에서 리다이렉트될 경로. itunes-appstore, airpage, HTTP(S) 형식의 URL이 가능합니다

    ENUM VALUES
    itunes-appstore

    appstore로 랜딩합니다.

    airpage

    airpage로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    fallbackPaths.desktop
    필수enum

    데스크톱에서 리다이렉트될 경로. google-play, itunes-appstore, HTTP(S) 형식의 URL이 가능합니다.

    ENUM VALUES
    google-play

    google play store로 랜딩합니다.

    itunes-appstore

    appstore로 랜딩합니다.

    {HTTP_URL}

    설정한 url로 랜딩합니다.

    option
    object

    fallback의 옵션을 설정합니다.

    option.iosCustomProductPageId
    string

    애플 앱 스토어의 맞춤형 제품 페이지(Custom Product Page)의 ppid.

    option.googlePlayCustomStoreListing
    string

    구글 플레이 스토어의 맞춤 스토어 등록정보(Custom Store Listing) listing 값.

    Response

    200 SUCCESS

    404 ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.


    목록 가져오기

    GET

    https://api.airbridge.io/v1/tracking-links

    생성한 트래킹 링크 목록을 불러옵니다.

    Request

    Query Params

    from
    필수string

    생성한 트래킹 링크 목록을 조회할 기준 시작일.

    to
    필수string

    생성한 트래킹 링크 목록을 조회할 기준 종료일.

    skip
    number

    건너뛸 item의 갯수.

    size
    number

    가져올 item의 갯수. (최대 500)

    keyword
    string

    검색 키워드.

    channel_name
    string

    채널 명 필터.

    sort_key
    enum

    정렬 기준 (기본값: createdAt)

    ENUM VALUES
    createdAt

    생성 순 정렬

    sort_type
    enum

    정렬 타입. (기본값: DESC)

    ENUM VALUES
    DESC

    내림차순 정렬.

    ASC

    오름차순 정렬.

    Response

    200 SUCCESS

    400 ERROR

    입력한 필드가 오류가 있거나 형태가 올바르지 않습니다.

    이 페이지가 도움이 되었나요?

    추가, 수정하면 좋을 내용이 있나요?