페이지 이동경로
  • 문서>
  • 카카오 키워드광고>
  • 광고 만들기: 비즈채널

카카오 키워드광고

광고 만들기: 비즈채널

이 문서는 광고 만들기: 비즈채널 API 사용 방법을 안내합니다.

비즈채널이란 광고 집행을 위해 홍보할 웹사이트로, 검색 사용자에게 광고를 통해 노출되는 사업자 정보입니다.

비즈채널 목록 보기

기본 정보

GET /openapi/v1/bizChannels/websites 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

Response

Name Type Description
id Long 비즈채널 ID
name String 웹사이트명
websiteUrl WebsiteUrl 웹사이트 URL 정보
ufoBusinessTypeId RequiredDocument 업종 ID

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/bizChannels/websites" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
[
   {
     "id": "2222222221",
     "name": "카카오1",
     "websiteUrl": {
         "rspvUrl": "http://www.daum.net",
         "pcUrl": null,
         "mobileUrl": null
     },
     "ufoBusinessTypeId": 445
   },
   {
     "id": "2222222222",
     "name": "카카오2",
     "websiteUrl": {
        "rspvUrl": "http://www.kakao.com",
        "pcUrl": null,
        "mobileUrl": null
     },
     "ufoBusinessTypeId": "445"
   }
]

비즈채널 보기

기본 정보

GET /openapi/v1/bizChannels/websites/${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
id Long 비즈채널 ID
name String 웹사이트명
websiteUrl WebsiteUrl 웹사이트 URL 정보
reviewStatus String 심사 상태
hasAccessAccount Boolean 검수계정 여부
talkChannels TalkChannels 카카오톡 채널 정보
ufoBusinessTypeId String 업종 ID

Sample

Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/bizChannels/websites/2222222221" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
{
  "id": "2222222221",
  "name": "카카오1",
  "websiteUrl": {
        "rspvUrl": "https://www.daum.net",
        "mobileUrl": null,
        "pcUrl": null
  },
  "reviewStatus": "APPROVED",
  "hasAccessAccount": false,
  "talkChannels": [
      {
        "uuid": "@kakao1",
        "name": "카카오채널1"
      },
      {
        "uuid": "@kakao2",
        "name": "카카오채널2"
      }
  ],
  "ufoBusinessTypeId": "445"
}

비즈채널 웹사이트 생성하기

기본 정보

POST /openapi/v1/bizChannels/websites 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
name String 웹사이트명 O
ufoBusinessTypeId RequiredDocument 업종 ID O
websiteUrl WebsiteUrl 웹사이트 URL 정보 O
accessAccount AccessAccount 검수계정 정보 X
talkChannels String[] 카카오톡 채널 프로필 ID X
reviewDocuments UfoReviewDocument fileUrl을 통해 접근 가능한 심사서류 리스트 X
Required-Review-Document-Id UfoReviewDocument 심사서류 ID
파일을 직접 업로드할 때 사용
X
Review-Document-Type String 심사서류 타입
파일을 직접 업로드할 때 사용
CREATIVE: 소재 심사서류
BIZ_CHANNEL: 비즈채널 심사서류
X

Response

Name Type Description
id Long 비즈채널 ID
name String 웹사이트명
websiteUrl WebsiteUrl 웹사이트 URL 정보
reviewStatus String 심사 상태
hasAccessAccount boolean 검수계정 여부
talkChannels String[] 카카오톡 채널 ID
ufoBusinessTypeId RequiredDocument 업종 ID

Sample

Request: application/json 방식
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/bizChannels/websites" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json" \
    -d '{
            "name": "카카오",
            "websiteUrl": {
               "rspvUrl": "https://www.daum.net"
             },
            "accessAccount": {
                "id": "kakao",
                "password": "k1234"
            },
            "talkChannels": ["@카카오채널1","@카카오채널2"],
            "ufoBusinessTypes": 445,
            "reviewDocuments": [
                {
                  "type": "BIZ_CHANNEL",
                  "requiredReviewDocumentId": 93,
                  "fileUrl": "http://www.kakao.com/test.jpg"
                }
              ]
        }'
Request: multipart/form-data 방식
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/bizChannels/websites" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: multipart/form-data" \
    -F "websiteBizChannelDto={\"name\":\"카카오\",\"websiteUrl\":{\"rspvUrl\":\"https:\/\/wwws.daum.net\"},\"accessAccount\":{\"id\":\"a_id\",\"password\":\"a_password\"},\"talkChannels\":[\"@카카오채널1\",\"@카카오채널2\"],\"ufoBusinessTypeId\":445};type=application/json" \
    -F "files=@파일_경로;filename=document.jpg;headers=\"Required-Review-Document-Id: 8\";headers=\"Review-Document-Type: BIZ_CHANNEL\";" \
    -F "files=@파일_경로;filename=content_document.jpg;headers=\"Required-Review-Document-Id: 93\";headers=\"Review-Document-Type: CREATIVE\";"
Response: 성공
{
  "id": "2222222221",
  "name": "카카오",
  "websiteUrl": {
        "rspvUrl": "https://www.daum.net"
  },
  "reviewStatus": "APPROVED",
  "hasAccessAccount": true,
  "talkChannels": [
      {
        "uuid": "@카카오채널1",
        "name": "카카오채널1"
      },
      {
        "uuid": "@카카오채널2",
        "name": "카카오채널2"
      }
  ],
  "ufoBusinessTypes": 445
}

카카오톡 채널 수정하기

기본 정보

PUT /openapi/v1/bizChannels/websites/${id}/talkChannels HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

생성된 비즈채널에 카카오톡 채널을 등록하거나 삭제합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 PUT으로 요청합니다. 성공 시 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
registration String 등록(ADD) 또는 삭제(DEL) 중 하나 입력 O
talkChannels String[] 카카오톡 채널 ID O

Sample

Request

curl -X PUT "https://api.keywordad.kakao.com/openapi/v1/bizChannels/websites/2222222221/talkChannels" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json" \
    -d '{
            "registration": "ADD",
            "talkChannels": ["@카카오채널1","@카카오채널2"]
        }'
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

비즈채널 삭제하기

기본 정보

DELETE /openapi/v1/bizChannels/${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/bizChannels/${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

더보기