페이지 이동경로
  • 문서>
  • 카카오모먼트>
  • 픽셀 & SDK 연동 관리

카카오모먼트

픽셀 & SDK 연동 관리

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

연동된 픽셀 & SDK 목록 조회

기본 정보
메서드 URL 인증 방식
GET https://apis.moment.kakao.com/openapi/v4/trackers/rights 비즈니스 토큰
권한 사전 설정 비즈니스 인증 비즈니스 동의항목
필요: 사용 권한 신청 비즈 앱 전환
비즈니스 리다이렉트 URI 등록
비즈니스 동의항목		 필요 필요

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

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

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

요청

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

응답

본문
이름 타입 설명
trackRights TrackRight[] 연동된 픽셀 & SDK 목록
TrackRight
이름 타입 설명
trackId String 트랙 아이디
trackName String 권한 추가한 픽셀 & SDK 이름
population String 타겟모수
해당 이벤트로 최근 180일 간 수집한 정보를 활용해 광고를 노출할 수 있는 추정 도달수를 의미하며 오후 8시 이후 전일까지의 정보를 갱신함
eventStatus String 상태
PRE_COLLECTION (수집전),
COLLECTION (수집중) 중 하나
createdDate String 생성일시
yyyy-MM-dd'T'HH:mm:ss.SSS
lastEventDate String 마지막 확인일시
yyyy-MM-dd'T'HH:mm:ss.SSSXXX
role String 트랙 권한
MASTER(마스터), MEMBER(멤버) 중 하나

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/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": "1234567890",
            "trackName": "픽셀",
            "population": 0,
            "eventStatus": "COLLECTION",
            "createdDate": "2019-12-10T08:18:22.000+0000",
            "lastEventDate": null,
            "role": "MASTER"
        },
        {
            "trackId": "1234567891",
            "trackName": "픽셀",
            "population": 0,
            "eventStatus": "PRE_COLLECTION",
            "createdDate": "2020-01-01T00:00:00.000+0000",
            "lastEventDate": "2020-01-01 15:00:00",
            "role": "MEMBER"
        }
    ]
}

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

기본 정보
메서드 URL 인증 방식
GET https://apis.moment.kakao.com/openapi/v4/trackers/rightAvailables 비즈니스 토큰
권한 사전 설정 비즈니스 인증 비즈니스 동의항목
필요: 사용 권한 신청 비즈 앱 전환
비즈니스 리다이렉트 URI 등록
비즈니스 동의항목		 필요 필요

연동 가능한 픽셀 & SDK 목록을 조회합니다. 광고계정당 최대 100 개의 픽셀 & SDK를 추가할 수 있습니다.

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

요청

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

응답

본문
이름 타입 설명
- RightAvailable[] 연동 가능한 픽셀 & SDK 목록
RightAvailable
이름 타입 설명
trackId String 트랙 아이디
픽셀 & SDK 권한 추가시 해당 값을 trackId로 요청
name String 트랙 이름
createdAt String 생성일시
updatedAt String 마지막 수정일시
role String 트랙 권한
MASTER(마스터), MEMBER(멤버), REQUEST(멤버 권한 요청 중) 중 하나

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/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": "1234567890123456789",
        "name": "권한추가_가능한_픽셀&SDK",
        "createdAt": "2020-01-01T00:00:00.000+0000",
        "updatedAt": "2020-01-01T00:00:00.000+0000",
        "role": "MEMBER"
    },
    {
        "trackId": "9876543210987654321",
        "name": "권한추가_가능한_픽셀&SDK",
        "createdAt": "2020-01-01T00:00:00.000+0000",
        "updatedAt": "2020-01-01T00:00:00.000+0000",
        "role": "REQUEST"
    }
]

픽셀 & SDK 연동

기본 정보
메서드 URL 인증 방식
POST https://apis.moment.kakao.com/openapi/v4/trackers 비즈니스 토큰
권한 사전 설정 비즈니스 인증 비즈니스 동의항목
필요: 사용 권한 신청 비즈 앱 전환
비즈니스 리다이렉트 URI 등록
비즈니스 동의항목		 필요 필요

지정한 픽셀 & SDK를 광고계정에 연동합니다. 광고계정당 최대 100 개의 픽셀 & SDK를 연동할 수 있습니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청하고, 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더
이름 설명 필수
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		 O
본문
이름 타입 설명 필수
trackId String 트랙 아이디
픽셀 & SDK 사용권한 추가 가능한 목록 보기 API 로 조회되는
trackId(트랙 아이디) 사용		 O
adAccountId Long 광고계정 번호 O

예제

요청
curl -X POST "https://apis.moment.kakao.com/openapi/v4/trackers" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "trackId": "5678901234",
            "adAccountId": "12345"
        }'
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

픽셀 & SDK 연동 해제

기본 정보
메서드 URL 인증 방식
DELETE https://apis.moment.kakao.com/openapi/v4/trackers/${TRACK_ID} 비즈니스 토큰
권한 사전 설정 비즈니스 인증 비즈니스 동의항목
필요: 사용 권한 신청 비즈 앱 전환
비즈니스 리다이렉트 URI 등록
비즈니스 동의항목		 필요 필요

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

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청합니다. 권한 추가된 픽셀 & SDK의 trackId를 전달해야 합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더
이름 설명 필수
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		 O
경로 변수
이름 타입 설명 필수
TRACK_ID String 트랙 아이디
픽셀 & SDK 사용 권한 목록 보기 API로 조회되는
trackId(트랙 아이디) 사용		 O

예제

요청
curl -v -X DELETE "https:// apis.moment.kakao.com/openapi/v4/trackers/${TRACK_ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

더 보기

카카오모먼트> 픽셀 & SDK 연동 관리