Campaigns sync

POST /campaigns/sync

Copied

---

                https://api.ocamba.com/api/v1/adex/campaigns/sync
            

Syncs Campaigns

Request Body Schema

---

Name

Description

account_idstring

A unique account identifier generated by the Ocamba platform.


Example: 52794322

---

configured_statusstring

The configured_status reflects the current status of the campaign configured by the client, regardless of the parent object status.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived

---

create_timedateTime

Timezone: GMT.


Example: 2021-09-29 15:40:10

---

descriptionstring

Additional describtion of campaign, maximum 600 characters.


Example: Description goes here

---

end_timedateTime

A time when the campaign employment is over. At this point, campaign status will be automatically changed to 'paused' by backed processes. Timezone: GMT.


Example: 2021-10-29 13:07:04

---

exchange_idnumber

Exchange id created on the Ocamba platform. If exchange_id is set, the campaign type will be implicitly set to "external" otherwise, the campaign type will be "internal".


Example: 12341

---

frequency_capobject

Name

Description

impressionobject

Name

Description

expiry_timenumber

Time frame for frequency capping, expressed in hours.


Example: 10

---

max_countnumber

Max number of times a user sees ads for a given time frame.


Example: 2

---

iab_category[ string ]

An array of maximum 3 unique items, where every item must be a valid IAB category.


Example: IAB1-1,IAB1-2

---

idstring

A unique identifier generated by the Ocamba platform.


Example: 10001233

---

namestring

Name of the campaign, max 200 characters.


Example: DemoCampaign

---

pricing_modelstring

Assigning the wanted pricing model to campaign.


Example: cpc

Possible values: cpc | cpm | cpa

---

remote_idnumber

Campaign id from an external source.


Example: 42131

---

scorenumber (integer)

Minimum value - 0, Maximum value - 100.


Example: 78

Default: 50

---

start_timedateTime

A time when the campaign will be employed. Only campaigns with active status will be employed once the start time is reached. If the start time is not specified, the campaign will start immediately. Timezone: GMT.


Example: 2021-10-20 12:47:00

---

statusstring

The status reflects the current status of the campaign which may be overridden by its parent or by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit

---

sync_statusnumber (integer)

Describes campaign sync status.


Example: 2

Possible values: 0 | 1 | 2 | 3

---

typestring

Describes type of the campaign.


Example: internal

Possible values: internal | external

Response status codes

---

200 - OK

Name

Description

failednumber

A number (0 or 1) that shows if the Campaign is synced.

---

successnumber

A number (0 or 1) that shows if the Campaign is synced.