Create Campaign Bids

POST

public

campaign-service

campaigns

{campaign-id}

bids

curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids \
  --header 'Content-Type: application/json' \
  --data '{
  "bids": [
    {
      "amount": 1,
      "formatProperties": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "location": "Santiago",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "keyword",
        "value": {
          "matchType": "exact",
          "words": [
            "<string>"
          ]
        }
      },
      "triggers": [
        {
          "type": "keyword",
          "value": {
            "matchType": "exact",
            "words": [
              "<string>"
            ]
          }
        }
      ]
    }
  ]
}'

{
  "bids": [
    {
      "amount": 1,
      "bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bidsBehaviorData": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "formatProperties": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "isActive": true,
      "location": "Santiago",
      "state": "active",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "keyword",
        "value": {
          "matchType": "exact",
          "words": [
            "<string>"
          ]
        }
      },
      "triggers": [
        {
          "type": "keyword",
          "value": {
            "matchType": "exact",
            "words": [
              "<string>"
            ]
          }
        }
      ]
    }
  ],
  "hasMore": true,
  "next": {
    "limit": 123,
    "offset": 123
  }
}

Path Parameters

campaign-id

string

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

object[]

required

An array of bids to be created.

The request model for bid creation.

bids.target

object

required

Represents a promotable entity that will be returned upon a winning auction.

bids.amount

integer

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

Required range: x > 0

bids.formatProperties

object

The format properties of the bid. This field is required for banner ads. Should be not set for listing ads.

bids.location

string

By using this option you will be able to target this campaign to a specific group.You must define the same location as a parameter on the auction request. Products on a specific campaign will have specific conversion rates, considering the context of location, so it will not interfere with the conversion rates for the same product in other campaigns.

Minimum length: 1

Example:

"Santiago"

bids.trigger

object

deprecated

When should this bid participate in an auction.

bids.triggers

object[]

A list of objects that trigger the appearance of this bid on an auction.

When should this bid participate in an auction.

Response

200

application/json

Successful Response

The public response body of the bids endpoints.

bids

object[]

required

An array of bids.

Represents an auction bid for a specific entity and a specific maximum amount.

bids.bidId

string

required

The ID of the bid

bids.campaignId

string

required

The ID of the campaign.

bids.isActive

boolean

required

Whether the bid is active.

bids.state

enum<string>

required

The activity state of the bid.

Available options:

active,

deactivated_manually,

inactive_entity,

deleted_entity,

legacy_inactive

bids.target

object

required

The type of entity this bid will be targeting.

bids.triggers

object[]

required

A list of objects that trigger the appearance of this bid on an auction.

When should this bid participate in an auction.

bids.amount

integer

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

Required range: x > 0

bids.bidsBehaviorData

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

bids.formatProperties

object

bids.location

string

Minimum length: 1

Example:

"Santiago"

bids.trigger

object

deprecated

When should this bid participate in an auction.

hasMore

boolean

required

Whether this is the last page of results or not.

object

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

Get Campaign Bids Delete Campaign Bid By Id

curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids \
  --header 'Content-Type: application/json' \
  --data '{
  "bids": [
    {
      "amount": 1,
      "formatProperties": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "location": "Santiago",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "keyword",
        "value": {
          "matchType": "exact",
          "words": [
            "<string>"
          ]
        }
      },
      "triggers": [
        {
          "type": "keyword",
          "value": {
            "matchType": "exact",
            "words": [
              "<string>"
            ]
          }
        }
      ]
    }
  ]
}'

{
  "bids": [
    {
      "amount": 1,
      "bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bidsBehaviorData": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "formatProperties": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "isActive": true,
      "location": "Santiago",
      "state": "active",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "keyword",
        "value": {
          "matchType": "exact",
          "words": [
            "<string>"
          ]
        }
      },
      "triggers": [
        {
          "type": "keyword",
          "value": {
            "matchType": "exact",
            "words": [
              "<string>"
            ]
          }
        }
      ]
    }
  ],
  "hasMore": true,
  "next": {
    "limit": 123,
    "offset": 123
  }
}

General

Auction examples

Asset examples

Webhook examples

Auctions

Events

Toptimize

Offsite Ads API

Assets API

Billing API

Campaign API

Catalog API

Invitation API

Modal API

Reporting API

Segments Service

Toppie API

User API

Webhooks API

Path Parameters

Query Parameters

Body

Response