페이지 이동경로

문서>
카카오 키워드광고>
광고 만들기: 캠페인

카카오 키워드광고

광고 만들기: 캠페인

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

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

캠페인 목록 보기

기본 정보

메서드	URL	인증 방식
`GET`	`https://api.keywordad.kakao.com/openapi/v1/campaigns`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

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

쿼리 파라미터

이름	타입	설명	필수
config	`String`	캠페인 상태(미입력시 `ON,OFF`값 출력)	X

응답

본문

이름	타입	설명
bizChannelId	`Long`	비즈채널 ID
id	`Long`	캠페인 ID
name	`String`	캠페인 이름
config	`String`	캠페인 상태
status	`String[]`	캠페인 운영상태
trackId	`String`	전환추적 고유코드(track_id)
trackUrl	`Boolean`	추적URL 설정상태
dailyBudgetAmount	`Long`	일 예산
dailyBudgetAmountOver	`Boolean`	일 예산 초과 여부

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/campaigns" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d "config=ON"

응답

[
    {
      "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
    }
]

캠페인 보기

기본 정보

메서드	URL	인증 방식
`GET`	`https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

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

경로 변수

이름	타입	설명	필수
ID	`Long`	캠페인 ID	O

응답

본문

이름	타입	설명
bizChannelId	`Long`	비즈채널 ID
id	`Long`	캠페인 ID
name	`String`	캠페인 이름
config	`String`	캠페인 상태
status	`String[]`	캠페인 운영상태
trackId	`String`	전환추적 고유코드(track_id)
trackUrl	`Boolean`	추적URL 설정상태
dailyBudgetAmount	`Long`	일 예산
dailyBudgetAmountOver	`Boolean`	일 예산 초과 여부

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

응답: 성공

{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인1",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": null,
  "traceUrl": true,
  "dailyBudgetAmount": 500000,
  "dailyBudgetAmountOver": false
}

캠페인 생성하기

기본 정보

메서드	URL	인증 방식
`POST`	`https://api.keywordad.kakao.com/openapi/v1/campaigns`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

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

본문

이름	타입	설명	필수
bizChannelId	`Long`	비즈채널 ID	O
name	`String`	캠페인 이름	O
trackId	`String`	전환추적 설정 번호(미입력시 '연동하지 않기'로 입력)	X
trackUrl	`Boolean`	추적URL 설정상태(미입력시 '설정'으로 입력)	X
dailyBudgetAmount	`Long`	일예산(미입력시 '미설정'으로 입력)	X

응답

본문

이름	타입	설명
bizChannelId	`Long`	비즈채널 ID
id	`Long`	캠페인 ID
name	`String`	캠페인 이름
config	`String`	캠페인 상태
status	`String[]`	캠페인 운영상태
trackId	`String`	전환추적 고유코드(track_id)
trackUrl	`Boolean`	추적URL 설정상태
dailyBudgetAmount	`Long`	일예산
dailyBudgetAmountOver	`Boolean`	일 예산 초과 여부

예제

요청

curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/campaigns" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json" \
    -d '{
          "bizChannelId": 2222222221,
          "name": "캠페인1",
          "trackId": null,
          "traceUrl": true,
          "dailyBudgetAmount": 30000
        }'

응답

{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인1",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": null,
  "traceUrl": true,
  "dailyBudgetAmount": 30000,
  "dailyBudgetAmountOver": false
}

캠페인 수정하기

기본 정보

메서드	URL	인증 방식
`PUT`	`https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

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

경로 변수

이름	타입	설명	필수
ID	`Long`	캠페인 ID	O

본문

이름	타입	설명	필수
name	`String`	캠페인 이름	O
trackId	`String`	전환추적 설정 번호(미입력시 '연동하지 않기'로 입력)	X
trackUrl	`Boolean`	추적URL 설정상태(미입력시 '설정'으로 입력)	X
dailyBudgetAmount	`Long`	일예산(미입력시 '미설정'으로 입력)	X

응답

본문

이름	타입	설명
bizChannelId	`Long`	비즈채널 ID
id	`Long`	캠페인 ID
name	`String`	캠페인 이름
config	`String`	캠페인 상태
status	`String[]`	캠페인 운영상태
trackId	`String`	전환추적 고유코드(track_id)
trackUrl	`Boolean`	추적URL 설정상태
dailyBudgetAmount	`Long`	일예산
dailyBudgetAmountOver	`Boolean`	일 예산 초과 여부

예제

요청

curl -v -X PUT "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json" \
    -d '{
          "name": "캠페인2",
          "trackId": 1234567890,
          "traceUrl": false,
          "dailyBudgetAmount": 30000
        }'

응답

{
  "bizChannelId": "2222222221",
  "id": "3333333331",
  "name": "캠페인2",
  "config": "ON",
  "status": [
    "OFF_BY_BIZ_CHANNEL_WAITING"
  ],
  "trackId": "1234567890",
  "traceUrl": false,
  "dailyBudgetAmount": 30000,
  "dailyBudgetAmountOver": false
}

캠페인 상태 바꾸기

기본 정보

메서드	URL	인증 방식
`PATCH`	`https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}/onOff`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

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

경로 변수

이름	타입	설명	필수
ID	`Long`	캠페인 ID	O

본문

이름	타입	설명	필수
id	`Long`	캠페인 ID	O
config	`String`	캠페인 상태 `ON`, `OFF` 중 하나	O

예제

요청

curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}/onOff" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"\
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "config": "ON"
        }'

응답: 성공

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

캠페인 일 예산 수정하기

기본 정보

메서드	URL	인증 방식
`PATCH`	`https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}/dailyBudget`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

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

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

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${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/campaigns/${ID}/dailyBudget" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "dailyBudgetAmount": 20000
        }'

요청: 캠페인 일예산 미설정

curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}/dailyBudget" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "dailyBudgetAmount": null
        }'

응답: 성공

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

캠페인 삭제하기

기본 정보

메서드	URL	인증 방식
`DELETE`	`https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}`	액세스 토큰

권한	사전 설정	카카오 로그인	사용자 동의
-	카카오 로그인 활성화 비즈 앱	필요	-

캠페인을 삭제합니다.

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

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${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/campaigns/${ID}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json"

응답: 성공

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

menu

시작하기

로그인

커뮤니케이션

지도/로컬

내비게이션

검색

인공지능

광고

더 보기

카카오 키워드광고

광고 만들기: 캠페인

캠페인 목록 보기

기본 정보

요청

헤더

쿼리 파라미터

응답

본문

예제

요청

응답

캠페인 보기

기본 정보

요청

헤더

경로 변수

응답

본문

예제

요청

응답: 성공

캠페인 생성하기

기본 정보

요청

헤더

본문

응답

본문

예제

요청

응답

캠페인 수정하기

기본 정보

요청

헤더

경로 변수

본문

응답

본문

예제

요청

응답

캠페인 상태 바꾸기

기본 정보

요청

헤더

경로 변수

본문

예제

요청

응답: 성공

캠페인 일 예산 수정하기

기본 정보

요청

헤더

경로 변수

본문

예제

요청: 캠페인 일예산 설정

요청: 캠페인 일예산 미설정

응답: 성공

캠페인 삭제하기

기본 정보

요청

헤더

경로 변수

예제

요청

응답: 성공