The Campaign object contains the details of the campaign the advertiser would like to run, along with a list of units. It starts out as a proposal, then moves into a booked state once purchased.
Show Guaranteed Campaign Auto Avails
Returns how far the campaign's automatic avails requests have got. Poll it after you create a campaign.
It covers the supplier avails requests (the supplier APIs and the managed vendors) only.
It does not include manual RFPs and has no timeout, so it can differ from the campaign's
availability_status.
auto_avails_status | auto_avails_percent |
|---|---|
not_requested | 0 |
in_progress | 0-99 |
completed | 100 |
path Parameters
campaign_tokenCampaign token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Show Guaranteed Campaign Auto Avails › Responses
successful
auto_avails_statusauto_avails_percentGuaranteed Campaign Collection
Returns a paginated collection of guaranteed campaigns for the authenticated partner. Supports optional filtering by status and date range. Archived campaigns are left out; pass archived=true to list those instead, each with its archived_at.
query Parameters
pagePage number (1-based)
per_pageNumber of records per page (max 100)
start_dateFilter campaigns with a start date on or after this date (YYYY-MM-DD)
end_dateFilter campaigns with an end date on or before this date (YYYY-MM-DD)
statusFilter by plan status
archivedWhen true, list only archived campaigns (and expose archived_at on each). Defaults to false, which lists only campaigns that have not been archived.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Guaranteed Campaign Collection › Responses
successful
Pagination metadata for paginated responses
Create Guaranteed Campaign
Creates a campaign for the authenticated partner. advertiser_id is the AdQuick advertiser id; start_date and end_date are optional. campaign_name is an alias of name, and the two may not disagree. A campaign with start_date, end_date and location_ids starts to request unit availability from suppliers; availability_status on show reports the progress.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Create Guaranteed Campaign › Request Body
user_emailCampaign owner email
sales_user_emailSales / Account Executive email
advertiser_idlocation_idsLocation ids, as listed by GET /v2/guaranteed/locations
fulfillment_user_emailAccount Manager email (optional)
namecampaign_nameAlias of name, as the payload reports it
start_dateend_datetarget_budget_centsTarget budget, in cents
media_type_idsMedia type ids, as listed by GET /v2/guaranteed/media_types
Create Guaranteed Campaign › Responses
campaign created
campaign_tokenShow Guaranteed Campaign
Returns a single guaranteed campaign by its token. Archived campaigns are still returned here, carrying the archived_at timestamp.
path Parameters
tokenCampaign token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Show Guaranteed Campaign › Responses
successful
campaign_tokencampaign_typecampaign_nameadvertiser_iduser_emailCampaign owner email
sales_user_emailSales / Account Executive email
fulfillment_user_emailAccount Manager email
start_dateend_datetarget_budget_centstarget_cpmestimated_impressionsscreen_countavailability_statusgeographiesmedia_typesarchived_atOnly present when the campaign is archived
Archive Guaranteed Campaign
Archives a guaranteed campaign: it leaves the default collection (list it with archived=true) and archiving it again returns 404, while show keeps returning it with archived_at set. Its units are preserved, and the campaign itself is only soft-deleted, so AdQuick can still restore it.
path Parameters
tokenCampaign token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Archive Guaranteed Campaign › Responses
campaign archived
campaign_tokenarchivedUpdate Guaranteed Campaign
Partially updates a guaranteed campaign. Every field is optional; only the fields present in the body are changed. target_budget_cents is in cents. advertiser_id is refused for a partner whose organization is the advertiser — their campaigns are scoped by it. campaign_name is an alias of name, and the two may not disagree. An empty fulfillment_user_email clears the account manager (refused once the campaign is booked); the three *_user_email fields refuse null, so omit a key to leave that field alone.
path Parameters
tokenCampaign token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Update Guaranteed Campaign › Request Body
namecampaign_nameAlias of name, as the payload reports it
user_emailReassign the campaign owner by email
sales_user_emailReassign the Sales / Account Executive by email
fulfillment_user_emailReassign the Account Manager by email, or send "" to clear it
target_budget_centsTarget budget, in cents
advertiser_idReassign the campaign to this AdQuick advertiser id
Update Guaranteed Campaign › Responses
campaign updated
campaign_tokencampaign_typecampaign_nameadvertiser_iduser_emailCampaign owner email
sales_user_emailSales / Account Executive email
fulfillment_user_emailAccount Manager email
start_dateend_datetarget_budget_centstarget_cpmestimated_impressionsscreen_countavailability_statusgeographiesmedia_typesarchived_atOnly present when the campaign is archived
Programmatic Campaign Collection
Returns a paginated collection of programmatic campaigns for the authenticated partner. Supports optional filtering by status and date range.
query Parameters
pagePage number (1-based)
per_pageNumber of records per page (max 100)
start_dateFilter campaigns with a start date on or after this date (YYYY-MM-DD)
end_dateFilter campaigns with an end date on or before this date (YYYY-MM-DD)
statusFilter by plan status
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Programmatic Campaign Collection › Responses
successful
Pagination metadata for paginated responses
Show Programmatic Campaign
Returns a single programmatic campaign by its token.
path Parameters
tokenCampaign token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key.
Show Programmatic Campaign › Responses
successful
campaign_tokencampaign_typecampaign_nameplan_tokenplan_nameadvertiser_idstart_dateend_datetarget_budget_centstarget_cpmestimated_impressionsscreen_countgeographiesmedia_types