Creatives
This SOAP service provides operations for managing your creatives.
Service endpoint URL (WSDL definition) is https://api.oddbytes.com/?v3=creatives.wsdl .
Service Operation | ||
Operation | Result Type | Descrition |
Returns the list of ID values for your already existing creatives. Optionally, returned list can also contain ID values of your currently deleted creatives. | ||
Returns the parameters stored for your already existing creatives. | ||
Creates new creative as part of your already existing campaign, see types CreativeAdd , AdUnit and FrequencyCap for more details. Please note that it is possible to add new creatives as paused. | ||
Performs changes to your already existing creative, by updating its parameters. Please note that it is required to specify only those creative parameters you actually want to update, see types , AdUnitUpdate and FrequencyCapUpdate for more details. | ||
Resumes your already existing and currently paused creatives. | ||
Pauses your already existing creatives currently in active, awaiting approval, awaiting update, no funds or rejected status. | ||
Deletes already existing non–deleted creatives from your account. Please note that deleting your creatives also deletes all of their targets — once deleted, they can not be undeleted. | ||
Returns all currently available creatives categories. Please note that specifying categories for creatives is optional, see type Category for more details. | ||
Returns all currently available creatives matching options. Please note that all returned values representing the creative matching options need to be added up as selected, and passed as that sum to the operations taking matching options as a parameter. Similar rule applies while looking at the matching options values as returned by API operations, see type MatchingOption for more details. |
getCreativeIds
Returns the list of ID values for your already existing creatives. Optionally, returned list can also contain ID values of your currently deleted creatives.
Property | Type | Null Allowed | Description |
campaignIds | unsignedInt[] (1:50) | List of campaign ID values | |
filterNames | string[] (1:100) | ✔ | Optional filter specification for creatives names |
includeDeleted | bool | Option for also fetching ID values of your currently deleted creatives |
CreativeIdsResult
Property | Type | Null Allowed | Description |
ids | unsignedInt[] (0:unbound) | List of creative ID values for non–deleted creatives | |
deletedIds | unsignedInt[] (0:unbound) | List of creative ID values for deleted creatives |
getCreatives
Returns the parameters stored for your already existing creatives.
Property | Type | Null Allowed | Description |
creativeIds | unsignedInt[] (1:500) | List of creative ID values | |
fileData | AdUnitDataType | ✔ | Type of file data to be returned for creatives having ad units with associated files: brief SHA1 hash of the file data, or complete Base64 encoded file data; defaults to returning the SHA1 hash if not specified |
fetchStats | bool | ✔ | Option for also fetching brief stats data for the returned creatives |
CreativesResult
Property | Type | Null Allowed | Description |
creatives | Creative[] (0:unbound) | Creatives data stored for your already existing non–deleted creatives | |
deletedIds | unsignedInt[] (0:unbound) | List of creative ID values for deleted creatives |
addCreative
Creates new creative as part of your already existing campaign, see types CreativeAdd , AdUnit and FrequencyCap for more details. Please note that it is possible to add new creatives as paused.
Property | Type | Null Allowed | Description |
campaignId | unsignedInt | Destination campaign ID value | |
creative | Creative details data | ||
addAsPaused | bool | ✔ | Option for your new creative to be added as paused; defaults to adding as awaiting approval if not specified |
AddResult
Property | Type | Null Allowed | Description |
addedId | unsignedInt | ID value of the successfully added item |
updateCreative
Performs changes to your already existing creative, by updating its parameters. Please note that it is required to specify only those creative parameters you actually want to update, see types , AdUnitUpdate and FrequencyCapUpdate for more details.
Property | Type | Null Allowed | Description |
creativeId | unsignedInt | Creative ID value | |
creative | Creative parameters to be updated |
UpdateResult
Property | Type | Null Allowed | Description |
updatedIds | unsignedInt[] (0:unbound) | List of ID values for successfully updated items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for unchanged items | |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for currently deleted items |
resumeCreatives
Resumes your already existing and currently paused creatives.
Property | Type | Null Allowed | Description |
creativeIds | unsignedInt[] (1:200) | List of creative ID values |
StatusResult
Property | Type | Null Allowed | Description |
changedIds | unsignedInt[] (0:unbound) | List of ID values for successfully changed items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for unchanged items | |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for currently deleted items |
pauseCreatives
Pauses your already existing creatives currently in active, awaiting approval, awaiting update, no funds or rejected status.
Property | Type | Null Allowed | Description |
creativeIds | unsignedInt[] (1:200) | List of creative ID values |
StatusResult
Property | Type | Null Allowed | Description |
changedIds | unsignedInt[] (0:unbound) | List of ID values for successfully changed items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for unchanged items | |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for currently deleted items |
deleteCreatives
Deletes already existing non–deleted creatives from your account. Please note that deleting your creatives also deletes all of their targets — once deleted, they can not be undeleted.
Property | Type | Null Allowed | Description |
creativeIds | unsignedInt[] (1:200) | List of creative ID values |
DeleteResult
Property | Type | Null Allowed | Description |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for successfully deleted items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for already deleted items |
getCategories
Returns all currently available creatives categories. Please note that specifying categories for creatives is optional, see type Category for more details.
Property | Type | Null Allowed | Description |
CategoriesResult
Property | Type | Null Allowed | Description |
categories | Category[] (1:unbound) | Available creatives categories |
getMatchingOptions
Returns all currently available creatives matching options. Please note that all returned values representing the creative matching options need to be added up as selected, and passed as that sum to the operations taking matching options as a parameter. Similar rule applies while looking at the matching options values as returned by API operations, see type MatchingOption for more details.
Property | Type | Null Allowed | Description |
MatchingOptionsResult
Property | Type | Null Allowed | Description |
options | MatchingOption[] (1:unbound) | Available creatives matching options |
CreativeIdsResult
Return value type used while fetching ID values of your creatives.
Property | Type | Null Allowed | Description |
ids | unsignedInt[] (0:unbound) | List of creative ID values for non–deleted creatives | |
deletedIds | unsignedInt[] (0:unbound) | List of creative ID values for deleted creatives |
CreativesResult
Return value type used while fetching stored data for your already existing creatives.
Property | Type | Null Allowed | Description |
creatives | Creative[] (0:unbound) | Creatives data stored for your already existing non–deleted creatives | |
deletedIds | unsignedInt[] (0:unbound) | List of creative ID values for deleted creatives |
Creative
Return value type used while fetching stored data for your already existing non–deleted creative.
Property | Type | Null Allowed | Description |
id | unsignedInt | Creative ID value | |
campaignId | unsignedInt | Campaign ID value, as the creative's parent element | |
name | string | Creative name | |
status | CreativeStatus | Creative status | |
categoryId | unsignedInt | Creative category ID value, describing advertising category of your product; receiving zero means that category is not set, please see operation getCategories() for more details | |
regionCode | string | Targeted region code; please see operation getRegions() for more details | |
url | string | Complete URL of the creative's landing page | |
matching | unsignedInt | Creative matching options; receiving zero means no matching options are set, please see operation getMatchingOptions() for more details | |
type | CreativeType | Type of creative | |
adUnit | ✔ | Parameters stored for the ad unit — as set for Textlink, Slidebar and Peelback creatives; returned as Null for Display creatives | |
totalBudget | float | Total budget for the creative; receiving zero means it is unlimited | |
frequencyCap | Specifies how often the creative is presented to each consumer | ||
dailyVisitors | unsignedInt | Limit for the number of unique visitors per day | |
scheduling | Advanced scheduling for the creative — start and end date, day parting by days and hours, and per–day daily budgets | ||
comments | string | ✔ | Comments from the Approval Team, describing any current issues with the creative; receiving Null means there is no comment available |
created | dateTime | Date and time of creative creation | |
modified | dateTime | Date and time of last creative modification | |
stats | ✔ | Brief daily, monthly and total stats data for the creative, returned only if requested; please see operation getCreatives() for more details |
AdUnit
Value type used for specifying ad unit parameters for a creative. Used while fetching stored data for your already existing non–deleted creative, and while adding new creative.
Please note that parameters fileType and fileData can be received or specified as Null only both at the same time, and only if the type of ad unit contains no file — also, they can be specified only if the ad unit contains file, what boils down to all ad unit types other than *_TEXT .
Parameters title , content and url need to be specified as empty strings for all *_300X250 and *_VIDEO ad unit types, and are also returned as such.
Please note that parameters brandingFileType and brandingFileData can be received or specified as Null only both at the same time, and only if the type of ad unit contains no branding file — also, they can be specified only if the ad unit contains branding file, which means it is allowed / required only for TEXTLINK_MODULAR .
Parameters brandingTitle , layoutID , ctaButton , color , statsViews and statsClicks need to be specified as empty strings or Null for all ad unit types except for TEXTLINK_MODULAR, and are also returned as such.
Parameters pushTemplateID , pushPosition , pushWidth , pushWidthType , pushHeight and pushHeightType and pushOffset and pushOffsetType and pushGap and pushGapType and pushCtaText and pushColor need to be specified as empty strings or Null for all ad unit types except for PUSH, and are also returned as such.
Parameter postcheckoutCtaText need to be specified as empty strings or Null for all ad unit types except for POSTCHECKOUT, and are also returned as such.
Parameter url need to be specified as empty strings or Null for POSTCHECKOUT, and are also returned as such.
Property | Type | Null Allowed | Description |
type | AdUnitType | Type of ad unit; only the TEXTLINK_MODULAR value listed below is currently allowed while adding new creatives | |
title | string | Title for the ad unit (top section) | |
content | string | Content for the ad unit (middle section) | |
url | string | URL for the ad unit (bottom section) | |
fileType | AdUnitFileType | ✔ | Type of the file associated with ad unit; receiving or specifying Null means the type of ad unit contains no file |
fileData | string | ✔ | Data for the ad unit's associated file; returned as either brief SHA1 hash of the file data, or complete Base64 encoded file data, see operation getCreatives() for more details; must be specified as Base64 encoded content of the file, while receiving or specifying Null means the type of ad unit contains no file; maximum file data size is 200 KB for IMAGE, 400 KB for FLASH and 10 MB for VIDEO |
brandingTitle | string | ✔ | Branding Title for the Modular ad unit (top section) |
layoutID | int | ✔ | Layout for Modular ad unit |
ctaButton | AdUnitCTAButton | ✔ | CTA Button text for the Modular ad unit |
color | AdUnitColor | ✔ | CTA Button color for the Modular ad unit |
statsViews | AdUnitStats | ✔ | Stats View info for the Modular ad unit |
statsClicks | AdUnitStats | ✔ | Stats Clicks info for the Modular ad unit |
brandingFileType | AdUnitFileType | ✔ | Type of the branding file associated with Modular ad unit; receiving or specifying Null means the type of ad unit contains no branding file; only the IMAGE value listed below is currently allowed while adding new creatives |
brandingFileData | string | ✔ | Data for the Modular ad unit's associated branding file; returned as either brief SHA1 hash of the file data, or complete Base64 encoded file data, see operation getCreatives() for more details; must be specified as Base64 encoded content of the file, while receiving or specifying Null means the type of ad unit contains no file; maximum file data size is 200 KB for IMAGE |
pushTemplateID | int | ✔ | Template for Push ad unit |
pushPosition | AdUnitPosition | ✔ | Position of Push ad unit on screen |
pushWidth | int | ✔ | Width of the Push ad unit |
pushWidthType | AdUnitDimType | ✔ | Width type for the Push ad unit |
pushHeight | int | ✔ | Height of the Push ad unit |
pushHeightType | AdUnitDimType | ✔ | Height type for the Push ad unit |
pushOffset | int | ✔ | Distance (Offset) from left or right screen margin where will be shown the Push ad unit |
pushOffsetType | AdUnitDimType | ✔ | Offset type for the Push ad unit |
pushGap | int | ✔ | Distance (Gap) from top or bottom screen margin where will be shown the Push ad unit |
pushGapType | AdUnitDimType | ✔ | Gap type for the Push ad unit |
pushCtaText | string | ✔ | CTA Button text for the Push ad unit |
pushColor | AdunitPushColor | ✔ | CTA Button color for the Push ad unit |
postcheckoutCtaText | string | ✔ | CTA Button text for the Postcheckout ad unit |
FrequencyCap
Value type used for specifying frequency cap parameters for a creative. Used while fetching stored data for your already existing non–deleted creative, and while adding new creative.
Please note that parameter value is required only for frequency cap type hourly,
for all others frequency cap types value must be received or specified as Null
Example: 1 impression per 24 hours with recency of 30 minutes
type is hourly
1 represent count
24 represent value
30 represents recency
Property | Type | Null Allowed | Description |
type | FrequencyCapType | Value representing the creative frequency cap types | |
count | unsignedInt | Count represents number of impressions/clicks per frequency cap period (type); allowed range is from 1 to 100 | |
value | unsignedInt | ✔ | Value for frequency cap is only available for hourly time frame (type). |
recency | unsignedInt | Choose how often your creative is presented to each consumer. |
CreativeScheduling
Value type used for specifying advanced scheduling for the creative — start and end date, day parting by days and hours, and per–day daily budgets. Used while fetching stored data for your already existing non–deleted creative, and while adding new creative.
Please note that day parting by hours must be specified for at least one day, meaning that creative can not be set to have no working hours for all of the days.
Property | Type | Null Allowed | Description |
startDate | date | Start date for the creative, as when it starts receiving traffic; must be set at most one month into the future | |
endDate | date | ✔ | End date for the creative, as when it stops receiving traffic; will be received and needs to be specified as Null when endDateUnlimited is set to True |
endDateUnlimited | bool | Option for having unlimited end date; receiving or specifying True means that end date for the creative is unlimited | |
sunday | ✔ | Day parting by hours and daily budget for Sunday; receiving or specifying Null means that creative is inactive for the day | |
monday | ✔ | Day parting by hours and daily budget for Monday; receiving or specifying Null means that creative is inactive for the day | |
tuesday | ✔ | Day parting by hours and daily budget for Tuesday; receiving or specifying Null means that creative is inactive for the day | |
wednesday | ✔ | Day parting by hours and daily budget for Wednesday; receiving or specifying Null means that creative is inactive for the day | |
thursday | ✔ | Day parting by hours and daily budget for Thursday; receiving or specifying Null means that creative is inactive for the day | |
friday | ✔ | Day parting by hours and daily budget for Friday; receiving or specifying Null means that creative is inactive for the day | |
saturday | ✔ | Day parting by hours and daily budget for Saturday; receiving or specifying Null means that creative is inactive for the day |
CreativeSchedulingDay
Value type used for specifying daily advanced scheduling for the creative — work hours and daily budget. Used while fetching stored data for your already existing non–deleted creative, and while adding new creative.
Property | Type | Null Allowed | Description |
workHours | SchedulingHours[] (0:24) | ✔ | List of hours (24h format) when the creative will be receiving traffic; receiving Null, or specifying Null or empty array, means that creative is inactive for the day |
dailyBudget | float | ✔ | Daily budget for the creative; receiving or specifying zero means it is unlimited, while receiving or specifying Null means the creative is inactive for the day |
CreativeStats
Return value type used while fetching brief daily, monthly and total stats data for your already existing non–deleted creative.
Property | Type | Null Allowed | Description |
costToday | float | Accounted cost for today | |
costMonth | float | Accounted cost for current month | |
costTotal | float | Total amount of accounted cost | |
impressionsToday | unsignedInt | Accounted number of impressions for today | |
impressionsMonth | unsignedInt | Accounted number of impressions for current month | |
impressionsTotal | unsignedInt | Total number of accounted impressions | |
clicksToday | unsignedInt | Accounted number of clicks for today | |
clicksMonth | unsignedInt | Accounted number of clicks for current month | |
clicksTotal | unsignedInt | Total number of accounted clicks | |
lastServed | dateTime | ✔ | Date and time of last received impression (for Display creatives) or click (for Textlink creatives); receiving Null means having no impressions or clicks received yet |
AddResult
Return value type used while creating one new item.
Property | Type | Null Allowed | Description |
addedId | unsignedInt | ID value of the successfully added item |
CreativeAdd
Value type used for specifying creative definition data while adding new creative.
Characters allowed within creative name are the following: 0–9 a–z A–Z - _ / # . : ; | &
URL of the creative's landing page needs to be a regular URL with required leading protocol definition ( http:// or https:// ).
Before adding creative, all leading or trailing whitespace within the creative name and URL is trimmed.
Length for the campaign name string needs to be between one and 250 characters, while for the URL up to 700 characters are allowed.
Property | Type | Null Allowed | Description |
name | string | Creative name | |
categoryId | unsignedInt | Creative category ID value, describing advertising category of your product; specifying zero means that category is not set, please see operation getCategories() for more details | |
regionCode | string | Targeted region code; please see operation getRegions() for more details | |
url | string | Complete URL of the creative's landing page | |
matching | unsignedInt | Creative matching options; specifying zero means no matching options are set, please see operation getMatchingOptions() for more details | |
type | CreativeType | Type of creative; only DISPLAY and TEXTLINK values are currently allowed | |
adUnit | ✔ | Parameters for the ad unit — as required for Textlink, Slidebar and Peelback creatives; must be specified as Null for Display creatives | |
totalBudget | float | Total budget for the creative; specifying zero means it is unlimited | |
frequencyCap | Specifies how often the creative is presented to each consumer | ||
dailyVisitors | unsignedInt | Limit for the number of unique visitors per day; minimal allowed values are 1,000 for Display creatives, 10 for Textlink creatives, 10 for Slidebar creatives and 10 for Peelback creatives | |
scheduling | Advanced scheduling for the creative — start and end date, day parting by days and hours, and per–day daily budgets |
UpdateResult
Return value type used while updating one or more already existing items.
Property | Type | Null Allowed | Description |
updatedIds | unsignedInt[] (0:unbound) | List of ID values for successfully updated items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for unchanged items | |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for currently deleted items |
CreativeUpdate
Value type used for specifying creative parameters while updating already existing non–deleted creative.
Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want
to leave unchanged need to have their values specified as Null.
Characters allowed within creative name are the following: 0–9 a–z A–Z - _ / # . : ; | &
URL of the creative's landing page needs to be a regular URL with required leading protocol definition ( http:// or https:// ).
Before updating creative, all leading or trailing whitespace within the creative name and URL (if specified as non-Null) is trimmed.
Length for the campaign name string needs to be between one and 250 characters, while for the URL up to 700 characters are allowed.
Property | Type | Null Allowed | Description |
name | string | ✔ | Creative name |
categoryId | unsignedInt | ✔ | Creative category ID value, describing advertising category of your product; specifying zero means that category is not set, please see operation getCategories() for more details |
url | string | ✔ | Complete URL of the creative's landing page |
matching | unsignedInt | ✔ | Creative matching options; specifying zero means no matching options are set, please see operation getMatchingOptions() for more details |
adUnit | ✔ | Parameters for the ad unit — as required for Textlink, Slidebar and Peelback creatives; must be specified as Null for Display creatives | |
totalBudget | float | ✔ | Total budget for the creative; specifying zero means it is unlimited |
frequencyCap | ✔ | Specifies how often the creative is presented to each consumer | |
dailyVisitors | unsignedInt | ✔ | Limit for the number of unique visitors per day; minimal allowed values are 1,000 for Display creatives, 10 for Textlink creatives, 10 for Slidebar creatives and 10 for Peelback creatives |
scheduling | ✔ | Advanced scheduling for the creative — start and end date, day parting by days and hours, and per–day daily budgets |
AdUnitUpdate
Value type used for specifying ad unit parameters while updating already existing non–deleted creative.
Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want to leave unchanged need to have their values specified as Null. In case you need no updates for the ad unit, please specify the parent property as Null instead of specifying all parameters as Null.
Parameters fileType and fileData can be specified as values other than Null only if the type of ad unit actually contains file, what boils down to all ad unit types other than *_TEXT . Also, please note that these two parameters can be specified as Null only both at the same time.
Please note that parameters title , content and url (if updated) need to be specified as empty strings for all *_300X250 and *_VIDEO ad unit types.
Parameters brandingFileType and brandingFileData can be specified as values other than Null only if the type of ad unit actually contains branding file, which means it is allowed / required only for TEXTLINK_MODULAR. Also, please note that these two parameters can be specified as Null only both at the same time.
Parameters brandingTitle , layoutID , ctaButton , color , statsViews and statsClicks (if updated) need to be specified as empty strings or Null for all ad unit types except for TEXTLINK_MODULAR.
Parameters pushTemplateID , pushPosition , pushWidth , pushWidthType , pushHeight and pushHeightType and pushOffset and pushOffsetType and pushGap and pushGapType and pushCtaText and pushColor (if updated) need to be specified as empty strings or Null for all ad unit types except for PUSH
Parameter postcheckoutCtaText (if updated) need to be specified as empty strings or Null for all ad unit types except for POSTCHECKOUT
Parameter url need to be specified as empty strings or Null for POSTCHECKOUT
Property | Type | Null Allowed | Description |
type | AdUnitType | ✔ | Type of ad unit; only the TEXTLINK_* values listed below are currently allowed while updating existing creatives |
title | string | ✔ | Title for the ad unit (top section) |
content | string | ✔ | Content for the ad unit (middle section) |
url | string | ✔ | URL for the ad unit (bottom section) |
fileType | AdUnitFileType | ✔ | Type of the file associated with ad unit |
fileData | string | ✔ | Data for the ad unit's associated file; please note that it needs to be specified as a complete Base64 encoded content of the file, while maximum file data size is 200 KB for IMAGE, 400 KB for FLASH and 10 MB for VIDEO |
brandingTitle | string | ✔ | Branding Title for the Modular ad unit (top section) |
layoutID | int | ✔ | Layout for Modular ad unit |
ctaButton | AdUnitCTAButton | ✔ | CTA Button text for the Modular ad unit |
color | AdUnitColor | ✔ | CTA Button color for the Modular ad unit |
statsViews | AdUnitStats | ✔ | Stats View info for the Modular ad unit |
statsClicks | AdUnitStats | ✔ | Stats Clicks info for the Modular ad unit |
brandingFileType | AdUnitFileType | ✔ | Type of the branding file associated with Modular ad unit; receiving or specifying Null means the type of ad unit contains no branding file; only the IMAGE value listed below is currently allowed |
brandingFileData | string | ✔ | Data for the Modular ad unit's associated branding file; returned as either brief SHA1 hash of the file data, or complete Base64 encoded file data, see operation getCreatives() for more details; must be specified as Base64 encoded content of the file, while receiving or specifying Null means the type of ad unit contains no file; maximum file data size is 200 KB for IMAGE |
pushTemplateID | int | ✔ | Template for Push ad unit |
pushPosition | AdUnitPosition | ✔ | Position of Push ad unit on screen |
pushWidth | int | ✔ | Width of the Push ad unit |
pushWidthType | AdUnitDimType | ✔ | Width type for the Push ad unit |
pushHeight | int | ✔ | Height of the Push ad unit |
pushHeightType | AdUnitDimType | ✔ | Height type for the Push ad unit |
pushOffset | int | ✔ | Distance (Offset) from left or right screen margin where will be shown the Push ad unit |
pushOffsetType | AdUnitDimType | ✔ | Offset type for the Push ad unit |
pushGap | int | ✔ | Distance (Gap) from top or bottom screen margin where will be shown the Push ad unit |
pushGapType | AdUnitDimType | ✔ | Gap type for the Push ad unit |
pushCtaText | string | ✔ | CTA Button text for the Push ad unit |
pushColor | AdunitPushColor | ✔ | CTA Button color for the Push ad unit |
postcheckoutCtaText | string | ✔ | CTA Button text for the Spotlight ad unit |
FrequencyCapUpdate
Value type used for specifying frequency cap parameters while updating already existing non–deleted creative.
Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want to leave unchanged need to have their values specified as Null. In case you need no updates for the frequency cap, please specify the parent property as Null instead of specifying all parameters as Null.
Please note that parameter value (if updated) need to be specified as Null for all frequency cap types except hourly
Example: 1 impression per 24 hours with recency of 30 minutes
type is hourly
1 represent count
24 represent value
30 represents recency
Property | Type | Null Allowed | Description |
type | FrequencyCapType | ✔ | Value representing the creative frequency cap types |
count | unsignedInt | ✔ | Count represents number of impressions/clicks per frequency cap period (type); allowed range is from 1 to 100 |
value | unsignedInt | ✔ | Value for frequency cap is only available for hourly time frame (type). |
recency | unsignedInt | ✔ | Choose how often your creative is presented to each consumer. |
CreativeSchedulingUpdate
Value type used for specifying advanced scheduling (start and end date, day parting by days and hours, and per–day daily budgets) while updating already existing non–deleted creative.
Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want to leave unchanged need to have their values specified as Null. In case you need no updates for the scheduling, please specify the parent property as Null instead of specifying all parameters as Null.
Please note that day parting by hours must be specified for at least one day, meaning that creative can not be set to have no working hours for all of the days.
Property | Type | Null Allowed | Description |
startDate | date | ✔ | Start date for the creative, as when it starts receiving traffic; must be set at most one month into the future |
endDate | date | ✔ | End date for the creative, as when it stops receiving traffic; needs to be specified as Null when endDateUnlimited is set to True |
endDateUnlimited | bool | ✔ | Option for having unlimited end date; specifying True means that end date for the creative is unlimited |
sunday | ✔ | Day parting by hours and daily budget for Sunday | |
monday | ✔ | Day parting by hours and daily budget for Monday | |
tuesday | ✔ | Day parting by hours and daily budget for Tuesday | |
wednesday | ✔ | Day parting by hours and daily budget for Wednesday | |
thursday | ✔ | Day parting by hours and daily budget for Thursday | |
friday | ✔ | Day parting by hours and daily budget for Friday | |
saturday | ✔ | Day parting by hours and daily budget for Saturday |
CreativeSchedulingDayUpdate
Value type used for specifying daily advanced scheduling while updating already existing non–deleted creative.
Please note that it is required to specify values only for those parameters you actually want to update, while remaining parameters you want to leave unchanged need to have their values specified as Null. In case you need no updates for the daily scheduling, please specify the parent property as Null instead of specifying all parameters as Null.
Property | Type | Null Allowed | Description |
workHours | SchedulingHours[] (0:24) | ✔ | List of hours (24h format) when the creative will be receiving traffic; specifying empty array means that creative will be inactive for the day |
dailyBudget | float | ✔ | Daily budget for the creative; specifying zero means it is unlimited, while specifying Null is required when creative is inactive for the day |
StatusResult
Return value type used while changing statuses for one or more already existing items.
Property | Type | Null Allowed | Description |
changedIds | unsignedInt[] (0:unbound) | List of ID values for successfully changed items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for unchanged items | |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for currently deleted items |
DeleteResult
Return value type used while deleting one or more already existing items.
Property | Type | Null Allowed | Description |
deletedIds | unsignedInt[] (0:unbound) | List of ID values for successfully deleted items | |
unchangedIds | unsignedInt[] (0:unbound) | List of ID values for already deleted items |
CategoriesResult
Return value type used while fetching available creatives categories.
Property | Type | Null Allowed | Description |
categories | Category[] (1:unbound) | Available creatives categories |
Category
Return value type used while fetching available creatives category. Please note that you can select only one category for each of your creatives, and selecting categories is optional.
Property | Type | Null Allowed | Description |
id | unsignedInt | Creative category ID value | |
name | string | Creative category name |
MatchingOptionsResult
Return value type used while fetching available creatives matching options.
Property | Type | Null Allowed | Description |
options | MatchingOption[] (1:unbound) | Available creatives matching options |
MatchingOption
Return value type used while fetching available creatives matching option.
Please note that each value is actually a decimal representation of an unique bit position, making it possible to look up returned matching options for creatives as summed values easily by applying bitwise operations, see operation getMatchingOptions() for more details.
Property | Type | Null Allowed | Description |
value | unsignedInt | Value representing the creative matching option | |
description | string | Description for the creative matching option, in terms of applied modifications to the way targets are matched |