카카오 키워드광고

광고 생성: 캠페인

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

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

캠페인 목록 조회

기본 정보

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

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

캠페인 목록을 반환합니다.

요청

헤더

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

쿼리 파라미터

이름	타입	설명	필수
config	`Enum: Config`	캠페인 상태(기본값: `ON,OFF`)	X

응답

본문

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

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/campaigns" \
    -H "Authorization: Bearer ${BUSINESS_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}`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

캠페인의 상세 정보를 반환합니다.

요청

헤더

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

경로 변수

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

응답

본문

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

예제

요청

curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_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`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

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

요청

헤더

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

본문

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

응답

본문

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

예제

요청

curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/campaigns" \
    -H "Authorization: Bearer ${BUSINESS_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}`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

캠페인 정보를 수정합니다.

캠페인 정보 유지 시 주의 사항

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

요청

헤더

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

경로 변수

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

본문

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

응답

본문

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

예제

요청

curl -v -X PUT "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_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`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

캠페인의 상태를 ON 또는 OFF로 변경합니다.

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

요청

헤더

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

경로 변수

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

본문

이름	타입	설명	필수
id	`Long`	캠페인 ID	O
config	`Enum: Config`	캠페인 상태 `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 ${BUSINESS_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`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

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

요청

헤더

이름	설명	필수
Authorization	인증 방식, 비즈니스 토큰으로 인증 요청 `Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}`	O
adAccountId	광고계정 ID `adAccountId: ${AD_ACCOUNT_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 ${BUSINESS_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 ${BUSINESS_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}`	비즈니스 토큰

요구 사항	참고
비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목 설정	에러 코드 용어집

캠페인을 삭제합니다.

요청

헤더

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

경로 변수

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

예제

요청

curl -v -X DELETE "https://api.keywordad.kakao.com/openapi/v1/campaigns/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_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

사이드 메뉴

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

광고

지도

내비게이션

검색

더 보기

광고 생성: 캠페인

캠페인 목록 조회

기본 정보

요청

헤더

쿼리 파라미터

응답

본문

예제

요청

응답

캠페인 조회

기본 정보

요청

헤더

경로 변수

응답

본문

예제

요청

응답: 성공

캠페인 생성

기본 정보

요청

헤더

본문

응답

본문

예제

요청

응답

캠페인 수정

기본 정보

캠페인 정보 유지 시 주의 사항

요청

헤더

경로 변수

본문

응답

본문

예제

요청

응답

캠페인 상태 변경

기본 정보

요청

헤더

경로 변수

본문

예제

요청

응답: 성공

캠페인 일 예산 수정

기본 정보

요청

헤더

경로 변수

본문

예제

요청: 캠페인 일예산 설정

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

응답: 성공

캠페인 삭제

기본 정보

요청

헤더

경로 변수

예제

요청

응답: 성공