--- title: "Create a banner campaign" method: POST path: "/v3/banner-campaigns" tags: ["bannerCampaign"] --- # Create a banner campaign `POST /v3/banner-campaigns` Creates a new banner campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new campaign. ## Request body - V3CreateBannerCampaignRequest - `bannerCampaign` V3CampaignRequest, required - `id` string — The unique identifier of the campaign. - `updateTime` string, date-time — The last time the entity was updated. - `name` string, required — The name of the campaign. - `namespaceId` string, required — The unique identifier of the namespace. - `campaignState` 'CAMPAIGN_STATE_UNSPECIFIED' | 'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED', required - `templateId` string — The unique identifier of the campaign template. - `managerTeamId` string — The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns. - `teamId` string, required — The unique identifier of the campaign's team. - `startTime` string, date-time — When the campaign starts as a precise ISO-8601 timestamp. - `endTime` string, date-time — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'. - `walletId` string, required — The unique identifier of the wallet to be charged for the campaign. - `placementId` string, required — The unique identifier of the campaign's placement. - `catalogIds` string[], required — The unique identifier of the retailer's catalog. - `advertisedProducts` Campaignv3AdvertisedProducts, required - `productsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `productGroupList` string[] — The list of product group ids from Epsilon Digital - `targeting` Campaignv3Targeting - `searchTerms` Campaignv3SearchTerm[] — Used for placements that target search terms. - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH' - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term. - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms. - `crossSell` Campaignv3CrossSell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `upsell` Campaignv3Upsell - `targetProductsByKey` Campaignv3CatalogProductSeller[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to an empty string. - `excludeFilters` Campaignv3TargetedFilter[] — Used for integrations, excluding those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `includeFilters` Campaignv3TargetedFilter[] — Used for integrations, including those with the filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `negativeSearchTerms` V3NegativeSearchTerm[] — Used for placements that target search terms. - `phrase` string — The negative search term. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_EXACT_MATCH' | 'MATCH_TYPE_PHRASE_MATCH' - `audience` V3Audience - `includeSegmentsSets` V3SegmentsSet[] — Segment sets used for audience targeting combined by AND operator. - `segmentIds` string[] — Segments used for audience targeting combined by OR operator. - `strategy` Campaignv3Strategy, required - `auction` Campaignv3Auction - `maxBid` string — The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid. - `spendLimit` Campaignv3SpendLimit - `daily` string — Daily spend limit. - `total` string — Total spend limit. - `fixedTenancy` Campaignv3FixedTenancy - `cost` string — The cost of the campaign for reporting purposes. This value is not charged to the wallet. - `positions` integer[] — The fixed tenancy position booked by the campaign. - `catalogCosts` Campaignv3CatalogCost[] - `catalogId` string — The unique identifier of the retailer's catalog. - `catalogCostPercentage` number, float — The percentage of the campaign's cost allocated to the catalog. - `fixedCosts` Campaignv3FixedCosts - `dataCost` string — The cost associated with data for the campaign. - `creativeCost` string — The cost associated with creative production for the campaign. - `otherCost` string — The cost associated with other expenses for the campaign. - `customFields` Campaignv3CustomField[] - `customFieldId` string — The unique identifier of the custom field. - `content` string — The contents of the custom field. - `customQuestions` Campaignv3CustomQuestion[] — Used for integrations utilising custom targeting. - `customQuestionId` string — The ID of the custom question. - `answers` string[] — The selections of the advertiser relevant to the custom question. - `sellerId` string — The sellerId of the campaign. Defaults to empty string if null. - `bannerConfig` V3BannerConfig, required - `contentStandardId` string — The unique identifier of the content standard. - `slotsConfiguration` V3SlotsConfiguration[] — The unique identifier of the slots configuration. - `slotId` string — The unique identifier for the slot in the configuration. Example: 'homepage_banner_slot_1' - `artworkImageId` string — The identifier for the image used as artwork in the slot. Example: 'image_1234' - `link` string — The URL link associated with the slot, directing the user to a target page when clicked. Example: 'https://www.example.com/promo' - `altText` string — Alternative text for the artwork image, providing a description for accessibility. Example: 'Promotional banner for summer sale' - `text` string — The display text for the slot, providing additional information or a message. Example: 'Get 20% off your first purchase!' - `trackingTagProvider` V3TrackingTag[] — List of tracking tags from the provider, required for tracking interactions with the slot. Example: '[ { provider: 'Google Analytics', tag: 'promo_click' }, { provider: 'Adobe Analytics', tag: 'banner_view' } ]' - `provider` 'TRACKING_TAG_PROVIDER_UNSPECIFIED' | 'TRACKING_TAG_PROVIDER_DV' | 'TRACKING_TAG_PROVIDER_DCM_CLICK' | 'TRACKING_TAG_PROVIDER_DCM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_MOAT' | 'TRACKING_TAG_PROVIDER_IAS' | 'TRACKING_TAG_PROVIDER_GTM360' | 'TRACKING_TAG_PROVIDER_SIZMEK' | 'TRACKING_TAG_PROVIDER_ADFORM_CLICK' | 'TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_DV_IMAGE' - `content` string — The content of the tracking tag. ## Response `200` Details of the created banner campaign. - V3CreateBannerCampaignResponse - `bannerCampaign` V3CampaignResponse - `id` string — The unique identifier of the campaign. - `updateTime` string, date-time — The last time the entity was updated. - `name` string — The name of the campaign. - `namespaceId` string — The unique identifier of the namespace. - `approval` Campaignv3Approval - `state` 'APPROVAL_STATE_PENDING' | 'APPROVAL_STATE_APPROVED' | 'APPROVAL_STATE_REJECTED' - `rejectionReason` string — The reason a campaign has been rejected. Mandatory field if status is APPROVAL_STATE_REJECTED - `campaignState` 'CAMPAIGN_STATE_UNSPECIFIED' | 'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED' - `templateId` string — The unique identifier of the campaign template. - `managerTeamId` string — The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns. - `teamId` string — The unique identifier of the campaign's team. - `startTime` string, date-time — When the campaign starts as a precise ISO-8601 timestamp. - `endTime` string, date-time — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'. - `walletId` string — The unique identifier of the wallet to be charged for the campaign. - `placementId` string — The unique identifier of the campaign's placement. - `catalogIds` string[] — The unique identifier of the retailer's catalog. - `advertisedProducts` Campaignv3AdvertisedProductsR - `productsByKey` Campaignv3CatalogProductSellerR[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to empty string. - `targeting` Campaignv3TargetingR - `searchTerms` Campaignv3SearchTermR[] — Used for placements that target search terms. - `phrase` string — The keyword you are targeting. Has a maximum length of 150 characters - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH' - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `excludedProducts` Campaignv3CatalogProductSellerR[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise. - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to empty string. - `maxBid` string — The maximum cost per click bid for the search term. This bid will override the auction max bid for this search term. - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms will apply to all products in the campaign. This flag should only be used when the placement has suggested search terms enabled and custom terms are allowed. - `crossSell` Campaignv3CrossSellR - `targetProductsByKey` Campaignv3CatalogProductSellerR[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to empty string. - `upsell` Campaignv3UpsellR - `targetProductsByKey` Campaignv3CatalogProductSellerR[] - `catalogId` string — The unique identifier of the retailer's catalog. - `productCode` string — The product code within the catalog. - `sellerId` string — The seller ID for the product. Defaults to empty string. - `excludeFilters` Campaignv3TargetedFilterR[] — Used for integrations with the excluding of filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `includeFilters` Campaignv3TargetedFilterR[] — Used for integrations with the including of filters enabled. - `catalogId` string — The unique identifier of the retailer's catalog. - `filter` string — The product filter targeted by the campaign. - `negativeSearchTerms` V3NegativeSearchTermR[] — Used for placements that target search terms. - `phrase` string, required — The negative search term. - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_EXACT_MATCH' | 'MATCH_TYPE_PHRASE_MATCH', required - `strategy` Campaignv3StrategyR - `auction` Campaignv3Auction - `maxBid` string — The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid. - `spendLimit` Campaignv3SpendLimit - `daily` string — Daily spend limit. - `total` string — Total spend limit. - `fixedTenancy` Campaignv3FixedTenancyR - `cost` string — The cost of the campaign for reporting purposes. This value is not charged to the wallet. - `catalogCosts` Campaignv3CatalogCostR[] - `catalogId` string — The unique identifier of the retailer's catalog. - `catalogCostPercentage` number, float — The percentage of the campaign's cost allocated to the catalog. - `fixedCosts` Campaignv3FixedCosts - `dataCost` string — The cost associated with data for the campaign. - `creativeCost` string — The cost associated with creative production for the campaign. - `otherCost` string — The cost associated with other expenses for the campaign. - `customFields` Campaignv3CustomFieldR[] - `customFieldId` string — The unique identifier of the custom field. - `content` string — The contents of the custom field. - `customQuestions` Campaignv3CustomQuestionR[] — Used for integrations utilising custom targeting. - `customQuestionId` string — The id of the custom question. - `answers` string[] — The selections of the advertiser relevant to the custom question. - `sellerId` string — The sellerId of the campaign. Defaults to empty string if null. - `bannerConfig` V3BannerConfigR - `contentStandardId` string — The unique identifier of the content standard. - `slotsConfiguration` V3SlotsConfiguration[] — The unique identifier of the slots configuration. - `slotId` string — The unique identifier for the slot in the configuration. Example: 'homepage_banner_slot_1' - `artworkImageId` string — The identifier for the image used as artwork in the slot. Example: 'image_1234' - `link` string — The URL link associated with the slot, directing the user to a target page when clicked. Example: 'https://www.example.com/promo' - `altText` string — Alternative text for the artwork image, providing a description for accessibility. Example: 'Promotional banner for summer sale' - `text` string — The display text for the slot, providing additional information or a message. Example: 'Get 20% off your first purchase!' - `trackingTagProvider` V3TrackingTag[] — List of tracking tags from the provider, required for tracking interactions with the slot. Example: '[ { provider: 'Google Analytics', tag: 'promo_click' }, { provider: 'Adobe Analytics', tag: 'banner_view' } ]' - `provider` 'TRACKING_TAG_PROVIDER_UNSPECIFIED' | 'TRACKING_TAG_PROVIDER_DV' | 'TRACKING_TAG_PROVIDER_DCM_CLICK' | 'TRACKING_TAG_PROVIDER_DCM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_MOAT' | 'TRACKING_TAG_PROVIDER_IAS' | 'TRACKING_TAG_PROVIDER_GTM360' | 'TRACKING_TAG_PROVIDER_SIZMEK' | 'TRACKING_TAG_PROVIDER_ADFORM_CLICK' | 'TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_DV_IMAGE' - `content` string — The content of the tracking tag. - `settings` V3CampaignSettings - `campaignType` 'CAMPAIGN_TYPE_UNSPECIFIED' | 'CAMPAIGN_TYPE_DISPLAY' | 'CAMPAIGN_TYPE_BANNER' | 'CAMPAIGN_TYPE_BANNERX' | 'CAMPAIGN_TYPE_BRAND_PAGE' | 'CAMPAIGN_TYPE_EMAIL' | 'CAMPAIGN_TYPE_SAMPLES' | 'CAMPAIGN_TYPE_SUBSTITUTIONS' | 'CAMPAIGN_TYPE_PAST_ORDERS' - `fromTime` string, date-time — fromTime - `toTime` string, date-time — toTime ## Other responses - `400` — There was a problem with input. - `401` — Login failed or token not valid. - `403` — Login failed or token not valid. - `default` — An unexpected error response. --- [API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)