페이지 이동경로
  • 문서>
  • 카카오 키워드광고>
  • 픽셀 & SDK 연동 관리

카카오 키워드광고

픽셀 & SDK 연동 관리

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

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

API 버전 변경 안내

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

연동 중인 픽셀 & SDK 목록 보기

기본 정보

GET /openapi/v2/trackers/rights HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

광고 계정에 연동된 픽셀 & SDK 목록을 조회합니다. 응답 중 타겟 모수는 해당 이벤트로 수집한 정보를 통하여 광고를 노출할 수 있는 추정 도달 수를 의미합니다. 타겟 모수 정보는 조회 당일 자정을 기준으로 최근 120일간의 정보를 활용합니다.

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

이 API는 사용자 계정, 광고계정마다 5초에 한 번씩 요청 가능하도록 제한되어 있습니다.

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O

Response

Name Type Description
trackRights TrackRight[] 연동된 픽셀 & SDK 목록
TrackRight
Name Type Description
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(멤버) 중 하나

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v2/trackers/rights" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "AdAccountId: ${adAccountId}"
Response
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 목록 보기

기본 정보

GET /openapi/v2/trackers/rightAvailables HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

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

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

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O

Response

Name Type Description
RightAvailables RightAvailable[] 연동 가능한 픽셀 & SDK 목록
RightAvailable
Name Type Description
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(멤버 권한 요청 중) 중 하나

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v2/trackers/rightAvailables" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "AdAccountId: ${adAccountId}"
Response
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"
     }
]

픽셀 & SDK 연동하기

기본 정보

POST /openapi/v2/trackers HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

픽셀 & SDK를 광고계정에 연동합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
trackId String 픽셀 & SDK ID
연동 가능한 픽셀 & SDK 목록 보기로 조회되는 trackId(픽셀 & SDK ID) 사용
O

Sample

Request
curl -X POST "https://api.keywordad.kakao.com/openapi/v2/trackers" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${adAccountId}" \
    -H "Content-Type: application/json"
    -d '{
            "trackId": "200000000000001"
        }'
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

픽셀 & SDK 연동 해제하기

기본 정보

DELETE /openapi/v2/trackers/${trackId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

픽셀 & SDK 연동을 해제합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
trackId String 픽셀 & SDK ID
연동 중인 픽셀 & SDK 목록 보기로 조회되는 trackId(픽셀 & SDK ID) 사용
O

Sample

Request
curl -X DELETE "https://api.keywordad.kakao.com/openapi/v2/tracker/${trackId}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
        -H "adAccountId: ${adAccountId}"
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

더보기