Kakao Moment

Audience management

This document describes how to use the Audience management APIs.

View list of Audiences

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/audiences`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns the list of Audiences in Audience management.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Response

Body

Name	Type	Description
content	`Audience[]`	List of Audience information.

Audience

Name	Type	Description
id	`Long`	Audience's ID.
name	`String`	Audience's name.
audienceStatus	`Enum`	Audience's status. `STANDBY`: Preparing. `AVAILABLE`: Available. `SEED_NOT_ENOUGH`: Insufficient target population. `ERROR`: Unavailable.
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message
createdDate	`String`	Date and time of Audience creation in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time of Audience modification in `yyyy-MM-dd'T'HH:mm:ss` format.

Sample

Request

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

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "content": [
    {
      "id": 1,
      "name": "first_audience",
      "audienceStatus": "AVAILABLE",
      "type": "DISPLAY",
      "createdDate": "2021-05-03T18:50:54",
      "lastModifiedDate": "2021-05-03T18:50:54"
    },
    {
      "id": 2,
      "name": "second_audience",
      "audienceStatus": "AVAILABLE",
      "type": "MESSAGE",
      "createdDate": "2021-04-21T14:36:07",
      "lastModifiedDate": "2021-04-21T14:43:23"
    },
    {
      "id": 3,
      "name": "third-audience",
      "audienceStatus": "SEED_NOT_ENOUGH",
      "type": "DISPLAY",
      "createdDate": "2021-04-21T14:35:32",
      "lastModifiedDate": "2021-04-21T14:35:42"
    }
  ]
}

View details of Audience

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/${ID}`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns detailed information about a specific Audience in Audience management.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
ID	`Long`	Audience's ID.	O

Response

Body

Name	Type	Description
id	`Long`	Audience's ID.
name	`String`	Audience's name.
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message
audienceStatus	`Enum`	Audience's status. `STANDBY`: Preparing. `AVAILABLE`: Available. `SEED_NOT_ENOUGH`: Insufficient target population. `ERROR`: Unavailable.
populationScore	`Long`	Estimated target population. Estimated target population for Audience.
createdDate	`String`	Date and time of Audience creation in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time of Audience modification in `yyyy-MM-dd'T'HH:mm:ss` format.
ageType	`Enum`	Selection type for age range. `ALL`: Select all age ranges `NOT_ALL`: Select some age ranges
ages	`String[]`	Age range.
genderType	`Enum`	Selection type for gender. `ALL`: Select all genders `NOT_ALL`: Select a specific gender
genders	`String[]`	Gender `M`: Male `F`: Female
locations	`Location[]`	-si (city) or -do (province) information. Refer to View city/province.
depth2Locations	`Depth2Location[]`	-si (city), -gun (county), or -gu (district) information. Refer to View city/county/district.
depth3Locations	`Depth3Location[]`	-dong (neighborhood), -eup (town), or -myeon (townships) information. Refer to View dong/eup/myeon.
ufoInterests	`UfoInterest[]`	Information of interest targeting. Refer to View category data for custom audience targeting API.
ufoDeprecatedInterests	`UfoInterest[]`	Deprecated information of interest targeting. Refer to View category data for custom audience targeting API.
ufoBusinessTypes	`UfoBusinessType[]`	Information of business type targeting. Refer to View category data for custom audience targeting API.
ufoDeprecatedBusinessTypes	`UfoBusinessType[]`	Deprecated information of business type targeting. Refer to View category data for custom audience targeting API.
talkChannelTargetings	`TalkChannelTargeting[]`	Information of Kakao Talk Channel targeting.
syncAppTargetings	`SyncAppTargeting[]`	Information of Kakao Login user targeting.
customerFileTargetings	`CustomerFileTargeting[]`	Information of customer file targeting.
cohortTargetings	`CohortTargeting[]`	Information of engagement targeting.
trackerTargetings	`TrackerTargeting[]`	Information of Pixel & SDK targeting.
talkChannelGroupTargetings	`TalkChannelGroupTargeting[]`	Information of friends group targeting.

Sample

Request

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

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 1,
  "type": "DISPLAY",
  "audienceStatus": "AVAILABLE",
  "name": "첫번째_오디언스",
  "ageType": "ALL",
  "genders": ["F", "M"],
  "genderType": "NOT_ALL",
  "locations": [
    {
      "value": "E",
      "description": "광주광역시",
      "depth1Name": "광주광역시"
    },
    {
      "value": "M55550301",
      "description": "전북특별자치도 전주시 덕진구 금암1동",
      "depth1Name": "전북특별자치도",
      "depth2Name": "전주시 덕진구",
      "depth3Name": "금암1동",
      "deprecated": true
    },
    {
      "value": "M55550302",
      "description": "전북특별자치도 전주시 덕진구 금암2동",
      "depth1Name": "전북특별자치도",
      "depth2Name": "전주시 덕진구",
      "depth3Name": "금암2동",
      "deprecated": true
    }
  ],
  "ufoInterests": ["I0202", "I020601", "I03", "I320104"],
  "ufoDeprecatedInterests": ["I320104"],
  "ufoBusinessTypes": ["P1021", "P2003"],
  "ufoDeprecatedBusinessTypes": ["P2003"],
  "populationScore": 100,
  "createdDate": "2021-04-14T17:49:35",
  "lastModifiedDate": "2021-04-14T17:49:35"
}

Create Audience

Basic information

Method	URL	Authorization
`POST`	`https://apis.moment.kakao.com/openapi/v4/targetings`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Creates a new Audience that you can use when creating or editing an ad group.

Available parameter by Audience type

Type	DISPLAY	MESSAGE
`ufoInterests` (Interest)	O	O
`ufoBusinessTypes` (Category)	O	O
`locations` (Cities/provinces)	O	O
`depth2Locations` (Cities/counties/districts)	O	O
`depth3Locations` (dong/eup/myeon)	O	O
`customerFileTargetings` (Customer file)	O	X
`trackerTargetings` (Pixel & SDK)	O	X
`cohortTargetings` (Engagement targeting)	O	O
`talkChannelTargetings` (Kakao Talk Channel)	O	O
`syncAppTargetings` (Kakao Login user)	O	O
`talkChannelGroupTargetings` (Friend group)	X	O

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Body

Name	Type	Description	Required
adAccountId	`Long`	Ad account's ID that the corresponding Audience is included.	O
name	`String`	Audience's name.	O
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message	O
ageType	`Enum`	Selection type for age range. `ALL`: Select all age ranges `NOT_ALL`: Select some age ranges Important: Set `ageType` to `NOT_ALL` when specifying adult targeting with `ages`.	O
ages	`String[]`	Age range `15`: 15 to 19 `20`: 20 to 24 `25`: 25 to 29 `30`: 30 to 34 `35`: 35 to 39 `40`: 40 to 44 `45`: 45 to 49 `50`: 50 to 54 `55`: 55 to 59 `60`: 60 to 64 `65`: 65 to 69 Important: Required if `ageType` is `NOT_ALL`. Do not pass if `ageType` is `ALL`. Important: To specify adult targeting, pass `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`, `65` as an array.	X
genderType	`Enum`	Selection type for gender. `ALL`: Select all genders `NOT_ALL`: Select a specific gender	O
genders	`String[]`	Gender `M`: Male `F`: Female Important: Required if `genderType` is `NOT_ALL`. Do not pass if `genderType` is `ALL`.	X
ufoInterests	`UfoInterest[]`	[맞춤타겟(Custom audience target)] > [추가 설정(Additional settings)] > [카테고리(Categories)] > [관심사(Interests)] Refer to View category data for custom audience targeting API.	X
ufoBusinessTypes	`UfoBusinessType[]`	[맞춤타겟(Custom audience target)] > [추가 설정(Additional settings)] > [카테고리(Categories)] > [업종(Industries) Refer to View category data for custom audience targeting API.	X
locationType	`Enum`	Selection type for areas. `ALL`: Select all `AREA`: Select some areas	O
locations	`Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [시/도(-si/do)] Refer to View city/province. Important: Not allowed if `locationType` is `ALL`. Important: If the campaign type is Kakao Bizboard, Overseas (`Z`) is not allowed. Note: Can be passed together with `depth2Locations` (-si/gun/gu) and `depth3Locations` (-dong/eup/myeon).	X
depth2Locations	`Depth2Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [시/군/구(-si/gun/gu)] Refer to View city/county/district. Important: If `locationType` is `AREA`, you must pass at least one of `locations` (-si/do), `depth2Locations` (-si/gun/gu), or `depth3Locations` (-dong/eup/myeon).	X
depth3Locations	`Depth3Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [동/읍/면(-dong/eup/myeon)] Refer to View dong/eup/myeon. Important: If `locationType` is `AREA`, you must pass at least one of `locations` (-si/do), `depth2Locations` (-si/gun/gu), or `depth3Locations` (-dong/eup/myeon).	X
customerFileTargetings	`CustomerFileTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [고객파일(Customer file]) Use information retrieved through the View list of targetable customer files API.	X
trackerTargetings	`TrackerTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [픽셀 & SDK(Pixel & SDK)] Use information retrieved through the View targetable Pixel & SDK events API.	X
cohortTargetings	`CohortTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [광고반응타겟(Engagement target)] Use information retrieved through the View targetable engagement targets API.	X
talkChannelTargetings	`TalkChannelTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [카카오 사용자(Kakao user) > [카카오톡 채널 친구(Kakao Talk Channel friend)] Use information retrieved through the View list of targetable Kakao Talk Channels API.	X
syncAppTargetings	`SyncAppTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [카카오 사용자(Kakao user) > [카카오 로그인 이용자(Kakao Login user)] Use information retrieved through the View list of targetable Kakao Login users API.	X
talkChannelGroupTargetings	`TalkChannelGroupTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [친구그룹(Friend group)] Use the information retrieved through the View list of targetable Friend groups API. Only the campaigns with 'Kakao Talk Channel X Reach(도달)' type are allowed.	X

Response

Body

Name	Type	Description
id	`Long`	Audience's ID.
name	`String`	Audience's name.
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message
audienceStatus	`Enum`	Audience's status. `STANDBY`: Preparing. `AVAILABLE`: Available. `SEED_NOT_ENOUGH`: Insufficient target population. `ERROR`: Unavailable.
populationScore	`Long`	Estimated target population. Estimated target population for Audience.
createdDate	`String`	Date and time of Audience creation in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time of Audience modification in `yyyy-MM-dd'T'HH:mm:ss` format.
ageType	`Enum`	Selection type for age range. `ALL`: Select all age ranges `NOT_ALL`: Select some age ranges
ages	`String[]`	Age range.
genderType	`Enum`	Selection type for gender. `ALL`: Select all genders `NOT_ALL`: Select a specific gender
genders	`String[]`	Gender `M`: Male `F`: Female
locations	`Location[]`	-si (city) or -do (province) information. Refer to View city/province.
depth2Locations	`Depth2Location[]`	-si (city), -gun (county), or -gu (district) information. Refer to View city/county/district.
depth3Locations	`Depth3Location[]`	-dong (neighborhood), -eup (town), or -myeon (townships) information. Refer to View dong/eup/myeon.
ufoInterests	`UfoInterest[]`	Information of interest targeting. Refer to View category data for custom audience targeting API.
ufoBusinessTypes	`UfoBusinessType[]`	Information of business type targeting. Refer to View category data for custom audience targeting API.
talkChannelTargetings	`TalkChannelTargeting[]`	Information of Kakao Talk Channel targeting.
syncAppTargetings	`SyncAppTargeting[]`	Information of Kakao Login user targeting.
customerFileTargetings	`CustomerFileTargeting[]`	Information of customer file targeting.
cohortTargetings	`CohortTargeting[]`	Information of engagement targeting.
trackerTargetings	`TrackerTargeting[]`	Information of Pixel & SDK targeting.
talkChannelGroupTargetings	`TalkChannelGroupTargeting[]`	Information of friends group targeting.

Sample

Request

curl -X POST "https://apis.moment.kakao.com/openapi/v4/targetings" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
    "adAccountId": 1,
    "name": "create_open_api",
    "type": "DISPLAY",
    "ageType": "NOT_ALL",
    "ages": ["20", "15"],
    "genderType": "NOT_ALL",
    "genders": ["M"],
    "locationType": "AREA",
    "locations": [
            {
                "value": "E",
                "description": "광주광역시",
                "depth1Name": "광주광역시"
            },
            {
                "value": "O",
                "description": "충청남도",
                "depth1Name": "충청남도"
            }
        ],
        "depth2locations": [
            {
                "value": "B7222",
                "description": "경기도 여주시",
                "depth1Name": "경기도",
                "depth2Name": "여주시"
            },
            {
                "value": "I1009",
                "description": "서울특별시 도봉구",
                "depth1Name": "광주광역시",
                "depth2Name": "도봉구"
            }
        ],
        "depth3Locations": [
            {
                "value": "A70052424",
                "description": "강원도 삼척시 원덕읍",
                "depth1Name": "강원도",
                "depth2Name": "삼척시",
                "depth3Name": "원덕읍"
            },
            {
                "value": "E13010702",
                "description": "광주광역시 남구 백운2동",
                "depth1Name": "광주광역시",
                "depth2Name": "남구",
                "depth3Name": "백운2동"
            }
        ]
    }'

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 1,
  "type": "DISPLAY",
  "adAccountId": 1,
  "name": "create_open_api",
  "ageType": "NOT_ALL",
  "ages": ["15", "20"],
  "genders": ["M"],
  "genderType": "NOT_ALL",
  "locations": [
    {
      "value": "E",
      "description": "광주광역시",
      "depth1Name": "광주광역시"
    },
    {
      "value": "O",
      "description": "충청남도",
      "depth1Name": "충청남도"
    }
  ],
  "depth2locations": [
    {
      "value": "B7222",
      "description": "경기도 여주시",
      "depth1Name": "경기도",
      "depth2Name": "여주시"
    },
    {
      "value": "I1009",
      "description": "서울특별시 도봉구",
      "depth1Name": "광주광역시",
      "depth2Name": "도봉구"
    }
  ],
  "depth3Locations": [
    {
      "value": "A70052424",
      "description": "강원도 삼척시 원덕읍",
      "depth1Name": "강원도",
      "depth2Name": "삼척시",
      "depth3Name": "원덕읍"
    },
    {
      "value": "E13010702",
      "description": "광주광역시 남구 백운2동",
      "depth1Name": "광주광역시",
      "depth2Name": "남구",
      "depth3Name": "백운2동"
    }
  ]
}

Edit Audience

Basic information

Method	URL	Authorization
`PUT`	`https://apis.moment.kakao.com/openapi/v4/targetings`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Enables you to edit the Audience.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Body

Name	Type	Description	Required
id	`Long`	Audience's ID.	O
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message	O
adAccountId	`Long`	Ad account's ID that the corresponding Audience is included.	O
name	`String`	Audience's name.	O
ageType	`Enum`	Selection type for age range. `ALL`: Select all age ranges `NOT_ALL`: Select some age ranges Important: Set `ageType` to `NOT_ALL` when specifying adult targeting with `ages`.	O
ages	`String[]`	Age range `15`: 15 to 19 `20`: 20 to 24 `25`: 25 to 29 `30`: 30 to 34 `35`: 35 to 39 `40`: 40 to 44 `45`: 45 to 49 `50`: 50 to 54 `55`: 55 to 59 `60`: 60 to 64 `65`: 65 to 69 Important: Required if `ageType` is `NOT_ALL`. Do not pass if `ageType` is `ALL`. Important: To specify adult targeting, pass `20`, `25`, `30`, `35`, `40`, `45`, `50`, `55`, `60`, `65` as an array.	X
genderType	`Enum`	Selection type for gender. `ALL`: Select all genders `NOT_ALL`: Select a specific gender	O
genders	`String[]`	Gender `M`: Male `F`: Female Important: Required if `genderType` is `NOT_ALL`. Do not pass if `genderType` is `ALL`.	X
ufoInterests	`UfoInterest[]`	Information of interest targeting. Refer to View category data for custom audience targeting API.	X
ufoBusinessTypes	`UfoBusinessType[]`	Information of business type targeting. Refer to View category data for custom audience targeting API.	X
locationType	`Enum`	Selection type for areas. `ALL`: Select all `AREA`: Select some areas	O
locations	`Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [시/도(-si/do)] Refer to View city/province. Important: Not allowed if `locationType` is `ALL`. Important: If the campaign type is Kakao Bizboard, Overseas (`Z`) is not allowed. Note: Can be passed together with `depth2Locations` (-si/gun/gu) and `depth3Locations` (-dong/eup/myeon).	X
depth2Locations	`Depth2Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [시/군/구(-si/gun/gu)] Refer to View city/county/district. Important: If `locationType` is `AREA`, you must pass at least one of `locations` (-si/do), `depth2Locations` (-si/gun/gu), or `depth3Locations` (-dong/eup/myeon).	X
depth3Locations	`Depth3Location[]`	[데모그래픽(Demographic)] > [행정구역(Administrative area)] > [동/읍/면(-dong/eup/myeon)] Refer to View dong/eup/myeon. Important: If `locationType` is `AREA`, you must pass at least one of `locations` (-si/do), `depth2Locations` (-si/gun/gu), or `depth3Locations` (-dong/eup/myeon).	X
customerFileTargetings	`CustomerFileTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [고객파일(Customer file]) Use information retrieved through the View list of targetable customer files API.	X
trackerTargetings	`TrackerTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [픽셀 & SDK(Pixel & SDK)] Use information retrieved through the View targetable Pixel & SDK events API.	X
cohortTargetings	`CohortTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [광고반응타겟(Engagement target)] Use information retrieved through the View targetable engagement targets API.	X
talkChannelTargetings	`TalkChannelTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [카카오 사용자(Kakao user) > [카카오톡 채널 친구(Kakao Talk Channel friend)] Use information retrieved through the View list of targetable Kakao Talk Channels API.	X
syncAppTargetings	`SyncAppTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [카카오 사용자(Kakao user) > [카카오 로그인 이용자(Kakao Login user)] Use information retrieved through the View list of targetable Kakao Login users API.	X
talkChannelGroupTargetings	`TalkChannelGroupTargeting[]`	[맞춤타겟(Custom audience target)] > [내 데이터 설정(My data settings)] > [친구그룹(Friend group)] Use the information retrieved through the View list of targetable Friend groups API. Only the campaigns with 'Kakao Talk Channel X Reach(도달)' type are allowed.	X

Response

Body

Name	Type	Description
id	`Long`	Audience's ID.
name	`String`	Audience's name.
type	`Enum`	Audience's type. `DISPLAY`: Display `MESSAGE`: Message
audienceStatus	`Enum`	Audience's status. `STANDBY`: Preparing. `AVAILABLE`: Available. `SEED_NOT_ENOUGH`: Insufficient target population. `ERROR`: Unavailable.
populationScore	`Long`	Estimated target population. Estimated target population for Audience.
createdDate	`String`	Date and time of Audience creation in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time of Audience modification in `yyyy-MM-dd'T'HH:mm:ss` format.
ageType	`Enum`	Selection type for age range. `ALL`: Select all age ranges `NOT_ALL`: Select some age ranges
ages	`String[]`	Age range.
genderType	`Enum`	Selection type for gender. `ALL`: Select all genders `NOT_ALL`: Select a specific gender
genders	`String[]`	Gender `M`: Male `F`: Female
locations	`Location[]`	-si (city) or -do (province) information. Refer to View city/province.
depth2Locations	`Depth2Location[]`	-si (city), -gun (county), or -gu (district) information. Refer to View city/county/district.
depth3Locations	`Depth3Location[]`	-dong (neighborhood), -eup (town), or -myeon (townships) information. Refer to View dong/eup/myeon.
ufoInterests	`UfoInterest[]`	Information of interest targeting. Refer to View category data for custom audience targeting API.
ufoBusinessTypes	`UfoBusinessType[]`	Information of business type targeting. Refer to View category data for custom audience targeting API.
talkChannelTargetings	`TalkChannelTargeting[]`	Information of Kakao Talk Channel targeting.
syncAppTargetings	`SyncAppTargeting[]`	Information of Kakao Login user targeting.
customerFileTargetings	`CustomerFileTargeting[]`	Information of customer file targeting.
cohortTargetings	`CohortTargeting[]`	Information of engagement targeting.
trackerTargetings	`TrackerTargeting[]`	Information of Pixel & SDK targeting.
talkChannelGroupTargetings	`TalkChannelGroupTargeting[]`	Information of friends group targeting.

Sample

Request

curl -X PUT "https://apis.moment.kakao.com/openapi/v4/targetings" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
    "adAccountId": 1,
    "name": "create_open_api",
    "type": "DISPLAY",
    "ageType": "NOT_ALL",
    "ages": ["20", "15"],
    "genderType": "NOT_ALL",
    "genders": ["M"],
    "locationType": "AREA",
    "locations": [
            {
                "value": "E",
                "description": "광주광역시",
                "depth1Name": "광주광역시"
            },
            {
                "value": "O",
                "description": "충청남도",
                "depth1Name": "충청남도"
            }
        ],
        "depth2locations": [
            {
                "value": "B7222",
                "description": "경기도 여주시",
                "depth1Name": "경기도",
                "depth2Name": "여주시"
            },
            {
                "value": "I1009",
                "description": "서울특별시 도봉구",
                "depth1Name": "광주광역시",
                "depth2Name": "도봉구"
            }
        ],
        "depth3Locations": [
            {
                "value": "A70052424",
                "description": "강원도 삼척시 원덕읍",
                "depth1Name": "강원도",
                "depth2Name": "삼척시",
                "depth3Name": "원덕읍"
            },
            {
                "value": "E13010702",
                "description": "광주광역시 남구 백운2동",
                "depth1Name": "광주광역시",
                "depth2Name": "남구",
                "depth3Name": "백운2동"
            }
        ]
    }'

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 1,
  "type": "DISPLAY",
  "adAccountId": 1,
  "name": "create_open_api",
  "ageType": "NOT_ALL",
  "ages": ["15", "20"],
  "genders": ["M"],
  "genderType": "NOT_ALL",
  "locations": [
    {
      "value": "E",
      "description": "광주광역시",
      "depth1Name": "광주광역시"
    },
    {
      "value": "O",
      "description": "충청남도",
      "depth1Name": "충청남도"
    }
  ],
  "depth2locations": [
    {
      "value": "B7222",
      "description": "경기도 여주시",
      "depth1Name": "경기도",
      "depth2Name": "여주시"
    },
    {
      "value": "I1009",
      "description": "서울특별시 도봉구",
      "depth1Name": "광주광역시",
      "depth2Name": "도봉구"
    }
  ],
  "depth3Locations": [
    {
      "value": "A70052424",
      "description": "강원도 삼척시 원덕읍",
      "depth1Name": "강원도",
      "depth2Name": "삼척시",
      "depth3Name": "원덕읍"
    },
    {
      "value": "E13010702",
      "description": "광주광역시 남구 백운2동",
      "depth1Name": "광주광역시",
      "depth2Name": "남구",
      "depth3Name": "백운2동"
    }
  ]
}

Delete Audience

Basic information

Method	URL	Authorization
`DELETE`	`https://apis.moment.kakao.com/openapi/v4/targetings/${ID}`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Deletes an Audience.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
ID	`Long`	Audience's ID.	O

Sample

Request

curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/targetings/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json"

Response

HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Delete multiple Audiences

Basic information

Method	URL	Authorization
`DELETE`	`https://apis.moment.kakao.com/openapi/v4/targetings`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Deletes multiple Audiences at once.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Query parameter

Name	Type	Description	Required
audienceIds	`String`	Audience's ID. To pass multiple Audience IDs, separate them with comma(,).	O

Sample

Request

curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/targetings?audienceIds=${AUDIENCE_ID},${AUDIENCE_ID}" \
  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
  -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "successCount": 1,
  "failCount": 1,
  "errorMessages": ["이미 삭제된 오디언스입니다."]
}

View usage of Audience

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/targetings/${ID}/adGroups`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns information about ad groups that use the designated Audience in Audience management.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
ID	`Long`	Audience's ID.	O

Response

Body

Name	Type	Description
content	`AudienceAdGroup[]`	List of ad groups using the Audience.

AudienceAdGroup

Name	Type	Description
campaignId	`Long`	Campaign's ID.
campaignName	`String`	Campaign's name.
campaignTypeGoal	`CampaignTypeGoal`	Campaign Type X Goal.
adGroupId	`Long`	Ad group's ID.
adGroupName	`String`	Ad group' name.
adGroupStatus	`Enum: Status[]`	Ad group's status.
adGroupType	`Enum: AdGroupType`	Ad group's type.

Sample

Request

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

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "content": [
    {
      "campaignId": 1,
      "campaignName": "first_campaign",
      "campaignTypeGoal": {
        "campaignType": "TALK_BIZ_BOARD",
        "goal": "VISITING"
      },
      "adGroupId": 1,
      "adGroupName": "first_ad_group",
      "adGroupStatus": ["OFF"],
      "adGroupType": "DISPLAY"
    },
    {
      "campaignId": 1,
      "campaignName": "first_campaign",
      "campaignTypeGoal": {
        "campaignType": "TALK_BIZ_BOARD",
        "goal": "VISITING"
      },
      "adGroupId": 2,
      "adGroupName": "second_ad_group",
      "adGroupStatus": ["OFF"],
      "adGroupType": "DISPLAY"
    },
    {
      "campaignId": 2,
      "campaignName": "second_campaign",
      "campaignTypeGoal": {
        "campaignType": "TALK_BIZ_BOARD",
        "goal": "VISITING"
      },
      "adGroupId": 3,
      "adGroupName": "third_ad_group",
      "adGroupStatus": ["OFF"],
      "adGroupType": "DISPLAY"
    }
  ]
}

Disable use of Audience

Basic information

Method	URL	Authorization
`PUT`	`https://apis.moment.kakao.com/openapi/v4/targetings/${ID}/unlink`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Enables you to disable the ad group that uses the designated Audience through the Audience management function.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
ID	`Long`	Audience's ID.	O

Body

Name	Type	Description	Required
adGroupId	`Long`	Ad group's ID.	O

Sample

Request

curl -X PUT "https://apis.moment.kakao.com/openapi/v4/targetings/${ID}/unlink" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json" \
    -d '{
        "adGroupId": ${AD_GROUP_ID}
    }'

Response

HTTP/1.1 200 OK

See more

Kakao Moment API Reference

사이드 메뉴

Getting started

Kakao Developers

Login

Communication

Map

Navigation

Advertisement

Search

More

Audience management

View list of Audiences

Basic information

Request

Header

Response

Body

Audience

Sample

Request

Response

View details of Audience

Basic information

Request

Header

Path variable

Response

Body

Sample

Request

Response

Create Audience

Basic information

Available parameter by Audience type

Request

Header

Body

Response

Body

Sample

Request

Response

Edit Audience

Basic information

Request

Header

Body

Response

Body

Sample

Request

Response

Delete Audience

Basic information

Request

Header

Path variable

Sample

Request

Response

Delete multiple Audiences

Basic information

Request

Header

Query parameter

Sample

Request

Response

View usage of Audience

Basic information

Request

Header

Path variable

Response

Body

AudienceAdGroup

Sample

Request

Response

Disable use of Audience