Ad API
Download OpenAPI specification:Download
COMMON HEADER PARAMETERS
- AccessManagerAccountNo: Manager account ID that has access to the ad account. If the manager account's permission level is member, this value must be included to make an API request to ad accounts.
List of campaigns
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| activated | boolean If true or false, it gets only the campaigns that are turned on or off, respectively. If not specified, it gets all campaigns. |
| deleteOnly | boolean Gets only the deleted ad groups. If not true, the deleted campaigns are excluded from the results. |
| objectives | Array of strings Items Enum: "CONVERSION" "WEB_SITE_TRAFFIC" "INSTALL_APP" "WATCH_VIDEO" "CATALOG" "SHOPPING" Gets campaigns that match the specified objectives. If not specified, it gets all campaigns. |
| page | integer <int32> Page number (default: 0) |
| size | integer <int32> Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Create a campaign
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
params
| brandNo required | integer <int64> Brand ID |
| budgetAmount | number Spending limit (deprecated) |
| conversionUrlNo | integer <int64> Conversion tracking URL ID |
| name required | string [ 2 .. 128 ] characters Campaign name |
| objective required | string Campaign objective |
| spendLimit | number Spending limit |
| urlNo required | integer <int64> Canonical URL ID |
| catalogId required | string Catalog ID |
| s2sApiOn | boolean Settings of S2S conversion tracking API |
Responses
Request samples
- Payload
{- "brandNo": 0,
- "budgetAmount": 100000,
- "conversionUrlNo": 0,
- "name": "string",
- "objective": "CATALOG",
- "spendLimit": 100000,
- "urlNo": 0,
- "catalogId": "string",
- "s2sApiOn": true
}Delete campaigns
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of campaign IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Turn campaigns on or off
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| activated | boolean Turns campaigns on or off. (Set this to true to turn them on.) |
| campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of campaign IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
List of brands
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| page | integer <int32> Page number (default: 0) |
| size | integer <int32> Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
List of conversion tracking sites available based on the specified campaign objective
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| objective required | string Enum: "CONVERSION" "WEB_SITE_TRAFFIC" "INSTALL_APP" "WATCH_VIDEO" "CATALOG" "SHOPPING" objective |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update campaign spending limits (deprecated) Deprecated
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| campaignBudget | number Campaign spending limit |
| campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of campaign IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update campaign spending limits
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| campaignNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of campaign IDs |
| campaignSpendLimit | number Campaign spending limit |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
List of canonical URLs
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| page | integer <int32> Page number (default: 0) |
| size | integer <int32> Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update CBO settings
path Parameters
| adAccountNo required | integer <int64> |
| campaignNo required | integer <int64> |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
| activated required | boolean Indicates whether CBO is enabled. |
| bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" The bid strategy to use for budget optimization |
| bidStrategy | string Enum: "BID_CAP" "COST_CAP" "NO_CAP" The cost management option to use for budget optimization |
| bidStrategyValue | number The bid and cost limit for budget optimization |
| budget | number CBO's total budget |
| defaultBudgetAmountForAdSets | number Budget to be allocated to all child ad groups at once. Default: (campaign budget) / (number of ad groups) |
| overwriteAllAdSets | boolean Indicates whether the child ad groups are updated all at once. |
Responses
Request samples
- Payload
{- "activated": true,
- "bidGoal": "MAX_CLICK",
- "bidStrategy": "BID_CAP",
- "bidStrategyValue": 0,
- "budget": 0,
- "defaultBudgetAmountForAdSets": 0,
- "overwriteAllAdSets": true
}List of ad groups
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| activated | boolean Indicates whether ad groups are turned on or off. If not specified, it gets all ad groups. |
| budgetTypes | Array of strings Items Enum: "DAILY" "TOTAL" Ad group budget types |
| campaignNo | integer <int64> Parent campaign ID |
| deleteOnly | boolean Gets only the deleted ad groups. If true, it gets only the deleted ad groups; if false, it gets the ad groups that are |
| page | integer <int32> Page number (default: 0) |
| placementGroupCodes | Array of strings Ad group placement |
| size | integer <int32> Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Create an ad group
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
params
| accelerated | boolean Delivery method indicating whether to accelerate ad delivery. |
Array of objects (CustomTargetParam) 고객파일 타겟 | |
Array of objects (CustomTargetParam) Customer file target (deprecated) | |
Array of objects (AgeRange) Age | |
| allDevice | boolean Indicates whether to select all eligible devices. |
| allPlacementGroup | boolean Indicates whether to select all eligible ad placement. |
| bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" "NONE" Bid strategy
|
| bidPrice | number Bid amount |
| bidStrategy | string Enum: "FIXED_BID" "BID_CAP" "COST_CAP" "NO_CAP" "TARGET_COST" How to manage costs
|
| bidStrategyValue | number Bid limit |
| bidType | string Enum: "CPC" "CPM" "CPV" Billing type
|
| budgetAmount | number Budget amount |
| budgetType | string Enum: "DAILY" "TOTAL" Budget type |
| campaignNo required | integer <int64> Campaign ID |
| creativeChooserType | string Enum: "VALUE_WEIGHTED_RANDOM" "SIMPLE_RANDOM" "OPTIMIZATION" Creative selection method |
| devices | Array of strings Items Enum: "DESKTOP" "MOBILE" Device type
|
| endTime | string End time |
| extensionDemos | Array of integers <int32> [ items <int32 > ] Extension demos |
| frequencyAdUnit | string Enum: "AD_SET" "CREATIVE" Impression unit |
| genders | Array of strings Items Enum: "M" "F" "U" Gender
|
Array of objects (InterestTargetParam) Interests | |
| locations | Array of strings Regions |
| name required | string [ 2 .. 128 ] characters Ad group name |
| ongoing | boolean Indicates whether to continue to show ads. |
| placementGroupCodes | Array of strings Ad group placement |
| platforms | Array of strings Items Enum: "ANDROID" "IOS" Operating system
|
| purchaseIntentCodes | Array of integers <int32> [ items <int32 > ] Buying intent |
| quota | integer <int32> [ 1 .. 5 ] Impression quota |
Array of objects (ScheduleTimeSlotParam) Detailed schedule | |
| startTime | string Start time |
| targetingType | string Value: "AUDIENCE" Targeting type |
| 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": [
- "ANDROID"
], - "purchaseIntentCodes": [
- 0
], - "quota": 1,
- "scheduleTimeSlots": [
- {
- "dayOfWeek": 0,
- "endHour": 0,
- "startHour": 0
}
], - "startTime": "string",
- "targetingType": "AUDIENCE",
- "useAutoFrequency": true
}Delete ad groups
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| adSetNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of ad group IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Turn ad groups on or off
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| activated | boolean Turns ad groups on or off. (Set this to true to turn them on.) |
| adSetNos | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of ad group IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Change budgets, bids and costs for ad groups
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
| adSetNos required | Array of integers <int64> [ items <int64 > [ 1 .. 100 ] ] List of ad group numbers |
| editType required | string Parameter to edit |
| bidPrice required | number Bid amount |
| bidType | string Enum: "CPC" "CPM" "CPV" Billing type
|
Responses
Request samples
- Payload
{- "adSetNos": [
- 1
], - "editType": "AdSetEditBidPriceParam",
- "bidPrice": 10000,
- "bidType": "CPC"
}Create an ad group - sample
A sample to create a child ad group of a campaign
path Parameters
| version required | number <float> Default: 1 API version |
query Parameters
| campaignNo required | integer <int64> campaignNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Create an ad group - type information
List of types available to create a child ad group of a campaign. Note that the creation of an ad group is not guaranteed.
path Parameters
| version required | number <float> Default: 1 API version |
query Parameters
| campaignNo required | integer <int64> campaignNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Get an ad group
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
| version required | number <float> Default: 1 API version |
query Parameters
| includeCreativeTemplates | boolean Default: false Indicates whether to include the list of creative templates that can be created. |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update customer file target
- The existing customer file target is deleted and replaced with a new target list.
- You can select up to 30 targets that are available, and a target cannot be chosen if the target population is less than 1,000.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
| version required | number <float> Default: 1 API version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
params
Array of objects (CustomTargetParam) 고객파일 타겟 | |
Array of objects (CustomTargetParam) Customer file target (deprecated) |
Responses
Request samples
- Payload
{- "adidLibraries": [
- {
- "included": true,
- "no": 0
}
], - "adidLibraryList": [
- {
- "included": true,
- "no": 0
}
]
}Update demographics
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
| version required | number <float> Default: 1 API version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
| adultOnly | boolean Indicates that its target demographic is adults. |
| 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" Age range |
| extensionDemos | Array of integers <int32> [ items <int32 > ] Extended demo |
| genders | Array of strings Items Enum: "M" "F" "U" Gender
|
| includeUnknownLocation | boolean Location: Indicates whether to include non-qualified individuals. |
| locations | Array of strings Location |
Responses
Request samples
- Payload
{- "adultOnly": true,
- "ageRanges": [
- "AGE_14_18"
], - "extensionDemos": [
- 0
], - "genders": [
- "M"
], - "includeUnknownLocation": true,
- "locations": [
- "string"
]
}Update device/placement
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
| version required | number <float> Default: 1 version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
| allDevice | boolean Indicates whether to select all eligible devices. |
| allPlacementGroup | boolean Indicates whether to select all eligible ad placement. |
| devices | Array of strings Items Enum: "DESKTOP" "MOBILE" Device type
|
| 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_FEED" "NW_BANNER" Ad placement |
| platforms | Array of strings Items Enum: "ANDROID" "IOS" Operating system
|
Responses
Request samples
- Payload
{- "allDevice": true,
- "allPlacementGroup": true,
- "devices": [
- "DESKTOP"
], - "placementGroupCodes": [
- "M_SMARTCHANNEL"
], - "platforms": [
- "ANDROID"
]
}Update interests/buying intent
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
| version required | number <float> Default: 1 version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
Array of objects (InterestTargetParam) 관심사 | |
| interestIntersection | boolean Indicates how the target is configured. |
Array of objects (PurchaseIntentParam) Buying intent |
Responses
Request samples
- Payload
{- "interestCodes": [
- {
- "code": 0,
- "depth": 0,
- "recommended": true
}
], - "interestIntersection": true,
- "purchaseIntentCodes": [
- {
- "code": 0,
- "recommended": true
}
]
}List of creatives
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| activated | boolean Indicates whether creatives are turned on. If true or false, it gets only the creatives that are turned on or off, respectively. If not specified, it gets all creatives. |
| adSetNo | integer <int64> Ad group ID |
| deleteOnly | boolean Default: false Indicates whether to get only the deleted creatives. If true, it gets only the deleted creatives. |
| page | string Page number (default: 0) |
| size | string Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Delete creatives
HTTP status code description
- Error 400 no creative exists, or the creative does not belong to the ad account, or the creative has already been deleted
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 > ] List of creative IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Create a creative (image banner)
Creates an IMAGE_BANNER type creative.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| altMessage required | string [ 2 .. 100 ] characters Ad message |
| creativeTemplateCode required | string Creative templates:
|
| imageNo required | integer <int64> Creative image ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| url required | string Landing URL |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "altMessage": "string",
- "creativeTemplateCode": "string",
- "imageNo": 0,
- "name": "string",
- "url": "string"
}Create a creative in in-stream type of video
Creative creation for an in-steam type of video is supported.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| creativeTemplateCode required | string Creative templates:
|
| linkUrl required | string Landing URL |
| name required | string [ 2 .. 128 ] characters Creative name |
| videoNo required | integer <int64> Creative video ID |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "creativeTemplateCode": "string",
- "linkUrl": "string",
- "name": "string",
- "videoNo": 0
}Create a creative with Collections
Creative creation with Collections is supported.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| creativeTemplateCode required | string Creative templates:
|
| ctaCode required | string CTA |
| ctaUrl required | string CTA URL |
required | Array of objects (OpenImageMedia) [ 4 .. 10 ] |
| message required | string [ 2 .. 65 ] characters |
| name required | string [ 2 .. 128 ] characters Creative name |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "creativeTemplateCode": "string",
- "ctaCode": "string",
- "ctaUrl": "string",
- "imageMedias": [
- {
- "imageNo": 0,
- "linkTitle": "string",
- "linkUrl": "string"
}
], - "message": "string",
- "name": "string"
}Create a creative in out-stream type of video
Creative creation for a out-stream type of video is supported.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| creativeTemplateCode required | string Creative templates:
|
| ctaCode | string Call-to-action |
| disableInducement required | boolean Indicates whether to enable call-to-action |
| linkDescription | string [ 2 .. 2147483647 ] characters Description 2 |
| linkTitle | string [ 2 .. 2147483647 ] characters Description 1 |
| linkUrl | string Landing URL |
| message required | string [ 2 .. 120 ] characters Ad message |
| name required | string [ 2 .. 128 ] characters Creative name |
| thumbnailImageNo required | integer <int64> Creative video thumbnail ID |
| videoNo required | integer <int64> Creative video ID |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "creativeTemplateCode": "string",
- "ctaCode": "string",
- "disableInducement": true,
- "linkDescription": "string",
- "linkTitle": "string",
- "linkUrl": "string",
- "message": "string",
- "name": "string",
- "thumbnailImageNo": 0,
- "videoNo": 0
}Create a creative (native image)
Currently, creative creation for a native image type is supported.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| adviceMessage | string [ 0 .. 45 ] characters Notice message |
| creativeTemplateCode required | string Creative templates:
|
| ctaCode required | string Call-to-action |
| imageNo required | integer <int64> Creative image ID |
| linkDescription | string >= 2 characters Description 2 |
| linkText3rd | string >= 2 characters Description 3 |
| linkText4th | string >= 2 characters Long description 1 for the desktop banner type |
| linkText5th | string >= 2 characters Long description 2 for the desktop banner type |
| linkTitle required | string >= 2 characters Description 1 |
| linkUrl required | string Landing URL |
| message required | string [ 2 .. 65 ] characters Ad message |
| name required | string [ 2 .. 128 ] characters Creative name |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "adviceMessage": "string",
- "creativeTemplateCode": "string",
- "ctaCode": "string",
- "imageNo": 0,
- "linkDescription": "string",
- "linkText3rd": "string",
- "linkText4th": "string",
- "linkText5th": "string",
- "linkTitle": "string",
- "linkUrl": "string",
- "message": "string",
- "name": "string"
}Turn creatives on or off
HTTP status code description
- Error 400 no creative exists
- Error 400 draftCreativeNos does not exist
- Error 422 & error.code='CONDITION_DOES_NOT_MEET' : Cannot edit the creative
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
query Parameters
| activated required | boolean Indicates whether to turn creatives on. (Set this to true to turn creatives on.) |
| creativeNos required | Array of integers <int64> [ 1 .. 100 ] [ items <int64 > ] List of creative IDs |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
List of call-to-action ad creatives
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| adSetNo required | integer <int64> Ad group ID |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Upload creative images
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
query Parameters
| creativeTemplateCode required | string Creative templates |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: multipart/form-data
| file required | string <binary> file |
Responses
Upload creative videos
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 version |
query Parameters
| callbackUrl required | string Callback URL |
| creativeTemplateCode required | string Creative templates |
| sizeGroupNo required | string <int32> Creative media (images and videos) size ID |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: multipart/form-data
| file required | string <binary> file |
Responses
Delete a creative
HTTP status code description
- Error 400 no creative exists, or the creative does not belong to the ad account, or the creative has already been deleted
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| creativeNo required | integer <int64> creativeNo |
| version required | number <float> Default: 1 version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Get a list of customer files
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| onlyAvailableOrPreparing | boolean Default: false When set to true, it indicates retrieving customer files in preparation or availability status. When set to false, it indicates retrieving a list of all files. |
| page | integer <int32> Page number (default: 0) |
| size | integer <int32> Page size (default: 10, max: 100) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Upload and add customer files
- A single customer file can be uploaded and added at a time.
- The upload process has a file size limit of 100 MB and a timeout limit of 20 seconds.
- Up to 50 customer files per ad account can be added.
- The length of a target name can be between 1 and 128 characters.
- Only CSV extensions are supported for customer files.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| name | string [ 1 .. 128 ] characters Customer file target name |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: multipart/form-data
| file | string <binary> Customer file |
Responses
Get a customer file
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adidLibraryNo required | integer <int64> adidLibraryNo |
| version required | number <float> Default: 1 API version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update customer files
- The length of a target name can be between 1 and 128 characters.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adidLibraryNo required | integer <int64> adidLibraryNo |
| version required | number <float> Default: 1 API version |
query Parameters
| name required | string [ 1 .. 128 ] characters name |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Delete customer files
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adidLibraryNo required | integer <int64> adidLibraryNo |
| version required | number <float> Default: 1 API version |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Add customer file target
- Only one file can be uploaded at a time.
- The upload process has a file size limit of 100 MB and a timeout limit of 20 seconds.
- Only CSV files can be uploaded.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adidLibraryNo required | integer <int64> adidLibraryNo |
| version required | number <float> Default: 1 API version |
query Parameters
| callbackUrl | string callback url |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: multipart/form-data
| file required | string <binary> Customer file |
Responses
Delete customer file target
- Only one file can be uploaded at a time.
- The upload process has a file size limit of 100 MB and a timeout limit of 20 seconds.
- Only CSV files can be uploaded.
- A request will fail if it attempts to delete all existing adid. The request will only succeed if at least one adid remains in the target.
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| adidLibraryNo required | integer <int64> adidLibraryNo |
| version required | number <float> Default: 1 API version |
query Parameters
| callbackUrl | string callback url |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: multipart/form-data
| file required | string <binary> Customer file |