Campaign API

[BETA] Create exclusive banner campaign.

Endpoint to create exclusive banner campaigns and its respective bids.

Exclusive campaigns override auctions and are always shown by a fixed daily price.

post/public/v1/campaign-service/campaigns/exclusive-banner

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner
  • Auth: HTTP bearer

Query parameters

vendor_idstring required

The ID of the vendor.

Request body

namestring required

The name of the campaign.

isActiveboolean

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

externalCampaignIdstring nullable

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

isAutoTriggerboolean

Whether the campaign is auto-triggered.

startDatestring date-time required

When should the campaign start. If the start date is in the past, it will be set to the current date.

endDatestring date-time required

When should the campaign stop. Must be greater than start date.

exclusivityPriceinteger required

The price to pay daily for the campaign to run.

positioninteger

The rank the ad will have in the auction

walletIdstring uuid nullable

The uuid of the wallet to be used with this campaign.

impressionsThresholdinteger nullable

Impressions allowed for the campaign before it is stopped.

exclusivityPercentagenumber nullable

Percentage of auctions the campaign will be exclusive in.

status'approved' | 'pending' | 'rejected'

Represents the review status of a banner campaign.

productIdsstring[]

The product IDs to be associated with the exclusive banner campaign. When provided, replaces the existing set of products on the campaign.

mediaType'video'

Media type for banner campaigns. Video campaigns can receive video events.

Example request

{
  "name": "Bola-Bola Ad campaign",
  "bids": [
    {
      "location": "Santiago",
      "target": {
        "id": "p_8983"
      },
      "formatProperties": {
        "bannerAssets": [
          {
            "contentType": "image/png",
            "dimensions": {
              "width": 1920,
              "height": 1080
            },
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca"
          }
        ]
      }
    }
  ]
}

Response

Successful Response

namestring required

The name of the campaign.

isActiveboolean

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

externalCampaignIdstring nullable

The external ID of the campaign in the marketplace.

isAutoTriggerboolean

Whether the campaign is auto-triggered.

marketplaceIdstring uuid required

The ID of the marketplace.

campaignIdstring uuid required

The ID of the campaign.

startDatestring date-time

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.If the start date is in the past, it will be set to the current date.

endDatestring date-time

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

exclusivityPriceinteger required

The price to pay daily for the campaign to run.

bidType'exclusive'

The bidding type of the campaign.

createdBystring uuid nullable

The ID of the user creating the campaign.

chargeType'DAILY' required

Charge types for exclusive campaigns.

positioninteger

The rank the ad will have in the auction

campaignType'manual' | 'autobidding' | 'exclusive' required

The bidding method for the campaign.

status'approved' | 'pending' | 'rejected'

Represents the review status of a banner campaign.

adFormat'exclusive_banner' required

The ad format of the campaign. Can be exclusive_banner.

vendorIdstring required

The marketplace's ID of the vendor.

impressionsThresholdinteger nullable

Impressions allowed for the campaign before it is stopped.

exclusivityPercentagenumber nullable

Percentage of auctions the campaign will be exclusive in.

walletIdstring uuid required

The uuid of the wallet to be used with this campaign.

mediaType'video'

Media type for banner campaigns. Video campaigns can receive video events.

Example response

{
  "name": "Bola-Bola Ad campaign",
  "adFormat": "exclusive_banner"
}

Changes

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