The Campaign API enables retailers to programmatically create and manage advertising campaigns for advertisers operating through their retail media program.
A campaign belongs to an advertiser and combines common advertising settings with configuration specific to the selected advertising channel.
Common Campaign Configuration
Common campaign properties describe characteristics that apply across multiple advertising channels.
Depending on the campaign, these can include:
Campaign Identity
Campaigns are assigned Symbiosys identifiers. Your retailer can also associate campaigns with identifiers maintained in your own systems.
Using a consistent retailer-provided identifier can make it easier to synchronize campaign records between your platform and Symbiosys.
Dates
Campaign configuration determines when advertising should begin and end.
Scheduling behavior may vary based on the selected advertising channel.
Budget
Campaigns define the amount available to spend and the applicable budget type.
Additional budget and pacing behavior can depend on the advertising channel and campaign type.
Objective
The objective describes the advertising outcome the campaign is configured to achieve.
Supported objectives vary by advertising channel and campaign type.
Bid Strategy
The bid strategy determines how bidding should be managed.
Available strategies and associated controls vary by channel. Some strategies may support additional parameters such as CPC limits or return-on-ad-spend targets.
Products
Applicable campaigns can define which products are eligible for advertising.
Product configuration can reference resources available within your retailer environment, such as merchants, brands, or individual products, depending on the channel and campaign type.
Geography
Applicable campaigns can define where advertising should be delivered.
Available geographic targeting options depend on the capabilities of the selected channel and your retailer configuration.
Channel Settings
Advertising platforms have capabilities that cannot always be represented through a single common campaign model.
The channel_settings portion of a campaign contains the additional configuration required for the selected advertising channel.
Depending on the channel, this can include:
-
Campaign settings
-
Targeting groups
-
Ad groups
-
Audiences
-
Placements
-
Assets
-
Product configuration
-
Optimization settings
The API Reference provides the complete schemas and supported values for each channel.
Campaign Types
The V3 API supports campaign configurations across multiple advertising channels and campaign types.
Examples represented in the API include:
-
Shopping
-
Performance Max
-
Search
-
Demand Gen
Meta
-
Campaign configurations supporting prospecting and retargeting use cases
-
Advantage+ audience capabilities
-
Channel-specific targeting groups
DoorDash
-
Sponsored Products
-
Sponsored Brands
The campaign types and capabilities available to your integration depend on your retailer and advertiser configuration.
Capabilities Vary by Channel and Advertiser
A property being represented in the overall campaign model does not necessarily mean it is available for every campaign.
Support for a particular:
-
Campaign type
-
Bid strategy
-
Placement
-
Audience type
-
Product setting
-
Asset type
-
Optimization option
can depend on your retailer configuration, advertiser configuration, selected advertising channel, and campaign type.
Your integration should use the applicable advertiser configuration and API schemas to determine which capabilities are available.
API Reference
For campaign endpoints, request and response schemas, channel-specific models, and supported values, see the V3 API Reference.