페이지 이동경로
  • 문서>
  • 카카오 키워드광고>
  • 광고 만들기: 캠페인

카카오 키워드광고

광고 만들기: 캠페인

이 문서는 광고 만들기: 캠페인 API 사용 방법을 안내합니다.

가장 상위의 전략 단위로, 캠페인의 전략 변경을 통해서 캠페인에 소속된 모든 광고그룹의 광고를 편리하게 관리할 수 있습니다.

캠페인 목록 보기

캠페인 목록을 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 응답 바디에 JSON 객체로 캠페인 정보 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v1/campaigns HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
config String 캠페인 상태(미입력시 ON,OFF값 출력) X
Response
Name Type Description
bizChannelId Long 비즈채널 ID
id Long 캠페인 ID
name String 캠페인 이름
config String 캠페인 상태
status String[] 캠페인 운영상태
trackId String 전환추적 고유코드(track_id)
trackUrl Boolean 추적URL 설정상태
dailyBudgetAmount Long 일 예산
dailyBudgetAmountOver Boolean 일 예산 초과 여부
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/campaigns?config=ON" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
[
    {
      "bizChannelId": "2222222221",
      "id": "3333333331",
      "name": "캠페인1",
      "config": "ON",
      "status": [
        "OFF_BY_BIZ_CHANNEL_WAITING"
      ],
      "trackId": null,
      "traceUrl": true,
      "dailyBudgetAmount": 500000,
      "dailyBudgetAmountOver": false
    },
    {
      "bizChannelId": "2222222221",
      "id": "3333333332",
      "name": "캠페인2",
      "config": "ON",
      "status": [
        "OFF_BY_BIZ_CHANNEL_WAITING"
      ],
      "trackId": null,
      "traceUrl": true,
      "dailyBudgetAmount": 500000,
      "dailyBudgetAmountOver": false
    }
]

캠페인 보기

캠페인의 상세 정보를 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 응답 바디에 JSON 객체로 캠페인의 상세 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v1/campaigns/${id} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 캠페인 ID O
Response
Name Type Description
bizChannelId Long 비즈채널 ID
id Long 캠페인 ID
name String 캠페인 이름
config String 캠페인 상태
status String[] 캠페인 운영상태
trackId String 전환추적 고유코드(track_id)
trackUrl Boolean 추적URL 설정상태
dailyBudgetAmount Long 일 예산
dailyBudgetAmountOver Boolean 일 예산 초과 여부
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/campaigns/${id}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response: 성공
{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인1",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": null,
  "traceUrl": true,
  "dailyBudgetAmount": 500000,
  "dailyBudgetAmountOver": false
}

캠페인 생성하기

새로운 캠페인을 생성합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청합니다. 성공 시 생성된 캠페인 정보를 받으며, 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
POST /openapi/v1/campaigns HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
bizChannelId Long 비즈채널 ID O
name String 캠페인 이름 O
trackId String 전환추적 설정 번호(미입력시 '연동하지 않기'로 입력) X
trackUrl Boolean 추적URL 설정상태(미입력시 '설정'으로 입력) X
dailyBudgetAmount Long 일예산(미입력시 '미설정'으로 입력) X
Response
Name Type Description
bizChannelId Long 비즈채널 ID
id Long 캠페인 ID
name String 캠페인 이름
config String 캠페인 상태
status String[] 캠페인 운영상태
trackId String 전환추적 고유코드(track_id)
trackUrl Boolean 추적URL 설정상태
dailyBudgetAmount Long 일예산
dailyBudgetAmountOver Boolean 일 예산 초과 여부
Sample
Request
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/campaigns" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json" \
    -d '{
          "bizChannelId": 2222222221,
          "name": "캠페인1",
          "trackId": null,
          "traceUrl": true,
          "dailyBudgetAmount": 30000
        }'
Response
{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인1",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": null,
  "traceUrl": true,
  "dailyBudgetAmount": 30000,
  "dailyBudgetAmountOver": false
}

캠페인 수정하기

캠페인 정보를 수정합니다. 기존 캠페인 정보를 조회한 후에 수정하고자 하는 필드와 수정을 원치 않는 필드를 조합하여 요청해야 합니다. 수정을 원치 않는 필드도 기존 값으로 요청되어야 캠페인 정보를 유지할 수 있습니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 PUT으로 요청합니다. 성공 시 수정된 JSON 객체로 수정된 캠페인 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
PUT /openapi/v1/campaigns/${id} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 캠페인 ID O
name String 캠페인 이름 O
trackId String 전환추적 설정 번호(미입력시 '연동하지 않기'로 입력) X
trackUrl Boolean 추적URL 설정상태(미입력시 '설정'으로 입력) X
dailyBudgetAmount Long 일예산(미입력시 '미설정'으로 입력) X
Response
Name Type Description
bizChannelId Long 비즈채널 ID
id Long 캠페인 ID
name String 캠페인 이름
config String 캠페인 상태
status String[] 캠페인 운영상태
trackId String 전환추적 고유코드(track_id)
trackUrl Boolean 추적URL 설정상태
dailyBudgetAmount Long 일예산
dailyBudgetAmountOver Boolean 일 예산 초과 여부
Sample
Request
curl -X PUT "https://api.keywordad.kakao.com/openapi/v1/campaigns/3333333331" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json" \
    -d '{
          "name": "캠페인2",
          "trackId": 1234567890,
          "traceUrl": false,
          "dailyBudgetAmount": 30000
        }'
Response
{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인2",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": "1234567890",
  "traceUrl": false,
  "dailyBudgetAmount": 30000,
  "dailyBudgetAmountOver": false
}

캠페인 상태 바꾸기

캠페인의 상태를 ON 또는 OFF로 변경합니다. 캠페인 상태가 ON 또는 OFF일 경우에만 변경합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없으며, 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
PATCH /openapi/v1/campaigns/${id}/onOff HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 캠페인 ID O
config String 캠페인 상태
ON, OFF 중 하나
O
Sample
Request
curl -X PATCH "https://api.keywordad.kakao.com/openapi/v1/campaigns/3333333331/onOff" \
    -H "adAccountId: {adAccountId}"\
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "config": "ON"
        }'
Response: 성공
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

캠페인 일 예산 수정하기

캠페인 일 예산을 수정합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
PATCH /openapi/v1/campaigns/${id}/dailyBudget HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 캠페인 ID O
dailyBudgetAmount Long 일예산(미입력시 '미설정'으로 입력) O
Sample
Request: 캠페인 일예산 설정
curl -X PATCH "https://api.keywordad.kakao.com/openapi/v1/campaigns/3333333331/dailyBudget" \
    -H "adAccountId: {adAccountId}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "dailyBudgetAmount": 20000
        }'
Request: 캠페인 일예산 미설정
curl -X PATCH "https://api.keywordad.kakao.com/openapi/v1/campaigns/3333333331/dailyBudget" \
    -H "adAccountId: {adAccountId}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "dailyBudgetAmount": null
        }'
Response: 성공
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

캠페인 삭제하기

캠페인을 삭제합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청합니다. 삭제하려는 캠페인의 ID를 파라미터로 지정해야 합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
DELETE /openapi/v1/campaigns/${id} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 캠페인 ID O
Sample
Request
curl -X DELETE "https://api.keywordad.kakao.com/openapi/v1/campaigns/${id}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json"
Response: 성공
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

더보기