Passer au contenu principal
POST
/
public
/
v1
/
offsite-ads
/
campaigns
Create Campaign
curl --request POST \
  --url https://api.topsort.com/public/v1/offsite-ads/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dsp": "google_ads",
  "name": "<string>",
  "budget": 123,
  "locationIds": [
    "<string>"
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "productIds": [
    "123456"
  ],
  "audienceIds": [
    "123456"
  ]
}
'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Autorisations

​
Authorization
string
header
requis

A valid API key generated in Topsort's UI.

Paramètres de requête

​
vendor_id
string
requis

The ID of the vendor to create the campaign for.

Corps

application/json
​
dsp
enum<string>
requis

The DSP to create the campaign for.

Options disponibles:
google_ads,
meta
​
name
string
requis
​
budget
integer<int64>
requis

The amount of money in the budget in minor units of currency according to ISO 4217.

Exemple:

1000

​
locationIds
string[]
requis

The location ids to target. Google ads geo target ids can be found here: https://developers.google.com/google-ads/api/data/geotargets. Facebook region ids can be found here: https://developers.facebook.com/docs/marketing-api/audiences/reference/targeting-search#regions

Minimum array length: 1
Exemple:
["123456"]
​
startDate
string<date-time>
​
endDate
string<date-time>
​
productIds
string[] | null

The product ids to target. These are the product ids from the catalog. If not provided, all products will be targeted.

Minimum array length: 5
Exemple:
["123456"]
​
audienceIds
string[] | null

The audience ids to target. These are the audience ids from each DSP platform. Currently, only one audience is supported. If not provided, no audience will be targeted.

Maximum array length: 1
Exemple:
["123456"]

Réponse

Successful Response

​
jobId
string<uuid>
requis

The unique identifier for the queued job.