Update Campaign By Id
Endpoint to update fields for a given campaign.
Path Parameters
The ID of the campaign.
Body
The budget of the campaign.
The bidding type of the campaign. Can only be updated to autobidding
.
autobidding
When should the campaign stop. Must be greater than start date.
Whether the campaign should be active/inactive.
Whether the campaign is smart
.
The name of the campaign.
When 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.
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.
Response
The ad format of the campaign. Can be listing or banner.
listing
, banner
The amount of active bids associated 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.
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.
Daily price for an exclusive campaign, can only be set if a campaign is exclusive
The external ID of the campaign in the marketplace.
The ID of the vendor. Deprecated. Use vendor_id instead.
Whether this campaign is active.
Whether this campaign is "smart".
Whether this is a promoted shop campaign.
The ID of the marketplace.
The name of 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 starting date of the campaign.
Represents the review status of a banner campaign.
approved
, pending
, rejected
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 ID of the vendor.
The uuid of the wallet to be used with this campaign.