Skip to main content
GET
Get a sponsored brand campaign.

Autorizações

Authorization
string
header
obrigatório

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 caminho

campaign-id
string<uuid>
obrigatório

The ID of the campaign.

Resposta

Successful Response

A regular sponsored brand campaign returned by the public API.

campaignId
string<uuid>
obrigatório

The ID of the campaign.

marketplaceId
string<uuid>
obrigatório

The ID of the marketplace.

vendorId
string
obrigatório

The external vendor ID.

name
string
obrigatório

The name of the campaign.

Minimum string length: 1
Exemplo:

"Bola-Bola Ad campaign"

isActive
boolean
obrigatório

Whether the campaign is active.

status
enum<string>
obrigatório

The approval status of the sponsored brand campaign.

Opções disponíveis:
approved,
pending,
rejected
isAutoTrigger
boolean
obrigatório

Whether the campaign is auto-triggered.

slotId
string
obrigatório

The external slot ID where the sponsored brand campaign is shown.

schedule
Schedule · object[]
obrigatório

The schedule for the campaign.

Required array length: 1 element
content
Content · object
obrigatório

Dynamic content validated against the slot's JSON template.

createdAt
string<date-time>
obrigatório

When this campaign was created.

updatedAt
string<date-time>
obrigatório

When this campaign was last updated.

bidType
enum<string>
obrigatório

The bidding type of the campaign.

Opções disponíveis:
manual,
autobidding
isAgency
boolean
obrigatório

Whether this campaign is promoted by an agency.

chargeType
enum<string>
obrigatório

How campaigns are charged.

Opções disponíveis:
CPM,
CPC,
CPA
budget
Budget · object
obrigatório

The assigned budget for the campaign.

externalCampaignId
string | null

The external ID of the campaign in the marketplace.

walletId
string<uuid> | null

The uuid of the wallet used with this campaign.

targetRoas
number | null

Indicates the vendor's target return on ad spend.

Intervalo necessário: 0.5 <= x <= 30
targetRoasPreference
enum<string> | null

Target ROAS preference label.

Opções disponíveis:
aggressive,
conservative,
moderate,
custom
autobiddingObjective
enum<string> | null

The objective of the campaign.

Opções disponíveis:
impressions,
clicks,
conversions,
revenue