Create Campaign Bids

Endpoint to create a bid for a campaign.

POST /public/v1/campaign-service/campaigns/{campaign-id}/bids

Create Campaign Bids

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bids": [
    {
      "target": {
        "id": "<string>"
      },
      "amount": "<unknown>",
      "location": "Santiago",
      "triggers": [],
      "formatProperties": {
        "bannerAssets": [
          {
            "dimensions": {
              "width": 123,
              "height": 123
            },
            "url": "<string>",
            "contentType": "image/png",
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "adFormat": "<string>",
        "deviceType": "desktop"
      }
    }
  ]
}
'

import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids"

payload = { "bids": [
        {
            "target": { "id": "<string>" },
            "amount": "<unknown>",
            "location": "Santiago",
            "triggers": [],
            "formatProperties": {
                "bannerAssets": [
                    {
                        "dimensions": {
                            "width": 123,
                            "height": 123
                        },
                        "url": "<string>",
                        "contentType": "image/png",
                        "size": 123,
                        "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
                        "content": {},
                        "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                    }
                ],
                "slotId": "<string>",
                "adFormat": "<string>",
                "deviceType": "desktop"
            }
        }
    ] }
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({
    bids: [
      {
        target: {id: '<string>'},
        amount: '<unknown>',
        location: 'Santiago',
        triggers: [],
        formatProperties: {
          bannerAssets: [
            {
              dimensions: {width: 123, height: 123},
              url: '<string>',
              contentType: 'image/png',
              size: 123,
              assetId: 'asset_01j713j64yfsvtj4bs3ccpy5ca',
              content: {},
              jsonTemplateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
            }
          ],
          slotId: '<string>',
          adFormat: '<string>',
          deviceType: 'desktop'
        }
      }
    ]
  })
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids', 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/campaign-service/campaigns/{campaign-id}/bids",
  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([
    'bids' => [
        [
                'target' => [
                                'id' => '<string>'
                ],
                'amount' => '<unknown>',
                'location' => 'Santiago',
                'triggers' => [
                                
                ],
                'formatProperties' => [
                                'bannerAssets' => [
                                                                [
                                                                                                                                'dimensions' => [
                                                                                                                                                                                                                                                                'width' => 123,
                                                                                                                                                                                                                                                                'height' => 123
                                                                                                                                ],
                                                                                                                                'url' => '<string>',
                                                                                                                                'contentType' => 'image/png',
                                                                                                                                'size' => 123,
                                                                                                                                'assetId' => 'asset_01j713j64yfsvtj4bs3ccpy5ca',
                                                                                                                                'content' => [
                                                                                                                                                                                                                                                                
                                                                                                                                ],
                                                                                                                                'jsonTemplateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                                                                ]
                                ],
                                'slotId' => '<string>',
                                'adFormat' => '<string>',
                                'deviceType' => 'desktop'
                ]
        ]
    ]
  ]),
  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/campaign-service/campaigns/{campaign-id}/bids"

	payload := strings.NewReader("{\n  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\",\n      \"triggers\": [],\n      \"formatProperties\": {\n        \"bannerAssets\": [\n          {\n            \"dimensions\": {\n              \"width\": 123,\n              \"height\": 123\n            },\n            \"url\": \"<string>\",\n            \"contentType\": \"image/png\",\n            \"size\": 123,\n            \"assetId\": \"asset_01j713j64yfsvtj4bs3ccpy5ca\",\n            \"content\": {},\n            \"jsonTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n          }\n        ],\n        \"slotId\": \"<string>\",\n        \"adFormat\": \"<string>\",\n        \"deviceType\": \"desktop\"\n      }\n    }\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/campaign-service/campaigns/{campaign-id}/bids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\",\n      \"triggers\": [],\n      \"formatProperties\": {\n        \"bannerAssets\": [\n          {\n            \"dimensions\": {\n              \"width\": 123,\n              \"height\": 123\n            },\n            \"url\": \"<string>\",\n            \"contentType\": \"image/png\",\n            \"size\": 123,\n            \"assetId\": \"asset_01j713j64yfsvtj4bs3ccpy5ca\",\n            \"content\": {},\n            \"jsonTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n          }\n        ],\n        \"slotId\": \"<string>\",\n        \"adFormat\": \"<string>\",\n        \"deviceType\": \"desktop\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids")

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  \"bids\": [\n    {\n      \"target\": {\n        \"id\": \"<string>\"\n      },\n      \"amount\": \"<unknown>\",\n      \"location\": \"Santiago\",\n      \"triggers\": [],\n      \"formatProperties\": {\n        \"bannerAssets\": [\n          {\n            \"dimensions\": {\n              \"width\": 123,\n              \"height\": 123\n            },\n            \"url\": \"<string>\",\n            \"contentType\": \"image/png\",\n            \"size\": 123,\n            \"assetId\": \"asset_01j713j64yfsvtj4bs3ccpy5ca\",\n            \"content\": {},\n            \"jsonTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n          }\n        ],\n        \"slotId\": \"<string>\",\n        \"adFormat\": \"<string>\",\n        \"deviceType\": \"desktop\"\n      }\n    }\n  ]\n}"

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

200

{
  "hasMore": true,
  "bids": [
    {
      "bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "target": {
        "id": "<string>"
      },
      "isActive": true,
      "triggers": [
        {
          "type": "<string>",
          "value": {
            "words": [
              "<string>"
            ]
          }
        }
      ],
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<unknown>",
      "location": "Santiago",
      "bidsBehaviorData": "<string>",
      "formatProperties": {
        "bannerAssets": [
          {
            "dimensions": {
              "width": 123,
              "height": 123
            },
            "url": "<string>",
            "contentType": "image/png",
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "adFormat": "<string>",
        "deviceType": "desktop"
      }
    }
  ],
  "next": {
    "offset": 123,
    "limit": 123
  }
}

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

Authorizations

Authorization · string · header · required

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.

Path Parameters

campaign-id · string<uuid> · required

The ID of the campaign.

Query Parameters

skip_existing_bids · boolean · default: false

Skip creating bids that already exist. Existing bids will not be updated and will not be returned in the response.

Body

application/json

bids · BidCreate · object[] · required

An array of bids to be created.

Required array length: 1 - 500 elements

Show child attributes

Response

200

application/json

Successful Response

The public response body of the bids endpoints.

hasMore · boolean · required

Whether this is the last page of results or not.

bids · Bid · object[] · required

An array of bids.

Maximum array length: 500

Show child attributes

next · Next · object | null

The parameters that should be used to fetch the next page.

Show child attributes