Ad API (1.0)
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 Whether to search deleted campaigns. If not set to true, deleted campaigns are omitted from the search results. |
| objectives | Array of strings Items Enum: "CONVERSION" "WEB_SITE_TRAFFIC" "INSTALL_APP" "WATCH_VIDEO" "CATALOG" "SHOPPING" "LEAD" "PMAX" 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
| name required | string [ 2 .. 128 ] characters Campaign name |
| objective required | string Campaign objective |
| urlNo required | integer <int64> Canonical URL ID |
| budgetAmount | number Deprecated Spending limit (deprecated) |
| spendLimit | number Spend limit. Not used for ADVoost Shopping campaigns (objective: |
| conversionUrlNo | integer <int64> Conversion tracking target ID. Not used when the campaign objective is |
| brandNo required | integer <int64> Brand ID |
| catalogId required | string Catalog ID |
| s2sApiOn | boolean Settings of S2S conversion tracking API |
Responses
Request samples
- Payload
{- "name": "string",
- "objective": "string",
- "urlNo": 0,
- "budgetAmount": 100000,
- "spendLimit": 100000,
- "conversionUrlNo": 0,
- "brandNo": 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 required | Array of integers <int64> [ 1 .. 100 ] items unique [ 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
| campaignNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of campaign IDs |
| activated required | boolean Turns campaigns on or off. (Set this to true to turn them on.) |
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
For ADVoost Shopping campaigns (objective: PMAX), only conversion tracking targets with the conversion script installed are returned, and only targets in this list can be used as conversionUrlNo when creating an ADVoost Shopping campaign.
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" "LEAD" "PMAX" 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
| campaignNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of campaign IDs |
| campaignBudget required | number Campaign spending limit |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Responses
Update campaign spending limits
For ADVoost Shopping campaigns (objective: PMAX), the campaignSpendLimit value is applied as the ADVoost Shopping budget (performanceMax.budget) rather than the spend limit, and the change result can be checked in performanceMax.budget of the campaign retrieval response. Frequent changes to the ADVoost Shopping campaign budget are restricted (once per 2 hours per campaign).
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| campaignNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of campaign IDs |
| campaignSpendLimit | number Campaign spend limit. For ADVoost Shopping campaigns (objective: PMAX), this value is applied as the ADVoost Shopping budget (performanceMax.budget). |
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> adAccountNo |
| campaignNo required | integer <int64> campaignNo |
| 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
| activated required | boolean Indicates whether CBO is enabled. |
| bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" Bid strategy applied for budget optimization (Maximize clicks: MAX_CLICK, Maximize conversions: MAX_CONV) |
| bidStrategy | string Enum: "BID_CAP" "COST_CAP" "NO_CAP" Cost management applied for budget optimization (Bid cap: BID_CAP, Cost cap: COST_CAP, No cap: NO_CAP) - COST_CAP can only be selected when the bid strategy is MAX_CLICK. |
| 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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
params
| campaignNo required | integer <int64> Campaign ID |
| name required | string [ 2 .. 128 ] characters Ad group name |
Array of objects (CustomTargetParam) Customer file target | |
| genders | Array of strings unique Items Enum: "M" "F" "U" Gender
|
Array of objects (AgeRange) unique Age | |
| locations | Array of strings unique Regions |
| extensionDemos | Array of integers <int32> unique [ items <int32 > ] Extension demos |
Array of objects (InterestTargetParam) unique Interests | |
| purchaseIntentCodes | Array of integers <int32> unique [ items <int32 > ] Buying intent |
| targetingType | string Enum: "AUDIENCE" "CONTEXT" "ADVOOST_AUDIENCE" "ADVOOST_EXPAND" Targeting type |
| devices | Array of strings unique Items Enum: "DESKTOP" "MOBILE" "UNKNOWN" Device type
|
| platforms | Array of strings unique Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS" Operating system
|
| allDevice | boolean Indicates whether to select all eligible devices. |
| placementGroupCodes | Array of strings unique Ad group placement |
| allPlacementGroup | boolean Indicates whether to select all eligible ad placement. |
| bidGoal | string Enum: "MAX_CLICK" "MAX_CONV" "MAX_CONV_VALUE" "NONE" Bid strategy
|
| bidStrategy | string Enum: "FIXED_BID" "BID_CAP" "COST_CAP" "NO_CAP" "TARGET_COST" "TARGET_ROAS" How to manage costs
|
| bidStrategyValue | number Bid limit |
| bidType | string Enum: "CPC" "CPM" "CPV" Billing type
|
| bidPrice | number Bid amount |
| budgetType | string Enum: "DAILY" "TOTAL" Budget type |
| budgetAmount | number Deprecated Budget amount |
| startTime | string <date-time> Start time |
| endTime | string <date-time> End time |
| ongoing | boolean Indicates whether to continue to show ads. |
Array of objects (ScheduleTimeSlotParam) unique Detailed schedule | |
| accelerated | boolean Delivery method indicating whether to accelerate ad delivery. |
| creativeChooserType | string Enum: "VALUE_WEIGHTED_RANDOM" "SIMPLE_RANDOM" "OPTIMIZATION" Creative selection method |
| frequencyAdUnit | string Enum: "AD_SET" "CREATIVE" Impression unit |
| quota | integer <int32> [ 1 .. 5 ] Impression quota |
| useAutoFrequency | boolean Whether to automatically set impression frequency |
Array of objects (CustomTargetParam) Customer file target (deprecated) |
Responses
Request samples
- Payload
{- "campaignNo": 0,
- "name": "string",
- "adidLibraries": [
- {
- "included": true,
- "no": 0
}
], - "genders": [
- "M"
], - "ageRanges": [
- {
- "from": 0,
- "to": 0
}
], - "locations": [
- "string"
], - "extensionDemos": [
- 0
], - "interestCodes": [
- {
- "code": 0,
- "depth": 0,
- "recommended": true
}
], - "purchaseIntentCodes": [
- 0
], - "targetingType": "AUDIENCE",
- "devices": [
- "DESKTOP"
], - "platforms": [
- "UNKNOWN"
], - "allDevice": true,
- "placementGroupCodes": [
- "string"
], - "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": [
- {
- "dayOfWeek": 0,
- "endHour": 0,
- "startHour": 0
}
], - "accelerated": true,
- "creativeChooserType": "VALUE_WEIGHTED_RANDOM",
- "frequencyAdUnit": "AD_SET",
- "quota": 1,
- "useAutoFrequency": true,
- "adidLibraryParams": [
- {
- "included": true,
- "no": 0
}
]
}Delete ad groups
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| adSetNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ 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
| adSetNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of ad group IDs |
| activated required | boolean Turns ad groups on or off. (Set this to true to turn them on.) |
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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
| editType required | string Parameter to edit |
| adSetNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of ad group numbers |
| bidPrice required | number Bid amount |
| bidType | string Enum: "CPC" "CPM" "CPV" Billing type
|
Responses
Request samples
- Payload
{- "editType": "string",
- "adSetNos": [
- 0
]
}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) Customer file target | |
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
| genders | Array of strings unique Items Enum: "M" "F" "U" Gender
|
| 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" Age range |
| adultOnly | boolean Indicates that its target demographic is adults. |
| locations | Array of strings unique Location |
| includeUnknownLocation | boolean Location: Indicates whether to include non-qualified individuals. |
| extensionDemos | Array of integers <int32> unique [ items <int32 > ] Extended demo |
Responses
Request samples
- Payload
{- "genders": [
- "M"
], - "ageRanges": [
- "AGE_14_18"
], - "adultOnly": true,
- "locations": [
- "string"
], - "includeUnknownLocation": true,
- "extensionDemos": [
- 0
]
}Update device/placement
path Parameters
| version required | number <float> Default: 1 API version |
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
| devices | Array of strings unique Items Enum: "DESKTOP" "MOBILE" "UNKNOWN" Device type
|
| platforms | Array of strings unique Items Enum: "UNKNOWN" "ANDROID" "IOS" "WINDOWS" "MACOS" Operating system
|
| allDevice | boolean Indicates whether to select all eligible devices. |
| 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" Ad placement |
| allPlacementGroup | boolean Indicates whether to select all eligible ad placement. |
Responses
Request samples
- Payload
{- "devices": [
- "DESKTOP"
], - "platforms": [
- "UNKNOWN"
], - "allDevice": true,
- "placementGroupCodes": [
- "M_SMARTCHANNEL"
], - "allPlacementGroup": true
}Update interests/buying intent
path Parameters
| version required | number <float> Default: 1 API version |
| adAccountNo required | integer <int64> adAccountNo |
| adSetNo required | integer <int64> adSetNo |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account ID that has access to the ad account |
Request Body schema: application/json
editParam
Array of objects (InterestTargetOpenApiParam) unique Interest | |
| purchaseIntentCodes | Array of integers <int32> unique [ items <int32 > ] Buying intent |
| interestIntersection | boolean Indicates how the target is configured. |
Responses
Request samples
- Payload
{- "interestCodes": [
- {
- "code": 0,
- "depth": 0
}
], - "purchaseIntentCodes": [
- 0
], - "interestIntersection": true
}List of creatives
path Parameters
| adAccountNo required | integer <int64> adAccountNo |
| version required | number <float> Default: 1 API version |
query Parameters
| adSetNo | integer <int64> Ad group ID |
| 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. |
| deleteOnly | boolean Default: false Indicates whether to get only the deleted creatives. If true, it gets only the deleted creatives. |
| 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
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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
query Parameters
| creativeNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ 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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| creativeTemplateCode required | string non-empty Creative template:
|
| imageNo required | integer <int64> Creative image ID |
| url required | string non-empty Landing URL |
| altMessage required | string [ 2 .. 100 ] characters Ad message |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "name": "string",
- "creativeTemplateCode": "string",
- "imageNo": 0,
- "url": "string",
- "altMessage": "string"
}Create a creative in in-stream type of video
Creative creation for an in-steam type of video is supported.
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| creativeTemplateCode required | string non-empty Creative templates:
|
| videoNo required | integer <int64> Creative video ID |
| linkUrl required | string non-empty Landing URL |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "name": "string",
- "creativeTemplateCode": "string",
- "videoNo": 0,
- "linkUrl": "string"
}Create ad creative (image collection)
You can create image creatives of creative type Collection.
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| message required | string [ 2 .. 65 ] characters Ad copy |
| creativeTemplateCode required | string non-empty Creative templates:
|
| ctaCode required | string non-empty Call-to-action |
| ctaUrl required | string non-empty Call-to-action URL |
required | Array of objects (OpenImageMedia) [ 4 .. 10 ] items Creative image collection information |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "name": "string",
- "message": "string",
- "creativeTemplateCode": "string",
- "ctaCode": "string",
- "ctaUrl": "string",
- "imageMedias": [
- {
- "imageNo": 0,
- "linkUrl": "string",
- "linkTitle": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string",
- "linkTitle": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string",
- "linkTitle": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string",
- "linkTitle": "string"
}
]
}Create a creative with Video + Image Collections
Creative creation with Video + Image Collections is supported.
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| message required | string [ 2 .. 65 ] characters Ad copy |
| creativeTemplateCode required | string non-empty Creative templates:
|
| ctaCode required | string non-empty CTA |
| ctaUrl required | string non-empty CTA URL |
| videoNo required | integer <int64> Creative video ID, Only video with sizeGroupNo: |
| thumbnailImageNo required | integer <int64> Creative video thumbnail ID, Only image with sizeGroupNo: |
required | Array of objects (OpenImageMediaInVideoCollection) [ 4 .. 9 ] items Creative image collection information. Only image specs with sizeGroupNo: |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "name": "string",
- "message": "string",
- "creativeTemplateCode": "string",
- "ctaCode": "string",
- "ctaUrl": "string",
- "videoNo": 0,
- "thumbnailImageNo": 0,
- "imageMedias": [
- {
- "imageNo": 0,
- "linkUrl": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string"
}, - {
- "imageNo": 0,
- "linkUrl": "string"
}
]
}Create a creative in out-stream type of video
Creative creation for a out-stream type of video is supported.
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| message required | string [ 2 .. 120 ] characters Ad message |
| creativeTemplateCode required | string non-empty Creative templates:
|
| videoNo required | integer <int64> Creative video ID |
| thumbnailImageNo required | integer <int64> Creative video thumbnail ID |
| linkUrl required | string Landing URL |
| linkTitle | string [ 2 .. 2147483647 ] characters Description 1 |
| linkDescription | string [ 2 .. 2147483647 ] characters Description 2 |
| ctaCode | string Call-to-action |
Responses
Request samples
- Payload
{- "adSetNo": 0,
- "name": "string",
- "message": "string",
- "creativeTemplateCode": "string",
- "videoNo": 0,
- "thumbnailImageNo": 0,
- "linkUrl": "string",
- "linkTitle": "string",
- "linkDescription": "string",
- "ctaCode": "string"
}Create a creative (native image)
Currently, creative creation for a native image type is supported.
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
Request Body schema: application/json
params
| adSetNo required | integer <int64> Ad group ID |
| name required | string [ 2 .. 128 ] characters Creative name |
| message | string [ 2 .. 65 ] characters Ad message |
| creativeTemplateCode required | string non-empty Creative template:
|
| imageNo required | integer <int64> Creative image ID |
| linkUrl required | string non-empty Landing URL |
| linkTitle | string [ 2 .. 2147483647 ] characters Description 1 |
| linkDescription | string [ 2 .. 2147483647 ] characters Description 2 |
| linkText3rd | string [ 2 .. 2147483647 ] characters Description 3 |
| linkText4th | string [ 2 .. 2147483647 ] characters Long description 1 for the desktop banner type |
| linkText5th | string [ 2 .. 2147483647 ] characters Long description 2 for the desktop banner type |
| ctaCode | string Call-to-action |
| adviceMessage | string [ 0 .. 45 ] characters Notice message |
Responses
Request samples
- Payload
{- "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"
}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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
query Parameters
| creativeNos required | Array of integers <int64> [ 1 .. 100 ] items unique [ items <int64 > ] List of creative IDs |
| activated required | boolean Indicates whether to turn creatives on. (Set this to true to turn creatives on.) |
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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
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 |
| creativeTemplateCode required | string Creative templates |
Responses
Upload creative videos
path Parameters
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
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 |
| creativeTemplateCode required | string Creative templates |
| sizeGroupNo required | integer <int32> Creative media (images and videos) size ID |
| callbackUrl required | string [ 0 .. 1024 ] characters Callback URL |
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
| version required | number <float> Default: 1 version |
| adAccountNo required | integer <int64> adAccountNo |
| creativeNo required | integer <int64> creativeNo |
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 |
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 |
| name required | string [ 1 .. 128 ] characters Customer file target name |
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 |
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 |
| callbackUrl | string callback url |
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 |
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 |
| callbackUrl | string callback url |