페이지 이동경로
- 문서>
- 카카오 키워드광고>
- 광고 만들기: 광고그룹
카카오 키워드광고
광고 만들기: 광고그룹
이 문서는 광고 만들기: 광고그룹 API 사용 방법을 안내합니다.
광고그룹은 캠페인 하위에 광고그룹을 생성할 수 있으며, 광고그룹별로 게재 설정, 입찰가, 집행기간 등 상세한 전략 설정이 가능합니다.
광고그룹 목록 보기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET |
https://api.keywordad.kakao.com/openapi/v1/adGroups |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹 목록을 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하고, 성공 시 응답 본문에 JSON 객체로 광고그룹 정보 목록을 받습니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
쿼리 파라미터
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| campaignId | Long |
캠페인 ID | O |
| config | String |
광고그룹 상태(미입력시 ON,OFF값 출력) |
X |
응답
본문
| 이름 | 타입 | 설명 |
|---|---|---|
| campaignId | Long |
캠페인 ID |
| id | Long |
광고그룹 ID |
| name | String |
광고그룹 이름 |
| config | String |
광고그룹 상태 |
| status | String[] |
광고그룹 운영상태 |
| placements | String[] |
상세 매체유형 설정 정보 |
| deviceTypes | String[] |
상세 디바이스 설정 정보 |
| useKeywordExtension | Boolean |
키워드확장 설정여부 |
| exceptionKeywords | String[] |
키워드확장 제외 키워드 |
| dailyBudgetAmount | Long |
일예산 |
| dailyBudgetAmountOver | Long |
일예산 초과 여부 |
| bidAmount | Long |
기본입찰가 |
| mobileBidWeight | Long |
모바일 입찰가중치 |
| pcBidWeight | Long |
PC 입찰가중치 |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 |
| contentBidAmount | Long |
콘텐츠매체 입찰가 |
| schedule | Schedule |
집행기간 |
예제
요청
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/adGroups" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-d "campaignId=1234" \
-d "config=ON""
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
{
"campaignId": "3333333331",
"id": "4444444441",
"name": "광고그룹1",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING",
"WAITING"
],
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceTypes": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"dailyBudgetAmount": 10000,
"dailyBudgetAmountOver": false,
"bidAmount": 70,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 70,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
},
{
"campaignId": "3333333331",
"id": "4444444442",
"name": "광고그룹2",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING",
"WAITING"
],
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceTypes": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"dailyBudgetAmount": 10000,
"dailyBudgetAmountOver": false,
"bidAmount": 70,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 70,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}
]
광고그룹 보기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID} |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
각 광고그룹 상세 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 응답 본문의 JSON 객체에 광고그룹의 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
응답
본문
| 이름 | 타입 | 설명 |
|---|---|---|
| campaignId | Long |
캠페인 ID |
| id | Long |
광고그룹 ID |
| name | String |
광고그룹 이름 |
| config | String |
광고그룹 상태 |
| status | String[] |
광고그룹 운영상태 |
| placements | String[] |
상세 매체유형 설정 정보 |
| deviceTypes | String[] |
상세 디바이스 설정 정보 |
| useKeywordExtension | Boolean |
키워드확장 설정여부 |
| exceptionKeywords | String[] |
키워드확장 제외 키워드 |
| dailyBudgetAmount | Long |
일예산 |
| dailyBudgetAmountOver | Long |
일예산 초과 여부 |
| bidAmount | Long |
기본입찰가 |
| mobileBidWeight | Long |
모바일 입찰가중치 |
| pcBidWeight | Long |
PC 입찰가중치 |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 |
| contentBidAmount | Long |
콘텐츠매체 입찰가 |
| schedule | Schedule |
집행기간 |
예제
요청
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
응답: 성공
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"campaignId": "3333333331",
"id": "4444444441",
"name": "광고그룹1",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING",
"WAITING"
],
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceTypes": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"dailyBudgetAmount": 10000,
"dailyBudgetAmountOver": false,
"bidAmount": 70,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 70,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}
광고그룹 생성하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
POST |
https://api.keywordad.kakao.com/openapi/v1/adGroups |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
새로운 광고그룹을 생성합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청하고, 성공 시 응답 본문에 JSON 객체로 생성된 광고그룹 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| campaignId | Long |
캠페인 ID | O |
| name | String |
광고그룹 이름 | O |
| placements | String[] |
상세 매체유형 설정 정보(미입력시 전체 매체유형 포함) | X |
| deviceTypes | String[] |
상세 디바이스 설정 정보(미입력시 전체 디바이스 포함) | X |
| useKeywordExtension | Boolean |
키워드확장 설정여부(미입력시 true의 설정으로 입력) |
X |
| exceptionKeywords | String[] |
키워드확장 제외 키워드 | X |
| bidAmount | Long |
기본입찰가(미입력시 300으로 입력) |
X |
| dailyBudgetAmount | Long |
일예산(미입력시 100000으로 입력) |
X |
| mobileBidWeight | Long |
모바일 입찰가중치(미입력시 100으로 입력) |
X |
| pcBidWeight | Long |
PC 입찰가중치(미입력시 100으로 입력) |
X |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치(미입력시 100으로 입력) |
X |
| contentBidAmount | Long |
콘텐츠매체 입찰가(미입력시 '미설정'으로 입력) | X |
| schedule | Schedule |
집행기간 | X |
응답
본문
| 이름 | 타입 | 설명 |
|---|---|---|
| campaignId | Long |
캠페인 ID |
| id | Long |
광고그룹 ID |
| name | String |
광고그룹 이름 |
| config | String |
광고그룹 상태ON, OFF 중 하나 광고계정 ID 입력시 DEL값 노출 가능 |
| status | String[] |
광고그룹 운영상태 |
| placements | String[] |
상세 매체유형 설정 정보 |
| deviceTypes | String[] |
상세 디바이스 설정 정보 |
| useKeywordExtension | Boolean |
키워드확장 설정여부 |
| exceptionKeywords | String[] |
키워드확장 제외 키워드 |
| dailyBudgetAmount | Long |
일예산 |
| dailyBudgetAmountOver | Long |
일예산 초과 여부 |
| bidAmount | Long |
기본입찰가 |
| mobileBidWeight | Long |
모바일 입찰가중치 |
| pcBidWeight | Long |
PC 입찰가중치 |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 |
| contentBidAmount | Long |
콘텐츠매체 입찰가 |
| schedule | Schedule |
집행기간 |
예제
요청
curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/adGroups" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"campaignId": "3333333331",
"name": "광고그룹1",
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceType": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"bidAmount": 70,
"dailyBudgetAmount": 100000,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"contentBidAmount": 70,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}'
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"campaignId": "3333333331",
"id": "4444444441",
"name": "광고그룹1",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING",
"WAITING"
],
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceTypes": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"dailyBudgetAmount": 100000,
"dailyBudgetAmountOver": false,
"bidAmount": 70,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 70,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}
광고그룹 수정하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PUT |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID} |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹을 수정합니다. 기존 광고그룹 정보를 조회한 다음에 수정하고자 하는 필드와 수정을 원치 않는 필드를 조합하여 요청해야 합니다. 수정을 원치 않는 필드도 기존 값으로 요청되어야 광고그룹의 정보를 유지할 수 있습니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 파라미터와 함께 PUT으로 요청합니다. 성공 시 응답 본문에 JSON 객체로 수정된 광고그룹 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| name | String |
광고그룹 이름 | O |
| placements | String[] |
상세 매체유형 설정 정보(미입력시 전체 매체유형 포함) | O |
| deviceTypes | String[] |
상세 디바이스 설정 정보(미입력시 전체 디바이스 포함) | O |
| useKeywordExtension | Boolean |
키워드확장 설정여부 | O |
| exceptionKeywords | String[] |
키워드확장 제외 키워드useKeywordExtension 값이 false일 경우, exceptionKeywords 값이 입력되어도 미반영 |
X |
| bidAmount | Long |
기본입찰가 | O |
| dailyBudgetAmount | Long |
일예산 | O |
| mobileBidWeight | Long |
모바일 입찰가중치 | O |
| pcBidWeight | Long |
PC 입찰가중치 | O |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 | O |
| contentBidAmount | Long |
콘텐츠매체 입찰가(미입력시 '미설정'으로 입력) | X |
| schedule | Schedule |
집행기간 | O |
응답
본문
| 이름 | 타입 | 설명 |
|---|---|---|
| campaignId | Long |
캠페인 ID |
| id | Long |
광고그룹 ID |
| name | String |
광고그룹 이름 |
| config | String |
광고그룹 상태ON, OFF 중 하나 광고계정 ID 입력시 DEL값 노출 가능 |
| status | String[] |
광고그룹 운영상태 |
| placements | String[] |
상세 매체유형 설정 정보 |
| deviceTypes | String[] |
상세 디바이스 설정 정보 |
| useKeywordExtension | Boolean |
키워드확장 설정여부 |
| exceptionKeywords | String[] |
키워드확장 제외 키워드 |
| dailyBudgetAmount | Long |
일예산 |
| dailyBudgetAmountOver | Long |
일예산 초과 여부 |
| bidAmount | Long |
기본입찰가 |
| mobileBidWeight | Long |
모바일 입찰가중치 |
| pcBidWeight | Long |
PC 입찰가중치 |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 |
| contentBidAmount | Long |
콘텐츠매체 입찰가 |
| schedule | Schedule |
집행기간 |
예제
요청
curl -v -X PUT "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"name": "광고그룹1",
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceType": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"bidAmount": 1000,
"dailyBudgetAmount": 2000,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 1000,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}'
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"campaignId": "3333333331",
"id": "4444444441",
"name": "광고그룹1",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING",
"WAITING"
],
"placements": ["PREMIUM_LINK_SEARCH_KAKAO", "PREMIUM_LINK_SEARCH_PARTNER", "PREMIUM_LINK_CONTENT_KAKAO", "PREMIUM_LINK_CONTENT_PARTNER"],
"deviceTypes": ["PC","MOBILE"],
"useKeywordExtension": true,
"exceptionKeywords": [
"키워드1",
"키워드2"
],
"bidAmount": 1000,
"dailyBudgetAmount": 2000,
"dailyBudgetAmountOver": false,
"mobileBidWeight": 150,
"pcBidWeight": 140,
"keywordExtensionBidWeight": 100,
"contentBidAmount": 1000,
"schedule": {
"beginDate": "2021-01-01",
"endDate": "2021-02-20",
"detailTime": true,
"mondayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"tuesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"wednesdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"thursdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"fridayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"saturdayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"],
"sundayTime": ["1", "1", "1", "1", "1", "1", "1", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "0", "1", "1"]
}
}
광고그룹 상태 바꾸기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/onOff |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고계정의 상태를 ON 또는 OFF로 변경합니다. 광고그룹 상태가 ON 또는 OFF일 경우만 변경 가능합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| config | String |
광고그룹의 상태 ON, OFF 중 하나 |
O |
예제
요청
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/onOff" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"config": "OFF"
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
광고그룹 기본입찰가 수정하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/bidAmount |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹의 기본입찰가를 수정합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| bidAmount | Long |
기본입찰가 | O |
예제
요청
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/bidAmount" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"bidAmount": 1000
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
광고그룹 일예산 수정하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/dailyBudget |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹의 일예산을 수정합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| dailyBudgetAmount | Long |
일예산 | O |
예제
요청
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/dailyBudget" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"dailyBudgetAmount": 2000
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
광고그룹 입찰가중치 수정하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/bidWeight |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹의 모바일 입찰가중치, PC 입찰가중치, 키워드확장 입찰가중치를 수정합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| mobileBidWeight | Long |
모바일 입찰가중치 | O |
| pcBidWeight | Long |
PC 입찰가중치 | O |
| keywordExtensionBidWeight | Long |
키워드확장 입찰가중치 | O |
예제
요청
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/bidWeight" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"mobileBidWeight": 100,
"pcBidWeight": 100,
"keywordExtensionBidWeight": 100
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
광고그룹 콘텐츠 매체 입찰가 수정하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/contentBidAmount |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹의 콘텐츠 매체 입찰가를 수정합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
본문
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| contentBidAmount | Long |
콘텐츠매체 입찰가(미입력시 '미설정'으로 입력) | X |
예제
요청
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}/contentBidAmount" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"contentBidAmount": 1000
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
광고그룹 삭제하기
기본 정보
| 메서드 | URL | 인증 방식 |
|---|---|---|
DELETE |
https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID} |
비즈니스 토큰 |
| 권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
|---|---|---|---|
| - | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹을 삭제합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청합니다. 삭제하려는 광고그룹의 ID를 파라미터로 지정해야 합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
요청
헤더
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID |
O |
경로 변수
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long |
광고그룹 ID | O |
예제
요청
curl -v -X DELETE "https://api.keywordad.kakao.com/openapi/v1/adGroups/${ID}" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8