Authorizations
A valid API key generated in Topsort's UI.
Path Parameters
The ID of the campaign.
Body
Public Campaign Update Request Body
The objective of the campaign, only for autobidding campaigns.
impressions, clicks, conversions, revenue The budget of the campaign.
The bidding type of the campaign. Can only be updated to autobidding.
autobidding How campaigns are going to be charged, by click, by per mille impressions, or by action.
CPM, CPC, CPA When should the campaign stop. Must be greater than start date.
The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.
Whether the campaign should be active/inactive.
Whether the campaign is auto-triggered.
Whether the campaign is smart.
The multipliers of the campaign.
The name of the campaign.
1"Bola-Bola Ad campaign"
The product IDs to be used in the banner campaign. This is only allowed for banner campaigns. When provided, the assets will be associated to the given product IDs.
1 - 200 elementsWhen should the campaign start. If the start date is in the past, it will be set to the current date.
The approval status of the campaign, if it's a banner campaign.
approved, pending, rejected The ID of the user who approved the banner campaign.
Indicates the vendor's goal. For banners, use autobiddingObjective instead. ROAS >12 is rare and depends on product metrics and attribution model.
0.5 <= x <= 20The segments that the campaign will participate for (and will not for other segments not here).
Response
Successful Response
The campaign model.
The ad format of the campaign. Can be listing or banner.
listing, banner, sponsored_brand, exclusive_listing, exclusive_banner, travel_listing, flight_listing The amount of active bids associated with this campaign.
The ID of the campaign.
The bidding method for the campaign.
manual, autobidding, exclusive How campaigns are going to be charged, by click, by per mille impressions, or by action. Campaign charge type.
CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.
CPM, CPC, CPA When was this campaign created.
The end date of the campaign.
The ID of the vendor. Deprecated. Use vendor_id instead.
1Whether this campaign is active.
Whether the campaign is auto-triggered.
Whether this campaign is "smart".
The ID of the marketplace.
The name of the campaign.
1"Bola-Bola Ad campaign"
The starting date of the campaign.
Represents the review status of a banner campaign.
approved, pending, rejected The ID of the vendor.
1The uuid of the wallet to be used with this campaign.
The autobidding objective for the campaign.
impressions, clicks, conversions, revenue The budget assigned to the campaign.
Deprecated. This field is always null. For behavioral data use reporting service.
Deprecated. This field is always null. For behavioral data use reporting service.
Daily price for an exclusive campaign, can only be set if a campaign is exclusive
The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.
The multiplier configuration for the campaign.
Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.
The ID of the user who reviewed the campaign. If it's null and the status is not "pending" then it means this campaign has autoapproval status.
The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.
The segments that the campaign will participate for (and will not for other segments not here).