카카오모먼트

광고그룹 타겟 조회

이 문서는 카카오모먼트 광고그룹 타겟 조회 API 사용 방법을 안내합니다.

광고그룹 타겟 API는 광고그룹의 타겟 설정을 위한 정보를 목록 형태로 제공하며, 각 정보는 광고그룹 생성 및 수정 전에 호출하여 필요한 파라미터 값을 확인하는 데 사용합니다.

시/도 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/location/depth1`	비즈니스 토큰

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

데모그래픽의 지역 선택을 위한 시/도 목록을 조회할 수 있습니다.

비즈니스 토큰을 헤더에 담아 GET으로 요청하며, 요청 파라미터는 없습니다. 성공 시 응답으로 받은 시/도 지역의 key 값을 광고그룹 생성 및 수정 시 targeting.locations에 사용할 수 있습니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`LocationDepth1[]`	시/도 목록

LocationDepth1

전체 목록은 행정구역 타입 정보 CSV 파일(다운로드) 내 Depth1Location 표 참고

이름	타입	설명
value	`String`	지역 Key
description	`String`	지역 설명
depth1Name	`String`	지역 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/location/depth1" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "value": "A",
        "description": "강원도",
        "depth1Name": "강원도",
    },
    {
        "value": "B",
        "description": "경기도",
        "depth1Name": "경기도",
    },
    {
        "value": "C",
        "description": "경상남도",
        "depth1Name": "경상남도",
    },
    ...
]

시/군/구 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/location/depth2`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 지역 타겟팅 옵션에 필요한 시/군/구 목록을 조회할 수 있습니다.

비즈니스 토큰을 헤더에 담아 검색하려는 지역 이름을 keyword 파라미터로 지정하여 GET으로 요청합니다.

성공 시 keyword로 검색된 지역의 시/군/구 정보를 담은 문자열 배열 목록을 받고, 해당 문자열 배열을 광고그룹 생성 및 삭제 시 targeting.depth2Locations 파라미터 값으로 사용할 수 있습니다. keyword 파라미터 누락 시 요청이 실패하며 에러 응답을 받습니다.

요청

헤더

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

쿼리 파라미터

이름	타입	설명	필수
keyword	`String`	시/군/구 검색어	O

응답

본문

이름	타입	설명
-	`LocationDepth2[]`	시/군/구 목록

LocationDepth2

전체 목록은 행정구역 타입 정보 CSV 파일(다운로드) 내 Depth2Location 표 참고

이름	타입	설명
value	`String`	지역 Key
description	`String`	지역 전체 이름
depth1Name	`String`	시/도 이름
depth2Name	`String`	시/군/구 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/location/depth2?keyword=서울" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

응답: 성공

[
    {
        "value": "I1000",
        "description": "서울특별시 강남구",
        "depth1Name": "서울특별시",
        "depth2Name": "강남구"
    },
    {
        "value": "I1001",
        "description": "서울특별시 강동구",
        "depth1Name": "서울특별시",
        "depth2Name": "강동구"
    },
    ...
]

응답: 실패

HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
       "detailCode": 75029,
       "detailMsg": "조회할 시/군/구 검색어를 입력해 주세요."
    }
}

동/읍/면 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/location/depth3`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 지역 타겟팅 옵션에 필요한 동/읍/면 목록을 조회할 수 있습니다.

비즈니스 토큰을 헤더에 담아 검색하려는 지역 이름을 keyword 파라미터로 지정하여 GET으로 요청합니다.

성공 시 keyword로 검색된 지역의 동/읍/면 정보를 담은 문자열 배열 목록을 받고, 해당 문자열 배열을 광고그룹 생성 및 삭제 시 targeting.depth3Locations 파라미터 값으로 사용할 수 있습니다. keyword 파라미터 누락 시 요청이 실패하며 에러 응답을 받습니다.

요청

헤더

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

쿼리 파라미터

이름	타입	설명	필수
keyword	`String`	동/읍/면 검색어	O

응답

본문

이름	타입	설명
-	`LocationDepth3[]`	동/읍/면 목록

LocationDepth3

전체 목록은 행정구역 타입 정보 CSV 파일(다운로드) 내 Depth3Location 표 참고

이름	타입	설명
Value	`String`	지역 Key
description	`String`	지역 전체 이름
depth1Name	`String`	시/도 이름
depth2Name	`String`	시/군/구 이름
depth3Name	`String`	동/읍/면 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/location/depth3?keyword=논현" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

응답: 성공

[
    {
        "value": "I10000101",
        "description": "서울특별시 강남구",
        "depth1Name": "서울특별시",
        "depth2Name": "강남구",
        "depth3Name" : "논현1동"
    },
    {
        "value": "I10000102",
        "description": "서울특별시 강동구",
        "depth1Name": "서울특별시",
        "depth2Name": "강남구",
        "depth3Name" : "논현2동"
    },
    ...
]

응답: 실패

HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
       "detailCode": 75528,
       "detailMsg": "조회할 동/읍/면 검색어를 입력해 주세요."
    }
}

네트워크 게재지면 하위 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/placement/adServingCategories`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 게재지면의 목록을 조회할 수 있습니다.

네트워크 게재지면의 경우 디스플레이 X 전환 캠페인 유형에서는 설정이 불가능합니다.

비즈니스 토큰을 헤더에 담아 GET으로 요청합니다. 파라미터는 없습니다. 성공 시 응답은 네트워크 게재지면 하위 목록 정보를 포함하며, 이 중 code 값을 광고그룹 생성 및 수정 시 adServingCategories 파라미터에 배열 형태로 사용합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`AdServingCategory[]`	네트워크 게재지면 정보 목록

AdServingCategory

이름	타입	설명
code	`Code`	네트워크 하위 게재지면 코드 광고그룹 생성 및 수정 시 "adServingCategories" 필드에 code를 배열로 전달 아래 `name`은 요구되지 않음
name	`String`	네트워크 하위 게재지면 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/placement/adServingCategories" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "code": "IAB16",
        "name": "애완동물"
    },
    {
        "code": "IAB8",
        "name": "식음료"
    },
    {
        "code": "IAB15",
        "name": "과학"
    },
    ...
]

섹션 카테고리 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/placement/sectionCategories`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 선택 가능한 섹션 카테고리 목록을 조회할 수 있습니다.

캠페인 유형이 카카오 비즈보드이고, placements에 KAKAO_TALK이 요청된 경우에만 선택 가능합니다.

비즈니스 토큰을 헤더에 담아 GET으로 요청합니다. 파라미터는 없습니다. 성공 시 응답은 선택 가능한 섹션 카테고리 목록 정보를 포함하며, 이 중 code 값을 광고그룹 생성 및 수정 시 sectionCategories 파라미터에 배열 형태로 사용합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`SectionCategory[]`	네트워크 게재지면 정보 목록

SectionCategory

이름	타입	설명
code	`Code`	섹션 카테고리 코드 광고그룹 생성 및 수정 시 `sectionCategories` 필드에 `code`를 배열로 전달 아래 `name`은 요구되지 않음
name	`String`	섹션 카테고리 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/placement/sectionCategories" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "code": "KKO99-1",
        "name": "채팅탭에만 노출"
    }
    ...
]

타게팅 가능한 광고반응타겟 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/cohort/availables`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 맞춤타겟의 광고반응타겟 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 사용 가능한 광고반응타겟의 상세 정보 및 상태를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`CohortAvailable[]`	타겟팅 옵션으로 요청할 수 있는 맞춤타겟의 광고반응타겟 목록

CohortAvailable

이름	타입	설명
id	`Long`	광고반응 타겟 번호 해당 필드 값을 광고그룹 생성/수정시 targeting.cohortTargetings 에 배열 하위에 cohortId로 요청
audienceType	`String`	광고반응 타겟 유형, 아래 중 하나 `DISPLAY`: 디스플레이 `MESSAGE`: 메시지
adAccountId	`Long`	광고계정 번호
name	`String`	광고반응 타겟 이름
baseAds	`BaseAd[]`	광고반응 데이터 목록
collectDuration	`Integer`	수집 기간 오늘은 기준으로 수집기간 동안 쌓인 사용자 데이터를 광고 타게팅에 사용함 단, 광고집행 이력이 있어도 수집기간 내 반응한 사용자가 없는 경우 노출 대상이 없을 수 있음
status	`String`	타겟 모수 상태, 아래 중 하나 `WAITING`: 준비 중 `AVAILABLE_ERROR`: 모출 추출 에러 `AVAILABLE`: 모수 추출 완료 `SEED_NOT_ENOUGH`: 모수부족 `DELETE`: 삭제 또는 삭제중 `ERROR`: 그 외 에러
populationScore	`Long`	타겟 모수
createdDate	`String`	생성일시 `yyyy-MM-dd'T'HH:mm:ss` 형식
lastModifiedDate	`String`	마지막 수정일시 `yyyy-MM-dd'T'HH:mm:ss` 형식

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/cohort/availables" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "adAccountId": 1234,
        "id": 1,
        "audienceType": "DISPLAY",
        "name": "첫번째_광고반응타겟",
        "baseAds": [
            {
                "campaign": {
                    "id": 5678,
                    "name": "첫번째_캠페인",
                    "campaignTypeGoal": {
                        "campaignType": "DISPLAY",
                        "goal": "VISITING"
                    }
                },
                "adGroup": {
                    "id": 9012,
                    "name": "첫번째_광고그룹"
                },
                "operation": "MINUS",
                "firstIndicator": "OPEN",
                "secondIndicator": "CLICK"
            }
        ],
        "collectDuration": 90,
        "status": "AVAILABLE",
        "createdDate": "2018-02-07 10:46:12",
        "lastModifiedDate": "2020-07-07 19:15:38"
    },
    {
        "adAccountId": 1234,
        "id": 2,
        "audienceType": "DISPLAY",
        "name": "두번째_광고반응타겟",
        "baseAds": [
            {
                "campaign": {
                    "id": 5678,
                    "name": "두번째_캠페인",
                    "campaignTypeGoal": {
                        "campaignType": "DISPLAY",
                        "goal": "CONVERSION"
                    }
                },
                "adGroup": {
                    "id": 9012,
                    "name": "두번째_광고그룹"
                },
                "operation": "ONLY",
                "firstIndicator": "CONVERSION"
            }
        ],
        "collectDuration": 90,
        "status": "AVAILABLE",
        "createdDate": "2020-01-01 00:00:00",
        "lastModifiedDate": "2020-01-01 00:00:00"
    }
]

타게팅 가능한 픽셀 & SDK 이벤트 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/trackers/eventCreatables/${TRACK_ID}`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 맞춤타겟의 픽셀 & SDK 이벤트 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 트래커 아이디(trackID), 타겟 기간을 지정하여 요청합니다. 성공 시 각 이벤트의 정보를 담은 JSON 객체 배열로 트래커 정보를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

경로 변수

이름	타입	설명	필수
TRACK_ID	`String`	트래커 아이디 광고 계정의 픽셀&SDK 조회 API로 조회된 아이디(id)	O

쿼리 파라미터

이름	타입	설명	필수
term	`Integer`	타겟 기간(최소: 1, 최대: 180)	O

응답

본문

이름	타입	설명
-	`PixelAndSdkEvent[]`	타겟팅 옵션으로 요청할 수 있는 맞춤타겟의 픽셀 & SDK 이벤트 목록

PixelAndSdkEvent

이름	타입	설명
eventCode	`String`	이벤트 코드
eventName	`String`	이벤트 이름
eventExtraName	`String`	커스텀 이벤트 이름
trackRuleId	`String`	트래커 정보 아이디
trackRule	`TrackRule`	트래커 정책 '모든 이벤트'의 경우 `trackRule` 값 없음
population	`Integer`	수집 모수
lastEventDate	`String`	마지막 확인일시 `yyyy-MM-dd'T'HH:mm:ss` 형식

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/trackers/eventCreatables/${TRACK_ID}?term=${TERM}" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "lastEventDate": "2019.10.16 19:36",
        "eventCode": "*",
        "eventName": "모든 이벤트",
        "trackRuleId": "*",
        "population": 15300000
    },
    {
        "trackRule": {
            "trackRuleId": "*",
            "trackId": "3830610710806837838",
            "eventCode": "PageView",
            "name": "방문",
            "ruleSetStr": "[]"
        },
        "lastEventDate": "2019.10.16 19:36",
        "eventCode": "PageView",
        "eventName": "방문",
        "trackRuleId": "*",
        "population":15290918
    }
]

타게팅 가능한 고객파일 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/customerFiles/availables`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 고객파일 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 각 고객파일 정보를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`CustomerFile[]`	타겟팅 옵션으로 요청할 수 있는 고객파일 목록

CustomerFile

이름	타입	설명
id	`Long`	고객파일 번호
adAccountId	`Long`	광고계정 번호
name	`String`	고객파일 이름
adidListKey	`String`	고객파일 등록 Key
status	`String`	상태, 아래 중 하나 `WAITING`: 고객파일 모수추출 대기중 `COMPLETE`: 모수추출 완료 `DELETE`: 삭제 또는 삭제중인 상태 `ERROR`: 그 외 비정상적인 경우
populationScore	`String`	타겟 모수 등록한 고객파일에서 추출된 카카오 사용자 수로 준비 중인 고객파일은 모수 추출 이전 단계로 타게팅에 사용할 수 없으며, 고객파일을 등록 후 최대 6시간 이내에 모수 추출이 완료됨
ready	`Boolean`	준비완료 여부
createdDate	`String`	타겟 생성일시 `yyyy-MM-dd'T'HH:mm:ss` 형식
lastModifyRequestDate	`String`	타겟 마지막 수정일시 `yyyy-MM-dd'T'HH:mm:ss` 형식

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/customerFiles/availables" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "adAccountId": 1234,
        "name": "첫번째_고객파일",
        "adidListKey": "123456789abcdefghijklmn",
        "status": "COMPLETE",
        "populationScore": 100,
        "ready": true,
        "createdDate": "2020-01-01 00:00",
        "lastModifyRequestDate": "2020-01-01 00:00"
    }
]

타게팅 가능한 친구그룹 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availables`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 친구그룹 목록을 조회합니다.

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

요청

헤더

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

쿼리 파라미터

이름	타입	설명	필수
profileId	`String`	카카오톡 채널 프로필 ID 캠페인의 `objective` 중 `value` 항목 참고 참고: 카카오톡 채널 프로필 ID 확인 방법	O

응답

본문

이름	타입	설명
-	`TalkChannelGroupFiles[]`	타겟팅 옵션으로 요청할 수 있는 친구그룹 목록

TalkChannelGroupFiles

이름	타입	설명
id	`Long`	친구그룹 ID
name	`String`	친구그룹 이름
profileId	`String`	카카오톡 채널 프로필 ID
groupkey	`String`	친구그룹 파일의 그룹 키
fileType	`String`	친구그룹 유형, 아래 중 하나 `APP_USER_ID`(앱유저아이디) `PHONE_NUMBER`(전화번호) `MESSAGE_RETARGET`(메시지 발송 대상자)
appId	`Integer`	앱 ID
talkChannelGroupFileStatus	`String`	상태, 아래 중 하나 `WAITING`(대기중) `COMPLETE`(완료) `DELETE`(삭제) `ERROR`(생성 실패)
friendCount	`Long`	친구 수
createdDate	`String`	타겟 생성일시 `yyyy-MM-dd'T'HH:mm:ss` 형식
populationUpdateDate	`String`	모수 업데이트 일시 `yyyy-MM-dd'T'HH:mm:ss` 형식

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availables?profileId=_Xxju" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}" \
  -d "profileId=${PROFILE_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1468,
        "profileId": "${PROFILE_ID}",
        "name": "예제1",
        "talkChannelGroupFileStatus": "COMPLETE",
        "fileType": "MESSAGE_RETARGET",
        "groupKey": "${GROUP_KEY}",
        "createdDate": "2022-07-25T16:12:43",
        "populationUpdateDate": "2022-07-25T16:50:30"
    }, {
        "id": 1392,
        "profileId": "${PROFILE_ID}",
        "name": "예제2",
        "talkChannelGroupFileStatus": "COMPLETE",
        "fileType": "PHONE_NUMBER",
        "groupKey": "${GROUP_KEY}",
        "createdDate": "2022-06-10T13:57:49",
        "populationUpdateDate": "2022-06-10T14:33:30"
    }, {
        "id": 528,
        "profileId": "${PROFILE_ID}",
        "name": "예제3",
        "talkChannelGroupFileStatus": "COMPLETE",
        "fileType": "MESSAGE_RETARGET",
        "groupKey": "${GROUP_KEY}",
        "createdDate": "2020-08-10T15:28:05"
    }
]

타게팅 가능한 카카오톡 채널 정보 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/talkChannels/availables`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 카카오톡 채널 정보 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며 전달해야 할 파라미터는 없습니다. 성공 시 검색된 카카오톡 채널 정보를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`ChannelProfile[]`	타겟팅 옵션으로 요청할 수 있는 카카오톡 채널 정보 목록

ChannelProfile

이름	타입	설명
id	`String`	카카오톡 채널 프로필 ID
name	`String`	카카오톡 채널 프로필 이름
searchId	`String`	검색된 카카오톡 채널 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/talkChannels/availables" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": "_xbHxd",
        "name": "첫번째_친구",
        "searchId": "첫번째_친구"
    },
    {
        "id": "_ZQxd",
        "name": "두번째_친구",
        "searchId": "두번째_친구"
    }
]

타게팅 가능한 카카오 로그인 이용자 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/syncProfiles/availables`	비즈니스 토큰

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

광고그룹 생성 및 수정 시 타겟팅 옵션으로 요청할 수 있는 카카오 로그인 이용자 목록을 조회합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며 전달해야 할 파라미터는 없습니다. 응답 본문의 id를 광고그룹 생성 및 수정 시 카카오 로그인 이용자 타게팅으로 활용할 수 있습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

응답

본문

이름	타입	설명
-	`SyncProfile[]`	타겟팅 옵션으로 요청할 수 있는 카카오 로그인 이용자 목록

SyncProfile

이름	타입	설명
id	`String`	카카오톡 채널 프로필 ID
name	`String`	카카오톡 채널 프로필 이름
searchId	`String`	검색된 카카오톡 채널 이름

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adGroups/targetings/syncProfiles/availables" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": "_XLd",
        "name": "프로필있는_첫번째_친구",
        "searchId": "now_profile_exist"
    },
    {
        "id": "_cWn",
        "name": "프로필있는_두번째_친구",
        "searchId": "after_profile_exist"
    }
]

사이드 메뉴

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

카카오맵

내비게이션

광고

검색

더 보기

광고그룹 타겟 조회

시/도 조회

기본 정보

요청

헤더

응답

본문

LocationDepth1

예제

요청

응답

시/군/구 조회

기본 정보

요청

헤더

쿼리 파라미터

응답

본문

LocationDepth2

예제

요청

응답: 성공

응답: 실패

동/읍/면 조회

기본 정보

요청

헤더

쿼리 파라미터

응답

본문

LocationDepth3

예제

요청

응답: 성공

응답: 실패

네트워크 게재지면 하위 목록 조회

기본 정보

요청

헤더

응답

본문

AdServingCategory

예제

요청

응답

섹션 카테고리 목록 조회

기본 정보

요청

헤더

응답

본문

SectionCategory

예제

요청

응답

타게팅 가능한 광고반응타겟 조회

기본 정보

요청

헤더

응답

본문

CohortAvailable

예제

요청

응답

타게팅 가능한 픽셀 & SDK 이벤트 조회

기본 정보

요청

헤더

경로 변수