Create Campaign
Endpoint to create a campaign with its respective budget and bids.
It is expected to use at all types of campaign creations.
Query Parameters
The ID of the vendor.
1Body
The request body of campaign creation.
An array of bids for this campaign.
The bidding method for the campaign.
manual, autobidding, exclusive The name of the campaign.
1The ad format of the campaign. Can be listing or banner.
listing, banner The assigned budget for the campaign.
How campaigns are going to be charged, by click or by per mille impressions.ListingAd campaigns are charged per click by default.BannerAd campaigns are charged per mille impressions by default.
CPM, CPC 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.
The external ID of the campaign in the marketplace.
Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.
Whether the campaign is smart.
Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.
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.
For a banner campaign, its initial review status.
approved, pending, rejected This is an indication of the vendor's advertising goals. However, a high ROAS (>12) is generally hard to achieve and depends on the metrics of the advertised products and the purchase attribution model used by the marketplace.
0.5 < x < 20The uuid of the wallet to be used with this campaign.
Response
The campaign model.
The ad format of the campaign. Can be listing or banner.
listing, banner 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 or by per mille impressions
CPM, CPC 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 this campaign is "smart".
The ID of the marketplace.
The name of the campaign.
1The 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 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.
Whether this is a promoted shop 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.