카카오 키워드광고

픽셀 & SDK 연동 관리

이 문서는 픽셀 & SDK 연동 관리 API 사용 방법을 안내합니다.

픽셀 & SDK는 카카오 서비스 활동 로그를 수집하는 도구입니다. 이 도구들을 활용하여 사용자가 서비스에 방문, 회원가입, 검색, 장바구니, 구매, 앱 실행, 앱 설치 등의 행위를 할 때 활동 내역에 대한 정보를 수집하여 사용자의 행동을 분석하거나 서비스 운영에 활용할 수 있습니다. 카카오 픽셀은 광고계정이 소유하고 있는 웹사이트에 설치할 수 있으며, 카카오 SDK는 모바일 애플리케이션에 설치할 수 있습니다.

API 버전 변경 안내

2022년 4월 26일(화)부터 픽셀 & SDK API의 신규 버전을 제공합니다. 기존 버전인 v1 API는 2022년 5월 31일(화)부터 더 이상 지원되지 않습니다.

연동 중인 픽셀 & SDK 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://api.keywordad.kakao.com/openapi/v2/trackers/rights`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
-	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

광고 계정에 연동된 픽셀 & SDK 목록을 조회합니다.

응답 중 타겟 모수는 해당 이벤트로 수집한 정보를 활용해 광고를 노출할 수 있는 추정 도달 수를 의미합니다. 타겟 모수 정보는 조회 당일 자정을 기준으로 최근 120일간의 정보를 활용합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 성공 시 JSON 객체로 연동 중인 픽셀 & SDK 목록을 받습니다. 실패 시 에러 코드로 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` 광고계정 ID	O

응답

본문

이름	타입	설명
trackRights	`TrackRight[]`	연동된 픽셀 & SDK 목록

TrackRight

이름	타입	설명
trackId	`String`	픽셀 & SDK ID
trackName	`String`	픽셀 & SDK 이름
population	`Integer`	모수
eventStatus	`EventStatus`	상태, 아래 중 하나 `PRE_COLLECTION`: 수집전 `COLLECTION`: 수집중
createdDate	`String`	생성일시(`yyyy-MM-dd'T'HH:mm:ss.SSS` 형식)
lastEventDate	`String`	마지막 확인일시(`yyyy-MM-dd'T'HH:mm:ss.SSS` 형식)
role	`String`	픽셀 & SDK 권한, 아래 중 하나 `MASTER`: 마스터 `MEMBER`: 멤버

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v2/trackers/rights" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "trackRights": [
        {
            "trackId": "200000000000001",
            "trackName": "픽셀1",
            "population": 0,
            "eventStatus": "COLLECTION",
            "createdDate": "2022-02-20T00:00:00.000+0000",
            "lastEventDate": "2022-02-20T20:00:00.000+0000",
            "role": "MASTER"
        },
        {
            "trackId": "200000000000002",
            "trackName": "픽셀2",
            "population": 0,
            "eventStatus": "PRE_COLLECTION",
            "createdDate": "2022-02-20T00:00:00.000+0000",
            "lastEventDate": null,
            "role": "MEMBER"
        },
      ]
}

연동 가능한 픽셀 & SDK 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://api.keywordad.kakao.com/openapi/v2/trackers/rightAvailables`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
-	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

사용 권한 추가가 가능한 픽셀 & SDK 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 성공 시 JSON 객체로 연동 가능한 픽셀 & SDK 목록을 받습니다. 실패 시 에러 코드로 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` 광고계정 ID	O

응답

본문

이름	타입	설명
RightAvailables	`RightAvailable[]`	연동 가능한 픽셀 & SDK 목록

RightAvailable

이름	타입	설명
trackId	`String`	픽셀 & SDK ID
trackName	`String`	픽셀 & SDK 이름
createdAt	`String`	생성일시(`yyyy-MM-dd'T'HH:mm:ss.SSS` 형식)
updatedAt	`String`	마지막 확인일시(`yyyy-MM-dd'T'HH:mm:ss.SSS` 형식)
role	`String`	픽셀 & SDK 권한, 아래 중 하나 `MASTER`: 마스터 `MEMBER`: 멤버 `REQUEST`: 멤버 권한 요청 중

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v2/trackers/rightAvailables" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "trackId": "200000000000001",
        "name": "픽셀1",
        "createdAt": "2022-02-20T00:00:00.000+0000",
        "updatedAt": "2022-02-20T20:00:00.000+0000",
        "role": "MEMBER"
     },
    {
        "trackId": "200000000000002",
        "name": "픽셀2",
        "createdAt": "2022-02-20T00:00:00.000+0000",
        "updatedAt": null,
        "role": "REQUEST"
     }
]