Create Campaign

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 '
{
  "dsps": [],
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "budget": 123,
  "targetRoas": 10.5,
  "locationIds": [
    "<string>"
  ],
  "productIds": [
    "prod1",
    "prod2",
    "prod3",
    "prod4",
    "prod5"
  ],
  "audienceIds": [
    "123456"
  ]
}
'

import requests

url = "https://api.topsort.com/public/v1/offsite-ads/campaigns"

payload = {
    "dsps": [],
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "budget": 123,
    "targetRoas": 10.5,
    "locationIds": ["<string>"],
    "productIds": ["prod1", "prod2", "prod3", "prod4", "prod5"],
    "audienceIds": ["123456"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dsps: [],
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    budget: 123,
    targetRoas: 10.5,
    locationIds: ['<string>'],
    productIds: ['prod1', 'prod2', 'prod3', 'prod4', 'prod5'],
    audienceIds: ['123456']
  })
};

fetch('https://api.topsort.com/public/v1/offsite-ads/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/offsite-ads/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dsps' => [
        
    ],
    'name' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'budget' => 123,
    'targetRoas' => 10.5,
    'locationIds' => [
        '<string>'
    ],
    'productIds' => [
        'prod1',
        'prod2',
        'prod3',
        'prod4',
        'prod5'
    ],
    'audienceIds' => [
        '123456'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/offsite-ads/campaigns"

	payload := strings.NewReader("{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/offsite-ads/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/offsite-ads/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

public

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 '
{
  "dsps": [],
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "budget": 123,
  "targetRoas": 10.5,
  "locationIds": [
    "<string>"
  ],
  "productIds": [
    "prod1",
    "prod2",
    "prod3",
    "prod4",
    "prod5"
  ],
  "audienceIds": [
    "123456"
  ]
}
'

import requests

url = "https://api.topsort.com/public/v1/offsite-ads/campaigns"

payload = {
    "dsps": [],
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "budget": 123,
    "targetRoas": 10.5,
    "locationIds": ["<string>"],
    "productIds": ["prod1", "prod2", "prod3", "prod4", "prod5"],
    "audienceIds": ["123456"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dsps: [],
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    budget: 123,
    targetRoas: 10.5,
    locationIds: ['<string>'],
    productIds: ['prod1', 'prod2', 'prod3', 'prod4', 'prod5'],
    audienceIds: ['123456']
  })
};

fetch('https://api.topsort.com/public/v1/offsite-ads/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/offsite-ads/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dsps' => [
        
    ],
    'name' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'budget' => 123,
    'targetRoas' => 10.5,
    'locationIds' => [
        '<string>'
    ],
    'productIds' => [
        'prod1',
        'prod2',
        'prod3',
        'prod4',
        'prod5'
    ],
    'audienceIds' => [
        '123456'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/offsite-ads/campaigns"

	payload := strings.NewReader("{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/offsite-ads/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/offsite-ads/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dsps\": [],\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"budget\": 123,\n  \"targetRoas\": 10.5,\n  \"locationIds\": [\n    \"<string>\"\n  ],\n  \"productIds\": [\n    \"prod1\",\n    \"prod2\",\n    \"prod3\",\n    \"prod4\",\n    \"prod5\"\n  ],\n  \"audienceIds\": [\n    \"123456\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Parámetros de consulta

vendor_id

string

requerido

The ID of the vendor to create the campaign for.

Cuerpo

application/json

dsps

enum<string>[]

requerido

The DSPs to create the campaign for.

Minimum array length: 1

Opciones disponibles:

google_ads,

meta

Ejemplo:

["google_ads", "meta"]

name

string

requerido

The name of the campaign

Maximum string length: 35

Pattern:

^[^;"'<>\#\|,\
\
\\]*[^;"'<>\#\|,\
\
\\\s][^;"'<>\#\|,\
\
\\]*$

startDate

string<date-time>

requerido

The start date of the campaign

endDate

string<date-time>

requerido

The end date of the campaign

budget

integer<int64>

requerido

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

Ejemplo:

1000

targetRoas

number

requerido

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.

Rango requerido: 1 <= x <= 20

Ejemplo:

3

locationIds

string[]

requerido

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).

Minimum array length: 1

Ejemplo:

["123456"]

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

Ejemplo:

["prod1", "prod2", "prod3", "prod4", "prod5"]

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

Ejemplo:

["123456"]

Respuesta

Successful Response

jobId

string<uuid>

requerido

The unique identifier for the queued job.

⌘I

General

Ejemplos de subastas

Ejemplos de webhooks

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

API Reference

Autorizaciones

Parámetros de consulta

Cuerpo

Respuesta