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

카카오 키워드광고

픽셀 & SDK

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

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

사용 권한 목록 보기

광고 계정에 사용 권한이 추가된 픽셀 & SDK 목록을 조회합니다. 응답 중 타겟 모수는 해당 이벤트로 최근 120일 간 수집한 정보를 통하여 광고를 노출할 수 있는 추정 도달 수를 의미하며 오후 8시 이후 전일까지의 정보를 갱신합니다.

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

Request
URL
GET /openapi/v1/trackers/rights HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Response
Name Type Description
trackRightId String 트래커 아이디
trackId String 고유코드 (track_id)
service String 서비스
targetCategory String 타겟 카테고리
targetCategoryName String 타겟 카테고리 이름
targetKey String 타겟 Key
trackName String 권한추가한 픽셀 & SDK 이름
population String 타겟모수
해당 이벤트로 최근 120일 간 수집한 정보를 통하여 광고를 노출할 수 있는 추정 도달수를 의미하며 오후 8시 이후 전일까지의 정보를 갱신함
eventStatus String 상태
createdDate String 생성일시
yyyy-MM-dd'T'HH:mm:ss.SSS
lastEventDate String 마지막 확인일시
yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/trackers/rights" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "trackRights": [
        {
            "trackRightId": "1000000001",
            "trackId": "200000000000001",
            "service": "keywordad",
            "targetCategory": "adaccount",
            "targetKey": "1111111111",
            "trackName": "픽셀1",
            "targetCategoryName": "광고계정",
            "population": 0,
            "eventStatus": "COLLECTION",
            "lastEventDate": null,
            "createdDate": "2021-02-20T08:18:22.000+0000"
        },
        {
            "trackRightId": "1000000002",
            "trackId": "200000000000002",
            "service": "keywordad",
            "targetCategory": "adaccount",
            "targetKey": "1111111111",
            "trackName": "픽셀2",
            "targetCategoryName": "광고계정",
            "population": 0,
            "eventStatus": "PRE_COLLECTION",
            "lastEventDate": "2020-01-01 15:00:00",
            "createdDate": "2021-02-20T08:18:22.000+0000"
        }
    ]
}

추가 가능한 권한 목록 보기

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

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 추가 가능한 권한 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v1/trackers/rightAvailables HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Response
Name Type Description
trackId String 고유코드 (track_id)
name String 트랙 이름
createdAt String 생성일시
updatedAt String 마지막 수정일시
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/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": "권한추가_가능한_픽셀&SDK1",
        "createdAt": "2020-01-01T00:00:00.000+0000",
        "updatedAt": "2020-01-01T00:00:00.000+0000"
    },
    {
        "trackId": "200000000000002",
        "name": "권한추가_가능한_픽셀&SDK2",
        "createdAt": "2020-01-01T00:00:00.000+0000",
        "updatedAt": "2020-01-01T00:00:00.000+0000"
    }
]

권한 추가하기

지정한 픽셀 & SDK의 사용 권한을 추가합니다.

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

Request
URL
POST /openapi/v1/trackers HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
trackId String 고유코드 (track_id) O
Sample
Request
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/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 사용 권한을 삭제합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청합니다. 권한을 삭제할 픽셀 & SDK의 trackId를 전달해야 합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
DELETE /openapi/v1/trackers/{trackId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
trackId String 고유코드 (track_id) O
Sample
Request
curl -X DELETE "https://api.keywordad.kakao.com/openapi/v1/tracker/200000000000001" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8

더보기