이 문서는 소재연결 API 사용 방법을 안내합니다.
생성된 소재들은 광고그룹과 연결되어야 합니다. 검색한 키워드가 속해있는 광고그룹 내 연결된 소재가 노출됩니다.
메서드 | URL | 인증 방식 |
---|---|---|
GET |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹 단위의 연결된 광고소재의 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 GET
으로 요청합니다. 조회하려는 광고그룹의 ID를 파라미터로 지정해야 합니다. 성공 시 응답 본문에 JSON 객체로 요청한 광고그룹에 연결된 광고소재 정보의 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
adGroupId | Long |
광고그룹 ID | O |
config | String |
광고그룹에 연결된 소재의 상태(미입력시 ON,OFF 값 출력) |
X |
이름 | 타입 | 설명 |
---|---|---|
creativeLinkId | Long |
소재연결 ID |
adGroupId | Long |
광고그룹 ID |
creativeId | Long |
소재 ID |
config | String |
광고그룹에 연결된 소재의 상태 |
status | String[] |
광고소재 운영상태 |
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-d "adGroupId=4444444441" \
-d "config=ON"
HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
[
{
"creativeLinkId": "7777777771",
"adGroupId": "4444444441",
"creativeId": "66666666661",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING"
]
},
{
"creativeLinkId": "7777777772",
"adGroupId": "4444444441",
"creativeId": "66666666662",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING"
]
}
]
메서드 | URL | 인증 방식 |
---|---|---|
GET |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고소재 단위의 연결된 광고그룹 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 GET
으로 요청합니다. 조회하려는 소재의 ID를 파라미터로 지정해야 합니다. 성공 시 응답 본문에 JSON 객체로 요청한 소재에 연결된 광고그룹 정보의 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
creativeId | Long |
소재 ID | O |
config | String |
광고그룹에 연결된 소재의 상태(미입력시 ON,OFF 값 출력) |
X |
이름 | 타입 | 설명 |
---|---|---|
creativeLinkId | Long |
소재연결 ID |
adGroupId | Long |
광고그룹 ID |
creativeId | Long |
소재 ID |
config | String |
광고그룹에 연결된 소재의 상태 |
status | String[] |
광고소재 운영상태 |
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-d "creativeId=66666666661" \
-d "config=ON"
HTTP/1.1 200 OK
Content-type: application/json;charset=UTF-8
[
{
"creativeLinkId": "7777777771",
"adGroupId": "4444444441",
"creativeId": "66666666661",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING"
]
},
{
"creativeLinkId": "7777777772",
"adGroupId": "4444444442",
"creativeId": "66666666661",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING"
]
}
]
메서드 | URL | 인증 방식 |
---|---|---|
GET |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID} |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
연결된 소재의 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 GET
으로 요청합니다. 소재연결 ID를 파라미터로 지정해야 합니다. 성공 시 응답 본문에 JSON 객체로 연결된 광고그룹과 소재 정보의 상세 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
CREATIVE_LINK_ID | Long |
소재연결 ID | O |
이름 | 타입 | 설명 |
---|---|---|
adGroupId | Long |
광고그룹 ID |
creativeId | Long |
소재 ID |
config | String |
광고그룹에 연결된 소재의 상태 ON, OFF 중 하나 |
status | String[] |
광고소재 운영상태 |
curl -v -G GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"creativeLinkId": "7777777771",
"adGroupId": "4444444441",
"creativeId": "66666666661",
"config": "ON",
"status": [
"OFF_BY_BIZ_CHANNEL_WAITING"
]
}
메서드 | URL | 인증 방식 |
---|---|---|
POST |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹에 광고소재를 연결합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 POST
로 요청합니다. 요청이 성공하면 응답 본문에 JSON 객체로 연결된 광고그룹과 소재 정보의 상세 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
creativeId | Long |
소재 ID | O |
adGroupId | Long |
연결할 광고그룹 ID | O |
이름 | 타입 | 설명 |
---|---|---|
creativeLinkId | Long |
소재연결 ID |
adGroupId | Long |
광고그룹 ID |
creativeId | Long |
소재 ID |
config | String |
광고그룹에 연결된 소재의 상태 ON, OFF 중 하나 |
curl -v -X POST "https://api.keywordad.kakao.com/openapi/v1/creativeLinks" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
-H "Content-Type: application/json" \
-d '{
"creativeId": "66666666661",
"adGroupId": "4444444441"
}'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"creativeLinkId": "7777777771",
"adGroupId": "4444444441",
"creativeId": "66666666661",
"config": "ON"
}
메서드 | URL | 인증 방식 |
---|---|---|
PATCH |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID}/onOff |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고계정에 연결된 소재의 상태를 ON 또는 OFF로 변경합니다. 연결된 소재의 상태가 ON 또는 OFF일 경우만 변경 가능합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 PATCH
로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
CREATIVE_LINK_ID | Long |
소재연결 ID | O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
config | String |
광고그룹의 상태 ON, OFF 중 하나 |
O |
curl -v -X PATCH "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID}/onOff" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
-H "Content-Type: application/json" \
-d '{
"config": "ON"
}'
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8
메서드 | URL | 인증 방식 |
---|---|---|
DELETE |
https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID} |
비즈니스 토큰 |
권한 | 사전 설정 | 비즈니스 인증 | 비즈니스 동의항목 |
---|---|---|---|
- | 비즈 앱 전환 비즈니스 Redirect URI 등록 비즈니스 동의항목 |
필요 | 필요 |
광고그룹에 연결된 광고소재의 연결을 삭제합니다.
비즈니스 토큰과 광고계정 ID(adAccountId
)를 헤더에 담아 DELETE
로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.
이름 | 설명 | 필수 |
---|---|---|
Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청 |
O |
adAccountId | adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID |
O |
이름 | 타입 | 설명 | 필수 |
---|---|---|---|
CREATIVE_LINK_ID | Long |
소재연결 ID | O |
curl -v -X DELETE "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/${CREATIVE_LINK_ID}" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8