Zum Hauptinhalt springen
POST
Create Slot

Autorisierungen

Authorization
string
header
erforderlich

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.

Body

application/json

Category or search slot create request.

slotId
string
erforderlich

The unique external slot ID that represents the slot.

Minimum string length: 1
Pattern: ^[\w!\"#$%&'()*+,\-._/:;<>?@\[\]^\{\}~=\\]*$
Beispiel:

"sidebar-2"

dimensions
SlotCreateRequestDimensions · object
erforderlich

The dimensions of the slot per device type.

position
enum<string>
erforderlich
Verfügbare Optionen:
category,
search

Antwort

Successful Response

The ad config slot model.

id
string<uuid>
erforderlich

The ID of the ad config slot.

externalId
string
erforderlich

The external ID provided by marketplaces.

Minimum string length: 1
position
enum<string>
erforderlich

The position of the ad config slot.

Verfügbare Optionen:
landing,
category_search,
category,
search
marketplaceId
string<uuid>
erforderlich

The ID of the marketplace that the ad config slot belongs to.

dimensions
Dimensions · object
erforderlich

The slot dimensions. There can be at most one dimension for each device type.

Beispiel:
page
AdConfigPage · object | null

The page that the ad config slot belongs to. Only 'landing' slots can belong to a page.

isActive
boolean
Standard:true

Indicates whether the ad config slot is active. If false, the slot cannot be used in campaigns.