--- title: "Get Banner X content standard details" method: GET path: "/v3/banner-x-content-standards/{id}" tags: ["bannerXContentStandard"] --- # Get Banner X content standard details `GET /v3/banner-x-content-standards/{id}` Retrieves Banner X content standard details for the specified content standard ID. ## Path parameters - `id` string, required ## Response `200` Banner X content standard details for the specified content standard ID. - V3GetBannerXContentStandardResponse - `contentStandard` V3BannerXContentStandard - `id` string — The content standard ID. - `namespace` string — The unique identifier of the namespace. - `retailerTeamId` string — The retailer managed team ID. - `websiteAddress` string — The full URL of the webpage. - `displayName` string — The display name of the content standard ID. - `pdfFileId` string — A unique identifier for the PDF file that provides detailed information about a specific content standard. - `displayLogoFileId` string — A unique identifier for the file containing the display logo associated with the specific content standard. - `archived` boolean — The flag which indicates if the content standard Id is archived. - `slotConfigurations` V3BannerXSlotConfiguration[] — Banner X slot configuration details. - `slotId` string — A unique identifier for the BannerX slot configuration. - `minImpressionPrice` string, int64 — Deprecated: Use min_impression_price_decimal instead. The minimum value of the impression price truncated to integer. - `shouldTargetProducts` boolean — A flag indicating whether the BannerX slot is configured to target specific products. - `slotType` 'BANNER_X_SLOT_TYPE_UNSPECIFIED' | 'BANNER_X_SLOT_TYPE_BANNER' | 'BANNER_X_SLOT_TYPE_SINGLE_TILE' | 'BANNER_X_SLOT_TYPE_DOUBLE_TILE' - `bannerXCreatorSettings` BannerXSlotConfigurationBannerXCreatorSettings - `fixedBannerTextColourHexOptions` string[] — The banner text color options for the created Banner X campaign, with each string representing a color in hexadecimal format. - `fixedBannerBackgroundColourHexOptions` string[] — An array of color options for the background on a banner in a Banner X Campaign, with each string representing a color in hexadecimal format. - `callToActionConfiguration` BannerXCreatorSettingsCallToActionConfiguration - `enable` boolean, required — Indicates whether the Call to Action (CTA) configuration is active. Setting this field to true enables the CTA configuration, allowing it to be applied or executed. If set to false, the CTA configuration is disabled and will not be active in the campaign or application. - `linkPrefix` string, required — The link prefix. - `linkCharacterLimit` string, int64, required — This is the text character limit set for the link in create Banner X campaign. - `fixedTextOptions` string[], required — The fixed text for the link. - `ctaTextCharacterLimit` string, int64, required — This is the text character limit set for the ctaText field in create Banner X campaign. - `ctaTextEnabled` boolean, required — The flag set to enable the call to action text. - `ctaTextMandatory` boolean, required — The flag set to check if the call to action text is mandatory. - `backgroundColorConfiguration` BannerXCreatorSettingsBackgroundColorConfiguration - `enable` boolean, required — The flag to set the backaground color configuration. - `primaryBackgroundImageConfiguration` BannerXCreatorSettingsPositionImageConfiguration - `enable` boolean, required — The flag to set the position of the image. - `mandatory` boolean, required — The flag to check if the position image is mandatory. - `imageConstraints` PositionImageConfigurationPositionImageConstraints[] - `position` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | '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', required - `fixedWidth` boolean — The flag to set fixed width of position. - `width` string, int64 — The width of the image in pixels. - `maxSize` string, int64 — The max size of the image in pixels. - `fixedHeight` boolean — The flag to set fixed height of the image. - `height` string, int64 — The fixed height of the image in pixels. - `secondaryBackgroundImageConfiguration` BannerXCreatorSettingsPositionImageConfiguration - `enable` boolean, required — The flag to set the position of the image. - `mandatory` boolean, required — The flag to check if the position image is mandatory. - `imageConstraints` PositionImageConfigurationPositionImageConstraints[] - `position` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | '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', required - `fixedWidth` boolean — The flag to set fixed width of position. - `width` string, int64 — The width of the image in pixels. - `maxSize` string, int64 — The max size of the image in pixels. - `fixedHeight` boolean — The flag to set fixed height of the image. - `height` string, int64 — The fixed height of the image in pixels. - `heroImageConfiguration` BannerXCreatorSettingsModeImageConfiguration - `enable` boolean, required — The boolean value to set the mode of the image configuration. - `mandatory` boolean, required — The boolean value to set if the field is mandatory. - `imageConstraints` ModeImageConfigurationModeImageConstraints[] — The image constraints of the mode image. - `mode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT', required - `fixedWidth` boolean — The flag to set the fixed width of the hero mode image. - `width` string, int64 — The width of the hero mode image. - `maxSize` string, int64 — The max size of the hero mode image in pixels. - `fixedHeight` boolean — The flag to set the fixed height of the hero mode image. - `height` string, int64 — The height of the hero mode image in pixels. - `secondaryHeroImageConfiguration` BannerXCreatorSettingsModeImageConfiguration - `enable` boolean, required — The boolean value to set the mode of the image configuration. - `mandatory` boolean, required — The boolean value to set if the field is mandatory. - `imageConstraints` ModeImageConfigurationModeImageConstraints[] — The image constraints of the mode image. - `mode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT', required - `fixedWidth` boolean — The flag to set the fixed width of the hero mode image. - `width` string, int64 — The width of the hero mode image. - `maxSize` string, int64 — The max size of the hero mode image in pixels. - `fixedHeight` boolean — The flag to set the fixed height of the hero mode image. - `height` string, int64 — The height of the hero mode image in pixels. - `headingTextConfiguration` BannerXCreatorSettingsSlotTextConfiguration - `mandatory` boolean, required - `maxCharacterLimit` string, int64 — The maximum character limit of the Slot text configuration. - `bannerTextConfiguration` BannerXCreatorSettingsSlotTextConfiguration - `mandatory` boolean, required - `maxCharacterLimit` string, int64 — The maximum character limit of the Slot text configuration. - `fieldNameOverrides` BannerXCreatorSettingsSlotFieldNameOverride[] - `field` string, required — The slot field . - `name` string, required — The slot of the field name. - `additionalField` BannerXCreatorSettingsSlotAdditionalField[] - `type` 'SLOT_ADDITIONAL_FIELD_TYPE_TEXT' | 'SLOT_ADDITIONAL_FIELD_TYPE_COLOR' | 'SLOT_ADDITIONAL_FIELD_TYPE_SELECT', required - `id` string, required — The slot ID. - `label` string, required — The slot label. - `enabled` boolean, required — The flag to set the slot. - `mandatory` boolean, required — The flag to set if the slot additional field is mandatory. - `fixedTextOptions` string[], required — The text field of the additional slot. - `maxCharacterLimit` string, int64, required — The max character limit of the additonal field. - `colorHexOptions` string[], required — The color option of the slot. - `selectOptions` SlotAdditionalFieldCampaignCustomTargetingAnswer[], required - `label` string, required — The label of the Campaign being targeted. - `value` string, required — The value of the campaign being targeted. - `videoConfigurations` BannerXCreatorSettingsVideoConfiguration[] - `id` string, required — The unique identifier of video config - `label` string — Human readable short description of video config - `mandatory` boolean, required — The boolean value to set if the field is mandatory. - `width` string, int64 — The width of the video. - `height` string, int64 — The height of the video. - `codecs` string[] — The list of codecs supported for video - `fileTypes` string[] — The list of file types supported for video - `minBitrate` string, int64 — The minimum bitrate of the video in Kbps. - `maxBitrate` string, int64 — The maximum bitrate of the video in Kbps. - `maxDuration` string, int64 — The maximum duration of the video in seconds. - `companionProductsConfiguration` BannerXCreatorSettingsCompanionProductsConfiguration - `enable` boolean, required — The boolean value to set the mode of the video configuration. - `maxNumberOfProducts` string, int64 — The maximum number of products allowed to be provided as companion products for campaign - `minClickPrice` string, int64 — The minimum cost per click for the particular slot type like Banner, Single_Tile or Double_Tile. - `minImpressionPriceDecimal` number, double — The minimum value of the impression price for the particular slot type like Banner, Single_Tile or Double_Tile. Supports fractional values (e.g., 0.50, 1.25). - `externalPreviewer` BannerXContentStandardBannerXExternalPreviewerConfiguration - `url` string, required — The Url of the BannerX Preview configuration details. - `viewportHeight` string, int64, required — The dimensional height detail of the preview image in pixels. - `viewportWidth` string, int64, required — The dimensional width detail of the preview image in pixels. ## 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)