Offsite Ads API

Create Campaign

Create a new offsite campaign.

post/public/v1/offsite-ads/campaigns

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/offsite-ads/campaigns
  • Auth: HTTP bearer

Query parameters

vendor_idstring required

The ID of the vendor to create the campaign for.

Request body

dspsAdvancedAPIsPublicDsp[] required

The DSPs to create the campaign for.

namestring required

The name of the campaign

startDatestring date-time required

The start date of the campaign

endDatestring date-time required

The end date of the campaign

budgetinteger required

The daily budget in minor units of currency according to ISO 4217.

targetRoasnumber required

Target ROAS of the campaign. Acceptable values are between 1.0 and 20.0. Topsort maps this value to the closest equivalent bidding configuration supported by each DSP.

locationIdsstring[] required

The DSP-native location IDs to target. Retrieve available IDs via GET /offsite-ads/marketplace/geolocations and use the values from dspLocationIds for the target DSP. Reference: Google Ads geo targets (https://developers.google.com/google-ads/api/data/geotargets), Meta region IDs (https://developers.facebook.com/docs/marketing-api/audiences/reference/targeting-search#regions).

productIdsstring[] nullable

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

audienceIdsstring[] nullable

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.

Example request

{
  "dsps": [
    "google_ads",
    "meta"
  ],
  "budget": 1000,
  "targetRoas": 3,
  "locationIds": [
    "123456"
  ],
  "productIds": [
    "prod1",
    "prod2",
    "prod3",
    "prod4",
    "prod5"
  ],
  "audienceIds": [
    "123456"
  ]
}

Response

Successful Response

jobIdstring uuid required

The unique identifier for the queued job.

Changes

No recorded changes to this operation across all 1 revision of this API.