--- language: "en" --- # Symbiosys Documentation Center ## Documentation * ### [Retailer Onboarding Guide](https://docs.symbiosys.ai/ss/integration-guide-for-retailers.md) Learn about the retailer onboarding process. * ### [Release Notes](https://docs.symbiosys.ai/ss/release-notes-1.md) Stay up to date on the latest product features and enhancements. * ### [Symbiosys API](https://docs.symbiosys.ai/ss/symbiosys-api.md) Build with the Symbiosys campaign and reporting API. --- language: "en" --- # API Reference For endpoints, request parameters, response schemas, available metrics, filters, and supported values, see the [++API Reference++](https://api.symbiosys.ai/v3/docs). --- language: "en" --- # April 2025 ## Release 3.5 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Snapchat Integration 1. Single Image \& Single Video ad formats support 2. Traffic \& Awareness objective support 3. Detailed Interest Targeting (aka Demographics ) 4. Lifetime budget support 2. Pinterest Integration Enhancements 1. Single Image \& Single Video ad formats support 2. Detailed Targeting 3. Multi-targeting groups 4. Multi-ad formats 5. Traffic \& Awareness objective support 3. Advertiser Configuration Changes 1. Additional Advertiser DFI Fields 2. "\ Funded" Billing Type 4. User login - switch to using a new solution that allows for logging in via Microsoft, Google, or a verification code 5. Misc. enhancements and user experience improvements --- language: "en" --- # April 2025 Release 2 ## Release 3.6 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Unified geolocation targeting campaign controls for retailers 2. SnapChat 1. Managed audience creation - custom and lookalike 3. Pinterest 1. Managed audience creation - custom and lookalike 4. YouTube 1. Lifetime budgets 5. Meta 1. Validation for Collection ad formats to require four unique products in the product set 2. Frequency cap default update 6. Retailer Audience Manager UX improvements 7. Asset redirect URL extension validation 8. Product Targeting - No Filter product list download 9. Misc bug fixes and UX improvements --- language: "en" --- # April 2026 ## Release 3.19 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ### **1. Meta Post Boost Ads** Post Boost ads are now available within the Meta campaign workflow, enabling advertisers to leverage existing organic retailer posts. To use this feature, a Post Boost asset must first be created in the retailer console using the post ID from the retailer's organic post. Once created, the asset can be selected as a Single ad format (non-catalog) within the campaign workflow. ![image-20260401-141739.png](https://docs.symbiosys.ai/__attachments/a_09ae5b5077292072a6e48af3734f464724073279468adf1afd80a7fa3c9221b4/image-20260401-141739.png?cb=47f67331e505326d59f1212cb56813c1) Post Boost Asset Creation - Retailer UI ![image-20260401-142056.png](https://docs.symbiosys.ai/__attachments/a_df4935bbf73eccf1be0fff06d3e82a187e54662505ac869bd2f61e5854f18f2f/image-20260401-142056.png?cb=92e271d0b8f4af82482bde6344eedea9) Single Catalog Off Post Boost Ad ### **2. Meta Comscore Market Geo-Targeting (US Only)** A new advanced geo-targeting option using Comscore Markets is now available for Meta campaigns. Markets can be included or excluded to refine targeting. This setting is enabled by default for retailers and is available to advertisers with the Advanced Geo-targeting access control enabled on their account. Find more information on Meta's Comscore Market targeting [here](https://www.facebook.com/business/help/709868688063859?id=176276233019487). *Note: This is available for US markets only.* ![image-20260401-141620.png](https://docs.symbiosys.ai/__attachments/a_823823329741431ea90c01ba4ad6185457ff7620fc3a1a846878ef5b08e9864a/image-20260401-141620.png?cb=ff578e5bb3d705dd7deb917bf9c56d54) Meta Comscore Market Geo-Targeting ### **3. YouTube Video Upload within Asset Creation** Asset creation for YouTube has been enhanced to allow for advertiser self-service video uploads to the retailer's channel. Uploaded assets will follow the standard asset approval workflow prior to activation. *Note: This feature is available for opted-in retailers only. Please reach out to your account manager for more details.* ![image-20260402-141040.png](https://docs.symbiosys.ai/__attachments/a_01767c37a1557eb0bd1dfb5d7852f13915a4bc9e61cd172d97664573fd606d72/image-20260402-141040.png?cb=179ce61aa9204a71ca5624a825cf0514) YouTube Asset Creation - Media File Upload ### **4. Campaigns Report - New Google Segment by Network Type** A new campaign reporting segment is available for Google and YouTube campaign types using Google's Ad Network Type breakout. This segment is available to retailers and optionally available to advertisers with channel targeting access and Google or YouTube channel access. ![image-20260401-143242.png](https://docs.symbiosys.ai/__attachments/a_de6b6aa96a014805856d1c42466c8fcc0568b1da21d1c04ee96c91d6aa289280/image-20260401-143242.png?cb=5ec1764e5b4217df6343f8333712c8a6) Google Segment by Network Type ### **5. Retailer Funded Campaigns** A retailer funded designation is available during retailer campaign creation to streamline retailer-led ad operations. Retailer funded campaigns: * Can be created within the retailer console only * Are visible to advertisers with limited editing capabilities * Are exempt from margins, budget match, and collaborative bidding Existing advertisers with a Retailer Funded billing type will have their existing campaigns transition to retailer funded campaigns as part of this rollout. Several new cost reporting columns have been added to the retailer Campaigns report. ![image-20260401-152850.png](https://docs.symbiosys.ai/__attachments/a_b2f0a56c54b36d36b371ca6946dcfa2a897be99a41dba8c4a5163287d3f60d4c/image-20260401-152850.png?cb=952cb6ef1287a96fd32bb21dc30c7f74) Retailer UI - Retailer Funded Designation ### **6. Miscellaneous improvements and bug fixes, including but not exclusive of the following:** * **Update Bulk Product ID Search:**Bulk searches of 6 or more product IDs within the product targeting module now use an exact match methodology. * **Audience Manager - Audience Details Improvement:** Audience channel details are now visible in a table view within the audience detail page and as an overlay within the audience table. * **Retailer Document Center Navigation:**A direct link off to the Symbiosys document center has been added to the retailer global navigation bar. * **Advertiser Cost (Local Currency):**A new reporting column is available on the retailer campaigns report to show the advertiser's cost financial amount in the localized currency. *We are continually deploying improvements between major releases.* --- language: "en" --- # April 2026 Release 2 ## Release 3.20 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **1. New Retailer Budget Match Module** Budget Match has been moved out of the Collaborative Bidding Strategies module and into a new, dedicated Budget Match module. The new module provides retailers with more flexibility and control when managing advertiser budget match settings. This dedicated module unlocks several new capabilities: * Support for lifetime budget campaigns. * Expanded budget match limit options. * Ability to apply budget match as a percentage or fixed amount. * Improved visibility into the applicable campaigns. ![image-20260420-164203.png](https://docs.symbiosys.ai/__attachments/a_3b216e78a5a25ae4529b63e3d9d047b15b646bf92131b5a98010fa6f2751446c/image-20260420-164203.png?cb=5b6ccb58d0916878b2d1a5a46990c340) New Budget Match Setup ### Retailer Campaign Workflow Budget Match Updates Within the retailer campaign management workflow, a new section is added in the Budget and Bidding step to designate budget match scenarios that apply to the campaign. ![image-20260420-164421.png](https://docs.symbiosys.ai/__attachments/a_d7c194e677e3c9fdc81e5c1ad916c345a3168bc8ebff1fde5c8362725f47b92d/image-20260420-164421.png?cb=38c531cb21e80e6a1640876db8995240) Retailer Campaign Budget and Bidding Step - Budget Match Designation ### Retailer Budget Match Reporting Improvements The Retailer Budget Match Channel Cost is a new, optional reporting column within the retailer Campaigns report. This field reflects the retailer spend driven by budget match scenarios managed via this new Budget Match module. ### **2. Miscellaneous improvements and bug fixes, including but not exclusive of the following:** * **Retailer Campaign ID 3:**Introduced a new, optional field in the retailer campaign workflow to support enhanced campaign classification for growing retailer programs. When used, the field appears in the campaign summary and Campaigns reporting. All Retailer Campaign ID fields remain hidden from advertisers. --- language: "en" --- # September 2025 ## Release 3.11 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* 1. **Campaigns Report - Tool Tips on Column Header Rollover** ![image-20250827-141054.png](https://docs.symbiosys.ai/__attachments/a_87e803022676e346d1565a1732479690ac6fe950ada269ce90b1b7910f53322a/image-20250827-141054.png?cb=96051711c5d0b4d7c3fc9c5ee05dc1c6) Tool Tips on Column Header Rollover - Campaigns Report 2. **Enhanced Retailer Controls - Advertiser Ad format/ Campaign Type Access Management** ![image-20250827-141013.png](https://docs.symbiosys.ai/__attachments/a_4712fdf9923d2dba248a65d12e73e905d010520a91cd16e77d2a87080e531fef/image-20250827-141013.png?cb=621e5718eb6bc4e02cbae3615ce23617) Enhanced Advertiser Channel Access Controls *Note: Existing campaigns that use an ad format or campaign type previously enabled and later disabled will remain editable by advertisers. New advertiser campaigns will reflect the ad formats access at time of creation. Campaigns created in the retailer console on behalf of the advertiser will show all ad formats for a given channel.* 1. **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. Improved handling of large volume zip codes input for retailer campaign geo-targeting 2. Security updates 3. Additional column sorting in retailer Audience Manager 4. UX improvements when managing audiences in the advertiser edit workflow 5. TikTok minimum budget validation update to support campaign-level budget optimization 6. Logo rebranding 7. Budget Type column in Campaigns and Ads reports 8. Bulk user creation in User Management 9. \[RETAILER UI\] Channel geotargeting input UX improvements 10. Meta ad preview placement UX improvements --- language: "en" --- # August 2026 ## Release 4.4 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Analyze campaign performance with enhanced Ads and Purchased Products reporting and a new Targeted Keyword report * Optimize DoorDash on-site campaigns with auto-bidding, keyword targeting, day and week parting, and behavioral targeting * Enable self-service advertiser funding with the new Wallet experience * Build YouTube creatives with multiple aspect ratios for placement-level optimization ### **1. Reporting \& Insights: Enhanced Reporting Experience for Purchased Products and Ads** The reporting table and data visualization have been upgraded to improve report load times, streamline KPI tracking, and simplify table navigation. **Focus on the KPIs that matter:** select up to four scorecard metrics and collapse visualization areas when you need more table workspace. **Navigate large reports more easily:** persistent headers/footers and clearer column descriptions make detailed reporting easier to explore. **Export cleaner, more useful reports:** exports now include filtered totals, cleaner formatting, and no unnecessary row-index column. ![image-20260812-124711.png](https://docs.symbiosys.ai/__attachments/a_aa7e6084691f87636b5aa97444e932091389b7f6be69e80e8cfd5490feb3e68d/image-20260812-124711.png?cb=ba2e31bfcb6fb0500b32bbbd0239220a) Ads Enhanced Reporting Page *Availability:* * *All retailers and advertisers* ### **2. Performance Optimization: DoorDash On-site Campaign Optimization** ### Sponsored Products Campaigns **Auto-bidding and target ROAS** Automatically optimize bids toward campaign performance, with the option to set a target ROAS. Auto-bidding is the recommended bid strategy and default for new campaigns. **Keyword targeting** Use positive and negative keywords to refine where campaigns compete and reduce spend against lower-value searches. Auto-bidding is limited to negative keyword controls. **Placement bid overrides** Adjust bids by placement when using custom bidding for greater control over bidding optimization. Not supported when using auto-bidding. ### Sponsored Products and Sponsored Brands Campaigns **Day and week parting** Schedule campaigns around specific days and times to concentrate delivery during the periods that matter most. Not supported when using auto-bidding on Sponsored Products campaigns. **Behavioral targeting** Reach audiences based on observed brand or category shopping behavior, including shoppers who purchased, did not purchase, or have lapsed. Either category or brand-based targeting is optionally available but cannot be used in combination together. **Summary of Targeting Capabilities by Campaign and Bidding Type** | | **Sponsored Products - Custom Bidding** | **Sponsored Products - Auto Bidding** | **Sponsored Brands** | |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | Placement Bid Overrides | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | | Positive Keywords | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | | Negative Keywords | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | | Day and Week Parting | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![cross mark](https://docs.symbiosys.ai/__attachments/a_ee46857db271bcc7c4d2c86e3d66ec6ffa972a95239147adbe2dc628023c5bc0/atlassian-cross_mark?cb=a9c671cfc7809253be52d640dbbf1019) | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | | Behavioral Targeting | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | ![check mark](https://docs.symbiosys.ai/__attachments/a_25bb9ae05efb0e20b0fcec7ae317db60b7e52f5824c8eb962e3daaadbe3163b8/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) | *Availability:* * *Select retailers and advertisers with access to the DoorDash On-site Ads channel* ### **3. Wallet Self-Service Payment Integration** Enable self-service advertisers to fund their own accounts with Wallet, while giving retailers visibility into advertiser balances and transaction activity across their program. Retailers who have this module enabled will see a new Wallet option in their sidebar menu as well as wallet configuration within the advertiser set up workflow. * Advertisers can self-manage funding and view their transaction history. * When a channel balance reached $0, campaigns will automatically pause until additional funding is added. Retailers can use the new Wallet module to see global transaction activity and balances across advertisers within their program. *Note: The Wallet feature is limited to retailer on-site campaigns powered by Criteo. Additional channel support is planned.* ![image-20260812-132200.png](https://docs.symbiosys.ai/__attachments/a_0ea68255fbb282e1ee41af41e812cc2e8deee9d7efd97ab4ac0f9b7bbb0f2878/image-20260812-132200.png?cb=e4c7cdc5d74fb5464fa877acab666e6c) Wallet - Self-Service Advertiser Account Funding *Availability:* * *Select retailers and advertisers with on-site campaigns powered by Criteo.* ### **4. Reporting \& Insights: New Targeted Keyword Report** A new Targeted Keyword report enables performance analysis and optimization at the keyword grain for Criteo-powered on-site Sponsored Products campaigns. * Identify which targeted keywords are driving performance and use those insights to optimize Sponsored Products campaigns. * Segment results by time-based (non-hourly) breakouts. * Schedule reports, save column views, and download results to Excel and CSV. *Note: The Targeted Keywords report is limited to retailer on-site campaigns powered by Criteo. Additional channel support is planned.* ![image-20260714-165422.png](https://docs.symbiosys.ai/__attachments/a_d157c82b2b9667272470981386abf63f4377005400d2d6f7655ec65a5f634527/image-20260714-165422.png?cb=f340a2220285d117cdb0216b3fec9399) Targeted Keyword Report *Availability: All retailers and select advertisers with access to retailer on-site campaigns powered by Criteo* ### **5. Creative Optimization: YouTube Multi-Aspect Ratio Creatives** Create YouTube ads optimized for different placements by providing assets in multiple aspect ratios. In addition to the required media file, you can now upload up to two optional files using the supported aspect ratios. Supported aspect ratios include: * 16:9 * 9:16 * 1:1 *Note: These additional media files are used to customize the ad for specific YouTube placements.* ![image-20260812-135252.png](https://docs.symbiosys.ai/__attachments/a_cf5247b7a8c3bea38f3f2ae9c6769693917e84537fefc70d22a08b9f9a89b4ca/image-20260812-135252.png?cb=4614422a60f09ae5dcec4a52ec37e22e) YouTube Asset Creation - Multiple Aspect Ratio Files *Availability:* * *Select retailers and advertisers with access to the YouTube channel* ### Additional Improvements Also in this release: * **Book Now CTA:** Use the new "Book Now" call to action in Meta and TikTok assets. * **Budget match percentage of gross budget:** Define budget match scenarios using a percentage of the advertiser's gross budget amount. * **Multi-tab support:**Work across multiple browser tabs with independent platform sessions. * **Improved change history:** More precisely track campaign asset and ad status changes for easier campaign traceability. * **Quick campaign editing:** Jump directly from Promoted Products reporting into the campaign editing workflow. * **Criteo scheduled budget overrides:** Configure daily and monthly budget override schedules for Criteo-powered retailer on-site campaigns. * **Criteo attribution controls:**Limit advertiser access to campaign attribution setting overrides on Criteo-powered on-site campaigns with this new advertiser control toggle. * **Criteo keyword targeting strategy:** Target conquesting keywords through use of this new strategy setting for Criteo-powered retailer on-site campaigns. Limited retailer availability. * **Tool tip and validation improvements:**View updated tool tips and validation messaging to improve overall usability and campaign experience. *We are continually deploying improvements between major releases.* --- language: "en" --- # Campaigns 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: **Google** * Shopping * Performance Max * Search * Demand Gen **Meta** * Sales * Traffic * Awareness **DoorDash** * Sponsored Products * Sponsored Brands The campaign types and capabilities available to your integration depend on your retailer and advertiser configuration. Multi-channel campaigns are currently not supported in the external API. ## 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](https://api.symbiosys.ai/v3/docs). --- language: "en" --- # \*Channel Integration Symbiosys integrates with the following ad platforms. This section provides step-by-step guides for granting access and completing the setup. * Google Ads * Meta Ads (Facebook \& Instagram) * Microsoft Ads (Bing Ads) * Pinterest Ads * Snapchat Ads * TikTok Ads * YouTube Ads **Catalog Targeting** If you have multiple product catalogs/feeds in an ad platform, specify to your Symbiosys Sales Engineer which catalog should be targeted in Symbiosys campaigns. **Tracking \& Custom Parameters** Symbiosys automatically appends the below tracking parameters to ad URLs in campaigns managed through our platform. These parameters help with internal reporting and attribution. * `sym_campaign_id` * `sym_adset_id` (`adgroup_id` in Google Ads) * `sym_ad_id` * `sym_source` * `sym_medium` If you have specific tracking requirements, such as additional UTM parameters for your own reporting, please share these with your Symbiosys Sales Engineer during channel integration so they can be incorporated. --- language: "en" --- # Core Concepts The Symbiosys API provides retailers with a common interface for managing advertisers, campaigns, and advertising resources across supported channels. Understanding how these resources relate to your retailer environment will make it easier to navigate and integrate with the API. ## Resource Model At a high level, API resources are organized within your retailer context. Your Retailer │ ├── Advertisers │ │ │ └── Campaigns │ ├── Brands ├── Sellers ├── Chains ├── Merchants ├── Audiences └── Ads Accounts Your API credentials establish the retailer context and determine which resources are available to your integration. ## Your Retailer Context The retailer represents the top-level context for your API integration. You do not typically need to provide a retailer ID with every request. Your API credentials establish your retailer context and determine which advertisers, campaigns, and supporting resources your integration can access. Retailer-level resources can include brands, sellers, chains, merchants, audiences, and ads accounts. ## Advertisers Advertisers represent the brands or organizations that run advertising through your retail media program. Advertiser configuration determines which advertising capabilities are available when campaigns are created for that advertiser. Depending on your retailer configuration and the selected channel, advertiser configuration can include: * Country and currency * Available advertising channels * Supported ad formats * Ads accounts * Catalog and pixel configuration * Available audiences * Geo-targeting capabilities * Bid strategy controls * Product targeting capabilities * Product set optimization capabilities Retailers can use the Advertiser API to synchronize advertiser configuration between their own systems and Symbiosys. ## Campaigns Campaigns represent advertising activity created for advertisers within your retail media program. Retailers can use the Campaign API to create, retrieve, and manage campaign configuration programmatically. Campaigns combine common advertising properties with configuration specific to the selected advertising channel. Common properties can include: * Campaign name * External ID * Country * Objective * Start and end dates * Budget and budget type * Bid strategy * Product configuration * Geographic targeting * Asset configuration Channel-specific behavior is defined separately through the campaign's channel settings. See **Campaigns** for a detailed explanation of the campaign model. ## Retailer Resources Your retailer environment can expose supporting resources that are used when configuring advertisers and campaigns. These include: ### Brands Brands available within your retailer environment. ### Sellers Sellers available within your retailer environment. ### Chains Retailer chain information available to your integration. ### Merchants Merchant resources that can be referenced by applicable advertising configuration. ### Audiences Audiences your retailer makes available for advertising and targeting. Audience availability can depend on the advertiser and advertising channel. ### Ads Accounts Advertising platform accounts configured for your retailer. Ads account IDs may be required when configuring advertisers to use particular advertising channels. ## Symbiosys IDs and Retailer IDs Resources within Symbiosys are assigned Symbiosys IDs. Your retailer may also maintain its own identifier for the same advertiser, campaign, or other supported resource. For endpoints that support the `use_client_ids` parameter: use_client_ids=false indicates that supplied IDs should be interpreted as Symbiosys IDs. use_client_ids=true allows supported identifiers to be resolved using the corresponding retailer-provided ID. Using retailer-provided IDs can simplify synchronization between Symbiosys and your existing systems. ## Common Model, Channel-Specific Capabilities Symbiosys provides retailers with a common campaign model across supported advertising channels. Common advertising concepts are standardized where possible: Campaign ├── Dates ├── Budget ├── Objective ├── Bid Strategy ├── Products ├── Geography └── Assets Channel-specific configuration supplements this common model when an advertising platform requires additional settings. This allows your integration to use a consistent overall structure while still accessing capabilities unique to individual channels. Available configuration can depend on your retailer setup, the advertiser, selected channel, campaign type, and capabilities enabled for that advertiser. See **Campaigns** for additional information. --- language: "en" --- # December 2024 ## Release 3.2 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Meta and TikTok \> Support for multiple targeting groups 2. Bulk Campaign Editing 3. Campaign Duplication 4. Google \> Search Campaigns integration 5. Meta \> Traffic Objective with Catalog integration 6. Google \> Demand Gen Campaigns Integration 7. Google/YouTube \> Custom Audience creation --- language: "en" --- # December 2025 ## Release 3.15 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* **YouTube Targeting Group Upgrades:**The ability to pause a targeting group has been added to the YouTube campaign management workflow, as well as improvements with managing placement and network targeting settings independently. The detailed targeting selection now includes a search feature to streamline campaign setup. *Note: Placements and Networks targeting is available to advertisers when activated for their advertiser account.* ![image-20251212-180032.png](https://docs.symbiosys.ai/__attachments/a_f8278622de3df521312145bd1bb9a3be9f2a10731dca82bc9d2202ca87d65a3e/image-20251212-180032.png?cb=872e2a438b8125882c2929ca79f16b2a) YouTube Targeting Group Updates **Asset Creation Ad Layout Preview:**The asset creation workflow now includes an ad layout preview based on commonly used ad formats and placements supported for the asset type. These layouts appear on the right panel in the asset form for select channels and are there to help you identify the location of the ad components. *Note: Channels supported include Meta, TikTok, Google/YouTube, and The Trade Desk* ![image-20251212-175802.png](https://docs.symbiosys.ai/__attachments/a_7f03ebc483f74a0be9da6b692983962ec4fed4001fab542f8bc4e3de619fd2ea/image-20251212-175802.png?cb=48250036a77d6cf5c41449430a48ef03) Asset Ad Layout Preview **Meta Multi-Aspect Ratio Assets:**The Meta asset creation workflow now allows for 2 optional media files to be uploaded in addition to the 1 required media file. When creating a Meta asset, use the arrow to expand the optional section to select two additional media files using the specified aspect ratios. *Note: These additional media files are used to customized the ad for specific Meta placements using the single ad format for non-catalog campaigns. The Meta ad preview will utilize these additional media files when previewing specific placements.* ![image-20251212-175704.png](https://docs.symbiosys.ai/__attachments/a_26666585e5778a0d8f3d5c3e10cd26df817935c564fccc5f8805646b4e1d355e/image-20251212-175704.png?cb=835a2a8e4995039c2da23acaaa67b6d5) Meta Multi-Aspect Ratio Assets **\[LIMITED AVAILABILITY\] DoorDash Onsite Channel Integration:**DoorDash onsite campaign management and asset workflows are enhanced to include support for the Sponsored Brands campaign type. ![image-20251212-180425.png](https://docs.symbiosys.ai/__attachments/a_eaaf38b24e97341ddd5bc876c6b666ab0e5be959cefaaa32383d368f7979200a/image-20251212-180425.png?cb=f6de14684338aa6ed7989a18b955dd96) DoorDash Onsite Channel - Sponsored Brands Campaign Type **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. \[RETAILER UI\] New advertiser-level controls for exposing enhanced local ads on Google Shopping and disabling comments on TikTok 2. \[ADVERTISER UI\] We've rolled out Optimized Targeting control for YouTube campaigns and Campaign Brand Scope selection for all campaigns to all brand advertisers (retailer-limited). 3. Updated tooltips in campaign product targeting and campaign copy 4. Upgrades to The Trade Desk campaign and ad group goals and target KPIs --- language: "en" --- # \*Event Data Integration: Overview Symbiosys requires two event-level datasets, which are used for reporting, attribution, and optimization: * **page views**-- visit/click events, includes subsequent page views for web integration * **orders** -- purchase events Event data can be integrated using one or more of the below methods: * **\[Preferred\] BigQuery Transfer** --Send data directly from your data warehouse (or via GA4) to Symbiosys via BigQuery transfer. * **\[Preferred\] File Dump** -- Send CSV file dumps to Symbiosys via shared cloud storage bucket (e.g., GCS, S3, Azure). * **Event API Integration** -- Use the Symbiosys Event API to stream data directly from your site/app to Symbiosys via client- or server-side tag. ## High-Level Guidance To ensure accurate attribution, clean event data, and seamless troubleshooting, follow these best practices when integrating visit and order data: * **Start early.** Event data integration runs independently of feed/channel setup---handling both in parallel ensures a faster launch. Integration and validation may take longer than feed/channel setup, so an early start is key. * **Track web and app data.** While web tracking is the focus in the pilot phase, collecting app data is essential for optimizing performance, especially if most purchases occur in-app. * **Include all campaign traffic (Symbiosys \& non-Symbiosys).** Sending event data from all campaigns helps diagnose tracking issues, assess data health, and improve performance evaluation. * **Ensure full-site tracking.** Capture all key page views---not just landing pages and orders---to prevent session mismatches and incomplete attribution. * **Include child and parent SKU identifiers.** For retailers with parent/child product catalogs, send `product_id` (child SKU) and `item_group_id` (parent SKU) in product page-view events and each order line item. These identifiers should match the corresponding product feed records. This applies to all integration methods. Review any identifier gaps or differences with your Symbiosys SE during onboarding. * **Monitor user/session identifiers.** Ensure Visitor IDs persist across sessions and correctly transition to CRM IDs. Conduct internal audits for issues like ID duplication, session-based generation, or bot anomalies, and report any concerns to your Symbiosys SE. * **Comply with privacy rules.** Inform Symbiosys of any tracking restrictions due to user agreements or privacy laws. Symbiosys does **not** collect PII. ## Instructions 1. **Review data requirements.** 1. See [Event API Endpoints and Example Requests](https://docs.symbiosys.ai/ss/event-data-integration-event-api-endpoints-and-exa) for expected data points\*. 2. **Choose an integration method.** 1. See [Methods \& Data Sources](https://docs.symbiosys.ai/ss/event-data-sources-event-api-integration-methods) to determine the best approach. 3. **Ensure complete and accurate user/event coverage.** 1. See [Ensuring Accurate Tracking \& Data Integrity](https://docs.symbiosys.ai/ss/event-data-integration-ensuring-accurate-tracking-) for user/event tracking guidance. 4. **Integrate Using Your Chosen Method(s).** 5. **Validate event data integration.** 1. Work with your Symbiosys SE to validate and fine-tune the integration. *** ** * ** *** **\*** The example requests in the [Event API Endpoints and Example Requests](https://docs.symbiosys.ai/ss/event-data-integration-event-api-endpoints-and-exa) contain parameter requirements that are specific to the Event API, including your public API key. You will not require a key if integrating via data dump or direct transfer. However, independent of integration method, your event data should contain all other fields in the expected format --- language: "en" --- # \*Event Data Integration: BigQuery Transfer Symbiosys supports two methods for integrating event data via BigQuery (BQ): * Direct BigQuery Dataset Transfer -- transfer datasets directly in BQ. * Google Analytics 4 (GA4) BigQuery Export -- create a BQ export from GA4 data. ## Option 1: Direct BigQuery Dataset Transfer 1. **\[Optional\] Create a Filtered View** 1. If needed, create a view containing only the required visit/order event data. Here is an example view that excludes the user_properties field to prevent PII exposure. 2. **Note:** Promoting the _TABLE_SUFFIX is important for efficient query execution. CREATE VIEW GAIntraday AS SELECT _TABLE_SUFFIX AS suffix, * EXCEPT(user_properties) FROM DATASETNAME.analytics_1234.events_intraday_* 2. **Grant Access to Symbiosys** 1. Share your dataset with [**system@symbiosys.ai**](mailto:system@symbiosys.ai) and assign the following roles: 1. **BigQuery Data Viewer** (roles/bigquery.dataViewer) 2. **BigQuery Job User** (roles/bigquery.jobUser) 3. **Set Up a Data Export Schedule** 1. Ensure data is transferred on a regular cadence (hourly or at least once daily). ### Option 2: **Google Analytics 4 (GA4) BigQuery Export \& Sharing** 1. **Enable Intraday BigQuery Export in GA4** 1. Log in to **Google Analytics** , go to **Admin** , and navigate to **Data Streams**. 2. Click **BigQuery Export** and toggle **Enable Intraday**. 3. Choose a **Dataset Name** and **Table ID**, then select the fields to include. 4. Click **Link BigQuery** and follow the authorization prompts. 5. Alternatively, add [**symbiosys@symbiosys.ai**](mailto:symbiosys@symbiosys.ai) as a **user** in your BigQuery dataset, allowing Symbiosys to export the data to their GCP account. 2. **Share the Dataset with Symbiosys** 1. Assign [**system@symbiosys.ai**](mailto:system@symbiosys.ai) the **BigQueryDataEditor** role in IAM OR create a **new dataset view** that excludes PII and share that dataset with Symbiosys. --- language: "en" --- # \*Event Data Integration: Ensuring Accurate Tracking & Data Integrity Our minimum requirement is to collect landing page views (click-throughs) and order events. However, to ensure consistent data quality, accurate attribution, and seamless troubleshooting, please ensure event tracking is as comprehensive. Our ingested dataset should essentially mirror the data collected by your target ad channel. Additionally, ensuring **user identifiers (Visitor ID \& CRM ID)**are correctly assigned and maintained is essential to prevent misattribution, duplicate orders, and inaccurate reporting. ## Comprehensive Tracking Requirements * **Client- or server-side tag on your site/app** * Load the tag on all page types, not just landing and order confirmation pages. Do not apply restrictive load rules. * **Direct transfer or CSV file dumps** * If your data source captures subsequent page views between landing page view and purchase, include these in your transfer/dump * **Exception: App data** * Currently, we only require click-through (app opens with deep link URI) and order events for app data ingestion. No need to send in-app navigations. * **Consideration: User Opt Out** * Events for users that have opted-out of tracking should still be passed, and flagged with `user_opt_out:true`to exclude them from data processing (attribution and performance reporting). Ingestion of opted-out events prevents data fragmentation. ## Reasons for Comprehensive Tracking * **More Accurate Attribution** * Full tracking provides a complete picture of user behavior, reducing the risk of misattributed conversions. * If certain pages are excluded, tracking gaps can lead to over- or under-reported sales figures. * **Prevents Data Gaps from User Behavior** * Users enter the site through various landing pages---not just campaign-specific ones. * Ensuring all entry and exit points are tracked prevents incomplete user session data. * **Eliminates Unexpected Tag Behavior \& Improves Performance** * Restrictive tag load rules can cause inconsistent visitor ID tracking, which in turn breaks attribution logic. * Ensuring the tag loads everywhere prevents session mismatches and incomplete conversions. * **Ensures Reliable Event Data Validation** * Full-site tracking allows us to verify that key identifiers (gclid, page views, conversions) are captured correctly. * This reduces time spent troubleshooting missing or incorrect data post-integration. * **Minimal Performance Impact** * Our client-side tag is lightweight (\<1 kb), ensuring no noticeable impact on page load speed while significantly improving data integrity. ## Product Identifiers: Child and Parent SKUs For retailers with parent/child product catalogs, provide both levels of product identifiers in product page-view events and every order line item. This applies to web and app data, whether delivered through the Event API, file dumps, or direct transfers. | **Field** | **Identifier** | **Meaning** | |-----------------|----------------|---------------------------------------------------------------------------------------------------| | `product_id` | Child SKU | Identifies the specific product variant viewed or purchased, such as a particular size and color. | | `item_group_id` | Parent SKU | Identifies the product family that groups related child variants. | **Page views:** Include the viewed or selected child SKU and its parent SKU when the variant is known. **Orders:** Include the purchased child SKU and its parent SKU on each order line item, alongside that item's quantity and prices. Preserve separate child variants rather than combining them into a parent-only record. **Consistency with product feeds:** Use the corresponding catalog identifiers and preserve their original formatting, including leading zeros and capitalization. If identifiers differ across feeds or channels, provide the mapping to your Symbiosys SE during onboarding. **Exceptions:** If a page has no product context, a child variant has not yet been selected, or your catalog does not use parent/child groupings, agree the appropriate field handling with your Symbiosys SE. Do not substitute a parent SKU for a child SKU. **Validation:** Before launch, validate sample page views and orders for two child variants belonging to the same parent. Confirm that the child IDs are distinct, the parent ID is shared, and both match the corresponding catalog records. ## Ensuring User Identifier Integrity (Visitor ID \& CRM ID Tracking) Beyond full-site tracking, correct user identifier assignment is crucial to prevent attribution errors and to ensure clean event data. A common issue occurs when a single visitor ID is linked to multiple CRM IDs, which can distort reporting. If you're aware of any nuances in how visitor or CRM IDs are assigned---such as session-based ID generation, customer service representative (CSR) workflows, or account merging rules---please inform us so we can account for these factors and ensure accurate tracking. Below are some common causes of identifier issues: * **Customer Service Representative (CSR) Logins** * **Issue:** Some CSR tools allow agents to log in as customers without properly resetting the visitor ID. * **Impact:** This can cause hundreds of customer accounts to appear under a single visitor session, inflating conversion data. * **Fix:** If CSRs frequently place orders for customers, visitor IDs should reset upon login to prevent session contamination. * **Duplicate or Merged CRM Records** * **Issue:** CRM systems may create multiple CRM IDs for the same user due to session-based ID generation, data imports, or account duplication. * **Impact:** Users may appear as multiple distinct customers, inflating order volume and misaligning campaign attribution. * **Fix:** Review how visitor IDs persist across sessions and devices to ensure that CRM IDs are assigned correctly. * **Bot or Automated Traffic** * **Issue:** Bots, scraping tools, or automated scripts can generate artificial CRM IDs tied to a single visitor ID. * **Impact:** This can lead to unnatural spikes in order volume or user activity, distorting performance metrics. * **Fix:** Conduct traffic analysis to detect bot-like behavior and ensure account creation processes prevent automated duplication. ## Observance of Privacy Law Symbiosys is fully compliant with broader privacy regulations (e.g. GDPR, CCPA, LGPD): * Symbiosys does NOT request, ingest, process or store PII. * Required user fields (visitor ID, CRM ID, hashed email, session ID) are anonymized and can't be used to personally identify a user. * Symbiosys does NOT share event data with third parties. * Symbiosys retains event data for 13 months by default, but this can be adjusted if needed. ## Consent-based Tracking Symbiosys only processes data for users that have not opted out of event tracking. Our data model supports an optional opt-out flag in the `user_opt_out`field. * If `user_opt_out:true`, the event is ingested, but not processed, meaning it's excluded from attribution and performance reporting. * If `user_opt_out:true` and the click page view URL contains a privacy identifier passed by the target ad channel (e.g., `gbraid`), Symbiosys defaults to using this this privacy identifier in place of the channel click identifier. * If `user_opt_out:false` or its not explicitly passed, the user's session data is processed normally. If your user agreement has other tracking stipulations, share these with your Symbiosys SE to ensure we're in full compliance. --- language: "en" --- # \*Event Data Integration: Event API Endpoints and Example Requests ## Authentication The API supports API Key authentication. Symbiosys will provide you with dev/prod API keys. **Note:** The Event API is only to be used for real-time event tracking via tag (client- or server-side). If you are integrating via file dump or direct transfer, Symbiosys will provide you with GCS bucket details and/or service keys. In this case, you should still use this document as a reference for data requirements. ### Endpoints The API has both GET and POST endpoints: * **GET Endpoints:** * Used for client-side integrations (e.g., GTM client-side). These are ideal for lightweight event tracking like page views or clicks, with data sent via URL query parameters. * **POST Endpoints:** * Used for server-side and app integrations (e.g., sGTM). These support larger payloads, complex data structures, batch processing, and secure transmission of sensitive data in the request body. * **Notes**: * The parameter names are not 1:1 for GET and POST requests. The GET requests use a shorthand naming scheme. * The endpoints are not 1:1 for GET and POST requests (e.g., the order endpoint name is pluralized for POST). * **Testing**: * When testing your API implementation in a testing/staging environment, be sure to use your **dev** **API key** and you should point the **dev endpoints** by replacing the top-level `.ai` domain with `.dev` in your request like so: * `https://event.symbiosys.dev/page_viewjs?api_key={dev_api_key}&...` * **EU production endpoint**: * If your business is based in Europe, use the EU endpoint for production traffic only. * Point to the EU endpoint by adding `eu.` subdomain before `event` like so: * `https://eu.event.symbiosys.ai/page_viewjs?api_key={prod_api_key}&...` * You should still use the `.dev`endpoint from the previous step for testing. **GET** `/page_viewjs` Example URL: https://event.symbiosys.ai/page_viewjs ?api_key=************************** &ts=1729696661986 &vid=01929d42ae1a0016c0cebe6dd43a0508900160810056a &sid=1729694623545 &crmid=119583788 &hashed_email=c61ca4013045d4992166ed703a736fbb7e6d0c3b831ff0721eaf953d460ff0a9 &hashed_phone_user=7b7bc2512ee1fedcd76bdc68926d4f7b4ad6eec7e1f1abf2a5e93df18bafad8e &hashed_phone_e164_user=bd99f4a2bda3f841d3f9a78cf39aa0d6ed7ac712a967351a51915d6c9837c1c3 &hashed_date_of_birth_user=32d10c7b8cf96570ca04ce37f2a19d84240d3a89e9c171a8f2f64d4e6b8f6e63 &hashed_first_name_user=a7d3e6d93b41f6a4941347ecb2e3cb5debe8272b2f8a60d2411b5acb739e6ef3 &hashed_last_name_user=77b7bbefbf6b6317014acded918b6e253a652d48970ee2f40f9f0f7d11f9e5f6 &hashed_zip_code_user=dc5a53bbedf238b49ef3ea7f41b5d64c8b993c79b7ae9c5b314ab29fa96cf6fa &hashed_city_user=8e9b752be8b1b1c8a76f96e50794e9d45ed4cb16a4fa1a6f2b70f8eebd8ef1be &hashed_state_user=f84e3c5642a9074536bb68bcb1b99c6a8a97aaab618c2d70ae007eac8315c6ff &uaclid=false &aclid=zxck87hwbasduuvgaosdf_afl &page_url=https%3A%2F%2Fwww.retailer.com%2Fshop%2Fproduct%2Fproduct170830%3Fgclid%3DCjwKCAiAneK8BhAVEiwAoy2HYQpFqiwODAaicabsXW_8vWawqji1354WiCHj15ZEygWv4sAnqfOBUxoCg-MQAvD_BwE &ch=google &cclid=CjwKCAiAneK8BhAVEiwAoy2HYQpFqiwODAaicabsXW_8vWawqji1354WiCHj15ZEygWv4sAnqfOBUxoCg-MQAvD_BwE &ccmp_id=342524 &prodid=170830 &item_group_id=3845239 &category_id=30087 &seller_id=18231233 &brand=nike **GET** `/orderjs` Example URL: https://event.symbiosys.ai/orderjs ?api_key=************************** &ts=1729696661986 &vid=01929d42ae1a0016c0cebe6dd43a0508900160810056a &sid=1729694623545 &crmid=119583788 &hashed_email=c61ca4013045d4992166ed703a736fbb7e6d0c3b831ff0721eaf953d460ff0a9 &hashed_phone=9f9d51bc70ef21ca5c14f307980a29d8d6eb68e4b5cf1e6a0e94d1c2c84e6f4d &hashed_phone_user=7b7bc2512ee1fedcd76bdc68926d4f7b4ad6eec7e1f1abf2a5e93df18bafad8e &hashed_phone_e164=ee26b0dd4af7e749aa1a8ee3c10ae992e9a9d7e40452a7c3a2e0a69fef6f1f7c &hashed_phone_e164_user=bd99f4a2bda3f841d3f9a78cf39aa0d6ed7ac712a967351a51915d6c9837c1c3 &hashed_date_of_birth=98b2979503d318edb1f6d1b802b4e6e0f90d43e5c5c91c1057b5d8a455b53c9b &hashed_date_of_birth_user=32d10c7b8cf96570ca04ce37f2a19d84240d3a89e9c171a8f2f64d4e6b8f6e63 &hashed_first_name=fbade9e36a3f36d3d676c1b808451dd7f7d011e7e50ddaa6f31bfb4e08b0e4a8 &hashed_first_name_user=a7d3e6d93b41f6a4941347ecb2e3cb5debe8272b2f8a60d2411b5acb739e6ef3 &hashed_last_name=4d186321c1a7f0f354b297e8914ab240e1dbb3f9842f53c111ed84fd0f9f9c5b &hashed_last_name_user=77b7bbefbf6b6317014acded918b6e253a652d48970ee2f40f9f0f7d11f9e5f6 &hashed_zip_code=0b4e7a0e5fe84ad35fb5f95b9ceeac79e4f9c11edaaef9c13d37b12cc9cfcc76 &hashed_zip_code_user=dc5a53bbedf238b49ef3ea7f41b5d64c8b993c79b7ae9c5b314ab29fa96cf6fa &hashed_city=6c3e226b4d4795d518ab341b0824ec29d996fc862f451c3dfe2a4ed29fc4b8e2 &hashed_city_user=8e9b752be8b1b1c8a76f96e50794e9d45ed4cb16a4fa1a6f2b70f8eebd8ef1be &hashed_state=907d14fb3af2b0d4f18c2d46abe8aedce17367bd2d46c9fa3c8f1b60c2549cd8 &hashed_state_user=f84e3c5642a9074536bb68bcb1b99c6a8a97aaab618c2d70ae007eac8315c6ff &page_url=https%3A%2F%2Fwww.retailer.com%2Fcheckout &prodid=170830~238443 &item_group_id=3845239~2342384 &category_id=30087~72342 &seller_id=18231233~23434232 &brand=nike~reebok &oid=238476923 &qty=1~1 ®unitpr=10.00~20.00 &disunitpr=5.00~20.00 **POST** `/page_view` Request body Example: { "headers": { "api_key": "**************************" }, "body": { "page_view_ts": 1649171323777, "platform": "app", "visitor_id": "01929d42ae1a0016c0cebe6dd43a0508900160810056a", "session_id": "1729694623545", "crm_id": "119583788", "hashed_email": "c61ca4013045d4992166ed703a736fbb7e6d0c3b831ff0721eaf953d460ff0a9", "hashed_phone_user": "7b7bc2512ee1fedcd76bdc68926d4f7b4ad6eec7e1f1abf2a5e93df18bafad8e", "hashed_phone_e164_user": "bd99f4a2bda3f841d3f9a78cf39aa0d6ed7ac712a967351a51915d6c9837c1c3", "hashed_date_of_birth_user": "32d10c7b8cf96570ca04ce37f2a19d84240d3a89e9c171a8f2f64d4e6b8f6e63", "hashed_first_name_user": "a7d3e6d93b41f6a4941347ecb2e3cb5debe8272b2f8a60d2411b5acb739e6ef3", "hashed_last_name_user": "77b7bbefbf6b6317014acded918b6e253a652d48970ee2f40f9f0f7d11f9e5f6", "hashed_zip_code_user": "dc5a53bbedf238b49ef3ea7f41b5d64c8b993c79b7ae9c5b314ab29fa96cf6fa", "hashed_city_user": "8e9b752be8b1b1c8a76f96e50794e9d45ed4cb16a4fa1a6f2b70f8eebd8ef1be", "hashed_state_user": "f84e3c5642a9074536bb68bcb1b99c6a8a97aaab618c2d70ae007eac8315c6ff", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_2 like Mac OS X) AppName/3.4.5.678 (com.example.app; 3.4.5; 345678)", "use_att_click_id": false, "att_click_id": "zxck87hwbasduuvgaosdf_afl", "page_view_url": "https%3A%2F%2Fwww.retailer.com%2Fshop%2Fproduct%2Fproduct170830%3Fgclid%3DCjwKCAiAneK8BhAVEiwAoy2HYQpFqiwODAaicabsXW_8vWawqji1354WiCHj15ZEygWv4sAnqfOBUxoCg-MQAvD_BwE", "channel": "google", "channel_click_id": "CjwKCAiAneK8BhAVEiwAoy2HYQpFqiwODAaicabsXW_8vWawqji1354WiCHj15ZEygWv4sAnqfOBUxoCg", "external_campaign_id": "342524", "product_id": "170830", "item_group_id": "3845239", "category_id": "30087", "seller_id": "18231233", "brand": "nike" } } **POST** `/orders` Request body Example: { "headers": { "api_key": "**************************" }, "body": [{ "order_ts": 1729696661986, "platform": "app", "visitor_id": "01929d42ae1a0016c0cebe6dd43a0508900160810056a", "session_id": "1729694623545", "crm_id": "119583788", "hashed_email": "c61ca4013045d4992166ed703a736fbb7e6d0c3b831ff0721eaf953d460ff0a9", "hashed_phone": "9f9d51bc70ef21ca5c14f307980a29d8d6eb68e4b5cf1e6a0e94d1c2c84e6f4d", "hashed_phone_user": "7b7bc2512ee1fedcd76bdc68926d4f7b4ad6eec7e1f1abf2a5e93df18bafad8e", "hashed_phone_e164": "ee26b0dd4af7e749aa1a8ee3c10ae992e9a9d7e40452a7c3a2e0a69fef6f1f7c", "hashed_phone_e164_user": "bd99f4a2bda3f841d3f9a78cf39aa0d6ed7ac712a967351a51915d6c9837c1c3", "hashed_date_of_birth": "98b2979503d318edb1f6d1b802b4e6e0f90d43e5c5c91c1057b5d8a455b53c9b", "hashed_date_of_birth_user": "32d10c7b8cf96570ca04ce37f2a19d84240d3a89e9c171a8f2f64d4e6b8f6e63", "hashed_first_name": "fbade9e36a3f36d3d676c1b808451dd7f7d011e7e50ddaa6f31bfb4e08b0e4a8", "hashed_first_name_user": "a7d3e6d93b41f6a4941347ecb2e3cb5debe8272b2f8a60d2411b5acb739e6ef3", "hashed_last_name": "4d186321c1a7f0f354b297e8914ab240e1dbb3f9842f53c111ed84fd0f9f9c5b", "hashed_last_name_user": "77b7bbefbf6b6317014acded918b6e253a652d48970ee2f40f9f0f7d11f9e5f6", "hashed_zip_code": "0b4e7a0e5fe84ad35fb5f95b9ceeac79e4f9c11edaaef9c13d37b12cc9cfcc76", "hashed_zip_code_user": "dc5a53bbedf238b49ef3ea7f41b5d64c8b993c79b7ae9c5b314ab29fa96cf6fa", "hashed_city": "6c3e226b4d4795d518ab341b0824ec29d996fc862f451c3dfe2a4ed29fc4b8e2", "hashed_city_user": "8e9b752be8b1b1c8a76f96e50794e9d45ed4cb16a4fa1a6f2b70f8eebd8ef1be", "hashed_state": "907d14fb3af2b0d4f18c2d46abe8aedce17367bd2d46c9fa3c8f1b60c2549cd8", "hashed_state_user": "f84e3c5642a9074536bb68bcb1b99c6a8a97aaab618c2d70ae007eac8315c6ff", "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_2 like Mac OS X) AppName/3.4.5.678 (com.example.app; 3.4.5; 345678)", "order_id": "238476923", "items": [ { "product_id": "170830", "item_group_id": "3845239", "category_id": "30087", "seller_id": "18231233", "brand": "nike", "quantity": 1, "regular_unit_price": 10.00, "discount_unit_price": 5.00 }, { "product_id": "238443", "item_group_id": "2342384", "category_id": "72342", "seller_id": "23434232", "brand": "reebok", "quantity": 1, "regular_unit_price": 20.00, "discount_unit_price": 20.00 } ] }] } ### Status Codes The API will return appropriate HTTP status codes: * 200: Success * 400: Bad Request (e.g., invalid data format) * 403: Forbidden (invalid API key) --- language: "en" --- # \*Event Data Integration: Event API & File Dump Data Requirements Click [LINK](https://claude.ai/public/artifacts/c3a2edc3-f0dd-4caf-8618-5a4e43972cfe) for requirements. --- language: "en" --- # \*Event Data Integration: File Dump Share CSV file dumps to Symbiosys via shared cloud storage bucket (e.g., GCS, S3, Azure). Symbiosys will create and share a bucket for you, or you can share your own bucket if you prefer. ## Bucket Sharing Options ### **\[Preferred\] Option 1: Using a Symbiosys-owned GCS Bucket** Symbiosys will provide a Google Cloud Storage (GCS) bucket for data ingestion. At your request, your team will receive write access via email and/or a service key. **Requirements:** * **\[Optional\] Encryption:** If you prefer the service key to be encrypted before sharing via email, please provide your Symbiosys Sales Engineer with your public key for encryption. * **\[Optional\] Test File:** We recommend sending a test file to validate the connection before regular data uploads. * **File Upload Schedule:** Files should be uploaded on a regular cadence -- hourly or at least once daily. * ***Processing Window: Files can contain events from previous days as per your order processing window, but do try to limit this window to 3 days if possible.*** * **Folder Structure:** Files containing visits and orders should be stored in separate folders to ensure organized processing. * **File Formatting:** Files should be in **CSV format with UTF-8 encoding** and use a standard delimiter (e.g., comma or tab). * **File Naming Convention:** Use a structured format, such as: * `retailername_visits_YYYYMMDD.csv` * `retailername_orders_YYYYMMDD.csv` ### **Option 2: Using a Retailer-owned Cloud Storage Bucket** If you prefer to use your own storage solution, Symbiosys can access your designated bucket. #### **Requirements:** * **Create or Use an Existing Bucket:** Ensure that the bucket is accessible to Symbiosys. * **Folder Structure \& Update Schedule:** Files should be structured similarly to Option 1, with separate folders for visits and orders, and updated at least once daily. * **Access Permissions:** Provide Symbiosys with the necessary credentials and assign appropriate IAM roles: * **Google Cloud Storage (GCS):** `Storage Object Viewer` or `Storage Object Admin` * **AWS S3:** `AmazonS3ReadOnlyAccess` or equivalent * **Azure Blob Storage:** `Storage Blob Data Reader` * **Service Key Security:** If required, encrypt the service key before sharing. --- language: "en" --- # \*Event Data Integration: Methods & Data Sources Below is an overview of the methods we support for event data integration, some of their advantages, and some commonly used data sources for each. Data can be sourced from platforms not listed here. Hybrid methods are common (e.g., client-side tag for web, file dump for app). * **\[Preferred\] BigQuery Transfer** -- Send data from BigQuery or via GA4 export. Shared event data tables must be partitioned by event date, with one partition per day. * **Advantages**: low-code/no-code, fast, less complexity, easier maintenance * **Data Sources**: * BigQuery direct transfer * Google Analytics 4 Export * **\[Preferred\] File Dump** -- Send CSV file dumps to Symbiosys via shared cloud storage bucket (e.g., GCS, S3, Azure). * **Advantages**: low-code/no-code, fast, less complexity, easier maintenance * **Data Sources**: * Adobe Analytics -- [Adobe Analytics Data Feed Guide](#) * Snowflake -- [Snowflake Export Guide](https://docs.snowflake.com/en/user-guide/data-unload-gcs) * Google Analytics * Segment * **Event API Integration** -- Use the Symbiosys Event API to stream data directly from your site/app to Symbiosys via client- or server-side tag. * **Advantages**: real-time data ingestion, turnkey integrations available in Google Tag Manager and Tealium; compatibility with other data storage platforms. * **Data Sources**: * Tealium iQ Tag Manager (client-side tag) * Tealium EventStream (server-side connector) * Google Tag Manager (client- or server-side tag) * MMPs (e.g., AppsFlyer) --- language: "en" --- # February 2026 ## Release 3.17 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* 1. **Meta Combined Catalog On and Off Campaigns:**Catalog control has shifted in the Meta campaign workflow to allow for more flexibility in mixing catalog on and catalog off ads within the same ad group. For Traffic and Sales objective campaigns, the ad format selection includes a two-tab design to designate these different ad format types. The available ad formats will continue to depend on the types of assets selected in the Asset tab of the campaign workflow. *Note: There are no changes to Awareness objective campaigns. To view both catalog on and off ad formats on Sales objective campaigns, the advertiser must have access to the Sales catalog control.* ![image-20260203-215542.png](https://docs.symbiosys.ai/__attachments/a_157801e430aab6fb301a40969caa3c5a6d2c27cbdf1c8512d041b6044b26c95f/image-20260203-215542.png?cb=79c57dec9d6281efdc5b648d6fd41628) Meta - New two-tab ad format setup showcasing combined catalog on and off ad formats 2. **Meta Ad Group Budget Optimization:**There is now the ability to set ad group specific budget minimum and maximums for each ad group within a Meta campaign. The ad group budget optimization type will be the same as the campaign's budget type. The minimum can be set based on a percentage of total campaign budget or a defined amount. This is optional and can be enabled for specific ad groups within the same campaign. *Note: The ad group budget maximum must fall within the campaign budget amount.* ![image-20260203-220219.png](https://docs.symbiosys.ai/__attachments/a_f09c0ee491a4201454406ad6323f2fdb2bb0eeeaac41f37b3d38a03f796948a9/image-20260203-220219.png?cb=06a38b3a5bdb8cf5fde6cbc2789f3b79) Meta - Optional ad group budget optimization 3. **Meta Additional Targeting Settings:**The Threads placement is now available within the Meta placement targeting setup. Additionally, it's now possible to add user language as an optional audience targeting parameter. Both settings are now visible in the Meta ad group setup within the campaign workflow. 1. *Note: A Threads profile is required on the retailer's Instagram account in order to utilize the Threads placement.* 4. **Pinterest Reach Estimator:**The Pinterest campaign workflow now includes an audience estimated size indicator to understand potential audience sizes based on targeting settings. 5. **\[RETAILER\] Custom Campaign Start and End Hour of Day:**A new retailer setting is available to define the hour of day to start and end campaigns for the first and last day of campaign flights. When customized, the start and end hour will be used in all campaigns for supported channels. To view the setting as a retailer, see the Account Settings page. To request updates, please contact your account manager. *Note: The time of day is reflective of the retailer's timezone. This does not impact the start time and end time for each day within the campaign flight. This setting is not visible to advertisers.* ![image-20260203-222352.png](https://docs.symbiosys.ai/__attachments/a_08d51546807683fda3f3852fb1de5017727c84baa9f443e5476880aeea4084ce/image-20260203-222352.png?cb=2232f47340259514b1f2ee2c28e9f79f) Retailer Custom Campaign Start and End Hour of Day 6. **Advertiser Campaign Control - Advanced Geo Targeting:** An advanced campaign control is now available within advertiser setup to allow access to zip and city geo targeting in supported channels. Advertisers with access to geo targeting are eligible for this advanced setting. ![image-20260203-222238.png](https://docs.symbiosys.ai/__attachments/a_29dc5eeaf21ab2c167595a79b5546677d848ec4ec19d767fd0071c239dbf5507/image-20260203-222238.png?cb=9357d889b483ccc3370da3f92eae87b8) Advertiser Advanced Geo targeting Control 7. **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. We've expanded the option to add more than one static carousel (non-catalog) per ad group in the Meta campaign workflow. 2. Updates to the The Trade Desk campaign workflow to support optional custom CPM targets. 3. Ad layout previews within the asset creation workflow now include Pinterest and SnapChat. 4. The Google campaign workflow will hide the Assets tab if not applicable for the selected campaign type. --- language: "en" --- # Getting Started with the Symbiosys API The Symbiosys API enables retailers to programmatically integrate their advertising systems and workflows with the Symbiosys platform. Retailers can use the API to manage advertisers and campaigns, access retailer-specific resources, and retrieve advertising performance data. This guide covers the basic concepts required to authenticate with the API and make your first request. ## API Version The current version of the API is **V3**. API requests use the V3 base path: `https://api.symbiosys.ai/v3/` For complete endpoint definitions, request and response schemas, and supported values, see the [API Reference](https://api.symbiosys.ai/v3/docs). ## Authentication The Symbiosys API uses API keys for authentication. Include your API key in the `x-api-key` header with each request: x-api-key: YOUR_API_KEY Your API key determines your retailer context and the resources available to your integration. Keep your API key secure and do not expose it in client-side applications or publicly accessible source code. ## Make Your First Request A good way to verify your credentials and begin exploring the API is to retrieve the advertisers configured for your retailer. Send a request to the Advertisers endpoint: GET /v3/advertiser/ Include your API key: GET https://api.symbiosys.ai/v3/advertiser/ x-api-key: YOUR_API_KEY A successful response returns advertisers available within your retailer context. The advertiser IDs returned by this request can be used to manage advertiser configuration, retrieve campaigns, and access other advertiser-specific resources. ## Pagination List endpoints may return paginated results. Use: * `limit` to control the maximum number of results returned. * `offset` to specify where the result set should begin. For example: GET /v3/advertiser/?limit=50&offset=0 To retrieve additional results, increment the offset: GET /v3/advertiser/?limit=50&offset=50 ## Resource IDs Resources managed through Symbiosys have internal Symbiosys IDs. Retailers may also maintain their own identifiers for these resources. Where supported, the `use_client_ids` parameter determines which identifier should be used to resolve a resource. When: use_client_ids=false IDs refer to Symbiosys resource IDs. When: use_client_ids=true supported IDs can refer to identifiers provided by the retailer. This allows retailers to integrate Symbiosys with existing systems without relying exclusively on Symbiosys-generated identifiers. ## Where to Go Next Once you've successfully authenticated: **Core Concepts** Understand how your retailer, advertisers, campaigns, and supporting resources relate to one another. **Campaigns** Learn how to create and manage campaigns for advertisers operating through your retail media program. **Reporting** Retrieve advertiser, campaign, and product-level advertising performance. **API Reference** Explore complete endpoint definitions, request and response schemas, and supported values in the [API Reference](https://api.symbiosys.ai/v3/docs). --- language: "en" --- # \*Google Ads ## Overview Symbiosys requires access to a Google Ads account. This can be an existing ad account where you are running brand campaigns (we refer to this as your "core" account) OR a new ad account created specifically for Symbiosys (preferred). This ad account will be linked to the Symbiosys Manager Account (MCC). If you choose to create a new ad account, you may still choose to grant Symbiosys read-only access to your core ad account -- this access will help us to validate your event data and it will unlock additional Symbiosys features like the Brand Opportunities Report. Lastly, we ask that you share conversion actions with Symbiosys to boost your pilot performance. There are three ways to share these (outlined in Step 7 below). ## Instructions 1. **Log In to Google Ads.** 2. **\[Optional\] Create New, Symbiosys-specific Google Ads Account**: Name the ad account using the format: "{Retailer}_{label}_Symbiosys". 3. **Share Ad Account ID**: Find your Google Ads account ID in the top-right corner of your screen when logged in. Email this ID to [system@symbiosys.ai](mailto:system@symbiosys.ai). 4. **Link Ad Account**: You will receive a link request to connect the ad account to the Symbiosys MCC. A Google Ads admin on your end must sign in and accept the link request. 5. **Link Google Merchant Center (GMC) to Ad Account**: 1. Make sure your GMC account is linked to the ad account. 2. Go to Tools \> Data Manager \> Connected Products. 3. Link the GMC feed that Symbiosys was granted access to in the [prior step](https://symbiosys-docs.scrollhelp.site/ss/google-merchant-center-gmc-product-feed). A GMC account admin on your end must approve this link request inside the GMC account. 6. **\[Optional\] Share UTM parameters with Symbiosys:** 1. If you expect specific UTM parameters on your ad URLs for reporting purposes, share these with your Symbiosys Sales Engineer. 7. **\[Optional\] Share Core Ad Account**: 1. Invite [system@symbiosys.ai](mailto:system@symbiosys.ai) as a Read-Only User to your core ad account. 8. **\[Optional\] Share Conversion Actions with Symbiosys**: 1. If you have [cross-account conversion tracking](https://support.google.com/google-ads/answer/3030657?hl=en) enabled (you manage sub-account access to shared conversions at the MCC level), you can: 1. **\[Option 1\]** **Share conversion actions from your MCC to the ad account**: 1. Ensure that the ad account is linked to your MCC. 2. In the MCC, navigate to Accounts \> Sub-account settings. 3. Locate the ad account row in the table. 4. In the Google Ads conversion account column, click the cell and switch the value from "Client" to "This manager". 2. **\[Option 2\]** **Provide Standard access to your MCC** by inviting [system@symbiosys.ai](mailto:system@symbiosys.ai) as a Standard User. 2. If you don't have cross-account conversion tracking enabled (conversions are managed at the ad account level and are specific to your core ad account), you can: 1. **\[Option 3\] Provide Standard access to your core ad account** by inviting [system@symbiosys.ai](mailto:system@symbiosys.ai) as a Standard User. ![https://lh7-rt.googleusercontent.com/docsz/AD_4nXd49zs3s2Z-7aYxwusBfav5ng4qv1TGL7QF6JBp4di23dzcdNw_Mg2XYSEoNMe9j6c3b0lUitxtYGxR10AQps8NBxTMikzEE_H2bMhCVY3ghKOw91VQmYXmPW6-EAkGxnAukqhoaAIndQB0jV-FZG2b_LI?key=uthZVGo6cn9qj-jVYT2Azg](https://lh7-rt.googleusercontent.com/docsz/AD_4nXd49zs3s2Z-7aYxwusBfav5ng4qv1TGL7QF6JBp4di23dzcdNw_Mg2XYSEoNMe9j6c3b0lUitxtYGxR10AQps8NBxTMikzEE_H2bMhCVY3ghKOw91VQmYXmPW6-EAkGxnAukqhoaAIndQB0jV-FZG2b_LI?key=uthZVGo6cn9qj-jVYT2Azg) This diagram shows your Google Ad account structure after integrating with Symbiosys. --- language: "en" --- # \*Product Catalog, Inventory, and Store Feed Requirements ## Overview Symbiosys uses product catalog data to make products available in the Symbiosys UI, support product and brand matching, create eligible product sets, and activate campaigns across supported onsite and offsite advertising channels. Our preferred approach is to receive a full, direct product feed from the retailer in Google Merchant Center (GMC) product feed format. This gives Symbiosys a complete view of the retailer's catalog, rather than relying on a feed that may already be filtered for Google, DoorDash, Criteo, or another channel. A direct feed helps avoid missing SKUs, improves product discovery in the Symbiosys UI, and gives Symbiosys the flexibility to determine channel eligibility based on the retailer's business rules and each ad channel's requirements. ## Product Catalog Feed Please provide a product catalog feed using Google Merchant Center product data formatting and attribute names, using the Google product data specification as a general reference for required and optional product attributes, formatting, and validation rules. [Google Merchant Center product data specification](https://support.google.com/merchants/answer/7052112?hl=en#zippy=%2Cformatting-your-product-data%2Cother-requirements) ## "Unfiltered" Feed Expectations The feed should include all products that may be relevant for advertising, attribution, and reporting across both online and in-store contexts, and should not be limited to products currently being sent to a single ad channel. Please do not remove products solely because they are: * Not currently included in a Google, Meta, Criteo, DoorDash, or other channel-specific feed * Temporarily out of stock or unavailable * Not currently selected for an active campaign Products that are never eligible for advertising due to legal, regulatory, policy, or retailer-specific restrictions may be excluded, or preferably included with eligibility flags so Symbiosys can apply the appropriate activation rules. ## Eligibility Flags Where available, please include flags that help Symbiosys understand whether a product can be advertised, where it can be sold or fulfilled These values can be delivered as additional columns in the direct feed: | Field | Example Values | Purpose | |---------------------------|--------------------------------------------|---------------------------------------------------------------------| | `advertising_eligible` | `true`, `false` | Indicates whether the product is generally eligible for advertising | | `fulfillment_eligibility` | `online`, `in-store`, `pickup`, `delivery` | Identifies which fulfillment methods the product is eligible for | For `fulfillment_eligibility`, multiple values may be provided as a pipe-delimited list. ## Omnichannel and In-Store Requirements If the retailer is omnichannel and will enable in-store campaigns, store-based optimization, or in-store attribution, Symbiosys may also require: 1. A store locations feed 2. A Google local inventory data feed These feeds allow Symbiosys to connect products, stores, and in-store availability. ## Local Inventory Data Feed Please provide a local inventory feed using Google Merchant Center local inventory data formatting and attribute names, using the Google local inventory data specification as a general reference for required and optional product attributes, formatting, and validation rules. [Google Merchant Center local inventory data specification](https://support.google.com/merchants/answer/14819809?hl=en) The local inventory feed should use product identifiers that can be matched back to the product catalog feed and store identifiers that can be matched to the store locations feed. ## Store Locations Feed Please provide a store locations feed so Symbiosys can connect store-level product availability to physical retail locations. The store locations feed should follow Google's store locations data requirements. Please refer to Google's documentation for the full specification of required and optional fields: The store identifier must be consistent between the local inventory feed and the store locations feed. ## Alternative: Granting GMC Access If a direct feed is not available, Symbiosys may be able to access product data through the retailer's Google Merchant Center account or DoorDash's GMC feed if the retailer provides a direct feed to DoorDash already. To grant access to the retailer's GMC account: 1. A user with admin access signs in to Google Merchant Center. 2. Navigate to Account Access. 3. Add `system@symbiosys.ai` as a Standard user. --- language: "en" --- # \*Google Tag Manager (client-side) ## Overview This guide explains how to integrate Google Tag Manager (GTM) to track page views and order completions on your retail site. Note, this is not for server-side GTM (sGTM); a separate guide is available for that. You'll set up tags and triggers in GTM to capture these events and send the data to the Symbiosys event server via HTTP GET requests. Data can be collected using Data Layer variables, JavaScript variables, or dynamically generated values. ## Instructions ### Determine API Key and Endpoint Contact a Symbiosys integration engineer to obtain your API key. Use the endpoint [++https://event.symbiosys.ai++](https://event.symbiosys.ai/) in the examples below. For Europe-based retailers, replace this with [++https://eu.event.symbiosys.ai++](https://eu.event.symbiosys.ai/). ### Set Up the Page Views Tag 1. **Create a Tag:** 1. In GTM, go to the Tags tab and click "New". 2. Name the tag, e.g., "Symbiosys -- Page View". 3. In the 'Tag Configuration' section, select "Custom HTML" as the tag type. ![https://lh7-rt.googleusercontent.com/docsz/AD_4nXdzwV80-8P8u0MmWMtc-rxxYDpRqfLf5DjHzGrhpGLS4lqOLh6y1hNbNIkaDKswhy6c-i7iWqIbv0EACStndQlvxIc3VP0URJ_V1t2_H_FnFkXO9Hh_SNKdyWfx_KXsRlEepXeGDK1gOGeSd3jCGxv-cNnL?key=vMxklkJIJO1b1syJU--yrQ](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdzwV80-8P8u0MmWMtc-rxxYDpRqfLf5DjHzGrhpGLS4lqOLh6y1hNbNIkaDKswhy6c-i7iWqIbv0EACStndQlvxIc3VP0URJ_V1t2_H_FnFkXO9Hh_SNKdyWfx_KXsRlEepXeGDK1gOGeSd3jCGxv-cNnL?key=vMxklkJIJO1b1syJU--yrQ) 2. **Add the Action:** 1. Consult the [Event Data Requirements](https://symbiosys-docs.scrollhelp.site/ss/event-data-requirements) section for information on requested parameters. 2. Add the below Page View tracking code snippet to the template. 3. Change any reference to CAPITALIZED_VARIABLE to the name of your data layer variable. 3. **Add a Trigger:** 1. In the tag setup, click "Triggering". 2. Click "+" to add a new trigger. 3. Select "Page View" as the trigger type to fire the tag on every page view. 4. Save the trigger and link it to the Page View Tag. ### Set Up the Orders Tag 1. **Create a Tag:** 1. In GTM, go to the Tags tab and click "New". 2. Name the tag, e.g., "Symbiosys -- Order". 3. In the 'Tag Configuration' section, select "Custom HTML" as the tag type. 2. **Add the Action:** 1. Consult the [Event Data Requirements](https://symbiosys-docs.scrollhelp.site/ss/event-data-requirements) section for information on requested parameters. 2. Add the below Page View tracking code snippet to the template. 3. Change any reference to CAPITALIZED_VARIABLE to the name of your data layer variable. 3. **Add a Trigger:** 1. Option 1 -- Based on the Order Confirmation Page 1. Click "Triggering" in your tag setup. 2. Click "+" to add a new trigger. 3. Choose "Page View" as the trigger type. 4. Select "Some page views" in the trigger settings. 5. Add a condition to check if the page URL contains a specific string (e.g., \`/order-confirmation\`). 2. Option 2 -- Based on a Custom JavaScript Event 1. Click "Triggering" in your tag setup. 2. Click "+" to add a new trigger. 3. Choose "Custom Event" as the trigger type. 4. Select "Some custom events" in the trigger settings. 5. Add a condition for the specific custom event. --- language: "en" --- # \*Google Tag Manager (server-side) ## Overview This guide assumes a specific SGTM configuration. If your setup differs from the example provided, contact [++support@symbiosys.ai++](mailto:support@symbiosys.ai) for assistance with event logging. The assumed configuration is detailed below. ## Instructions This guide assumes a frontend with a web container tag of type "Google Tag" that sends data to a GTM server container. The server container has a client of type "Google Analytics: GA4" installed. It also applies to setups with or without a server-side tag forwarding events to Google Analytics or another event server. The guide is compatible with frontends using either GTM or gtag.js. ![AD_4nXeg8ug7VYet4gTIpj5Y6CWKks_pBJx0OPpLx_YcuWhT_EMFzdYKwRncFDkA3SbW2ZQ_3b4dc9V9oF-k65Dq_2R0JnO0BQMtgLzP6QA29wax1a4dUg7BuiVH6ppsMLGi1fG5DYTrB5eBxnZUTDFsFF5MZ-2B?key=u0dB5VLL4Xiscryd78jAoA](https://docs.symbiosys.ai/__attachments/a_e91dbfb21b31e5d37395844dd3f248ce00e42cb43b04398c652bde4fc2acd806/AD_4nXeg8ug7VYet4gTIpj5Y6CWKks_pBJx0OPpLx_YcuWhT_EMFzdYKwRncFDkA3SbW2ZQ_3b4dc9V9oF-k65Dq_2R0JnO0BQMtgLzP6QA29wax1a4dUg7BuiVH6ppsMLGi1fG5DYTrB5eBxnZUTDFsFF5MZ-2B%3Fkey=u0dB5VLL4Xiscryd78jAoA?cb=67d1b040d21910c747665374178a14dd) Existing Google tag on frontend ![AD_4nXdHsIQrnavyoGgEQXtNLXKwpC0fFRMcAP5EtRvTyaTIGkTSOCck0AbD3UURPsL6nhsErhjHoYGZo89tzwI2tYPyiRsh-UgkEEVCTPvf0d2gMxXQX3yCXmiOjFk5t7lIovvEk4nnDiTGjYgV6i_WYWb2M0E?key=u0dB5VLL4Xiscryd78jAoA](https://docs.symbiosys.ai/__attachments/a_c9d7f7dacb683fd96636a4128c18b88538d20bd5ef9fd4f4b9e038803581264a/AD_4nXdHsIQrnavyoGgEQXtNLXKwpC0fFRMcAP5EtRvTyaTIGkTSOCck0AbD3UURPsL6nhsErhjHoYGZo89tzwI2tYPyiRsh-UgkEEVCTPvf0d2gMxXQX3yCXmiOjFk5t7lIovvEk4nnDiTGjYgV6i_WYWb2M0E%3Fkey=u0dB5VLL4Xiscryd78jAoA?cb=acb89575c437529719c1a1e28d2ac479) Installed GA4 client that receives data from the frontend. If your setup does not have these components already (or the gtag.js installed), contact [++support@symbiosys.ai++](mailto:system@symbiosys.ai). ### Set up attribution fields To ensure proper attribution, we need to link visits to orders using custom fields as outlined below. #### 1. Product ID field In Google Analytics, set up a custom field for the current product ID, named "product_id." The method is client-specific; for example, you could use custom JavaScript in GA4 to extract the product ID from the URL. #### 2. CRM User ID field We use several user identifiers for attribution, most provided by Google Analytics. However, please include the CRM User ID for logged-in users in every event, using the field name "user_id." ### Tag Installation All changes should be made in Google Tag Manager. Ensure that the Tag Manager account you are working inside has a Container Type of "Server", not "Web". 1. In Tag Manager, go to Overview \> New Tag \> Tag Configuration \> Community Template Gallery. 2. Search "Symbiosys Event API". 3. Select the Symbiosys Event API tag and add it to your workspace. 4. Select the tag. 5. Enter your Symbiosys-provided API key. 1. Ensure that you are using the correct key per the environment (dev or prod). 6. Click the Triggering tile 7. Select All Pages and click Add. 8. Save changes. ![image-20241211-170527.png](https://docs.symbiosys.ai/__attachments/a_53219641d9900939a8429d9d83f6525d092c397d8922a2f63562442e7bd25e90/image-20241211-170527.png?cb=0f94b5e08a63324c4e02fb1f90b6db3d) ### Validation Validate that the correct data is being sent. After completing the integration, contact your Symbiosys Sales Engineer for data validation checks. --- language: "en" --- # Retailer Onboarding Guide Learn about the retailer onboarding process. Symbiosys requires your product feed, access to your search and social ad channels, and your event data. ## 1. Product Feed Symbiosys uses your product feed to display products in the Symbiosys UI and to promote them on search and social channels. Most clients provide their Google Merchant Center (GMC) product feed. If your GMC feed does not include the full catalog of products advertised on your site or app, we may request a supplemental feed. * See section: Product Catalog, Inventory, and Store Feed Requirements ### 2. Ad Channels Symbiosys integrates with your ad channels to create and manage campaigns directly from the Symbiosys UI. Most clients start by integrating with Google Ads and Meta Ads. We also support other channels, including TikTok Ads, Pinterest Ads, Snapchat Ads and YouTube Ads. * See section: Google Ads * See section: Meta Ads ### 3. Event Data Symbiosys requires two types of event-level data for attribution: **Visits** and **Orders** . A **Visit** is a page view that occurs when a user lands on your site after being redirected from an off-site ad click. For mobile apps, a Visit occurs when a user clicks on an ad that opens your app (e.g., via a deep link). An **Order** occurs when a user completes a purchase. * See section: Event Data Integration ![Screenshot 2024-12-02 at 8.32.29 PM.png](https://docs.symbiosys.ai/__attachments/a_74d02b73d1944759e464e760035f655a1754e536136b934327129d4fcacc7f9c/Screenshot%202024-12-02%20at%208.32.29%20PM.png?cb=cd434a134fd501ea91303d1166ca427d) --- language: "en" --- # January 2025 ## Release 3.3 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Google / Meta Merchant Campaign Targeting Support 2. Meta / TikTok Multiple Ad Format Support within a Single Campaign 3. Email Notifications for Asset Submissions 4. Targeting Group reporting segmentation 5. Retailer Fiscal YTD Date Range 6. Misc UX enhancements and bug fixes --- language: "en" --- # January 2026 ## Release 3.16 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* **Meta Static Image/Video Carousels:**A new static Carousel ad format is now available for eligible advertisers activating catalog-off Meta campaigns. This carousel uses multiple static images or videos to build a sequence of cards that a viewer can engage with using the left and right arrows of the ad. To activate this ad format, advertisers build a new Asset Group on the Assets tab within their campaign workflow. * The Asset Group must contain between 2 and 10 approved assets. * Assets can be sorted in sequence using drag and drop or they can be removed from the group altogether. * Assets can also be added and removed from the group, and the same asset can be used in multiple groups. * The Primary Text from the first asset will be used for the text that appears above the carousel in the ad. * Each asset's unique Headline, URL, and CTA is used for each card in the carousel. ![image-20260106-203509.png](https://docs.symbiosys.ai/__attachments/a_9d04bd80301ca41161e3d011cd4cbd0a9fd1277dc3e49b06e62999c5a5f2e602/image-20260106-203509.png?cb=ab16db87d6db5f1cd429c7a86e1257a3) Asset Group Setup Once the Asset Group is created in the campaign, it can be enabled within the Meta tab under the ad group as shown below. An asset group can be paused on the ad group when editing the campaign. ![image-20260106-200828.png](https://docs.symbiosys.ai/__attachments/a_7794221761a96b17387f2c51c50a9a969817c2af521573ec5f96935441acc40b/image-20260106-200828.png?cb=1b7dfe7657a36c7b397a920bb3cde403) Ad Format Selection *Note: The catalog must be turned off on Traffic and Sales objective campaigns in order to see the Static Carousel and Asset Group options.* --- language: "en" --- # July 2025 ## Release 3.10 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. **Enhanced Google Campaign Targeting Controls** 1. Shopping/Search - custom first-party audience selection in campaign workflow 1. ![image-20250718-144854.png](/__attachments/a_a200ece839905f2ea28bd5e4d142b9d859205e8467d843c5d7ea4760654a527e/image-20250718-144854.png?cb=7d96d8b85d19ecfeba577b62172181fb) 2. Demand Gen/YouTube - enhanced Network controls 1. *Note: The options will differ based on whether the campaign type is YouTube or Demand Gen. For YouTube, we will always include Discover, Gmail, and Google Display Network behind the scenes. For Demand Gen, we will always include YouTube placements behind the scenes, as a video will be automatically created using static assets if a video asset is not provided.* 2. ![image-20250723-152950.png](/__attachments/a_88554f5a4ec80c88da993394b1ed24d3272f7994b3c81c134835303dcae98164/image-20250723-152950.png?cb=90747cd6872c91821be21c497c4c8d6e) 2. **TikTok Sales objective campaigns with catalog control toggle** 1. Note: Advertisers will see this toggle if the Sales Catalog Control advertiser setting is turned on for them. 2. ![image-20250718-151300.png](https://docs.symbiosys.ai/__attachments/a_6d0a322bc7223cb8b44afdf5c7497c3feef8091f94988c93b0d1fe0e46ec76d2/image-20250718-151300.png?cb=68af6bceaa9392df97b76d85dd41e128) 3. **Enhancements to Pinterest asset and campaign creation** 1. Support for 1:1 image ratio on asset files 1. ![image-20250718-153751.png](/__attachments/a_486ebaec860a934ee0c535e9b17740c5db31eef10299228c9da13e225587de6d/image-20250718-153751.png?cb=cffd16b331b11b812392b0e9447dc67f) 2. Updated call-to-action options based on asset file type 1. *Note: Catalog assets will default to Shop Now* 2. ![image-20250718-153948.png](/__attachments/a_4ae90458b55ad21d65a0f0a59ddd21978badde8fd5ebaa82172b8dd1c8228757/image-20250718-153948.png?cb=cc4a97b61cc914ba9ee8ab035d0d4139) 3. Asset and placement customization per targeting group 1. ![image-20250718-155156.png](/__attachments/a_0106c6913100146e8e0db45be72a24a9c7f4ebf48e186864b59eebc4f8d5ff93/image-20250718-155156.png?cb=3662885a39fb706ce6ee1f32d801eb31) 4. **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. Search Term additional retailer-facing cost reporting fields 2. Copy and paste multiple zip codes for retailer campaign geo-targeting 3. Single color gradient design update for campaign Audience Estimator 4. Download file for retailer User Management 5. Insertion Order usability and retailer control enhancements 6. Advertiser copy on the Advertisers listing table 7. Country selection on advertiser creation for multi-country retailers 8. Representative name in campaigns reporting column selector --- language: "en" --- # July 2026 ## Release 4.3 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Enhanced Insertion Orders and Promoted Products reporting with improved navigation, KPI tracking, and report exports * Budget recommendations for DoorDash on-site ads utilizing a daily budget ### **1. Reporting \& Insights: Enhanced Reporting Experience for Promoted Products and Insertion Orders** The reporting table and data visualization have been upgraded to improve report load times, streamline KPI tracking, and simplify table navigation. #### Scorecards and Data Visualization * Choose up to four scorecard metrics to keep your most important KPIs in focus. * Scorecards and data visualization can now be collapsed to create more workspace for large reporting tables. #### Reporting Table and Menu Options * Table header and footer rows remain visible while scrolling through results. * The column selection menu displays column type and description clearly, eliminating the need to hover over labels. * Reporting tables display segmented data more clearly when metrics are unavailable at detailed levels. #### Report Downloads * Downloaded reports, including scheduled report exports, now include the following improvements: * Row number index column (column 0) is removed. * Filtered totals row is now included. * Cleaner formatting. ![image-20260714-165522.png](https://docs.symbiosys.ai/__attachments/a_aef25be6824d86593df4ddd303d703a273f4629aaf8686a272178e21831dc7bd/image-20260714-165522.png?cb=b055a2c327f14ff03090fc6c0dd154ec) Promoted Products Enhanced Reporting UX *Availability:* * *Promoted Products - most retailers and advertisers will have this enabled; please reach out to your account manager to confirm availability for your specific program.* * *Insertion Orders - select retailers with Insertion Orders enabled* ### 2. Performance Optimization: DoorDash On-site Daily Budget Recommendations and Hours Live per Day For live DoorDash on-site campaigns with daily budgets, you can now view daily hours live and budget recommendations directly in the campaign sidebar. These insights help you identify campaigns that may be constrained by budget and improve their reach. ![image-20260714-175614.png](https://docs.symbiosys.ai/__attachments/a_6013974bf32ea6cdd8565b52dcb026b0937eeb729ee61c7428dcae5d249debc4/image-20260714-175614.png?cb=beedbadd0d4cbdb438fc7c3f91850126) DoorDash Ads Sponsored Products Budget Analysis This feature is not available during campaign creation or for campaigns with lifetime budgets. *Availability: Retailers and select advertisers with access to DoorDash On-site* ### 3. Campaign Operations: Streamlined Criteo Campaign Workflow The campaign experience for on-site Sponsored Products campaigns powered by Criteo has been adjusted to improve the campaign setup and optimization workflow. ![image-20260714-170153.png](https://docs.symbiosys.ai/__attachments/a_d788b9083f82946fda6747465a0f61bceb47f6e781cecce3f18a9176c1c407f0/image-20260714-170153.png?cb=b12db5565edf7f1c4ea6d3e4d9309bd7) Updated Ad Group Workflow * Follow a more intuitive sequence when configuring ad groups. * Manage product bid overrides alongside product-set selection. * Create ad groups without entering a budget override unless one is needed. *Availability: Retailers and select advertisers with access to Criteo* ### 4. Reporting \& Insights: Retailer Default Segments and Columns Retailer admins can now set the default segment and column view for the advertisers within their program by report. Campaigns, Promoted Products, Search Terms, and Targeted Keyword reports are currently supported. To enable a default segment: 1. Within the report, apply the segment you want to set as the default. 2. Select the pin icon to the right of the segment name. ![image-20260714-165801.png](https://docs.symbiosys.ai/__attachments/a_8dbf373fdfb2f3f63827a247d06539f7c86d3bbc1ec7fa33ccf497069d1149e7/image-20260714-165801.png?cb=6f130d1197108b4744190b7228142baa) Retailer Default Reporting Segment To enable a default column view: 1. Select the view. 2. Select columns for the view. 3. Select set retailer default columns within the view selector. ![image-20260714-170421.png](https://docs.symbiosys.ai/__attachments/a_48348b548b266fa92ee53d80a81f57059c996ba856afbb38bb3a38ec160684f1/image-20260714-170421.png?cb=8087568fbc77dea16830991f3065cfa1) Retailer Default Reporting Column View Defaults are automatically applied when advertisers open the report. Advertisers can remove or change it in their own view. *Availability: All retailer admins* ### Additional Improvements Including: * **TikTok Ad Max:** A maximum of 50 ads per TikTok ad group has been set within the campaign workflow. * **Multi-Channel Sponsored Product Campaign Budget Allocation:**Use the redesigned controls and quick-edit buttons to allocate budget across channels. Retailers can also set a default allocation for your program while allowing advertisers to override it on campaign create. * **Change History Embedded within the Campaign Workflow:** Review campaign change history directly within the campaign workflow, making campaign auditing and troubleshooting easier. * **Tool Tip and Field Validation Improvements:**Several tool tips and input field validations have been modified or added to improve user experience throughout the campaign workflow. * **Select All Asset to Ad Format Assignment:**Use Select all to assign all eligible assets to an ad format in one step by selecting the three dots next to the ad format column header. * **Criteo Campaigns Now Support Placement Segmentation:**Placement segmentation available on the Campaigns, Promoted Products, and Ads reports now support for on-site Sponsored Products campaigns powered by Criteo. Placement segmentation for Promoted Products is currently supported for Criteo campaigns only. --- language: "en" --- # June 2025 ## Release 3.8 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. \[RETAILER UI ONLY\] Retailer Insertion Order (IO) Management 1. A new Insertion Order module will appear in the left sidebar within the retailer console. The IO list table allows retailers to see all IOs that exist for their retail media program by IO name, advertiser, and effective IO dates. It allows users to quickly see which IOs are active, how much spend has accrued against an IO, and how many campaigns are funded by an IO. ![image-20250605-142028.png](https://docs.symbiosys.ai/__attachments/a_255b0cb1b7990b9c95911580f3a65efadad3cacbc941d45476dc1c95ed825a7d/image-20250605-142028.png?cb=94954b65b096c3505f6d71d6a01f93ec) 2. New IOs can be created using the plus sign in the top left of the table. A name and advertiser must be defined on an IO. The IO optionally can have a defined end date and/or maximum spend amount. ![image-20250605-142259.png](/__attachments/a_9f40ea9cfeafa5cc1d49e8e98cdc3373977a0acecee17539d1301090028413e0/image-20250605-142259.png?cb=fbf985a57e877644df4018b3ed6b0da4) 3. Once the IO is created by the retailer, the IO will appear in the campaign workflow. Many campaigns can be mapped to one IO. Please see below for more details. 2. *\[The following changes are dependent on the campaign IO setting being activated for your retailer program.* ***Please contact your account manager for more information and to activate this setting.*** *\]* IO Selection within the Campaign Workflow 1. During campaign creation, a new IO selection will appear in the campaign budget step in both the retailer and advertiser consoles. The IOs available are specific to the advertiser for which the campaign is being created. An IO is required for campaign creation when the setting is on. ![image-20250605-143921.png](https://docs.symbiosys.ai/__attachments/a_045982d62ef60b87fb8e98555de12317833ba36e7d6d68498f02fafc2671215e/image-20250605-143921.png?cb=a8f738077bca9f3e6c577dad8c61ebb0) 2. If the daily budget amount set on the campaign is larger than what is available remaining on the IO, a message will appear to indicate this. 3. This release also includes high priority bug fixes. --- language: "en" --- # June 2025 Release 2 ## Release 3.9 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. **New report segmentation options:** Segmentation by Placement and by Age are now available on the Campaigns and Ads reports. Please note that select reporting metrics are unavailable at these segmentation grains. 1. ![image-20250620-162922.png](/__attachments/a_1193e6ec1f0ef1a20a75b9a1e508bd94ba7094f60cdd3e78fd461cb63bf9a5bb/image-20250620-162922.png?cb=9a45aa72b62324cf40efa0844a1a65c5) 2. **Segmentation by Placement:** When selected, the report will breakout each campaign and ad by the channel placement value. 1. ![image-20250620-162819.png](/__attachments/a_9d0664b5df45588e4a7018d336c7c624abf97e66177861d6e980f37f1eb9e33f/image-20250620-162819.png?cb=6295c420acb606fc123146760e4f41ce) Segmentation by Placement Meta Example 3. **Segmentation by Age:**This segmentation will breakout the campaign and ad reports by age demographic rolled into unified age buckets presented as nested rows under the campaign or ad row in the reports. 1. ![image-20250620-164234.png](/__attachments/a_53ceaaef324f1ac4fd4126f00728b84aa4b0e8347f178c35ce77b77f09194252/image-20250620-164234.png?cb=8e43961166f42a4e868841de8001c81d) Segmentation by Age Example 2. **Additional Reporting Metrics:** 1. **Video Views:**This release introduces several new reporting metrics including Video Views and Video View % complete quartiles (25, 50, 75, 100%). These are now visible on the campaigns and ads report. 2. **Engagements:** We've added the ability to report on Engagements at the campaign and ad-level. It is also selectively available for Meta campaigns only on the Promoted Products report. 3. **Asset Customization by Targeting Group for TikTok:**TikTok has been upgraded to allow asset customization at the targeting (ad) group level. 1. ![image-20250620-165746.png](https://docs.symbiosys.ai/__attachments/a_33d9ca89af244c7cd5c87595771dfdebacf4a1e55e9c6f33dddbeb6772dc8b2f/image-20250620-165746.png?cb=eb4314eb79a07229ebc33d473b275085) TikTok Asset to Targeting Group Customization 4. **Rejected Asset Edit and Resubmission Workflow for Advertisers:** Advertisers now have the ability to edit a rejected asset based on the retailer's comments rather than submit a new asset from scratch. The channel and asset type cannot be edited. The asset editing functionality is accessible via the Asset Manager using the *cog* icon next to the asset name. Retailers are notified that the revised asset is ready for review via email on advertiser resubmission. 1. ![image-20250620-170050.png](https://docs.symbiosys.ai/__attachments/a_575a867bdcd6e878ff4d9224ef70412795ea541f18d0bdc8166bcb22b03ec839/image-20250620-170050.png?cb=6153d086f3faeb5018552b94a9c8d401) Edit Icon on Asset Manager 5. **Advertiser rollout for two new reports: Search Terms and Ads:**Advertisers now have access to view the Search Term report and Ads report in the advertiser console. 1. Note: The Search Term report supports select Google campaign types only. 2. The Ads report supports ad-level reporting granularity based on channel availability. *Update* : *The Ads report will be gradually rolled out to advertisers.* 6. **Advertiser rollout for YouTube Upper-Funnel campaign Objectives and multiple targeting groups:**Advertisers now have the ability to run awareness and traffic campaigns on YouTube as well as add multiple targeting groups. The advertiser must have access to YouTube to see these new objective selections. 7. **\[RETAILER ONLY\] Margin History Viewer:** This new viewer allows retailers the ability to search on changes to advertiser margins by channel over specific date ranges. 8. As usual, this release also includes high priority bug fixes and small usability improvements through the platform. --- language: "en" --- # June 2026 ## Release 4.2 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Enhanced Search Terms, Collaborative Bidding, and Brand Opportunities reporting with improved navigation, KPI tracking, and report exports * Third-party measurement support for TikTok and The Trade Desk campaigns * New TikTok Spark Ads workflow for creator-led advertising * Deal ID targeting support for The Trade Desk campaigns * New Kevel display advertising integration ### **1. Reporting \& Insights: Enhanced Reporting Experience for Search Terms, Collaborative Bidding, and Brand Opportunities** The reporting table and data visualization has been upgraded to improve report load times, streamline KPI tracking, and simplify table navigation. #### Scorecards and Data Visualization * The scorecards are limited to four cards with a drop-down for metric selection to improve focus on key KPIs. * Scorecards and data visualization can now be collapsed to create more workspace for large reporting tables. #### Reporting Table and Menu Options * Table header and footer rows remain visible while scrolling through results. * The column selection menu displays column type and description clearly, eliminating the need to hover over labels. * Reporting tables display segmented data more clearly when metrics are unavailable at detailed levels. #### Report Downloads * Downloaded reports, including scheduled report exports, now include the following improvements: * Row number index column (column 0) is removed. * Filtered totals row is now included. * Cleaner formatting. *Availability: All retailers and select advertisers with access to the Search Terms report* ### **2. Measurement: Third-Party Post-Bid Impression and Click Trackers** Advertisers can now integrate approved third-party measurement solutions directly into TikTok and The Trade Desk campaigns for independent impression and click tracking. **How It Works:** * Retailers enable advertiser access to third-party trackers * Optional allowlists can be configured for approved measurement partners * Advertisers can then apply click or impression trackers at the ad level. * VAST URLs are unsupported. Note: DoubleVerify and IAS measurement requires advanced setup in the TikTok ad account. Contact your account manager for more information. ![image-20260611-203517.png](https://docs.symbiosys.ai/__attachments/a_ccb87ef2160aef709ad7316790aa248635be6ae2a4a92e7e9c938dd3c98c794e/image-20260611-203517.png?cb=804579f501e35183ee14d3c41b02e0ab) *Availability: Retailers and advertisers with access to TikTok and/or The Trade Desk.* ***For TikTok, the ability to select IAS and DoubleVerify will be visible if the advertiser has access to third-party trackers.*** ### **3. Creatives: TikTok Spark Ads** Spark Ads enables advertisers to amplify creator-owned organic TikTok content through paid promotion while preserving engagement and social proof from the original post. **How It Works:** * Retailers enable advertiser access to Spark Ads ad format * Advertisers enter the authorization code within the Spark Ads asset creation workflow * Advertisers configure the ad once the asset is approved *Availability: Retailers and advertisers with access to the TikTok Spark Ads ad format* ### **4. Programmatic Inventory: The Trade Desk Deal IDs** Advertisers can now activate private marketplace (PMP) and guaranteed inventory deals directly within The Trade Desk campaign workflow, simplifying premium inventory activation. Retailers must first share the deal in the Deal Desk and enable the deal within the Symbiosys platform. ![image-20260611-203723.png](https://docs.symbiosys.ai/__attachments/a_5caab489e9d4aca9e930a6db67987d2c83848e60d30cc5c3e87384e6ce39f27c/image-20260611-203723.png?cb=1282944bc97af2068c34e945d460bdb6) Once a deal is provisioned to an advertiser, the advertiser assigns the deal to their ad within the campaign workflow. * Programmatic and Non-Programmatic Guaranteed deals are supported. * Programmatic Guaranteed deals can be configured with optional daily and lifetime budget allocations. *Availability: Retailers and advertisers with access to The Trade Desk deals* ### **5. Channel Availability: Kevel** Kevel is now available as a supported advertising channel, enabling display campaign activation for eligible retailers. Please contact your account manager for more details. *Availability: Eligible retailers only* ### **6. Miscellaneous improvements and bug fixes** Including: * **The Trade Desk Campaign Reporting Segments:**Domain/App and Device \& Environment segment breakouts are newly available on the Campaigns report. Retailer and advertisers with The Trade Desk enabled will see these new segments. Domain/App segmentation is capped to the Top 25 domains by impression count, rolling all other sites into a Tail Domains category. * **Google Impression Share Metric:**A new Impression Share metric is available within the Campaigns report and applicable to Google Search and Shopping campaigns enabling analysis of won impressions against total eligible impression. Supported at the campaign-day level. * **DoorDash On-site Campaign Spending Limit:**DoorDash on-site campaigns now include the option spending limit amount used in conjunction with daily budget to manage pacing. * **DoorDash On-site Campaign Lifetime Budgets:** Additional support has been added for lifetime budget campaigns on DoorDash on-site. * **Retailer On-site (Powered by Criteo) Ad Group Spending Limits:** Ad group spending limits are now required to enable pacing optimization. * **Meta Product Set Optimization Advertiser Access Toggle:**A new advertiser access toggle is available to enable product set optimization setting control within the Meta ad group setup. * **TikTok Advanced Targeting Parameters:** Audience language and operating system are new optional audience targeting settings within the TikTok ad group setup. * **Multi-Channel Campaign Improvements:** Several usability changes have been made as part of the overall multi-channel campaign management experience including Bid Strategy, Spending Limit, and Max CPC updated controls. * **Usability and Reliability Improvements:** * Minor improvements have been made through the Criteo and DoorDash on-site campaign and asset workflows. * A new tool tip is available on the Campaigns report when hovering on the Campaign Status filter to improve status categorization. * Advertiser audience provisioning now checks for ad account eligibility. *We are continually deploying improvements between major releases.* --- language: "en" --- # March 2025 ## Release 3.4 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Catalog Carousel Ad Format Support (Pinterest, TikTok) 2. Catalog text asset types for catalog-on, "asset-less" campaigns (i.e. non-video/image assets) 3. Improved change history logging 4. Audience Lookalike Support (TikTok \& Google) 5. Google - Shopping campaign negative keyword input 6. Misc UX enhancements and bug fixes --- language: "en" --- # March 2026 ## Release 3.18 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ### **1. Meta Partner Ads** A new partnership ads module is now available within the Meta campaign workflow. Partnership ads can be configured directly in the Meta campaign tab, allowing advertisers to associate campaigns with approved Meta partners. More than one ad can be set up per partner within a campaign. A new "Partnership" column has also been added to reporting for improved visibility. *Note: Partners must already be in an accepted state within Meta and set up as a Partner in Symbiosys in order to be available for selection.* ![image-20260227-211208.png](https://docs.symbiosys.ai/__attachments/a_b67e7fe4b3f4e7abf7d4bf7c5559060948c9181d6786eec9f264fdcbdf2bc58c/image-20260227-211208.png?cb=07162be2c408b6edd46f28efd0427415) Meta Campaign Partner Ad Setup ### **2. Meta Campaign Max Spending Limit** An optional maximum campaign spend limit can now be applied to Meta campaigns utilizing a daily budget. This amount defines the total allowable spend for the campaign. *Note: This setting does not apply to campaign utilizing lifetime budgets.* ![image-20260227-205906.png](https://docs.symbiosys.ai/__attachments/a_faec6ce0475a5a896bc6b9588a3471ef3f46e11b29a00d11d6b3168d54a9ff60/image-20260227-205906.png?cb=bfb1937158025b7d5c7212dcc265242e) Meta Campaign Spend Limit ### **3. Meta Ad Group Schedule Optimization:** Ad group-level start and end date/time overrides are now available within Meta campaigns. These optional overrides allow advertisers to control timing at the ad group level within the campaign workflow. *Note: Date overrides must fall within the campaign's overall start and end dates. Timing will default to retailer-specific settings when not customized.* ![image-20260227-210225.png](https://docs.symbiosys.ai/__attachments/a_cf55f4fd22f320fe9922784a8544f01e31eefa6c831a60a5c48ea6cb70eca689/image-20260227-210225.png?cb=e265a72072eea799a8c32c29466105aa) Meta Ad Group Schedule Optimization ### **4. YouTube Ad Group Asset Customization:** YouTube campaigns now support ad and asset customization at the ad group level, aligning the YouTube workflow with other supported channels. *Note: Assets must be used at least once across ad groups within a campaign.* ![image-20260227-210126.png](https://docs.symbiosys.ai/__attachments/a_cb381704f1b6e110f15561a7f365a87b617e4203d7110957f99a0dbc11be947b/image-20260227-210126.png?cb=6ff1d76f4d93c1369b43ea8c322c95f9) YouTube Ad Customization ### **5. Miscellaneous improvements and bug fixes, including but not exclusive of the following:** * **Meta Product Set Optimization:** Added an optional advertiser-level campaign control to enable product set optimization for Meta catalog-based ads without changes to the campaign workflow. * **Meta Embedded Ad Preview Link:** Updated the "Copy URL" functionality to generate a Meta embedded ad preview link when editing campaigns. * **The Trade Desk Mobile Image Aspect Ratios:** Expanded supported mobile image aspect ratios within asset creation to provide greater creative flexibility. * **The Trade Desk Campaign Max Spending Limit:**Added an optional maximum campaign spend limit to support optimization. * **Reach and Frequency Reporting:** Enabled Reach and Frequency metrics globally across supported channels, including Meta, YouTube, and TikTok. * **Campaign Brand Scope Reporting:** Added brand halo performance metrics to select reports. * **PDF Terms \& Conditions:** Introduced support for PDF uploads in Terms \& Conditions management. * **Advertiser Margin Support for Lifetime Budgets:** Extended advertiser margin updates to apply to lifetime budget campaigns. * **Branded Asset Review Emails:** Updated asset notifications to support custom retailer branding for select retailers. * **Audience Builder Sync Button:** Added Audience Sync button to poll for channel-derived audience updates. *We are continually deploying improvements between major releases. Recent notable items include:* 1. *Max number of ad groups per campaign has increased to 25.* 2. *Meta static carousel ad format is now available on Awareness campaigns.* 3. *Minor UX improvement to the campaign editing workflow.* --- language: "en" --- # May 2025 ## Release 3.7 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. \[RETAILER UI ONLY\] Google Search Term report 2. \[RETAILER UI ONLY\] YouTube awareness and traffic objective support 3. \[RETAILER UI ONLY\] YouTube multi-targeting groups 4. Meta - Placement/Asset customization by targeting/ad group 5. \[RETAILER UI ONLY\] Ads Reports 6. Misc Enhancements and Bug Fixes 1. \[RETAILER UI ONLY\] Retailer Campaign Id #2 field 2. \[RETAILER UI ONLY\] Advertiser form UX redesign 3. \[RETAILER UI ONLY\] Geotargeting - Advertiser access setting 4. \[RETAILER UI ONLY\] Retailer Settings - Financial settings UX design updates --- language: "en" --- # May 2026 ## Release 4.0 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Upgraded retailer reporting and streamlined KPI tracking * New Media Library for reusable assets and bulk uploads * Save campaigns as drafts and resume setup later * Create Meta retargeting audiences using page-visit criteria * Expanded targeting and pacing controls for The Trade Desk campaigns * Same Day Campaign support for eligible channels ### **1. Reporting \& Insights: Upgraded Retailer Campaigns Reporting Module** The Campaigns reporting table and data visualization has been upgraded to improve report load times, streamline KPI tracking, and simplify table navigation. #### Scorecards and Data Visualization * The scorecards are limited to four cards with a drop-down for metric selection to improve focus on key KPIs. * Scorecards and data visualization can now be collapsed to create more workspace for large reporting tables. #### Reporting Table and Menu Options * Table header and footer rows are frozen in view when scrolling through results. * The column selection menu displays column type and description clearly, eliminating the need to hover over labels. * Segmentation options are streamlined into a multi-level menu. Channel segmentation is removed. * Reporting tables display segmented data more clearly when metrics are unavailable at detailed levels. #### Report Download Files * Extracted reports (included scheduled reports) have several changes: * Row number index column (column 0) is removed. * Filtered totals row is now included. * Cleaner formatting. * Existing scheduled reports are not impacted. Please work with your account manager to align on a migration plan. *Availability: Retailers only* ### **2. Asset Management: Introducing the Media Library** The Media Library has been added within the Asset Management module. This new feature unlocks more streamlined workflows in both media file management and media file selection within asset creation. * A bulk upload option is available to select multiple media files in one upload action. * Within the asset creation workflow, media files can be selected from the library or new files can be uploaded directly within the asset workflow. The media selection option during asset creation is optional and intended to make asset creation across multiple channels more efficient with one media file upload. * There are no changes to the asset review workflow. * This new module is available for both advertisers and retailers. *Availability: Retailers and advertisers* ### **3. Audience Targeting: Meta Retargeting Audiences** The retailer audiences module includes an option to create a retargeting audience. Supported channels include Meta for the initial rollout. Use the form to define the audience criteria based on page visit URLs. *Availability: Retailers only* ### **4. Campaign Optimization: The Trade Desk Enhancements** There are several new features within the campaign creation and edit workflow for The Trade Desk campaigns. * Advertisers can now better control budget delivery pacing across lifetime campaigns. Daily budget campaigns pace to daily budget amount. * Inventory targeting controls are available at the ad group level, including Category, Category (App), and Genre targeting. These settings allow advertisers to target inventory based on the context of the content of a site or app. Options include both inclusion and exclusion. *Availability: Retailers and advertisers* ### **5. Campaign Creation: Draft Campaigns** The campaign creation workflow includes a new Save as Draft option to streamline ad operations. Campaigns are assigned a draft status designation and edits can resume upon reentering the campaign workflow. Campaign settings that are restricted from changes after campaign creation will also remain unavailable for editing within draft campaign modifications. *Availability: Retailers and advertisers* ### **6. Miscellaneous improvements and bug fixes, including but not exclusive of the following:** * **Addition of channel selection on audience edit:**Managed audiences can be edited to now include additional channels. * **Limited YouTube objectives:**The Awareness objective has been disabled for YouTube campaigns in favor of using the Traffic objective which utilizes the same optimization strategy. Existing campaigns are not impacted. * **Same Day Campaigns:** Campaigns can now utilize the current day as the end date, including single day campaigns where the start and end date are the current day, based on channel availability. * **Asset Emails:** Additional asset attributes have been added within the asset email body. * **Criteo On-site channel integration:** Additional features have been added to the Criteo on-site campaign workflow, including keyword bidding, attribution windows, placement bid multipliers, and spending limits. * **Campaign Spend Limit Advertiser Control:** A new advertiser control toggle is available within the advertiser campaign controls settings. * **The Trade Desk Lookalike Audiences:**It's possible to create lookalike audiences for The Trade Desk. * **Meta Traffic Optimization Update:** Meta Traffic campaigns are now optimizing to landing page. * **Campaign Copy Improvements:**Budget type and amount are now available on campaign copy. * **Retailer Reporting Improvements:** The Set Margin reporting column has been deprecated. Retailers using the Set Margin column should migrate to using the Channel Margin History report. * **Usability and Reliability Improvements:** Improvements continue to be added to improve system reliability, channel campaign sync nuances, and platform user experience. *We are continually deploying improvements between major releases.* --- language: "en" --- # May 2026 Release 2 ## Release 4.1 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Launch multi-channel Sponsored Product campaigns across DoorDash Onsite and Retailer Onsite (powered by Criteo) inventory * Improved lifetime budget recalculations when advertiser margin updates occur ### **1. Multi-Channel Campaign Support for DoorDash Onsite and Retailer Onsite (Powered by Criteo)** Advertisers can now manage DoorDash Onsite and Retailer Onsite Sponsored Product placements within a single campaign workflow, simplifying setup and cross-channel execution. Advertisers must be enabled for both channels in order to use this feature. Channel segmentation is now available within the Campaigns report to support channel-level performance analysis. *Availability: Limited availability to select retailers and advertisers* ### **2. Additional improvements and fixes include:** * **Advertiser margin update process:**Advertiser margin updates now apply only to the remaining unspent budget for active lifetime budget campaigns. * **Custom retailer branding extended to the retailer console:**The retailer's custom branding is now applied to the retailer's view of the platform. *We are continually deploying improvements between major releases.* --- language: "en" --- # \*Meta Ads (Facebook & Instagram) Symbiosys requires access to a dedicated Meta ad account and the applicable business assets to support a Meta Ads integration. The retailer retains ownership of all assets; a new Meta Business Portfolio is not required. **Important:** Creating and sharing the dedicated ad account does not automatically share the related Facebook Page, Instagram account, catalog, datasets/pixels, mobile app, or offline data source. Each applicable asset must be assigned separately to the Symbiosys partner record. Some assets must also be connected to the dedicated ad account. ## 1. Confirm Business and Domain Verification Confirm the retailer's existing Meta Business Portfolio is verified. If campaigns will direct users to the retailer's website or use website conversion events, also confirm that the retailer's domain is verified in Meta. The retailer retains ownership of the domain; it does not normally need to be shared with Symbiosys. * [Meta: Business Verification](https://www.facebook.com/business/help/1294735268952297) * [Meta: Domain Verification](https://developers.facebook.com/documentation/sharing/domain-verification/verifying-your-domain/) ## 2. Create a Dedicated Ad Account In **Business Settings → Accounts → Ad Accounts**: 1. Select **Add → Create a new ad account**. 2. Name it `{RETAILER} - Symbiosys`. 3. Set the appropriate currency and time zone. *Note: For consistent reporting, we recommend matching this time zone to your other channels (including on-site).* 4. Add the applicable payment method. 5. Keep the ad account owned by the retailer's existing Business Portfolio. * [Meta: Create or add an ad account](https://www.facebook.com/business/help/910137316041095) * [Meta: Ad-account permission levels](https://www.facebook.com/business/help/155909647811305) ## 3. Add Symbiosys as a Partner In **Business Settings → Users → Partners**: 1. Select **Add → Give a partner access to your assets**. 2. Enter the Symbiosys Meta Business Account ID: `189868700164474`. 3. Select each applicable asset listed below and grant its specific permissions. 4. Click **Save Changes**. If Symbiosys already appears as a partner, select the existing Symbiosys partner record and choose **Share assets** or **Assign assets**. Do not create a second partner record. Permissions are assigned separately for each asset. There is no need to grant a single global **Full Control** permission. [Meta: Give a partner access to business assets](https://www.facebook.com/business/help/1717412048538897) ## 4. Share and Connect Required Assets | Asset | Retailer setup and connection | Access to share with Symbiosys | Meta reference | |----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | Facebook Page | Confirm the Page is added to the retailer's Business Portfolio. | Content, Ads, Insights | [Add a Facebook Page](https://www.facebook.com/business/help/720478807965744) and [Page task access](https://www.facebook.com/business/help/2628326020772810) | | Instagram account, if used | Connect the professional Instagram account to the applicable Facebook Page and add it to the retailer's Business Portfolio. | Ads, Insights | [Connect Facebook and Instagram](https://www.facebook.com/help/instagram/connect-instagram-account/guide/) | | Relevant Commerce Manager catalog(s) | Use the existing catalog unless a separate catalog is required. Connect the dedicated Symbiosys ad account to the catalog as an associated or connected asset in Commerce Manager. | Partial Access → Create ads | [Assign catalog permissions](https://www.facebook.com/business/help/1953352334878186) | | Primary website dataset/Meta pixel | Confirm the existing data source is owned by the retailer. Connect the dedicated ad account if this source will be used for reporting, optimization, or fallback attribution. | View Pixels | [Meta Pixel setup](https://developers.facebook.com/documentation/meta-pixel/get-started/) | | Dedicated Symbiosys dataset/Meta pixel | Create it under the retailer's Business Portfolio and connect it to the dedicated Symbiosys ad account. | Manage Pixels | [Meta Pixel setup](https://developers.facebook.com/documentation/meta-pixel/get-started/) | Meta may use **dataset** and **pixel** for the same web event source in different parts of the interface. Symbiosys may use the primary website dataset/pixel as a fallback if events sent to the dedicated Symbiosys dataset/pixel are missing key matching fields, such as hashed email or Meta click IDs. ## 5. Share App and Offline Assets, If Applicable ### Mobile app Complete these steps if campaigns will direct users to or measure activity in the retailer's mobile app: 1. Add or claim the retailer's Meta app under **Business Settings → Accounts → Apps**. 2. Connect the dedicated Symbiosys ad account to the app. 3. Share the app asset and its applicable app-event source with the Symbiosys partner record. Grant the access required to create and manage app ads. 4. Provide the iOS and Android App IDs. 5. Confirm the mobile measurement partner, if applicable. 6. For Symbiosys attribution, provide click-through app-open and app-order events. * [Meta: Add apps and properties](https://www.facebook.com/business/help/709041312624617/) * [Meta: App Ads setup](https://developers.facebook.com/documentation/app-ads/get-started/) ### Offline attribution Complete these steps if Meta campaigns will be measured against in-store or other offline purchases: 1. Identify or create the Meta dataset/data source that will receive the offline events. 2. Connect the dedicated Symbiosys ad account to the dataset. 3. Share the applicable dataset/data source with the Symbiosys partner record. 4. Confirm whether the retailer or Symbiosys will send offline conversion events to Meta. * [Meta: Offline-event partner integrations](https://www.facebook.com/business/help/offlineconversionspartners/) * [Meta: Send offline events through Conversions API](https://developers.facebook.com/documentation/ads-commerce/conversions-api/offline-events/) ## 6. Confirm the Performance-Data Source Confirm how Symbiosys will receive Meta performance and conversion data: * If Symbiosys can pull the required data from the retailer's existing Meta setup, a separate direct integration of pageview and order events is not required for Meta. * If Symbiosys cannot pull the required data from the retailer's existing Meta setup, the retailer must send pageview and order events directly to Symbiosys for reporting, attribution, and optimization. [Symbiosys: Event Data Integration](https://docs.symbiosys.ai/ss/event-data-integration) ## 7. Optional * Share approved seed or lookalike audiences with the dedicated Symbiosys ad account. * For the Brand Opportunities Report, grant **View Performance** access to the retailer's core ad account. * Share required UTM conventions with your Symbiosys Sales Engineer. ## 8. Notify Symbiosys Once setup is complete: * Notify your Symbiosys contact that the assets have been shared. * If multiple Pages, catalogs, datasets/pixels, or apps exist, identify which assets Symbiosys should use. * Confirm the mobile measurement partner and who will send offline events, if applicable. Symbiosys will verify access and record the shared asset IDs before campaign setup begins. --- language: "en" --- # \*Microsoft Ads (formerly Bing) ## Overview Symbiosys requires access to a new Microsoft Ads account to support a Microsoft Ads integration. The ad account will be linked to the Symbiosys Microsoft Ads Manager account. Additionally, you may choose to provide Symbiosys with access to your core Microsoft ad account to unlock additional features like the Brand Opportunities Report. ## Instructions 1. **Log In to Microsoft Ads.** 2. **Create Symbiosys Ad Account**: a. Name the ad account using the format: "{Retailer}_{label}_Symbiosys". b. Ensure that your Catalog is linked to this ad account. 3. **Request to Link Ad Account:** 1. On the left-hand navigation, go to All Accounts, then click View all accounts. Click Link to accounts. Enter the Symbiosys Manager account number: `G1450013T4`. 2. Your Symbiosys Sales Engineer will approve the request. 4. **\[Optional\] Share Core Ad Account**: 1. Repeat Step 4 for your core ad accounts. --- language: "en" --- # \*Marketplaces ## Marketplaces and Seller Mapping If your business is marketplace or seller-based, meaning multiple sellers or vendors may offer the same product or brand, Symbiosys needs seller-level product data to support activation, attribution, and reporting. The preferred approach is to include seller information directly in the product catalog feed and send one row per seller offer for a given product. For example, if the same product is sold by three sellers, the feed should include three rows for that product, one for each seller offer. Each seller-offer row should include a stable product identifier, a stable `seller_id`, seller or vendor name where available, and any seller-specific values such as price, availability, fulfillment eligibility, and advertising eligibility. If seller information cannot be included directly in the product catalog feed, Symbiosys may request a separate seller mapping file that maps products to sellers. The product identifiers in the seller mapping file should match the identifiers used in the product catalog feed. When providing seller information or seller mapping files, please ensure that brand, seller, and vendor names are consistent across all files. --- language: "en" --- # November 2025 ## Release 3.14 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* 1. **YouTube Ad preview:**Ad preview is now supported in the campaign management setup experience for the YouTube channel. Once a YouTube asset is attached to the campaign, the asset will display in the ad preview box. 1. ![image-20251112-211836.png](https://docs.symbiosys.ai/__attachments/a_1ba8cd5abb68d1ec373581b9f141f84e2b6a4a6bc6a0717c9e8bdd240ccc7b22/image-20251112-211836.png?cb=1f91879435f962488fe50d7dcba00f16) YouTube Ad Preview 2. **SnapChat Custom Audiences and Multi-Targeting Groups:**We've added the ability to attach first-party custom audiences to SnapChat campaigns as well as more than one targeting group to support audience segmentation within the same campaign. 1. ![image-20251112-212240.png](https://docs.symbiosys.ai/__attachments/a_9a340fa61fe3a9c17d4524cc5b78cbf47f04c53177b19ac93ce32528f9e40aa4/image-20251112-212240.png?cb=17f7d5a2b632f12e2d1b2c05761758f5) SnapChat Custom Audiences and Multi-Targeting Group Setup 3. **\[LIMITED AVAILABILITY\] DoorDash Onsite Channel Integration:**DoorDash onsite ads are now supported as a channel inside of the platform. Availability depends on the retailer program and is limited to select retailers on initial rollout. 1. ![image-20251112-213746.png](https://docs.symbiosys.ai/__attachments/a_65300044c2cb05a723d7b5b77daa20fe5dbcd4ab324880a1ba2ae280872a41fa/image-20251112-213746.png?cb=eaaa7bac2947dff3ca7edbe89cae5b7e) DoorDash Onsite Channel Integration 4. **Reporting - Tool tips on column header row:**Tool tips will now display when hovering on the column header row in all major retailer and advertiser reports, extending the behavior released in September specifically on the Campaigns report. 1. ![image-20251118-144435.png](https://docs.symbiosys.ai/__attachments/a_64ab6e3cd98462ae6f859374ca31b185fa74fb92abab05d5575c478ca3abd336/image-20251118-144435.png?cb=5670f571da4a9214b1233748d9b84167) Tool tips on column header row 5. **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. \[RETAILER UI\] New advertiser-level control for exposing Demand Gen / YouTube network targeting options 2. Updated tooltips in campaign product targeting and campaign copy 3. Improvements to the Trade Desk campaign workflow experience 4. \[RETAILER UI ONLY\] New Optimized Targeting control for YouTube campaign management 5. Clickable links within the Campaigns report asset segmentation child rows to improve navigation to the Ads report 6. Visual asset preview thumbnail within the Ads report --- language: "en" --- # October 2025 ## Release 3.12 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* 1. **\[RETAILER UI ONLY\] Campaign Brand Scope:**A new brand selection allowing campaigns to be categorized by brand for multi-brand advertisers. This feature and related settings are available for limited retailers only with this release. 1. Optional **Brand Scope** **selection on campaign creation** 1. Select from a list of the advertiser's brands when an advertiser has more than one brand mapped to their account. By default, all advertiser brands are used, if unchanged. 2. ![image-20251002-145845.png](https://docs.symbiosys.ai/__attachments/a_600d77bbea3220f7e98f9d54bb80659a67ad89abc7c5bb8097b0058b344c6952/image-20251002-145845.png?cb=9d7a33d4f025beaab554a9afad851303) Campaign Brand Scope 2. Optional **Campaign Brand Sales** and **Campaign Brand Scope** **reporting columns** 1. Campaign Brand Sales calculates sales for the specific brand selected on the campaign. For campaigns using all brands, the sales will be calculated the same as the Sales metric. 2. ![image-20251002-145754.png](/__attachments/a_586c7b8485222e5299aea9bb6d5e12db32a6bf3769e43dc4586cebbeb3a25378/image-20251002-145754.png?cb=3ede797f51f467098daad42d1dc70d24) Campaign Brand Scope and Campaign Brand Sales reporting columns 2. **\[RETAILER UI ONLY\] Audience Pricing Groups:** Retailer-configurable audience margin tiers provide the ability to monetize first-party audiences on advertiser campaigns.The max audience margin is applied on a campaign when more than one audience is appended. This feature and related settings are available for limited retailers only. 1. Dedicated tab in the Audience Manager for **managing pricing groups and setting pricing group margins**. 1. ![image-20251002-155518.png](https://docs.symbiosys.ai/__attachments/a_6be47380b560798be14c62467b2f904918efcba58c2869e461b8895b6d8537c4/image-20251002-155518.png?cb=4e09b5b8947f817c8e3921d106bbd581) Pricing Groups within Audience Manager 2. 3. ![image-20251002-155719.png](/__attachments/a_261563b6ca6227a59030e7eea72a09f55ca263f397565b3ba5aa321527ba712d/image-20251002-155719.png?cb=9f8f30a9e89e705e87b1032e0f3119f3) New Pricing Group Setup 2. **Audience Earnings and Audience Margin %** optionally available within retailer reporting. 3. **Miscellaneous improvements and bug fixes,** including but not exclusive of the following: 1. Google Performance Max - Detailed interest and demographic targeting 2. \[RETAILER UI ONLY\] Advertiser Currency field on the Campaigns report 3. Pinterest - custom first-party audiences in the campaign workflow 4. Meta asset creation with featured SKUs - added validation to check for non-unique products 5. Reporting by Daily segmentation will show the max daily budget for the specific day when reporting data is present --- language: "en" --- # October 2025 Release 2 ## Release 3.13 *Note: Some of these features may not be available in your retailer's offsite media program. Please contact your account manager for more information.* 1. **\[RETAILER UI ONLY, LIMITED ROLLOUT\] The Trade Desk Display/Video/CTV:** The Trade Desk is now supported as a channel inside of the platform. Availability depends on the retailer program. We have introduce a new tab within the campaign workflow for The Trade Desk along with reporting capabilities. 2. As usual, this release includes high-priority bug fixes. --- language: "en" --- # October 2026 ## Release 4.6 *Note: Feature availability varies by retailer program, channel, and advertiser access. See each section below for details, or contact your account manager for more information.* ## **What's New** * Launch multi-channel Sponsored Products campaigns across Google Shopping and DoorDash Ads. * Optimize delivery with multiple ad group support, ad-group product set targeting, scheduling, budget controls, and optional YouTube Target CPA. * Improve campaign measurement with custom URL parameters, dynamic macros, and destination-URL previews. ### **1. Channel Expansion: Multi-Channel Campaigns combining Google Shopping and DoorDash Ads** Run catalog-based Sponsored Products across Google Shopping and DoorDash Ads from a single multi-channel campaign. Maintain channel-specific budget allocation, bidding, and targeting strategies while managing one campaign. ![image-20261015-135714.png](https://docs.symbiosys.ai/__attachments/a_1da0f1e00738ab0ed163792104c74b502a7dc242283a3b37d5c5c838e993c754/image-20261015-135714.png?cb=7bf83b4eaba566032973d6c7cc95663a) *Availability: Available to select retailers and advertisers enabled for multi-channel campaigns with Google Shopping and DoorDash Ads access* ### **2. Campaign Optimization: Ad Group and Product Controls** Refine campaign delivery and audience targeting with enhanced ad group controls and flexible product-set targeting for catalog-enabled ads. **Google Multiple Ad Groups** Create multiple ad groups within eligible Google campaigns to reach distinct audiences with tailored targeting strategies. * Supported on Google Shopping, Performance Max, and Search campaign types. **YouTube CPA Target** Set an optional Target CPA for eligible YouTube sales campaigns to guide bidding toward your desired acquisition cost. ![image-20261015-134434.png](https://docs.symbiosys.ai/__attachments/a_529c0cb96cd28343af60127f2fba7770e43f200bcde4bc5ad252444af21b8542/image-20261015-134434.png?cb=48793688868a9797b5cd387eb1b4f1c7) YouTube Target CPA Goal **Meta and Google Ad Group Product Set Customization** Match each ad group's products to its dedicated audience targeting while maintaining one campaign-level product set. Choose the campaign product set, a subset of campaign products, or a unique product set for each ad group. Options include: * The same product set defined at the campaign level * A subset of products from the campaign's product set * A unique product set ![image-20261015-141109.png](https://docs.symbiosys.ai/__attachments/a_d9092df39c99c7b659e27cc72ac467f2d26873b9f0f6eacec0b31c1dca9de7f2/image-20261015-141109.png?cb=7a29581bd69a717808ee25d3dca2b23c) Ad Group Product Set Overrides **DoorDash Ads Ad Group Schedule Overrides** Set ad group start and end dates for DoorDash Ads campaigns to align delivery with specific campaign timing strategies. ![image-20261015-134646.png](https://docs.symbiosys.ai/__attachments/a_42f1d724f61b6ef4a93eda27d07b9d518e134d4ecd34b0f1daf20412184f07b7/image-20261015-134646.png?cb=776ff84d894664993639c1beb0605a7c) DoorDash Ads Ad Group Schedule Overrides **The Trade Desk Ad Group Budget Overrides** Reserve a minimum budget for specific ad groups in The Trade Desk campaigns, helping align spend with individual targeting strategies. When no minimum is set, the campaign budget continues to distribute dynamically across ad groups. ![image-20261015-135408.png](https://docs.symbiosys.ai/__attachments/a_77adf8e14c989f5b36de4cd9257921ba0762f0bb78e8024e638c5498c82982f6/image-20261015-135408.png?cb=9b02dd421cda48cb6ee80722ddd97d4d) The Trade Desk Minimum Budget Allocation *Availability: Available to retailers and advertisers with eligible Google, YouTube, Meta, DoorDash Ads, or The Trade Desk access, depending on the capability* ### **3. Measurement \& Reporting: Custom URL Parameter Support** Append custom query parameters to an asset's destination URL in a streamlined workflow. **Custom URL Query Parameters** Add static query parameters, dynamic macros, and custom fragments to asset destination URLs to support consistent measurement. You can also apply parameters at the ad level and preview the final URL before publishing. Available on supported channels. * **Define parameters:** Enter a parameter name and assign a static value, dynamic value, or both. * **Use dynamic tokens:** Pass programmatic attributes into destination URLs. * **Append custom fragments:** Add fragments when needed. * **Apply parameters at the ad level:** Add URL parameters to individual ads. * **Preview the final URL:** Review the updated destination URL before publishing. ![image-20261015-140812.png](https://docs.symbiosys.ai/__attachments/a_a7190236568c87f079651258f894718ad4ae9b881b6a960fc5f4ee920723ee03/image-20261015-140812.png?cb=dd85716401e6ef32fddb2fc0d728dc65) Query Parameter Configuration using Dynamic Tokens *Availability: All retailers and advertisers with URL parameter access enabled* ### Additional Improvements * **Channel Specific Minimum Budgets:** Set a minimum budget per channel to help maintain planned investment across multi-channel campaigns. * **Advertiser Controls - Multi-Channel Budget Allocation Defaults:** Set budget allocation percentage defaults for advertisers with access to multi-channel campaigns. * **Advertiser Controls - Multi-Channel Budget Allocation Permission:**Limit advertiser access to campaign budget allocation for multi-channel campaigns. Set advertiser budget allocation defaults or retailer program-wide budget allocation defaults. * **Advertiser controls - Channel Reporting Permission:** Limit advertiser access to channel-level reporting including channel segmentation and Ads reporting. * **Expanded Child Product Visibility in Product Targeting:**View child product counts and expand parent products to review their associated child products during product targeting. * **Advertiser Controls - Asset Domain Overrides:**Allow advertisers to use a specific domain in the asset's URL for custom landing page optimization. Options include using the retailer's program-wide default, an advertiser-specific domain, or any domain. * **Advertiser Controls - Kevel-Powered Onsite Incrementality Target:** Allow advertisers to define campaign-specific incrementality targets for eligible Kevel on-site campaigns. * **Advertiser Controls - The Trade Desk Custom Measurement and Audience Seed Definition:** Assign specific pixels at the advertiser or brand-level for campaign optimization and create audience seeds using corresponding data. * *We are continually deploying improvements between major releases.* --- language: "en" --- # \*Pinterest Ads Symbiosys requires access to a new Pinterest Ads account to support a Pinterest Ads integration. The ad account will be linked to the Symbiosys Business account. Additionally, you may choose to provide Symbiosys with read-only access to your core Pinterest ad account to unlock additional features like the Brand Opportunities Report. ## **Instructions** 1. **Log In to Pinterest Business account.** 2. **Create a New Pinterest Ads Account:** 1. On the left tab, go to Assets \> Ad Accounts. 2. Click Add account \> Create new ad account. 3. Name it "{RETAILER} - Symbiosys". 4. Select the country where your business is headquartered. 5. **\[Optional\]** Assign members of your team to the ad account. 3. **Partner with Symbiosys Business**: 1. **OPTION A**: Symbiosys Requests Partner Access 1. Provide your Symbiosys Sales Engineer with your Business ID for Symbiosys to request partner access to your business. 2. **OPTION B**: Grant Partner Access 1. Click your Profile dropdown menu and hover over your Business account and click the briefcase icon to go to your business account settings. 2. On the left panel, click the Partners tab. 3. Click Add Partner. 4. Enter the Symbiosys Business ID: `985725574599280865`. 5. Select "Invite this partner..." \> Add partner. 6. In step 2, select the newly created "{RETAILER} - Symbiosys" ad account and, optionally, any core accounts you'd like to share. 7. Grant account permissions. 1. Ad account admin OR \[Analyst, Audience, Campaign, Catalogs\]. 4. **Specify which Catalog Data Source to Target**. 1. During campaign creation, Pinterest requires that you specify which Data Source to target as the "product group". If your Catalog contains multiple Data Sources, tell your Symbiosys Sales Engineer which Data Source should be targeted. 5. **\[Optional\]** Share UTM Parameters with Symbiosys: 1. If you expect specific UTM parameters on your ad URLs for reporting purposes, share these with your Symbiosys Sales Engineer. --- language: "en" --- # Preventing Campaign Overlap ## Preventing Campaign Overlap ### Preventing overlap between Symbiosys and retailer-managed Google campaigns Products running in Symbiosys campaigns may also be eligible to serve in retailer-managed Google campaigns; however, when the same SKU is active in multiple campaigns, they can overlap and compete against each other. To prevent this, Symbiosys identifies products that are currently active in Symbiosys campaigns and makes them available for exclusion from retailer-managed campaigns in Google Ads. #### How Symbiosys identifies active products Symbiosys creates and maintains a supplemental feed in your Google Merchant Center (GMC) that populates a selected `custom_label` field with the value `symbiosys_active`. In the simplest setup, Symbiosys uses an unused `custom_label` field, such as `custom_label_0` or `custom_label_4`, where the full value is exactly: `custom_label = symbiosys_active` If all `custom_label` fields are already in use, Symbiosys can instead add `symbiosys_active` to an existing custom label value using an agreed delimiter, such as: `custom_label_3 = seasonal|symbiosys_active` In this case, the retailer should configure the Google Ads product group to match where the custom label **contains** `symbiosys_active`, rather than where it **equals** `symbiosys_active`. Reference: This value is applied only to SKUs that are currently active in Symbiosys campaigns. The label is updated hourly while campaigns are active, so product eligibility reflects live campaign activity. When a Symbiosys campaign ends, the `symbiosys_active` value is removed and the SKU becomes eligible again for retailer-managed campaigns. #### How the exclusion works in Google Ads The retailer creates a product group using the selected custom label value, then applies that product group as a filter to exclude overlapping products from their own campaigns. If Symbiosys is using a dedicated custom label, the product group can be configured using an exact match: `custom_label equals symbiosys_active` If Symbiosys is adding `symbiosys_active` to an existing custom label that already contains other values, the product group should be configured using a contains match: `custom_label contains symbiosys_active` After this setup is complete, any SKU activated in a Symbiosys campaign is automatically filtered out of retailer-managed campaigns for the duration of the Symbiosys campaign. Reference: #### Retailer setup steps 1. Confirm the Symbiosys supplemental feed is active - Symbiosys will create and maintain a supplemental feed in your Google Merchant Center that populates a selected `custom_label` field with the value `symbiosys_active` for relevant SKUs. 2. Confirm which custom label setup will be used: * If an unused `custom_label` field is available, configure the Google Ads product group where `custom_label equals symbiosys_active`. * If Symbiosys is adding `symbiosys_active` to an existing custom label value, configure the Google Ads product group where `custom_label contains symbiosys_active`. 3. Exclude the product group from retailer-managed campaigns - Apply an exclusion for the `symbiosys_active` product group across all retailer-managed campaigns. Important: The product group only needs to be created once; however, the exclusion filter must be applied to every retailer-managed campaign where Symbiosys overlap should be prevented. #### Optional: retailer-first prioritization Alternatively, retailers can also use the same `custom_label` field to indicate products that are already active in retailer-managed campaigns: `retailer_active`. Symbiosys can then exclude those products from Symbiosys campaigns in the same manner, supporting a first-in-wins prioritization model where whichever campaign first flags a SKU takes priority and the other campaign excludes it. If `retailer_active` is the only value in a dedicated custom label, Symbiosys can match on `custom_label equals retailer_active`. If `retailer_active` is added to an existing custom label with multiple values, Symbiosys can match on `custom_label contains retailer_active`. To ensure this works correctly, the `retailer_active` value must be kept up to date based on retailer campaign flight dates. --- language: "en" --- # September 2024 ## Release 2.7 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Meta and TikTok Ad preview 2. Marketplace seller support 3. Meta country-specific/multi-ad account support 4. Retailer channel settings - ad format default improvements 5. Various bug fixes to improve campaign management experience --- language: "en" --- # October 2024 ## Release 3.0 *Note: Some of these features may not be available in your retailer's offsite media program.* 1. Meta and TikTok Traffic and Awareness objectives support 2. Product targeting user experience improvements 3. YouTube asset creation user experience improvements 4. Google Performance Max asset support 5. Managed retailer first-party audience support for TikTok campaigns 6. Bug fixes and user experience enhancements [Next Page](https://docs.symbiosys.ai/llms-full.txt/1)