사이드 메뉴
시작하기
로그인
커뮤니케이션
광고
카카오 키워드광고
심사서류 관리
이 문서는 심사서류 관리 API 사용 방법을 안내합니다.
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET | https://api.keywordad.kakao.com/openapi/v1/documents | 비즈니스 토큰 |
심사서류 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 응답 본문에 JSON 객체로 종류별 심사서류 관리 상세 정보를 받습니다. 실패 시 에러 코드로 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| bizChannelId | Long | 비즈채널 ID | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| bizChannelId | Long | 비즈채널 ID |
| bizChannelName | String | 웹사이트명 |
| documents | ReviewDocument | 심사서류 정보 |
요청
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/documents" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}" \-d "bizChannelId=2222222221"
응답
HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8{"bizChannelId": "2222222221","bizChannelName": "비즈채널_변경이력1","documents": [{"id": "9999999991","fileName": "test.jpg","requiredDocumentId": 92,"requiredDocumentName": "의료광고심의필증","type": "CREATIVE","url": "https://www.kakao.com/document1.jpg"},{"id": "9999999991","fileName": "test.jpg","requiredDocumentId": 93,"requiredDocumentName": "기타서류","type": "CREATIVE","url": "https://www.kakao.com/document2.jpg"}]}
| 메서드 | URL | 인증 방식 |
|---|---|---|
POST | https://api.keywordad.kakao.com/openapi/v1/documents | 비즈니스 토큰 |
새로운 심사서류를 등록합니다.
심사서류 등록을 위해 application/json과 multipart/form-data 두 가지 Content-Type을 지원합니다. 어느 방식으로 요청하더라도 등록 결과는 같습니다.
- application/json:
fileUrl파라미터로 https:// 또는 https:// URL 형식의 심사서류 경로 전달 - multipart/form-data:
file파라미터로 로컬 파일 경로 전달
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청합니다. 요청이 성공하면 응답 본문에 JSON 객체로 생성된 심사서류 정보를 받습니다. 실패 시 에러 코드로 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| bizChannelId | Long | 비즈채널 ID | O |
| type | String | 심사서류 타입CREATIVE: 소재 심사서류 BIZ_CHANNEL: 비즈채널 심사서류 | O |
| requiredDocumentId | RequiredDocument | 심사서류 ID | O |
| fileUrl | String | http:// 또는 https:// 형식의 URL형태로 요청 최대 파일글자수: 255자 최대 용량: 10MB 지원하는 파일형식: JPG, JPEG, GIF, PNG, TIF, HWP, DOC, DOCX, PDF | O* |
| file | Multipart File | 로컬 파일 경로 입력 최대 용량: 10MB 지원하는 파일형식: JPG, JPEG, GIF, PNG, TIF, HWP, DOC, DOCX, PDF | O* |
요청: application/json 방식
curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/documents" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"-H "Content-Type: application/json" \-d '{"bizChannelId": "2222222221","requiredDocumentId": 93,"type": "CREATIVE","fileUrl":"https://www.image.com/document1.png"}'
요청: multipart/form-data 방식
curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/documents" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"-H "Content-Type: multipart/form-data" \-F "bizChannelId=2222222221" \-F "type=CREATIVE" \-F "requiredDocumentId=93" \-F "file=@파일_경로"
응답
HTTP/1.1 200 OKContent-Length: 0Content-Type: application/json;charset=UTF-8