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

카카오 키워드광고

광고 만들기: 소재연결

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

생성된 소재들은 광고그룹과 연결되어야 합니다. 검색한 키워드가 속해있는 광고그룹 내 연결된 소재가 노출됩니다.

(광고그룹 단위) 연결 소재 목록 보기

광고그룹 단위의 연결된 광고소재의 정보를 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 조회하려는 광고그룹의 ID를 파라미터로 지정해야 합니다. 성공 시 응답 바디에 JSON 객체로 요청한 광고그룹에 연결된 광고소재 정보의 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v1/creativeLinks?adGroupId={adGroupId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
adGroupId Long 광고그룹 ID O
config String 광고그룹에 연결된 소재의 상태(미입력시 ON,OFF값 출력) X
Response
Name Type Description
creativeLinkId Long 소재연결 ID
adGroupId Long 광고그룹 ID
creativeId Long 소재 ID
config String 광고그룹에 연결된 소재의 상태
status String[] 광고소재 운영상태
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks?adGroupId=4444444441&config=ON" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
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"
      ]
    }
]

(광고소재 단위) 연결 광고그룹 목록 보기

광고소재 단위의 연결된 광고그룹 정보를 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 조회하려는 소재의 ID를 파라미터로 지정해야 합니다. 성공 시 응답 바디에 JSON 객체로 요청한 소재에 연결된 광고그룹 정보의 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v1/creativeLinks/?creativeId={creativeId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
creativeId Long 소재 ID O
config String 광고그룹에 연결된 소재의 상태(미입력시 ON,OFF값 출력) X
Response
Name Type Description
creativeLinkId Long 소재연결 ID
adGroupId Long 광고그룹 ID
creativeId Long 소재 ID
config String 광고그룹에 연결된 소재의 상태
status String[] 광고소재 운영상태
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/?creativeId=66666666661&config=ON" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
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"
      ]
    }
]

소재연결 보기

연결된 소재의 정보를 조회합니다.

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

Request
URL
GET /openapi/v1/creativeLinks/{creativeLinkId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
creativeLinkId Long 소재연결 ID O
Response
Name Type Description
creativeLinkId Long 소재연결 ID
adGroupId Long 광고그룹 ID
creativeId Long 소재 ID
config String 광고그룹에 연결된 소재의 상태
ON, OFF 중 하나
status String[] 광고소재 운영상태
Sample
Request
curl -X GET "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/7777777771" \
     -H "adAccountId: {adAccountId}" \
     -H "Authorization: Bearer {ACCESS_TOKEN}" 
Response
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"
  ]
}

소재연결하기

광고그룹에 광고소재를 연결합니다.

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

Request
URL
POST /openapi/v1/creativeLinks HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
creativeId Long 소재 ID O
adGroupId Long 연결할 광고그룹 ID O
Response
Name Type Description
creativeLinkId Long 소재연결 ID
adGroupId Long 광고그룹 ID
creativeId Long 소재 ID
config String 광고그룹에 연결된 소재의 상태
ON, OFF 중 하나
Sample
Request
curl -X POST "https://api.keywordad.kakao.com/openapi/v1/creativeLinks" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
    -H "Content-Type: application/json" \
    -d '{
            "creativeId": "66666666661",
            "adGroupId": "4444444441"
       }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
      "creativeLinkId": "7777777771",
      "adGroupId": "4444444441",
      "creativeId": "66666666661",
      "config": "ON"
}

소재연결 상태 바꾸기

광고계정에 연결된 소재의 상태를 ON 또는 OFF로 변경합니다. 연결된 소재의 상태가 ON 또는 OFF일 경우만 변경 가능합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 PATCH로 요청합니다. 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
PATCH /openapi/v1/creativeLinks/{creativeLinkId}/onOff HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
creativeLinkId Long 소재연결 ID O
config String 광고그룹의 상태
ON, OFF 중 하나
O
Sample
Request
curl -X PATCH "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/7777777771/onOff" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
    -H "Content-Type: application/json" \
    -d '{
            "config": "ON"
       }'
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

소재연결 삭제하기

광고그룹에 연결된 광고소재의 연결을 삭제합니다.

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

Request
URL
DELETE /openapi/v1/creativeLinks/{creativeLinkId} HTTP/1.1
Host: api.keywordad.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
creativeLinkId Long 소재연결 ID O
Sample
Request
curl -X DELETE "https://api.keywordad.kakao.com/openapi/v1/creativeLinks/7777777771" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8

더보기