> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/createbannerxcampaign-1.md). # バナー X キャンペーンの作成 {% hint style="info" %} ファイル アップロード ガイドライン ## BannerX 設定フィールドの検証 ### contentStandardId * 有効な UUID 形式である必要があります * shotgun\_banner\_content\_standard\_model テーブルに存在する必要があります * ユーザーと同じネームスペースに属している必要があります ### slotID * 指定された contentStandardId の一部である必要があります ### slotType * 次のいずれかの enum である必要があります: * `BANNER_X_SLOT_TYPE_BANNER` * `BANNER_X_SLOT_TYPE_SINGLE_TILE` * `BANNER_X_SLOT_TYPE_DOUBLE_TILE` * contentStandardId の詳細に含まれている必要があります ### headingText * contentStandardId の詳細にある headingTextConfiguration に対して検証されます * 指定された最大文字制限を超えてはなりません * 設定でそのようにマークされている場合は必須です ### bannerText * contentStandardId の詳細にある bannerTextConfiguration に対して検証されます * 指定された最大文字制限を超えてはなりません * 設定でそのようにマークされている場合は必須です ### bannerTextColourHex * 有効な HEX カラーである必要があります * コンテンツ スタンダードで提供されている場合、fixedBannerTextColourHexOptions のオプションのいずれかと一致する必要があります ### ctaFlag * contentStandardId の詳細にある callToActionConfiguration に対して検証されます * 有効になっている場合、すべての CTA フィールド (ctaText、ctaTextAccessibility、ctaLink) を提供する必要があります ### ctaText * コンテンツ スタンダードの callToActionConfiguration に対して検証されます * 設定で指定された文字制限を超えてはなりません * そのようにマークされている場合は必須です ### ctaTextAccessibility * 最大長は 200 文字です ### ctaLink * linkPrefix と一致し、設定で指定された linkCharacterLimit を超えないようにする必要があります * デフォルトの最大長は 200 文字です ### backgroundColourHex * 有効な HEX カラーである必要があります * コンテンツ スタンダードで提供されている場合、そのオプションと一致する必要があります ### backgroundImageId * イメージ バケット内に存在する必要があります * 有効になっている場合、画像の寸法は primaryBackgroundImageConfiguration で指定されたものと一致する必要があります * そのようにマークされている場合は必須です ### backgroundImagePosition * 設定で指定されているとおり、次のいずれかの enum である必要があります: * `BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING` * `BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED` * `BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED` * `BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED` * `BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED` * `BANNER_X_BACKGROUND_IMAGE_POSITION_FILL` ### secondaryBackgroundImageId * イメージ バケット内に存在する必要があります * 有効になっている場合、画像の寸法は secondaryBackgroundImageConfiguration で指定されたものと一致する必要があります * そのようにマークされている場合は必須です ### secondaryBackgroundImagePosition * 設定で許可されている enum のいずれかである必要があります * コンテンツ スタンダードに対して有効である必要があります ### heroImageId * イメージ バケット内に存在する必要があります * 有効になっている場合、画像の寸法は heroImageConfiguration で指定されたものと一致する必要があります * そのようにマークされている場合は必須です ### heroImageAltText * 最大長は 200 文字です ### heroMode * 設定で指定されているとおり、次のいずれかの enum である必要があります: * `BANNER_X_HERO_IMAGE_MODE_BLOCK` * `BANNER_X_HERO_IMAGE_MODE_LANDSCAPE` * `BANNER_X_HERO_IMAGE_MODE_PORTRAIT` * コンテンツ スタンダードに対して有効である必要があります ### secondaryHeroImageId * イメージ バケット内に存在する必要があります * 有効になっている場合、画像の寸法は secondaryHeroImageConfiguration で指定されたものと一致する必要があります * そのようにマークされている場合は必須です ### secondaryHeroImageAltText * 最大長は 200 文字です ### secondaryHeroMode * 設定で許可されている enum のいずれかである必要があります * コンテンツ スタンダードに対して有効である必要があります ### additionalFields 検証はフィールド タイプによって異なります: **カラー フィールドの場合:** * mandatory が false で enabled が true の場合、有効な HEX カラーである必要があります * mandatory が true で enabled が true の場合、colorHexOptions のいずれかと一致する必要があります **テキスト フィールドの場合:** * maxCharacterLimit を超えてはなりません * 設定で定義されている固定オプションまたはドロップダウンが含まれる場合があります ### trackingTagProvider * 現時点では検証は不要です ## CTAフィールドの特別検証 ### コンテンツ標準レベルでCTAが有効になっている場合: * 設定 `ctaFlag=true` では、3つのフィールド（ctaText、ctaTextAccessibility、ctaLink）をすべて指定する必要があります * コンテンツ標準で制限が設定されている場合はそれが適用されます。そうでない場合、デフォルトの制限は次のとおりです: #### CTAテキスト: * `BANNER_X_SLOT_TYPE_SINGLE_TILE`: 15文字 * `BANNER_X_SLOT_TYPE_DOUBLE_TILE`: 15文字 * `BANNER_X_SLOT_TYPE_BANNER`: 10文字 * `BANNER_X_SLOT_TYPE_UNSPECIFIED`: 1000文字 #### CTAリンク: 最大200文字 #### CTA TextAccessibility: 最大200文字 * If `ctaFlag=false`, すべてのCTAフィールドはnullである必要があります。そうでない場合、400 Bad Requestが返されます ### コンテンツ標準レベルでCTAが無効になっている場合: * `ctaFlag` falseに設定する必要があり、すべてのCTAフィールドはnullである必要があります * 設定 `ctaFlag=true` またはCTAフィールド値を指定すると、400 Bad Requestが発生します {% endhint %} ## Create a banner X campaign > Creates a new banner X 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. ```json {"openapi":"3.0.0","info":{"title":"Citrus Campaign APIs","version":"v3"},"tags":[],"servers":[{"url":"https://campaign..citrusad.com"}],"security":[{"TokenSecurity":[]}],"components":{"securitySchemes":{"TokenSecurity":{"description":"For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"v3CreateBannerXCampaignRequest":{"properties":{"bannerXCampaign":{"$ref":"#/components/schemas/v3CampaignRequest"}},"required":["bannerXCampaign"],"type":"object"},"v3CampaignRequest":{"properties":{"advertisedProducts":{"$ref":"#/components/schemas/campaignv3AdvertisedProducts"},"bannerXConfig":{"$ref":"#/components/schemas/v3BannerXConfig"},"campaignState":{"$ref":"#/components/schemas/campaignv3CampaignState"},"catalogIds":{"description":"The unique identifier of the retailer's catalog.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"customFields":{"items":{"$ref":"#/components/schemas/campaignv3CustomField"},"maxItems":5,"type":"array","uniqueItems":true},"customQuestions":{"description":"Used for integrations utilising custom targeting.","items":{"$ref":"#/components/schemas/campaignv3CustomQuestion"},"maxItems":5,"type":"array"},"endTime":{"description":"When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.","format":"date-time","type":"string"},"fixedCosts":{"$ref":"#/components/schemas/campaignv3FixedCosts"},"id":{"description":"The unique identifier of the campaign.","readOnly":true,"type":"string"},"managerTeamId":{"description":"The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns.","type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"namespaceId":{"description":"The unique identifier of the namespace.","type":"string"},"placementId":{"description":"The unique identifier of the campaign's placement.","type":"string"},"sellerId":{"description":"The sellerId of the campaign. Defaults to empty string if null.","type":"string"},"startTime":{"description":"When the campaign starts as a precise ISO-8601 timestamp.","format":"date-time","type":"string"},"strategy":{"$ref":"#/components/schemas/campaignv3Strategy"},"targeting":{"$ref":"#/components/schemas/campaignv3Targeting"},"teamId":{"description":"The unique identifier of the campaign's team.","type":"string"},"templateId":{"description":"The unique identifier of the campaign template.","type":"string"},"updateTime":{"description":"The last time the entity was updated.","format":"date-time","readOnly":true,"type":"string"},"walletId":{"description":"The unique identifier of the wallet to be charged for the campaign.","type":"string"}},"required":["name","namespaceId","campaignState","teamId","walletId","placementId","catalogIds","strategy","bannerXConfig","advertisedProducts"],"type":"object"},"campaignv3AdvertisedProducts":{"properties":{"productsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array"}},"type":"object"},"campaignv3CatalogProductSeller":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"productCode":{"description":"The product code within the catalog.","type":"string"},"sellerId":{"description":"The seller ID for the product. Defaults to empty string.","type":"string"}},"required":["catalogId","productCode"],"type":"object"},"v3BannerXConfig":{"properties":{"additionalFields":{"description":"BannerX AdditionalFields","items":{"$ref":"#/components/schemas/v3AdditionalFields"},"type":"array"},"backgroundColourHex":{"description":"The background color of the banner in hex format.","type":"string"},"backgroundImageId":{"description":"The unique identifier of the background image.","type":"string"},"backgroundImagePosition":{"$ref":"#/components/schemas/BannerXConfigBannerXBackgroundImagePosition"},"bannerText":{"description":"The main text of the banner.","type":"string"},"bannerTextColourHex":{"description":"The color of the banner text in hex format.","type":"string"},"contentStandardId":{"description":"The unique identifier of the content standard.","type":"string"},"ctaFlag":{"description":"Flag indicating if the banner has a call-to-action.","type":"boolean"},"ctaLink":{"description":"The URL for the call-to-action link.","type":"string"},"ctaText":{"description":"The call-to-action text on the banner.","type":"string"},"ctaTextAccessibility":{"description":"The call-to-action text for accessibility purposes.","type":"string"},"headingText":{"description":"The heading text for the banner.","type":"string"},"heroImageAltText":{"description":"The alternate text for the hero image.","type":"string"},"heroImageId":{"description":"The unique identifier for the hero image.","type":"string"},"heroMode":{"$ref":"#/components/schemas/BannerXConfigBannerXHeroImageMode"},"secondaryBackgroundImageId":{"description":"The unique identifier for the secondary background image.","type":"string"},"secondaryBackgroundImagePosition":{"$ref":"#/components/schemas/BannerXConfigBannerXBackgroundImagePosition"},"secondaryHeroImageAltText":{"description":"The alt text for the secondary hero image.","type":"string"},"secondaryHeroImageId":{"description":"The unique identifier for the secondary hero image.","type":"string"},"secondaryHeroMode":{"$ref":"#/components/schemas/BannerXConfigBannerXHeroImageMode"},"slotId":{"description":"The unique identifier of the slot.","type":"string"},"slotType":{"$ref":"#/components/schemas/BannerXConfigBannerXSlotType"},"trackingTagProvider":{"description":"BannerX TrackingTagProvider","items":{"$ref":"#/components/schemas/v3TrackingTag"},"type":"array"}},"required":["contentStandardId","slotId","slotType"],"type":"object"},"v3AdditionalFields":{"properties":{"id":{"description":"The unique identifier for the item.","type":"string"},"value":{"description":"The value associated with the item.","type":"string"}},"type":"object"},"BannerXConfigBannerXBackgroundImagePosition":{"default":"BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING","enum":["BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING","BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED","BANNER_X_BACKGROUND_IMAGE_POSITION_FILL"],"type":"string"},"BannerXConfigBannerXHeroImageMode":{"default":"BANNER_X_HERO_IMAGE_MODE_BLOCK","enum":["BANNER_X_HERO_IMAGE_MODE_BLOCK","BANNER_X_HERO_IMAGE_MODE_LANDSCAPE","BANNER_X_HERO_IMAGE_MODE_PORTRAIT"],"type":"string"},"BannerXConfigBannerXSlotType":{"default":"BANNER_X_SLOT_TYPE_BANNER","enum":["BANNER_X_SLOT_TYPE_BANNER","BANNER_X_SLOT_TYPE_SINGLE_TILE","BANNER_X_SLOT_TYPE_DOUBLE_TILE"],"type":"string"},"v3TrackingTag":{"properties":{"content":{"description":"The content of the tracking tag.","type":"string"},"provider":{"$ref":"#/components/schemas/TrackingTagTrackingTagProvider"}},"type":"object"},"TrackingTagTrackingTagProvider":{"default":"TRACKING_TAG_PROVIDER_DV","enum":["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"],"type":"string"},"campaignv3CampaignState":{"enum":["CAMPAIGN_STATE_ACTIVE","CAMPAIGN_STATE_PAUSED","CAMPAIGN_STATE_DRAFT","CAMPAIGN_STATE_ARCHIVED"],"type":"string"},"campaignv3CustomField":{"properties":{"content":{"description":"The contents of the custom field.","type":"string"},"customFieldId":{"description":"The unique identifier of the custom field.","type":"string"}},"required":["customFieldId","content"],"type":"object"},"campaignv3CustomQuestion":{"properties":{"answers":{"description":"The selections of the advertiser relevant to the custom question.","items":{"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"customQuestionId":{"description":"The id of the custom question.","type":"string"}},"required":["customQuestionId","answers"],"type":"object"},"campaignv3FixedCosts":{"properties":{"creativeCost":{"description":"The cost associated with creative production for the campaign.","type":"string"},"dataCost":{"description":"The cost associated with data for the campaign.","type":"string"},"otherCost":{"description":"The cost associated with other expenses for the campaign.","type":"string"}},"type":"object"},"campaignv3Strategy":{"properties":{"auction":{"$ref":"#/components/schemas/campaignv3Auction"},"fixedTenancy":{"$ref":"#/components/schemas/campaignv3FixedTenancy"}},"type":"object"},"campaignv3Auction":{"properties":{"maxBid":{"description":"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.","type":"string"},"spendLimit":{"$ref":"#/components/schemas/campaignv3SpendLimit"}},"type":"object"},"campaignv3SpendLimit":{"properties":{"daily":{"description":"Daily spend limit.","type":"string"},"total":{"description":"Total spend limit.","type":"string"}},"type":"object"},"campaignv3FixedTenancy":{"properties":{"catalogCosts":{"items":{"$ref":"#/components/schemas/campaignv3CatalogCost"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"cost":{"description":"The cost of the campaign for reporting purposes. This value is not charged to the wallet.","type":"string"},"positions":{"description":"The fixed tenancy position booked by the campaign.","items":{"format":"int32","minimum":1,"type":"integer"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"required":["cost","positions","catalogCosts"],"type":"object"},"campaignv3CatalogCost":{"properties":{"catalogCostPercentage":{"description":"The percentage of the campaign's cost allocated to the catalog.","format":"float","maximum":1,"type":"number"},"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"}},"required":["catalogId","catalogCostPercentage"],"type":"object"},"campaignv3Targeting":{"properties":{"crossSell":{"$ref":"#/components/schemas/campaignv3CrossSell"},"excludeFilters":{"description":"Used for integrations with the excluding of filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilter"},"maxItems":250,"type":"array","uniqueItems":true},"includeFilters":{"description":"Used for integrations with the including of filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilter"},"maxItems":250,"type":"array","uniqueItems":true},"negativeSearchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/v3NegativeSearchTerm"},"maxItems":500,"type":"array","uniqueItems":true},"searchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/campaignv3SearchTerm"},"maxItems":500,"type":"array","uniqueItems":true},"upsell":{"$ref":"#/components/schemas/campaignv3Upsell"}},"type":"object"},"campaignv3CrossSell":{"properties":{"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3TargetedFilter":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"filter":{"description":"The product filter targeted by the campaign.","type":"string"}},"required":["catalogId","filter"],"type":"object"},"v3NegativeSearchTerm":{"properties":{"matchType":{"$ref":"#/components/schemas/v3NegativeSearchTermMatchType"},"phrase":{"description":"The negative search term.","type":"string"}},"required":["phrase","matchType"],"type":"object"},"v3NegativeSearchTermMatchType":{"default":"MATCH_TYPE_EXACT_MATCH","enum":["MATCH_TYPE_EXACT_MATCH","MATCH_TYPE_PHRASE_MATCH"],"type":"string"},"campaignv3SearchTerm":{"properties":{"collectionName":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","type":"string"},"excludedProducts":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"readOnly":true,"type":"array"},"matchType":{"$ref":"#/components/schemas/campaignv3SearchTermMatchType"},"maxBid":{"description":"The maximum cost per click bid for the search term. This bid will override the auction max bid for this search term.","type":"string"},"phrase":{"description":"The keyword you are targeting. Has a maximum length of 150 characters","type":"string"},"suggested":{"description":"Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.","readOnly":true,"type":"boolean"},"treatAsCustom":{"description":"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.","type":"boolean"}},"required":["phrase","matchType"],"type":"object"},"campaignv3SearchTermMatchType":{"default":"MATCH_TYPE_PHRASE_MATCH","enum":["MATCH_TYPE_PHRASE_MATCH","MATCH_TYPE_EXACT_MATCH"],"type":"string"},"campaignv3Upsell":{"properties":{"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSeller"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"v3CreateBannerXCampaignResponse":{"properties":{"bannerXCampaign":{"$ref":"#/components/schemas/v3CampaignResponse"}},"type":"object"},"v3CampaignResponse":{"properties":{"advertisedProducts":{"$ref":"#/components/schemas/campaignv3AdvertisedProductsR"},"approval":{"$ref":"#/components/schemas/campaignv3Approval"},"bannerXConfig":{"$ref":"#/components/schemas/v3BannerXConfigR"},"campaignState":{"$ref":"#/components/schemas/campaignv3CampaignState"},"catalogIds":{"description":"The unique identifier of the retailer's catalog.","items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"customFields":{"items":{"$ref":"#/components/schemas/campaignv3CustomFieldR"},"maxItems":5,"type":"array","uniqueItems":true},"customQuestions":{"description":"Used for integrations utilising custom targeting.","items":{"$ref":"#/components/schemas/campaignv3CustomQuestionR"},"maxItems":5,"type":"array"},"endTime":{"description":"When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.","format":"date-time","type":"string"},"fixedCosts":{"$ref":"#/components/schemas/campaignv3FixedCosts"},"id":{"description":"The unique identifier of the campaign.","readOnly":true,"type":"string"},"managerTeamId":{"description":"The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns.","type":"string"},"name":{"description":"The name of the campaign.","type":"string"},"namespaceId":{"description":"The unique identifier of the namespace.","type":"string"},"placementId":{"description":"The unique identifier of the campaign's placement.","type":"string"},"sellerId":{"description":"The sellerId of the campaign. Defaults to empty string if null.","type":"string"},"settings":{"$ref":"#/components/schemas/v3CampaignSettings"},"startTime":{"description":"When the campaign starts as a precise ISO-8601 timestamp.","format":"date-time","type":"string"},"strategy":{"$ref":"#/components/schemas/campaignv3StrategyR"},"targeting":{"$ref":"#/components/schemas/campaignv3TargetingR"},"teamId":{"description":"The unique identifier of the campaign's team.","type":"string"},"templateId":{"description":"The unique identifier of the campaign template.","type":"string"},"updateTime":{"description":"The last time the entity was updated.","format":"date-time","readOnly":true,"type":"string"},"walletId":{"description":"The unique identifier of the wallet to be charged for the campaign.","type":"string"}},"type":"object"},"campaignv3AdvertisedProductsR":{"properties":{"productsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSellerR"},"maxItems":250,"type":"array"}},"type":"object"},"campaignv3CatalogProductSellerR":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"productCode":{"description":"The product code within the catalog.","type":"string"},"sellerId":{"description":"The seller ID for the product. Defaults to empty string.","type":"string"}},"type":"object"},"campaignv3Approval":{"properties":{"rejectionReason":{"description":"The reason a campaign has been rejected. Mandatory field if status is APPROVAL_STATE_REJECTED","type":"string"},"state":{"$ref":"#/components/schemas/campaignv3ApprovalApprovalState"}},"type":"object"},"campaignv3ApprovalApprovalState":{"default":"APPROVAL_STATE_PENDING","enum":["APPROVAL_STATE_PENDING"],"type":"string"},"v3BannerXConfigR":{"properties":{"additionalFields":{"description":"BannerX AdditionalFields","items":{"$ref":"#/components/schemas/v3AdditionalFields"},"type":"array"},"backgroundColourHex":{"description":"The background color of the banner in hex format.","type":"string"},"backgroundImageId":{"description":"The unique identifier of the background image.","type":"string"},"backgroundImagePosition":{"$ref":"#/components/schemas/BannerXConfigBannerXBackgroundImagePosition"},"bannerText":{"description":"The main text of the banner.","type":"string"},"bannerTextColourHex":{"description":"The color of the banner text in hex format.","type":"string"},"contentStandardId":{"description":"The unique identifier of the content standard.","type":"string"},"ctaFlag":{"description":"Flag indicating if the banner has a call-to-action.","type":"boolean"},"ctaLink":{"description":"The URL for the call-to-action link.","type":"string"},"ctaText":{"description":"The call-to-action text on the banner.","type":"string"},"ctaTextAccessibility":{"description":"The call-to-action text for accessibility purposes.","type":"string"},"headingText":{"description":"The heading text for the banner.","type":"string"},"heroImageAltText":{"description":"The alternate text for the hero image.","type":"string"},"heroImageId":{"description":"The unique identifier for the hero image.","type":"string"},"heroMode":{"$ref":"#/components/schemas/BannerXConfigBannerXHeroImageMode"},"secondaryBackgroundImageId":{"description":"The unique identifier for the secondary background image.","type":"string"},"secondaryBackgroundImagePosition":{"$ref":"#/components/schemas/BannerXConfigBannerXBackgroundImagePosition"},"secondaryHeroImageAltText":{"description":"The alt text for the secondary hero image.","type":"string"},"secondaryHeroImageId":{"description":"The unique identifier for the secondary hero image.","type":"string"},"secondaryHeroMode":{"$ref":"#/components/schemas/BannerXConfigBannerXHeroImageMode"},"slotId":{"description":"The unique identifier of the slot.","type":"string"},"slotType":{"$ref":"#/components/schemas/BannerXConfigBannerXSlotType"},"trackingTagProvider":{"description":"BannerX TrackingTagProvider","items":{"$ref":"#/components/schemas/v3TrackingTag"},"type":"array"}},"type":"object"},"campaignv3CustomFieldR":{"properties":{"content":{"description":"The contents of the custom field.","type":"string"},"customFieldId":{"description":"The unique identifier of the custom field.","type":"string"}},"type":"object"},"campaignv3CustomQuestionR":{"properties":{"answers":{"description":"The selections of the advertiser relevant to the custom question.","items":{"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"customQuestionId":{"description":"The id of the custom question.","type":"string"}},"type":"object"},"v3CampaignSettings":{"properties":{"campaignType":{"$ref":"#/components/schemas/v3CampaignSettingsCampaignType"},"fromTime":{"description":"fromTime","format":"date-time","type":"string"},"isWildcard":{"description":"isWildcard","type":"boolean"},"toTime":{"description":"toTime","format":"date-time","type":"string"}},"type":"object"},"v3CampaignSettingsCampaignType":{"default":"CAMPAIGN_TYPE_BANNERX","enum":["CAMPAIGN_TYPE_BANNERX"],"type":"string"},"campaignv3StrategyR":{"properties":{"auction":{"$ref":"#/components/schemas/campaignv3Auction"},"fixedTenancy":{"$ref":"#/components/schemas/campaignv3FixedTenancyR"}},"type":"object"},"campaignv3FixedTenancyR":{"properties":{"catalogCosts":{"items":{"$ref":"#/components/schemas/campaignv3CatalogCostR"},"maxItems":5,"minItems":1,"type":"array","uniqueItems":true},"cost":{"description":"The cost of the campaign for reporting purposes. This value is not charged to the wallet.","type":"string"},"positions":{"description":"The fixed tenancy position booked by the campaign.","items":{"format":"int32","minimum":1,"type":"integer"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3CatalogCostR":{"properties":{"catalogCostPercentage":{"description":"The percentage of the campaign's cost allocated to the catalog.","format":"float","maximum":1,"type":"number"},"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"}},"type":"object"},"campaignv3TargetingR":{"properties":{"crossSell":{"$ref":"#/components/schemas/campaignv3CrossSellR"},"excludeFilters":{"description":"Used for integrations with the excluding of filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilterR"},"maxItems":250,"type":"array","uniqueItems":true},"includeFilters":{"description":"Used for integrations with the including of filters enabled.","items":{"$ref":"#/components/schemas/campaignv3TargetedFilterR"},"maxItems":250,"type":"array","uniqueItems":true},"negativeSearchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/v3NegativeSearchTermR"},"maxItems":500,"type":"array","uniqueItems":true},"searchTerms":{"description":"Used for placements that target search terms.","items":{"$ref":"#/components/schemas/campaignv3SearchTerm"},"maxItems":500,"type":"array","uniqueItems":true},"upsell":{"$ref":"#/components/schemas/campaignv3UpsellR"}},"type":"object"},"campaignv3CrossSellR":{"properties":{"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSellerR"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"campaignv3TargetedFilterR":{"properties":{"catalogId":{"description":"The unique identifier of the retailer's catalog.","type":"string"},"filter":{"description":"The product filter targeted by the campaign.","type":"string"}},"type":"object"},"v3NegativeSearchTermR":{"properties":{"matchType":{"$ref":"#/components/schemas/v3NegativeSearchTermMatchType"},"phrase":{"description":"The negative search term.","type":"string"}},"type":"object"},"campaignv3UpsellR":{"properties":{"targetProductsByKey":{"items":{"$ref":"#/components/schemas/campaignv3CatalogProductSellerR"},"maxItems":250,"type":"array","uniqueItems":true}},"type":"object"},"rpcStatus":{"description":"The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).","properties":{"code":{"description":"The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.","items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.","type":"string"}},"type":"object"},"protobufAny":{"additionalProperties":{},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","properties":{"@type":{"description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.","type":"string"}},"type":"object"}}},"paths":{"/v3/bannerx-campaigns":{"post":{"description":"Creates a new banner X 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.","operationId":"createBannerXCampaign","requestBody":{"content":{"application/jsona":{"schema":{"$ref":"#/components/schemas/v3CreateBannerXCampaignRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v3CreateBannerXCampaignResponse"}}},"description":"Details of the created banner X campaign."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"There was a problem with input."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"Login failed or token not valid."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create a banner X campaign","tags":["bannerXCampaign"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/createbannerxcampaign-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.