광고 API
Download OpenAPI specification:Download
공통 HEADER PARAMETERS
- AccessManagerAccountNo
: 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID. 관리계정으로만 멤버인 경우, 이 값을 포함해서 호출해야 광고계정에 대한 호출이 가능합니다.
캠페인 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
activated | boolean true/false 인 경우 각각 ON/OFF 인 캠페인만 검색합니다. 값이 없을 시 모든 캠페인을 검색합니다. |
deleteOnly | boolean 삭제된 광고 그룹 검색. true 로 설정하지 않을 시 삭제된 캠페인은 검색 결과에서 누락됩니다. |
objectives | Array of strings Items Enum: "CONVERSION" "WEB_SITE_TRAFFIC" "INSTALL_APP" "WATCH_VIDEO" "CATALOG" "SHOPPING" 주어진 목적에 해당하는 캠페인을 검색합니다. 값이 없을 시 모든 캠페인을 검색합니다. |
page | integer <int32> 페이지 번호 (기본값: 0) |
size | integer <int32> 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
캠페인 만들기
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
params
brandNo required | integer <int64> 브랜드 ID |
budgetAmount | number 지출 한도 (Deprecated) |
conversionUrlNo | integer <int64> 전환 추적 대상 ID, 캠페인 목적 |
name required | string [ 2 .. 128 ] characters 캠페인 이름 |
objective required | string 캠페인 목적 |
spendLimit | number 지출 한도 |
urlNo required | integer <int64> 대표 url ID |
catalogId required | string 카탈로그 ID |
Responses
Request samples
- Payload
{- "brandNo": 0,
- "budgetAmount": 100000,
- "conversionUrlNo": 0,
- "name": "string",
- "objective": "CATALOG",
- "spendLimit": 100000,
- "urlNo": 0,
- "catalogId": "string"
}
캠페인 다중 삭제
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 캠페인 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
캠페인 ON/OFF 다중 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
activated | boolean ON/OFF 설정. (예, true : ON) |
campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 캠페인 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
브랜드 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
page | integer <int32> 페이지 번호 (기본값: 0) |
size | integer <int32> 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
지정된 캠페인 목적에 따라 사용 가능한 전환 추적 대상 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
objective required | string Enum: "CONVERSION" "WEB_SITE_TRAFFIC" "INSTALL_APP" "WATCH_VIDEO" "CATALOG" "SHOPPING" objective |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
캠페인 예산 다중 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
campaignBudget | number 캠페인 예산 |
campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 캠페인 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
캠페인 지출 한도 다중 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 캠페인 ID 목록 |
campaignSpendLimit | number 캠페인 지출 한도 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
대표url 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
page | integer <int32> 페이지 번호 (기본값: 0) |
size | integer <int32> 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
CBO 설정 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
campaignNo required | integer <int64> campaignNo |
version required | number <float> Default: 1 API 버전 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
params
activated required | boolean 캠페인 예산 최적화 사용 여부 |
bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" "NONE" 예산 최적화 시 적용할 입찰 전략 |
bidStrategy | string Enum: "FIXED_BID" "BID_CAP" "COST_CAP" "NO_CAP" "TARGET_COST" 예산 최적화 시 적용할 비용 관리 |
bidStrategyValue | number 예산 최적화 시 적용할 비용 관리 금액 |
budget | number 예산 최적화 캠페인의 총 예산 |
defaultBudgetAmountForAdSets | number 하위 광고그룹에 일괄 적용할 예산값, 기본값: (현재 캠페인 예산) / (현재 광고그룹 갯수) |
overwriteAllAdSets | boolean 하위 광고그룹 일괄 변경 여부 |
Responses
Request samples
- Payload
{- "activated": true,
- "bidGoal": "MAX_CLICK",
- "bidStrategy": "FIXED_BID",
- "bidStrategyValue": 0,
- "budget": 0,
- "defaultBudgetAmountForAdSets": 0,
- "overwriteAllAdSets": true
}
광고 그룹 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
activated | boolean 광고 그룹 ON/OFF 여부. 미입력 시 모든 광고 그룹을 검색합니다. |
budgetTypes | Array of strings Items Enum: "DAILY" "TOTAL" 광고 그룹의 예산 타입 |
campaignNo | integer <int64> 상위 캠페인 ID |
deleteOnly | boolean 삭제된 광고 그룹만 검색. true 인 경우 삭제된 광고 그룹, false 인 경우 운영가능/광고집행전/광고집행종료 상태의 광고 그룹을 검색합니다. |
page | integer <int32> 페이지 번호 (기본값: 0) |
placementGroupCodes | Array of strings 광고 그룹의 게재 위치 |
size | integer <int32> 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 그룹 만들기
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 version |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
params
accelerated | boolean 게재 방식. 빠른 게재 여부 |
Array of objects (CustomTargetParam) 고객파일 타겟 | |
Array of objects (CustomTargetParam) 고객파일 타겟 (deprecated) | |
Array of objects (AgeRange) 연령 | |
allDevice | boolean 노출 가능한 모든 디바이스 선택 여부 |
allPlacementGroup | boolean 노출 가능한 모든 게재위치 선택 여부 |
bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" "NONE" 입찰 전략
|
bidPrice | number 입찰가 |
bidStrategy | string Enum: "FIXED_BID" "BID_CAP" "COST_CAP" "NO_CAP" "TARGET_COST" 비용 관리
|
bidStrategyValue | number 한도 금액 |
bidType | string Enum: "CPC" "CPM" "CPV" 청구 기준
|
budgetAmount | number 예산 금액 |
budgetType | string Enum: "DAILY" "TOTAL" 예산 타입 |
campaignNo required | integer <int64> 캠페인 ID |
creativeChooserType | string Enum: "VALUE_WEIGHTED_RANDOM" "SIMPLE_RANDOM" "OPTIMIZATION" 소재 선택 방식 |
devices | Array of strings Items Enum: "DESKTOP" "MOBILE" "UNKNOWN" 디바이스 타입
|
endTime | string 종료일시 |
extensionDemos | Array of integers <int32> [ items <int32 > ] 확장 데모 |
frequencyAdUnit | string Enum: "AD_SET" "CREATIVE" 노출 빈도 단위 |
genders | Array of strings Items Enum: "M" "F" "U" 성별
|
Array of objects (InterestTargetParam) 관심사 | |
locations | Array of strings 지역 |
name required | string [ 2 .. 128 ] characters 광고 그룹 이름 |
ongoing | boolean 계속 게재 여부 |
placementGroupCodes | Array of strings 게재 위치 |
platforms | Array of strings Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS" 운영체제
|
purchaseIntentCodes | Array of integers <int32> [ items <int32 > ] 구매 의도 |
quota | integer <int32> [ 1 .. 5 ] 노출 빈도 횟수 |
Array of objects (ScheduleTimeSlotParam) 상세 일정 | |
startTime | string 시작일시 |
targetingType | string Enum: "AUDIENCE" "CONTEXT" 타게팅 타입 : 현재는 AUDIENCE 로만 고정함. 향후 다른타입도 지원할 예정 |
useAutoFrequency | boolean 노출 빈도 자동 설정 여부 |
Responses
Request samples
- Payload
{- "accelerated": true,
- "adidLibraries": [
- {
- "included": true,
- "no": 0
}
], - "adidLibraryParams": [
- {
- "included": true,
- "no": 0
}
], - "ageRanges": [
- {
- "from": 0,
- "to": 0
}
], - "allDevice": true,
- "allPlacementGroup": true,
- "bidGoal": "MAX_CLICK",
- "bidPrice": 0,
- "bidStrategy": "FIXED_BID",
- "bidStrategyValue": 0,
- "bidType": "CPC",
- "budgetAmount": 0,
- "budgetType": "DAILY",
- "campaignNo": 0,
- "creativeChooserType": "VALUE_WEIGHTED_RANDOM",
- "devices": [
- "DESKTOP"
], - "endTime": "string",
- "extensionDemos": [
- 0
], - "frequencyAdUnit": "AD_SET",
- "genders": [
- "M"
], - "interestCodes": [
- {
- "code": 0,
- "depth": 0,
- "recommended": true
}
], - "locations": [
- "string"
], - "name": "string",
- "ongoing": true,
- "placementGroupCodes": [
- "string"
], - "platforms": [
- "UNKNOWN"
], - "purchaseIntentCodes": [
- 0
], - "quota": 1,
- "scheduleTimeSlots": [
- {
- "dayOfWeek": 0,
- "endHour": 0,
- "startHour": 0
}
], - "startTime": "string",
- "targetingType": "AUDIENCE",
- "useAutoFrequency": true
}
광고 그룹 다중 삭제
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
adSetNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 광고 그룹 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 그룹 ON/OFF 다중 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
activated | boolean ON/OFF 설정. (예, true : ON) |
adSetNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 광고 그룹 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 그룹 예산/입찰가/비용관리 다중 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 version |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
editParam
adSetNos required | Array of integers <int64> [ items <int64 > [ 1 .. 100 ] ] 광고그룹no 목록 |
editType required | string 변경 파라미터 구분 |
bidPrice required | number 입찰가 |
bidType | string Enum: "CPC" "CPM" "CPV" 청구 기준
|
Responses
Request samples
- Payload
{- "adSetNos": [
- 1
], - "editType": "AdSetEditBidPriceParam",
- "bidPrice": 10000,
- "bidType": "CPC"
}
광고 그룹 만들기 - 타입 정보
캠페인 하위 광고 그룹 만들기 위한, 사용가능한 타입 목록. 단, 다른 조건에 따라 불가능한 케이스가 발생할 수도 있습니다.
path Parameters
version required | number <float> Default: 1 API 버전 |
query Parameters
campaignNo required | integer <int64> campaignNo |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
고객파일 타겟 수정
- 기존의 정의된 고객파일 타겟은 삭제되고, 요청한 타겟 리스트로 재정의 됩니다.
- 사용 가능 상태의 타겟을 최대 30개까지 선택 할 수 있으며 타겟 모수가 1,000 미만인 경우 포함(타게팅) 설정 할 수 없습니다.
path Parameters
adAccountNo required | integer <int64> adAccountNo |
adSetNo required | integer <int64> adSetNo |
version required | number <float> Default: 1 API 버전 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
params
Array of objects (CustomTargetParam) 고객파일 타겟 | |
Array of objects (CustomTargetParam) 고객파일 타겟 (deprecated) |
Responses
Request samples
- Payload
{- "adidLibraries": [
- {
- "included": true,
- "no": 0
}
], - "adidLibraryList": [
- {
- "included": true,
- "no": 0
}
]
}
광고 그룹 데모그래픽 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
adSetNo required | integer <int64> adSetNo |
version required | number <float> Default: 1 API 버전 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
editParam
adultOnly | boolean 성인 타겟팅 여부 |
ageRanges | Array of strings Items Enum: "AGE_14_18" "AGE_19_24" "AGE_25_29" "AGE_30_34" "AGE_35_39" "AGE_40_44" "AGE_45_49" "AGE_50_54" "AGE_55_59" "OVER_60" "UNKNOWN" 연령 |
extensionDemos | Array of integers <int32> [ items <int32 > ] 확장 데모 |
genders | Array of strings Items Enum: "M" "F" "U" 성별
|
includeUnknownLocation | boolean 지역 : 비해당자 포함 여부 |
locations | Array of strings 지역 |
Responses
Request samples
- Payload
{- "adultOnly": true,
- "ageRanges": [
- "AGE_14_18"
], - "extensionDemos": [
- 0
], - "genders": [
- "M"
], - "includeUnknownLocation": true,
- "locations": [
- "string"
]
}
광고 그룹 디바이스 및 게재 위치 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
adSetNo required | integer <int64> adSetNo |
version required | number <float> Default: 1 version |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
editParam
allDevice | boolean 노출 가능한 모든 디바이스 선택 여부 |
allPlacementGroup | boolean 노출 가능한 모든 게재위치 선택 여부 |
devices | Array of strings Items Enum: "DESKTOP" "MOBILE" "UNKNOWN" 디바이스 타입
|
placementGroupCodes | Array of strings Items Enum: "M_SMARTCHANNEL" "M_MAIN" "M_BANNER" "M_FEED" "N_INSTREAM" "N_SHOPPING" "N_COMMUNICATION" "F_SMARTCHANNEL" "F_BANNER" "BAND" "NW_SMARTCHANNEL" "NW_BANNER" 게재 위치 |
platforms | Array of strings Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS" 운영체제
|
Responses
Request samples
- Payload
{- "allDevice": true,
- "allPlacementGroup": true,
- "devices": [
- "DESKTOP"
], - "placementGroupCodes": [
- "M_SMARTCHANNEL"
], - "platforms": [
- "UNKNOWN"
]
}
광고 그룹 관심사/구매의도 변경
path Parameters
adAccountNo required | integer <int64> adAccountNo |
adSetNo required | integer <int64> adSetNo |
version required | number <float> Default: 1 version |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: application/json
editParam
Array of objects (InterestTargetOpenApiParam) 관심사 | |
interestIntersection | boolean 타겟 설정 방식 |
purchaseIntentCodes | Array of integers <int32> [ items <int32 > ] 구매 의도 |
Responses
Request samples
- Payload
{- "interestCodes": [
- {
- "code": 0,
- "depth": 0
}
], - "interestIntersection": true,
- "purchaseIntentCodes": [
- 0
]
}
광고 소재 목록
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
activated | boolean 소재 활성화 여부, true/false 인 경우 각각 ON/OFF 인 광고 소재만 검색합니다. 이 값이 없을 시 모든 광고 소재를 검색합니다. |
adSetNo | integer <int64> 광고 그룹 ID |
deleteOnly | boolean Default: false 삭제된 소재 조회 여부, 이 값이 true인 경우, 삭제된 소재만 조회합니다. |
page | string 페이지 번호 (기본값: 0) |
size | string 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 소재 다중 삭제
http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우 or 광고계정 내 광고 소재가 아닐 경우 or 기삭제되었을 경우
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 version |
query Parameters
creativeNos required | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 소재 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 소재 ON/OFF 다중 변경
http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우
- 에러 400 draftCreativeNos가 존재하지 않을 경우
- 에러 422 & error.code='CONDITION_DOES_NOT_MEET' : 광고 소재를 수정할 수 없는 경우
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 version |
query Parameters
activated required | boolean 소재 활성화 여부, (예> true : ON) |
creativeNos required | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] 소재 ID 목록 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
광고 소재 삭제
http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우 or 광고계정 내 광고 소재가 아닐 경우 or 기삭제되었을 경우
path Parameters
adAccountNo required | integer <int64> adAccountNo |
creativeNo required | integer <int64> creativeNo |
version required | number <float> Default: 1 version |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
고객 파일 목록 조회
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
onlyAvailableOrPreparing | boolean Default: false true : 준비중 혹은 사용 가능 상태의 고객 파일 조회, false : 전체 고객 파일 조회 |
page | integer <int32> 페이지 번호 (기본값: 0) |
size | integer <int32> 페이지 크기 (기본값: 10, 최대: 100) |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Responses
고객 파일 업로드 및 등록
- 고객 파일 업로드는 파일 1개씩 업로드 및 등록 가능합니다.
- 파일 업로드의 경우 100MB의 파일 용량 제한 및 업로드에 20초의 timeout 제한 사항이 있습니다.
- 고객 파일의 경우 광고계정 별로 최대 50개 까지 등록 가능합니다.
- 타겟 명은 최소 1자, 최대 128자 까지 정의 가능합니다.
- 'csv' 확장자만 업로드 가능합니다.
path Parameters
adAccountNo required | integer <int64> adAccountNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
name | string [ 1 .. 128 ] characters 고객 파일 타겟 명 |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |
Request Body schema: multipart/form-data
file | string <binary> 고객 파일 |
Responses
고객 파일 수정
- 타겟 명은 최소 1자, 최대 128자 까지 정의 가능합니다.
path Parameters
adAccountNo required | integer <int64> adAccountNo |
adidLibraryNo required | integer <int64> adidLibraryNo |
version required | number <float> Default: 1 API 버전 |
query Parameters
name required | string [ 1 .. 128 ] characters name |
header Parameters
AccessManagerAccountNo | integer <int64> 해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID |