페이지 이동경로
  • Docs>
  • Kakao Moment>
  • Engagement targeting management

Kakao Moment

Engagement targeting management

This document describes how to use the engagement targeting management APIs.

Engagement targeting

The engagement targeting can be used as targeting information when creating or editing an ad group. The targeting information is created based on a combination of clicks, plays, and conversions to your ads.

The Kakao Moment Ads provide a variety of ad engagement data according to your campaign's goal and type. Depending on users' choices, various engagement data is collected and used to make ad engagement target. The types of engagement data that you can use may vary depending on your campaign's type.

Criteria by engagement target type

Engagement response targets are created based on which ad type (DISPLAY, MESSAGE) they will be used for. Depending on the ad type, the campaign type and ad response data items that can be used to create engagement response targets. See the table below for more information.

Ad type: DISPLAY
Creatable campaign types Usable engagement response data
Kakao Bizboard
Kakao Bizboard CBT
Video
Focus board
Focus full view
Profile full view		 Click(클릭), Conversion(전환), Play(재생)
Display
Daum Shopping
Product catalog
Reach pop all day		 Click(클릭), Conversion(전환)
Kakao Talk Channel
Personalized message		 Conversion(전환)
Ad type: MESSAGE
Creatable campaign types Usable engagement response data
Kakao Talk Channel
Personalized message		 Click(클릭), Play(재생), Open(열람)

Defining ad response data

Each ad type has a different definition of available ad response data.

Type Click (클릭) Play (재생) Conversion (전환) Open (열람)
DISPLAY Users who have clicked at least one area in clickable areas of the ad. Users who have played the video of the message for over 3 seconds or over 25% (May include users who have clicked or converted). 1) Users whose conversion is detected by the Kakao Pixel & SDK

2) If the ObjectiveType is set to 'TALK_CHANNEL' among the Kakao Bizboard X Conversion(전환) type of campaigns, users who have added Kakao Talk Channel through the ad.

- If the advertisement target is the Kakao Talk Channel

- If using the button for adding Kakao Talk Channel when the landing to the ad view		 -
MESSAGE Users who have clicked at least one area in clickable areas of the message the users have viewed. Users who have played the video of the message for over 3 seconds (May include users who have clicked). - Users who opened the Kakao Talk Channel's chat and read a message.

Ad response data configurable operations

Ad response data is available for the following operations.

Ad response data Operation
Click(All) operation: ONLY
firstIndicator: CLICK
Play(All) operation: ONLY
firstIndicator: PLAY
Conversion(All) operation: ONLY
firstIndicator: CONVERSION
Open(All) operation: ONLY
firstIndicator: OPEN
Click-Play operation: MINUS
firstIndicator: CLICK
secondIndicator: PLAY
Play-Click operation: MINUS
firstIndicator: PLAY
secondIndicator: CLICK
Click-Conversion operation: MINUS
firstIndicator: CLICK
secondIndicator: CONVERSION
Open-Click-Play operation: MINUS
firstIndicator: OPEN
secondIndicator: CLICK
thirdIndicator: PLAY
Click&Play operation: AND
firstIndicator: PLAY
secondIndicator: CLICK

View list of engagement targets

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/targetings/cohort/list Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve a list of engagement targets you can use as a targeting option when creating or editing an ad group.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of engagement targets. If failed, refer to Error code to figure out its failure cause.

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
- CohortTarget[] List of engagement targets.
CohortTarget
Name Type Description
id Long Engagement target's ID.
audienceType String Engagement target's type.
Either DISPLAY or MESSAGE.
When you create or edit an ad group or Audience, you need to use the available Audience type between Display and Message according to its campaign Type X Goal.
name String Engagement target's name.
baseAds BaseAd[] List of engagement data.
collectDuration Integer Collecting period.
User data collected during this period from today is used for the ad targeting.
If no one responded to your ad during this period, data may not exist even though you have run ads before.
cohortStatus String Status of target population.
One of the followings:
- WAITING: Preparing for extracting target population.
- AVAILABLE_ERROR: Error in extracting target population.
- AVAILABLE: Target population has been extracted from a customer file.
- MODIFYING: Modifying target population.
- DELETE: Deleted or deleting.
- ERROR: Other errors.
popultaionScore Long Target population that is normally extracted when target population's status is AVAILABLE.
After requesting the creation of an ad response target based on the estimated reach of Kakao users who interacted with the selected ad, the audience extraction is completed within one hour, and the audience is updated in real-time.
A target in the WAITING state is in the pre-extraction stage and cannot be used for targeting.
createdDate String Date and time of creation in yyyy-MM-dd'T'HH:mm:ss format.
lastModifiedDate String Date and time of modification in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/cohort/list" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "adAccountId": 1234,
        "id": 1,
        "audienceType": "MESSAGE",
        "name": "first_engagement_target",
        "baseAds": [
            {
                "campaign": {
                    "id": 5678,
                    "name": "first_campaign",
                    "campaignTypeGoal": {
                        "campaignType": "TALK_CHANNEL",
                        "goal": "REACH"
                    }
                },
                "adGroup": {
                    "id": 20425,
                    "name": "first_ad_group"
                },
                "operation": "ONLY",
                "firstIndicator": "OPEN"
            }
        ],
        "collectDuration": 90,
        "cohortStatus": "AVAILABLE",
        "createdDate": "2020-01-01 00:00:00",
        "lastModifiedDate": "2020-01-01 00:00:00"
    }
]

View engagement target

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/targetings/cohort/${ID} Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve detailed information of the specified engagement target.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the engagement target's ID to be retrieved when you request. If the request is successful, this API returns the detailed information and status of the requested engagement target in JSON format. If failed, refer to Error code to figure out its failure cause.

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 Engagement target's ID. O

Response

Body
Name Type Description
id Long Engagement target's ID.
audienceType String Engagement target's type.
Either DISPLAY or MESSAGE.
When you create or edit an ad group or Audience, you need to use the available Audience type between Display and Message according to its campaign Type X Goal.
adAccountId Long Ad account's ID.
name String Engagement target's name.
baseAds BaseAd[] List of engagement data.
collectDuration Integer Collecting period.
User data collected during this period from today is used for the ad targeting.
If no one responded to your ad during this period, data may not exist even though you have run ads before.
cohortStatus String Status of target population.
One of the followings:
- WAITING: Preparing for extracting target population.
- AVAILABLE_ERROR: Error in extracting target population.
- AVAILABLE: Target population has been extracted from a customer file.
- MODIFYING: Modifying target population.
- DELETE: Deleted or deleting.
- ERROR: Other errors.
popultaionScore Long Target population that is normally extracted when target population's status is AVAILABLE.
After requesting the creation of an ad response target based on the estimated reach of Kakao users who interacted with the selected ad, the audience extraction is completed within one hour, and the audience is updated in real-time.
A target in the WAITING state is in the pre-extraction stage and cannot be used for targeting.
createdDate String Date and time of creation in yyyy-MM-dd'T'HH:mm:ss format.
lastModifiedDate String Date and time of modification in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X GET 'https://apis.moment.kakao.com/openapi/v4/targetings/cohort/${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
{
    "adAccountId": 1234,
    "id": 1,
    "audienceType": "MESSAGE",
    "name": "first_engagement_target",
    "baseAds": [
        {
            "campaign": {
                "id": 5678,
                "name": "first_campaign",
                "campaignTypeGoal": {
                    "campaignType": "TALK_CHANNEL",
                    "goal": "REACH"
                }
            },
            "adGroup": {
                "id": 9012,
                "name": "first_ad_group"
            },
            "operation": "ONLY",
            "firstIndicator": "OPEN"
        }
    ],
    "collectDuration": 90,
    "cohortStatus": "AVAILABLE",
    "createdDate": "2020-01-01 00:00:00",
    "lastModifiedDate": "2020-01-01 00:00:00"
}

View creatable engagement targets

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/targetings/cohort/creatables Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve the list of information about ad groups and campaigns under an ad account required when you create engagement target.

Only ad group information for campaign's Type X Goal that allow ad reaction target creation can be retrieved. The campaign types that can be created can be found in Criteria by engagement target type.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the type, goal, and name of the campaign to be retrieved when you request. If the request is successful, this API returns the detailed information of each ad group and campaign in JSON format. If failed, refer to Error code to figure out its failure cause.

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
campaignType CampaignType Campaign type you want to retrieve. O
goal Goal Campaign goal you want to retrieve. O
searchKeyword String Campaign's name you want to retrieve. O

Response

Body
Name Type Description
- AdGroupAndCampaign[] List of ad groups and campaigns.
AdGroupAndCampaign
Name Type Description
adGroup AdGroup Ad group.
campaign Campaign Campaign.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/cohort/creatables?campaignType=DISPLAY&goal=VISITING&searchKeyword=HG" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "campaignType": "DISPLAY",
            "goal": "VISITING",
            "searchKeyword":"HG"
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "campaign": {
            "id": 1234,
            "name": "first_campaign",
            "campaignTypeGoal": {
                "campaignType": "DISPLAY",
                "goal": "VISITING"
            }
        },
        "adGroup": [
            {
                "id": 56,
                "name": "first_ad_group"
            },
            {
                "id": 78,
                "name": "second_ad_group"
            }
        ]
    }
]

Create engagement target

Basic information
Method URL Authorization
POST https://apis.moment.kakao.com/openapi/v4/targetings/cohort Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to create a new engagement target. You can create up to 50 engagement targets per ad account. Engagement targeting can be used as targeting information when creating or editing an ad group. The targeting information is created based on a combination of clicks, plays, and engagement data to your ads.

Refer to Engagement targeting for the criteria by engagement target type, engagement criteria by campaign type, and available operation and engagement types by Type X Goal.

Send a POST request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the created engagement target. If failed, refer to Error code to figure out its failure cause.

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
audienceType String Engagement target's type.
Either DISPLAY or MESSAGE.		 O
name String Engagement target's name.

Allowed characters: Korean, English, special characters, space
Character limits: 50 characters		 O
baseAds BaseAd[] List of engagement data. O
BaseAd
Name Type Description Required
adGroup AdGroup Information of the ad group. O
campaign Campaign Information of the campaign. O
operation Operation Operation type.
Refer to Available operation and engagement types by Type X Goal.		 O
firstIndicator Indicator First response type.
Refer to Available operation and engagement types by Type X Goal.		 O
secondIndicator Indicator Second response type.
Refer to Available operation and engagement types by Type X Goal.		 X
thirdIndicator Indicator Third response type.
Refer to Available operation and engagement types by Type X Goal.		 X

Response

Body
Name Type Description
id Long Engagement target's ID.
adAccountId Long Ad account's ID.
name String Engagement target's name.
collectDuration Integer Collecting period.
User data collected during this period from today is used for the ad targeting.
If no one responded to your ad during this period, data may not exist even though you have run ads before.
baseAds BaseAd[] List of engagement data.
cohortStatus String Status of target population.
One of the followings:
- WAITING: Preparing for extracting target population.
- AVAILABLE_ERROR: Error in extracting target population.
- AVAILABLE: Target population has been extracted from a customer file.
- MODIFYING: Modifying target population.
- DELETE: Deleted or deleting.
- ERROR: Other errors.
createdDate String Date and time of creation in yyyy-MM-dd'T'HH:mm:ss format.
lastModifiedDate String Date and time of modification in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/targetings/cohort" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "name": "first_ad_response",
            "audienceType": "MESSAGE",
            "baseAds": [
                {
                    "campaign": {
                        "id": 56,
                        "campaignTypeGoal": {
                            "campaignType": "TALK_CHANNEL"
                        }
                    },
                    "adGroup": {
                        "id": 78
                    },
                    "firstIndicator": "OPEN",
                    "operation": "ONLY"
                }
            ]
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "adAccountId": 1234,
    "id": 1,
    "audienceType": "MESSAGE",
    "collectDuration": 90,
    "cohortStatus": "WAITING",
    "name": "first_ad_response",
    "baseAds": [
        {
            "campaign": {
                "id": 56,
                "name": "first_campaign",
                "campaignTypeGoal": {
                    "campaignType": "TALK_CHANNEL",
                    "goal": "REACH"
                }
            },
            "adGroup": {
                "id": 78,
                "name": "first_ad_group"
            },
            "operation": "ONLY",
            "firstIndicator": "OPEN"
        }
    ],
    "createdDate": "2020-01-01 00:00:00",
    "lastModifiedDate": "2020-01-01 00:00:00"
}

Edit name of engagement target

Basic information
Method URL Authorization
PUT https://apis.moment.kakao.com/openapi/v4/targetings/cohort/name Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to edit the name of the engagement target. If the engagement target has already been deleted or the name is already being used, you cannot edit its name.

Send a PUT request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the changed information of the engagement target in JSON format. If failed, refer to Error code to figure out its failure cause.

This API limits the number of calls you can make to every 10 seconds per user account.

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 Engagement target's ID. O
name String Engagement target's name.

Allowed characters: Korean, English, special characters, space
Character limits: 50 characters		 O

Response

Body
Name Type Description
adAccountId Long Ad account's ID.
id Long Engagement target's ID.
audienceType String Engagement target's type.
Either DISPLAY or MESSAGE.
When you create or edit an ad group or Audience, you need to use the available Audience type between Display and Message according to its campaign Type X Goal.
name String Engagement target's name.
collectDuration Integer Collecting period.
User data collected during this period from today is used for the ad targeting.
If no one responded to your ad during this period, data may not exist even though you have run ads before.
baseAds BaseAd[] List of engagement data.
cohortStatus String Status of target population.
One of the followings:
- WAITING: Preparing for extracting target population.
- AVAILABLE_ERROR: Error in extracting target population.
- AVAILABLE: Target population has been extracted from a customer file.
- MODIFYING: Modifying target population.
- DELETE: Deleted or deleting.
- ERROR: Other errors.
createdDate String Date and time of creation in yyyy-MM-dd'T'HH:mm:ss format.
lastModifiedDate String Date and time of modification in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X PUT "https://apis.moment.kakao.com/openapi/v4/targetings/cohort/name" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "id": 1,
            "name": "edit_engagement_target_name"
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "adAccountId": 1234,
    "id": 1,
    "audienceType": "MESSAGE",
    "collectDuration": 90,
    "cohortStatus": "WAITING",
    "name": "edit_engagement_target_name",
    "baseAds": [
        {
            "campaign": {
                "id": 56,
                "name": "first_campaign",
                "campaignTypeGoal": {
                    "campaignType": "TALK_CHANNEL",
                    "goal": "REACH"
                }
            },
            "adGroup": {
                "id": 78,
                "name": "first_ad_group"
            },
            "operation": "ONLY",
            "firstIndicator": "OPEN"
        }
    ],
    "createdDate": "2020-01-01 00:00:00",
    "lastModifiedDate": "2020-01-01 12:00:00"
}

Edit data of engagement target

Basic information
Method URL Authorization
PUT https://apis.moment.kakao.com/openapi/v4/targetings/cohort Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to edit the data of the engagement target.

After retrieving the information on the existing engagement target through the Viewing engagement target API, you must pass the fields to be edited and not to be edited together when requesting this API. You must also pass the existing values of the fields you do not want to edit to retain the existing information of the engagement target.

When a target is modified, it will be updated within one hour. Until the modification is complete, ad group targeting operates based on the pre-modification target size. Once the modification is complete, the ad group target is updated to the modified target. (The name of the ad reaction target cannot be modified using this API.)

Send a PUT request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the changed information of the engagement target in JSON format. If failed, refer to Error code to figure out its failure cause.

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 Engagement target's ID. O
baseAds BaseAd[] List of engagement data. O
BaseAd
Name Type Description Required
adGroup AdGroup Information of the ad group. O
campaign Campaign Information of the campaign. O
operation Operation Operation type.
One of ONLY,MINUS, or AND.
Refer to Available operation and engagement types by Type X Goal.		 O
firstIndicator Indicator First response type.
One of PLAY, CLICK, OPEN, or CONVERSION.
Refer to Available operation and engagement types by Type X Goal.		 O
secondIndicator Indicator Second response type.
One of PLAY, CLICK, or CONVERSION.
Refer to Available operation and engagement types by Type X Goal.		 X

Response

Body
Name Type Description
id Long Engagement target's ID.
audienceType String Engagement target's type.
Either DISPLAY or MESSAGE.
When you create or edit an ad group or Audience, you need to use the available Audience type between Display and Message according to its campaign Type X Goal.
adAccountId Long Ad account's ID.
name String Engagement target's name.
collectDuration Integer Collecting period.
User data collected during this period from today is used for the ad targeting.
If no one responded to your ad during this period, data may not exist even though you have run ads before.
baseAds BaseAd[] List of engagement data.
cohortStatus String Status of target population.
One of the followings:
- WAITING: Preparing for extracting target population.
- AVAILABLE_ERROR: Error in extracting target population.
- AVAILABLE: Target population has been extracted from a customer file.
- MODIFYING: Modifying target population.
- DELETE: Deleted or deleting.
- ERROR: Other errors.
createdDate String Date and time of creation in yyyy-MM-dd'T'HH:mm:ss format.
lastModifiedDate String Date and time of modification in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X PUT "https://apis.moment.kakao.com/openapi/v4/targetings/cohort" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "id": 1234,
            "name": "edit_engagement_target_data",
            "baseAds": [
                {
                    "campaign": {
                        "id": 56,
                        "campaignTypeGoal": {
                            "campaignType": "TALK_CHANNEL"
                        }
                    },
                    "adGroup": {
                        "id": 78
                    },
                    "firstIndicator": "OPEN",
                    "operation": "ONLY"
                }
            ]
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "adAccountId": 1234,
    "id": 1,
    "audienceType": "MESSAGE",
    "collectDuration": 90,
    "cohortStatus": "WAITING",
    "name": "edit_engagement_target_data",
    "baseAds": [
        {
            "campaign": {
                "id": 56,
                "name": "first_campaign",
                "campaignTypeGoal": {
                    "campaignType": "TALK_CHANNEL",
                    "goal": "REACH"
                }
            },
            "adGroup": {
                "id": 78,
                "name": "first_ad_group"
            },
            "operation": "ONLY",
            "firstIndicator": "OPEN"
        }
    ],
    "createdDate": "2020-01-01 00:00:00",
    "lastModifiedDate": "2020-01-01 15:00:00"
}

Delete engagement target

Basic information
Method URL Authorization
DELETE https://apis.moment.kakao.com/openapi/v4/targetings/cohort/${ID} Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to delete an engagement target. You cannot delete the engagement target that has already been deleted or is being used.

Send a DELETE request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the engagement target's ID as a parameter when you request. If the request is successful, this API returns the HTTP status code 200 without the response body. If failed, refer to Error code to figure out its failure cause.

This API limits the number of calls you can make to every second per user account.

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 Engagement target's ID. O

Sample

Request
curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/targetings/cohort/${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

Delete multiple engagement targets

Basic information
Method URL Authorization
DELETE https://apis.moment.kakao.com/openapi/v4/targetings/cohort Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to delete multiple engagement targets at once. You cannot delete the engagement target that has already been deleted or is being used.

Send a DELETE request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the engagement target's IDs as a parameter when you request. If the request is successful, this API returns the HTTP status code 200 without the response body. If failed, refer to Error code to figure out its failure cause.

This API limits the number of calls you can make to every second per user account.

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
cohortIds String Engagement target's ID.
To pass multiple Engagement target IDs, separate them with a comma(,).		 O

Sample

Request
curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/targetings/cohort?cohortIds=${COHORT_ID},${COHORT_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 engagement target

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/targetings/cohort/usages/${ID} Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve the list of ad groups and campaigns that use the designated engagement target.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the engagement target's ID as a parameter when you request. If the request is successful, this API returns the list of ad groups and campaigns that use the requested engagement target for targeting in JSON format. If failed, refer to Error code to figure out its failure cause.

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 Engagement target's ID. O

Response

Body
Name Type Description
- AdGroupAndCampaign[] List of ad groups and campaigns using the engagement target.
AdGroupAndCampaign
Name Type Description
adGroup AdGroup Information of the ad group.
campaign Campaign Information of the campaign.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/targetings/cohort/usages/${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
[
    {
        "adGroup": {
            "id": 1234,
            "name": "first_ad_group",
            "adGroupStatus": [
                "LIVE"
            ],
            "adGroupType": "DISPLAY"
        },
        "campaign": {
            "id": 5678,
            "name": "first_campaign",
            "campaignTypeGoal": {
                "campaignType": "DISPLAY",
                "goal": "VISITING"
            }
        }
    }
]

See more

Kakao Moment> Engagement targeting management