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

카카오 키워드광고

소재

이 문서는 소재 API 사용 방법을 안내합니다.

소재란 하나의 광고 단위로 텍스트, 이미지, 전화번호 등 다양한 노출방식의 소재를 설정할 수 있습니다. 생성한 소재 형식에 따라 광고가 노출됩니다.

소재 목록 보기

기본 정보

GET /openapi/v1/creatives/basic?bizChannelId=${bizChannelId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

비즈채널 단위 소재의 목록을 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 응답 바디에 JSON 객체로 소재 상세 정보 목록을 받습니다.

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
bizChannelId Long 비즈채널 ID O
page Integer 페이지 번호(미입력시 0으로 입력) X
limit Integer 페이지당 갯수
(미입력시 10으로 입력, 최대 1000)
X
config String 소재 상태
ON, DEL 중 하나
X

Response

Name Type Description
bizChannelId Long 비즈채널 ID
id Long 소재 ID
name String 소재 이름
title String [기본소재]제목
description String [기본소재]설명문구
assetTypese String[] 사용중 확장소재 타입
config String 소재 상태
page String 페이지 정보

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/creatives/basic?bizChannelId=2222222221&config=ON&page=0&limit=10" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
{
  "content": [
    {
      "bizChannelId": "2222222221",
      "id": "66666666661",
      "name": "소재1",
      "title": "타이틀",
      "description": "설명문구",
      "assetTypes": [
        "THUMBNAIL",
        "MULTI_THUMBNAIL",
        "ADDITIONAL_TITLE",
        "ADDITIONAL_LINK",
        "SUBJECT",
        "PRICE_TABLE",
        "CALCULATE",
        "PHONE_NUMBER",
        "TALK_CHANNEL"
      ],
      "config": "ON"
    },
    {
      "bizChannelId": "2222222221",
      "id": "66666666662",
      "name": "소재2",
      "title": "타이틀",
      "description": "설명문구",
      "assetTypes": [],
      "config": "ON"
    }
  ],
  "page": {
    "number": 0,
    "size": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}

소재 보기

기본 정보

GET /openapi/v1/creatives/basic/${id} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

소재의 상세 정보를 조회합니다.

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

Request

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
adAccountId Long 광고계정 ID
bizChannelId Long 비즈채널 ID
id Long 소재 ID
name String 소재 이름
title String [기본소재]제목
description String [기본소재]설명문구
landingInfo LandingInfo [기본소재]랜딩 URL(미입력시 비즈채널 URL 정보 입력)
license License [기본소재]의료광고 심의필 번호, 서류
assets Assets 확장소재 상세 정보

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/creatives/basic/66666666661" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "adAccountId": "1111111111",
  "bizChannelId": "2222222221",
  "id": "66666666661",
  "name": "소재이름",
  "title": "타이틀",
  "description": "설명문구"
  "landingInfo": {
    "rspvLandingUrl": "https://www.daum.net",
    "pcLandingUrl": null,
    "mobileLandingUrl": null
  },
  "license": {
    "licenseNumber": "1234567890",
    "reviewDocumentId": "9999999991"
  },
  "assets": {
    "thumbnail": {
      "imageId": "8888888881",
      "text": "썸네일이미지설명"
    },
    "multiThumbnails": [
      {
        "imageId": "8888888882",
        "text": "멀티썸네일1",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "imageId": "8888888883",
        "text": "멀티썸네일2",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "imageId": 8888888883,
        "text": "멀티썸네일3",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "additionalTitle": "추가제목",
    "additionalLinks": [
      {
        "text": "부가링크1",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "부가링크2",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "부가링크3",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "subject": {
      "subject": "DISCOUNT",
      "text": "할인말머리",
      "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
      }
    },
    "priceTables": [
      {
        "text": "가격테이블1",
        "price": 1000,
        "range": "STATIC",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "가격테이블2",
        "price": 2000,
        "range": "FROM",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "가격테이블3",
        "price": 3000,
        "range": "TO",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "phoneNumber": "010-1234-5678",
    "calculate": {
      "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
      }
    },
    "talkChannelId": "@kakao1"
  }
}

소재 생성하기

기본 정보

POST /openapi/v1/creatives/basic HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

새로운 소재를 생성합니다.

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

Request

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
title String [기본소재]제목 O
description String [기본소재]설명문구 O
landingInfo LandingInfo [기본소재]랜딩 URL(미입력시 비즈채널 URL 정보 입력) X
license License [기본소재]의료광고 심의필 번호, 서류 X
assets Assets 확장소재 상세 정보 X

Response

Name Type Description
adAccountId Long 광고계정 ID
bizChannelId Long 비즈채널 ID
id Long 소재 ID
name String 소재 이름
title String [기본소재]제목
description String [기본소재]설명문구
landingUrl LandingInfo [기본소재]랜딩 URL(미입력시 비즈채널 URL 정보 입력)
license License [기본소재]의료광고 심의필 번호, 서류
assets Assets 확장소재 상세 정보

Sample

Request
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/creatives/basic" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json" \
    -d '{
          "name": "소재이름",
          "title": "타이틀",
          "description": "설명문구",
          "bizChannelId": "2222222221",
          "landingInfo": {
            "rspvLandingUrl": "https://www.daum.net",
            "pcLandingUrl": null,
            "mobileLandingUrl": null
          },
          "license": {
            "licenseNumber": "1234567890",
            "reviewDocumentId": "9999999991"
          },
          "assets": {
            "thumbnail": {
              "imageId": "8888888881",
              "text": "썸네일이미지설명"
            },
            "multiThumbnails": [
              {
                "imageId": "8888888882",
                "text": "멀티썸네일1",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "imageId": "8888888883",
                "text": "멀티썸네일2",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "imageId": "8888888884",
                "text": "멀티썸네일3",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              }
            ],
            "additionalTitle": "추가제목",
            "additionalLinks": [
              {
                "text": "부가링크1",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "text": "부가링크2",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "text": "부가링크3",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              }
            ],
            "subject": {
              "subject": "DISCOUNT",
              "text": "할인말머리",
              "landingInfo": {
                "rspvLandingUrl": "https://www.daum.net",
                "pcLandingUrl": null,
                "mobileLandingUrl": null
              }
            },
            "priceTables": [
              {
                "text": "가격테이블1",
                "price": 1000,
                "range": "STATIC",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "text": "가격테이블2",
                "price": 2000,
                "range": "FROM",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              },
              {
                "text": "가격테이블3",
                "price": 3000,
                "range": "TO",
                "landingInfo": {
                  "rspvLandingUrl": "https://www.daum.net",
                  "pcLandingUrl": null,
                  "mobileLandingUrl": null
                }
              }
            ],
            "phoneNumber": "010-1234-5678",
            "calculate": {
              "landingInfo": {
                "rspvLandingUrl": "https://www.daum.net",
                "pcLandingUrl": null,
                "mobileLandingUrl": null
              }
            },
            "talkChannelId": "@test"
          }
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "adAccountId": "1111111111",
  "bizChannelId": "2222222221",
  "id": "66666666661",
  "name": "소재이름",
  "title": "타이틀",
  "description": "설명문구",
  "landingInfo": {
    "rspvLandingUrl": "https://www.daum.net",
    "pcLandingUrl": null,
    "mobileLandingUrl": null
  },
  "license": {
    "licenseNumber": "1234567890",
    "reviewDocumentId": "9999999991"
  },
  "assets": {
    "thumbnail": {
      "imageId": "8888888881",
      "text": "썸네일이미지설명"
    },
    "multiThumbnails": [
      {
        "imageId": "8888888882",
        "text": "멀티썸네일1",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "imageId": "8888888883",
        "text": "멀티썸네일2",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "imageId": "8888888884",
        "text": "멀티썸네일3",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "additionalTitle": "추가제목",
    "additionalLinks": [
      {
        "text": "부가링크1",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "부가링크2",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "부가링크3",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "subject": {
      "subject": "DISCOUNT",
      "text": "할인말머리",
      "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
      }
    },
    "priceTables": [
      {
        "text": "할인1",
        "price": 1000,
        "range": "STATIC",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "할인2",
        "price": 2000,
        "range": "FROM",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      },
      {
        "text": "할인3",
        "price": 3000,
        "range": "TO",
        "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
        }
      }
    ],
    "phoneNumber": "010-1234-5678",
    "calculate": {
      "landingInfo": {
          "rspvLandingUrl": "https://www.daum.net",
          "pcLandingUrl": null,
          "mobileLandingUrl": null
      }
    },
    "talkChannelId": "@test"
  }
}

소재 삭제하기

기본 정보

DELETE /openapi/v1/creatives/${id} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

소재를 삭제합니다.

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

Request

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/creatives/66666666661" \
    -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

더보기