본문으로 건너뛰기

광고 API (1.0)

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" "LEAD" "PMAX"

주어진 목적에 해당하는 캠페인을 검색합니다. 값이 없을 시 모든 캠페인을 검색합니다.

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

One of
name
required
string [ 2 .. 128 ] characters

캠페인 이름

objective
required
string

캠페인 목적

urlNo
required
integer <int64>

대표 url ID

budgetAmount
number
Deprecated

지출 한도 (Deprecated)

spendLimit
number

지출 한도. ADVoost 쇼핑 캠페인(objective: PMAX)은 이 필드를 사용하지 않으며, 예산은 performanceMax.budget 으로 입력합니다.

conversionUrlNo
integer <int64>

전환 추적 대상 ID, 캠페인 목적 LEAD일 경우 사용되지 않습니다. ADVoost 쇼핑 캠페인(objective: PMAX)은 필수이며 전환스크립트가 설치 완료된 대상이어야 합니다.

brandNo
required
integer <int64>

브랜드 ID

catalogId
required
string

카탈로그 ID

s2sApiOn
boolean

전환 API를 연동하여 전환 추적 사용 여부

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "objective": "string",
  • "urlNo": 0,
  • "budgetAmount": 100000,
  • "spendLimit": 100000,
  • "conversionUrlNo": 0,
  • "brandNo": 0,
  • "catalogId": "string",
  • "s2sApiOn": true
}

캠페인 다중 삭제

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
campaignNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ 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
campaignNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

캠페인 ID 목록

activated
required
boolean

ON/OFF 설정. (예, true : ON)

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
mallId
string

mallId

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

지정된 캠페인 목적에 따라 사용 가능한 전환 추적 대상 목록

ADVoost 쇼핑 캠페인(objective: PMAX)은 전환스크립트가 설치 완료된 전환 추적 대상만 반환하며, 이 목록의 대상만 ADVoost 쇼핑 캠페인 생성 시 conversionUrlNo 로 사용할 수 있습니다.

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" "LEAD" "PMAX"

objective

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

캠페인 지출 한도 다중 변경(deprecated) Deprecated

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
campaignNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

캠페인 ID 목록

campaignBudget
required
number

캠페인 지출 한도

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

캠페인 지출 한도 다중 변경

ADVoost 쇼핑 캠페인(objective: PMAX)은 campaignSpendLimit 값이 지출 한도가 아닌 ADVoost 쇼핑 예산(performanceMax.budget)으로 반영되며, 변경 결과는 캠페인 조회 응답의 performanceMax.budget 으로 확인할 수 있습니다. ADVoost 쇼핑 캠페인 예산 변경에는 잦은 변경 제한이 적용됩니다 (캠페인당 2시간에 1회).

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
campaignNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

캠페인 ID 목록

campaignSpendLimit
number

캠페인 지출 한도. ADVoost 쇼핑 캠페인(objective: PMAX)은 이 값이 ADVoost 쇼핑 예산(performanceMax.budget)으로 반영됩니다.

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

캠페인 삭제

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

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_CLICK, 전환수 최대화 : MAX_CONV)

bidStrategy
string
Enum: "BID_CAP" "COST_CAP" "NO_CAP"

예산 최적화 시 적용할 비용 관리 (입찰가 한도 : BID_CAP, 비용 한도 : COST_CAP, 한도 없음 : NO_CAP) - COST_CAP 은 입찰 전략이 MAX_CLICK 인 경우에만 선택 가능합니다.

bidStrategyValue
number

예산 최적화 시 적용할 비용 관리 금액

budget
number

예산 최적화 캠페인의 총 예산

defaultBudgetAmountForAdSets
number

하위 광고그룹에 일괄 적용할 예산값, 기본값: (현재 캠페인 예산) / (현재 광고그룹 갯수)

overwriteAllAdSets
boolean

하위 광고그룹 일괄 변경 여부

Responses

Request samples

Content type
application/json
{
  • "activated": true,
  • "bidGoal": "MAX_CLICK",
  • "bidStrategy": "BID_CAP",
  • "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
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: application/json

params

campaignNo
required
integer <int64>

캠페인 ID

name
required
string [ 2 .. 128 ] characters

광고 그룹 이름

Array of objects (CustomTargetParam)

고객파일 타겟

genders
Array of strings unique
Items Enum: "M" "F" "U"

성별

  • 사용 가능한 값: M,F,U
Array of objects (AgeRange) unique

연령

locations
Array of strings unique

지역

extensionDemos
Array of integers <int32> unique [ items <int32 > ]

확장 데모

Array of objects (InterestTargetParam) unique

관심사

purchaseIntentCodes
Array of integers <int32> unique [ items <int32 > ]

구매 의도

targetingType
string
Enum: "AUDIENCE" "CONTEXT" "ADVOOST_AUDIENCE" "ADVOOST_EXPAND"

타게팅 타입

devices
Array of strings unique
Items Enum: "DESKTOP" "MOBILE" "UNKNOWN"

디바이스 타입

  • 사용 가능한 값: DESKTOP,MOBILE
platforms
Array of strings unique
Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS"

운영체제

  • 사용 가능한 값: ANDROID,IOS
allDevice
boolean

노출 가능한 모든 디바이스 선택 여부

placementGroupCodes
Array of strings unique

게재 위치

allPlacementGroup
boolean

노출 가능한 모든 게재위치 선택 여부

bidGoal
string
Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" "NONE"

입찰 전략

  • 사용 가능한 값: MAX_CONV,MAX_CLICK,MAX_CONV_VALUE,NONE
bidStrategy
string
Enum: "FIXED_BID" "BID_CAP" "COST_CAP" "NO_CAP" "TARGET_COST" "TARGET_ROAS"

비용 관리

  • 사용 가능한 값: FIXED_BID,BID_CAP,COST_CAP,NO_CAP
bidStrategyValue
number

한도 금액

bidType
string
Enum: "CPC" "CPM" "CPV"

청구 기준

  • 사용 가능한 값: CPC,CPM,CPV
bidPrice
number

입찰가

budgetType
string
Enum: "DAILY" "TOTAL"

예산 타입

budgetAmount
number
Deprecated

예산 금액

startTime
string <date-time>

시작일시

endTime
string <date-time>

종료일시

ongoing
boolean

계속 게재 여부

Array of objects (ScheduleTimeSlotParam) unique

상세 일정

accelerated
boolean

게재 방식. 빠른 게재 여부

creativeChooserType
string
Enum: "VALUE_WEIGHTED_RANDOM" "SIMPLE_RANDOM" "OPTIMIZATION"

소재 선택 방식

frequencyAdUnit
string
Enum: "AD_SET" "CREATIVE"

노출 빈도 단위

quota
integer <int32> [ 1 .. 5 ]

노출 빈도 횟수

useAutoFrequency
boolean

노출 빈도 자동 설정 여부

Array of objects (CustomTargetParam)

고객파일 타겟 (deprecated)

Responses

Request samples

Content type
application/json
{
  • "campaignNo": 0,
  • "name": "string",
  • "adidLibraries": [
    ],
  • "genders": [
    ],
  • "ageRanges": [
    ],
  • "locations": [
    ],
  • "extensionDemos": [
    ],
  • "interestCodes": [
    ],
  • "purchaseIntentCodes": [
    ],
  • "targetingType": "AUDIENCE",
  • "devices": [
    ],
  • "platforms": [
    ],
  • "allDevice": true,
  • "placementGroupCodes": [
    ],
  • "allPlacementGroup": true,
  • "bidGoal": "MAX_CLICK",
  • "bidStrategy": "FIXED_BID",
  • "bidStrategyValue": 0,
  • "bidType": "CPC",
  • "bidPrice": 0,
  • "budgetType": "DAILY",
  • "budgetAmount": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ongoing": true,
  • "scheduleTimeSlots": [
    ],
  • "accelerated": true,
  • "creativeChooserType": "VALUE_WEIGHTED_RANDOM",
  • "frequencyAdUnit": "AD_SET",
  • "quota": 1,
  • "useAutoFrequency": true,
  • "adidLibraryParams": [
    ]
}

광고 그룹 다중 삭제

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
adSetNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ 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
adSetNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

광고 그룹 ID 목록

activated
required
boolean

ON/OFF 설정. (예, true : ON)

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 그룹 예산/입찰가/비용관리 다중 변경

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: application/json

editParam

One of
editType
required
string

변경 파라미터 구분

adSetNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

광고그룹no 목록

bidPrice
required
number

입찰가

bidType
string
Enum: "CPC" "CPM" "CPV"

청구 기준

  • 사용 가능한 값: CPC,CPM,CPV

Responses

Request samples

Content type
application/json
Example
{
  • "editType": "string",
  • "adSetNos": [
    ]
}

광고 그룹 만들기 - 샘플

캠페인 하위 광고 그룹 만들기 위한 기본값으로 채워진 샘플

path Parameters
version
required
number <float>
Default: 1

API 버전

query Parameters
campaignNo
required
integer <int64>

campaignNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 그룹 만들기 - 타입 정보

캠페인 하위 광고 그룹 만들기 위한, 사용가능한 타입 목록. 단, 다른 조건에 따라 불가능한 케이스가 발생할 수도 있습니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

query Parameters
campaignNo
required
integer <int64>

campaignNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 그룹 조회

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

adSetNo
required
integer <int64>

adSetNo

version
required
number <float>
Default: 1

API 버전

query Parameters
includeCreativeTemplates
boolean
Default: false

생성 가능한 소재 템플릿 목록 포함 여부

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 그룹 삭제

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

adSetNo
required
integer <int64>

adSetNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

고객파일 타겟 조회

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

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

Content type
application/json
{
  • "adidLibraries": [
    ],
  • "adidLibraryList": [
    ]
}

광고 그룹 demographic 변경

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

genders
Array of strings unique
Items Enum: "M" "F" "U"

성별

  • 사용 가능한 값: M,F,U
ageRanges
Array of strings unique
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"

연령

adultOnly
boolean

성인 타겟팅 여부

locations
Array of strings unique

지역

includeUnknownLocation
boolean

지역 : 비해당자 포함 여부

extensionDemos
Array of integers <int32> unique [ items <int32 > ]

확장 데모

Responses

Request samples

Content type
application/json
{
  • "genders": [
    ],
  • "ageRanges": [
    ],
  • "adultOnly": true,
  • "locations": [
    ],
  • "includeUnknownLocation": true,
  • "extensionDemos": [
    ]
}

광고 그룹 디바이스/게재위치 변경

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

adSetNo
required
integer <int64>

adSetNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: application/json

editParam

devices
Array of strings unique
Items Enum: "DESKTOP" "MOBILE" "UNKNOWN"

디바이스 타입

  • 사용 가능한 값: DESKTOP,MOBILE
platforms
Array of strings unique
Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS"

운영체제

  • 사용 가능한 값: ANDROID,IOS
allDevice
boolean

노출 가능한 모든 디바이스 선택 여부

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" "NW_FEED" "PMAX" "COMPOSITION" "N_ETC"

게재 위치

allPlacementGroup
boolean

노출 가능한 모든 게재위치 선택 여부

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "platforms": [
    ],
  • "allDevice": true,
  • "placementGroupCodes": [
    ],
  • "allPlacementGroup": true
}

광고 그룹 관심사/구매의도 변경

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

adSetNo
required
integer <int64>

adSetNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: application/json

editParam

Array of objects (InterestTargetOpenApiParam) unique

관심사

purchaseIntentCodes
Array of integers <int32> unique [ items <int32 > ]

구매 의도

interestIntersection
boolean

타겟 설정 방식

Responses

Request samples

Content type
application/json
{
  • "interestCodes": [
    ],
  • "purchaseIntentCodes": [
    ],
  • "interestIntersection": true
}

광고 소재

광고 소재 목록

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
adSetNo
integer <int64>

광고 그룹 ID

activated
boolean

소재 활성화 여부, true/false 인 경우 각각 ON/OFF 인 광고 소재만 검색합니다. 이 값이 없을 시 모든 광고 소재를 검색합니다.

deleteOnly
boolean
Default: false

삭제된 소재 조회 여부, 이 값이 true인 경우, 삭제된 소재만 조회합니다.

page
integer <int32>

페이지 번호 (기본값: 0)

size
integer <int32>

페이지 크기 (기본값: 10, 최대: 100)

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 다중 삭제

http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우 or 광고계정 내 광고 소재가 아닐 경우 or 기삭제되었을 경우

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

query Parameters
creativeNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

소재 ID 목록

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 생성 (이미지 배너)

소재타입 이미지 배너의 소재 생성합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

creativeTemplateCode
required
string non-empty

소재 템플릿: BANNER_750, BANNER_750X200, BANNER_1250X560, BANNER_1200X1200

imageNo
required
integer <int64>

소재 이미지 ID

url
required
string non-empty

랜딩 URL

altMessage
required
string [ 2 .. 100 ] characters

광고 안내 문구

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "creativeTemplateCode": "string",
  • "imageNo": 0,
  • "url": "string",
  • "altMessage": "string"
}

광고 소재 생성 (동영상 - 인스트림형)

소재타입 동영상의 인스트림형 소재 생성이 가능합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

creativeTemplateCode
required
string non-empty

소재 템플릿: INSTREAM_VIDEO

videoNo
required
integer <int64>

소재 동영상 ID

linkUrl
required
string non-empty

랜딩 URL

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "creativeTemplateCode": "string",
  • "videoNo": 0,
  • "linkUrl": "string"
}

광고 소재 생성 (이미지 컬렉션)

소재타입 컬렉션의 이미지 소재 생성이 가능합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

message
required
string [ 2 .. 65 ] characters

광고 문구

creativeTemplateCode
required
string non-empty

소재 템플릿: FEED_MULTIPLE_IMAGE

ctaCode
required
string non-empty

행동 유도

ctaUrl
required
string non-empty

행동 유도 URL

required
Array of objects (OpenImageMedia) [ 4 .. 10 ] items

소재 이미지 컬렉션 정보

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "message": "string",
  • "creativeTemplateCode": "string",
  • "ctaCode": "string",
  • "ctaUrl": "string",
  • "imageMedias": [
    ]
}

광고 소재 생성 (동영상 콜렉션)

소재타입 콜렉션의 동영상 + 이미지 소재 생성이 가능합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

message
required
string [ 2 .. 65 ] characters

광고 문구

creativeTemplateCode
required
string non-empty

소재 템플릿: FEED_MULTIPLE_IMAGE_WITH_VIDEO

ctaCode
required
string non-empty

행동 유도

ctaUrl
required
string non-empty

행동 유도 URL

videoNo
required
integer <int64>

소재 동영상 ID, sizeGroupNo: 5인 동영상 규격만 등록 가능합니다.

thumbnailImageNo
required
integer <int64>

소재 동영상 썸네일 ID, sizeGroupNo: 5인 이미지 규격만 등록 가능합니다.

required
Array of objects (OpenImageMediaInVideoCollection) [ 4 .. 9 ] items

소재 이미지 컬렉션 정보, sizeGroupNo: 3인 이미지 규격만 등록 가능합니다.

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "message": "string",
  • "creativeTemplateCode": "string",
  • "ctaCode": "string",
  • "ctaUrl": "string",
  • "videoNo": 0,
  • "thumbnailImageNo": 0,
  • "imageMedias": [
    ]
}

광고 소재 생성 (동영상 - 배너형/피드형)

소재타입 동영상의 배너형/피드형 소재 생성이 가능합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

message
required
string [ 2 .. 120 ] characters

광고 문구

creativeTemplateCode
required
string non-empty

소재 템플릿: NATIVE_SINGLE_VIDEO, FEED_SINGLE_VIDEO, FEED_SHORTFORM_VIDEO

videoNo
required
integer <int64>

소재 동영상 ID

thumbnailImageNo
required
integer <int64>

소재 동영상 썸네일 ID

linkUrl
required
string

랜딩 URL

linkTitle
string [ 2 .. 2147483647 ] characters

설명 문구1

linkDescription
string [ 2 .. 2147483647 ] characters

설명 문구2

ctaCode
string

행동 유도

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "message": "string",
  • "creativeTemplateCode": "string",
  • "videoNo": 0,
  • "thumbnailImageNo": 0,
  • "linkUrl": "string",
  • "linkTitle": "string",
  • "linkDescription": "string",
  • "ctaCode": "string"
}

광고 소재 생성 (네이티브 이미지)

소재타입 네이티브 이미지의 소재 생성이 가능합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

Request Body schema: application/json

params

adSetNo
required
integer <int64>

광고 그룹 ID

name
required
string [ 2 .. 128 ] characters

소재 이름

message
string [ 2 .. 65 ] characters

광고 문구

creativeTemplateCode
required
string non-empty

소재 템플릿: NATIVE_SINGLE_IMAGE_V2, NATIVE_SINGLE_IMAGE_PC, NATIVE_SINGLE_IMAGE_450X450, FEED_SINGLE_IMAGE, FEED_SINGLE_IMAGE_2TO3, FEED_SINGLE_IMAGE_SQUARE, NATIVE_SINGLE_IMAGE_COMMUNICATION

imageNo
required
integer <int64>

소재 이미지 ID

linkUrl
required
string non-empty

랜딩 URL

linkTitle
string [ 2 .. 2147483647 ] characters

설명 문구1

linkDescription
string [ 2 .. 2147483647 ] characters

설명 문구2

linkText3rd
string [ 2 .. 2147483647 ] characters

설명 문구3

linkText4th
string [ 2 .. 2147483647 ] characters

PC 배너형 긴 설명문구 1

linkText5th
string [ 2 .. 2147483647 ] characters

PC 배너형 긴 설명문구 2

ctaCode
string

행동 유도

adviceMessage
string [ 0 .. 45 ] characters

고지 문구

Responses

Request samples

Content type
application/json
{
  • "adSetNo": 0,
  • "name": "string",
  • "message": "string",
  • "creativeTemplateCode": "string",
  • "imageNo": 0,
  • "linkUrl": "string",
  • "linkTitle": "string",
  • "linkDescription": "string",
  • "linkText3rd": "string",
  • "linkText4th": "string",
  • "linkText5th": "string",
  • "ctaCode": "string",
  • "adviceMessage": "string"
}

광고 소재 ON/OFF 다중 변경

http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우
- 에러 400 draftCreativeNos가 존재하지 않을 경우
- 에러 422 & error.code='CONDITION_DOES_NOT_MEET' : 광고 소재를 수정할 수 없는 경우

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

query Parameters
creativeNos
required
Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ]

소재 ID 목록

activated
required
boolean

소재 활성화 여부, (예> true : ON)

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 행동 유도 목록

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

version
required
number <float>
Default: 1

API 버전

query Parameters
adSetNo
required
integer <int64>

광고 그룹 ID

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 이미지 업로드

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: multipart/form-data
file
required
string <binary>

file

creativeTemplateCode
required
string

소재 템플릿

Responses

광고 소재 동영상 업로드

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: multipart/form-data
file
required
string <binary>

file

creativeTemplateCode
required
string

소재 템플릿

sizeGroupNo
required
integer <int32>

소재 미디어(이미지/동영상) 규격ID

callbackUrl
required
string [ 0 .. 1024 ] characters

콜백 URL

Responses

광고 소재 조회

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

creativeNo
required
integer <int64>

creativeNo

version
required
number <float>
Default: 1

API 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 삭제

http status code 에러코드별 설명
- 에러 400 광고 소재가 존재하지 않을 경우 or 광고계정 내 광고 소재가 아닐 경우 or 기삭제되었을 경우

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>

adAccountNo

creativeNo
required
integer <int64>

creativeNo

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

광고 소재 동영상 조회

업로드한 동영상의 인코딩 상태를 조회합니다.

path Parameters
version
required
number <float>
Default: 1

API 버전

adAccountNo
required
integer <int64>
videoNo
required
integer <int64>

동영상 업로드 응답의 no

Responses

타겟팅 상세

ageRanges

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

extendedDemoCodes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

interests

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

locations

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

placementGroupCodes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

purchaseIntents

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

타입 정보

multipleConstants

path Parameters
version
required
number <float>
Default: 1

API 버전

query Parameters
types
required
Array of strings

types

Responses

bidGoals

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

bidStrategies

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

bidTypes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

budgetTypes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

campaignObjectives

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

creativeChooserTypes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

deviceTypes

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

frequencyAdUnits

path Parameters
version
required
number <float>
Default: 1

API 버전

Responses

genders

path Parameters
version
required
number <float>
Default: 1

API 버전

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 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: multipart/form-data
file
required
string <binary>

고객 파일

name
required
string [ 1 .. 128 ] characters

고객 파일 타겟 명

Responses

고객 파일 단건 조회

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

adidLibraryNo
required
integer <int64>

adidLibraryNo

version
required
number <float>
Default: 1

API 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

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

Responses

고객 파일 삭제

path Parameters
adAccountNo
required
integer <int64>

adAccountNo

adidLibraryNo
required
integer <int64>

adidLibraryNo

version
required
number <float>
Default: 1

API 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Responses

고객 파일 타겟 추가

  • 파일 1개씩 업로드 가능합니다.
  • 파일 업로드의 경우 100MB의 파일 용량 제한 및 업로드에 20초의 timeout 제한 사항이 있습니다.
  • 'csv' 확장자만 업로드 가능합니다.
path Parameters
adAccountNo
required
integer <int64>

adAccountNo

adidLibraryNo
required
integer <int64>

adidLibraryNo

version
required
number <float>
Default: 1

API 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: multipart/form-data
file
required
string <binary>

고객 파일

callbackUrl
string

callback url

Responses

고객 파일 타겟 제거

  • 파일 1개씩 업로드 가능합니다.
  • 파일 업로드의 경우 100MB의 파일 용량 제한 및 업로드에 20초의 timeout 제한 사항이 있습니다.
  • 'csv' 확장자만 업로드 가능합니다.
  • 기존 모든 adid가 제거되도록 호출이 되는 경우 실패합니다. 타겟에는 하나 이상의 adid가 남을 때만 성공합니다.
path Parameters
adAccountNo
required
integer <int64>

adAccountNo

adidLibraryNo
required
integer <int64>

adidLibraryNo

version
required
number <float>
Default: 1

API 버전

header Parameters
AccessManagerAccountNo
integer <int64>

해당 광고 계정에 대한 접근 권한이 있는 관리 계정 ID

Request Body schema: multipart/form-data
file
required
string <binary>

고객 파일

callbackUrl
string

callback url

Responses