The third step of the Advertiser API Integration allows you to decide when you would like to get updates from the advertiser API per offer field.
This configuration will help you to set the updates of the fields based on your desired behaviour. Below you can find 3 useful cases:
Get always updates from Advertiser API
If you would like to sync always updates coming from the advertiser API, you shall follow the configuration displayed in the example below.
For instance, if you would like always get click budgets updated whenever the advertiser updates them in their API, the "On Sync" must be checked as image below:
Set custom default value and ignore updates from Advertiser API
If you would like to set your custom default value instead of using the value coming from the Advertiser API, you shall follow the configuration displayed in the example below.
For example, if you would like to insert a custom value for click budgets and ignore the updates of the advertiser API:
Set default value coming from API and ignore updates from advertiser API
If you would like to take only first time the value from the advertiser API, you shall follow the configuration displayed in the example below.
For example, you would like to set only the first time the click budgets coming from the Advertiser API on an offer, but you would like to ignore the updates if any from the API on this field, then you shall follow the configuration below.
Fields that are supported (please check adapter page to see if that field is supported)
Below you can find the fields that are supported by Swaarm Advertiser API Integration:
Name
This field refers to the name of the offer is displayed in the image below.
On Approval:
If Default value is inserted, every offer approved from this advertiser will have the name inserted on the field
If Use API Value is checked, the offer will have the name coming from the advertiser API at the moment of approval.
On Sync:
"On sync": If checked, every time there is an update on the Advertiser API side, the offer name will be synced
"On sync": If unchecked: It will not syn any changes of the advertiser API, only first time
Private and required approval flags
These fields refers to flags on the offer page below the Notes field:
If Private is checked, the offer will be set as private the moment of approval
If Required approval is checked, the offers will be set as this at the moment of approval
Status
On Approval:
Default Value can be Active or Pending. If inserted, this will be the status of the offer at the moment of approval
If Use API Value is checked, the offer will have the status coming from the advertiser API at the moment of approval.
On Sync:
"On sync": If checked, every time there is an update on the Advertiser API side, the offer status will be updated to Active or Paused
"On sync": If unchecked: It will not syn any changes of the advertiser API, only first time
Leadflow
It can have 2 values CPI or CPA
On Approval:
Default Value can be CPA or CPI
If Use API Value is checked, the offer leadflow will come from the advertiser API
Tracking link
On Approval:
Default Value can be CPA or CPI
If Use API Value is checked, the offer leadflow will come from the advertiser API
Description
Creatives URL
Events
Events are always created on the offer at the moment of approval with the value provided by the advertiser API
However you can decide to always sync the events or ignore if any updates coming from the advertiser API by unchecking the flag On Sync
Targeting
This field refers to the OS and Country set in the offer as displayed below:
"On sync": If checked, every time the Advertiser API changes the country or OS, this will be reflected on the offer.
"On sync": If unchecked: It will not syn any changes related to the countries, meaning the countries at the moment of the approval of the offers will remain and never changed.
Advanced targeting
This field is related to the Targeting tab on the offer edit mode as displayed on image below:
By default it is set "User API Value" This means that any region or city targeting is detected by default from the advertiser API
"On sync": If checked, everything inserted under the advanced Targeting of the offer will be overridden (e.g. if you have time targeting, it will be overwritten)
"On sync": If unchecked: It will not syn any changes of the advertiser API, only first time
Click budgets
Click budgets are field is related to the Daily Click budget of the offer.
Budgets
This field refers to conversion and revenue budgets to the offer that are default or belong to an event
Payouts
This field refers to Default Payouts of the offer or Payouts related to any event.
Payouts are always created on the offer at the moment of approval with the value provided by the advertiser API
However you can decide to always sync the Payouts or ignore if any updates coming from the advertiser API by unchecking the flag On Sync
Blacklisted subIds
Blacklisted SubIds are always created on the offer at the moment of approval with the value provided by the advertiser API
However you can decide to always sync them or ignore if any updates coming from the advertiser API by unchecking the flag On Sync
Kpi
This field refers to the offer KPI field of the offer in the general tab.
