📘

File upload guidelines

BannerX Config Field Validations

contentStandardId

• Must be a valid UUID format
• Should exist in the shotgun_banner_content_standard_model table
• Must belong to the same namespace as the user

slotID

• Must be part of the specified contentStandardId

slotType

• Must be one of the following enums:
  • BANNER_X_SLOT_TYPE_BANNER
  • BANNER_X_SLOT_TYPE_SINGLE_TILE
  • BANNER_X_SLOT_TYPE_DOUBLE_TILE
• Must be present in the contentStandardId details

headingText

• Validated against the headingTextConfiguration in the contentStandardId details
• Must not exceed the maximum character limit specified
• Mandatory if marked as such in the configuration

bannerText

• Validated against the bannerTextConfiguration in the contentStandardId details
• Must not exceed the maximum character limit specified
• Mandatory if marked as such in the configuration

bannerTextColourHex

• Must be a valid HEX color
• Should match one of the options in fixedBannerTextColourHexOptions if provided in the content standard

ctaFlag

• Validated against the callToActionConfiguration in the contentStandardId details
• If enabled, all CTA fields (ctaText, ctaTextAccessibility, ctaLink) must be provided

ctaText

• Validated against callToActionConfiguration in the content standard
• Must not exceed the character limit specified in the configuration
• Mandatory if marked as such

ctaTextAccessibility

• Maximum length is 200 characters

ctaLink

• Must match the linkPrefix and not exceed the linkCharacterLimit specified in the configuration
• Default maximum length is 200 characters

backgroundColourHex

• Must be a valid HEX color
• Should match options in the content standard if provided

backgroundImageId

• Must exist in the image bucket
• Image dimensions must match those specified in primaryBackgroundImageConfiguration if enabled
• Mandatory if marked as such

backgroundImagePosition

• Must be one of the following enums, as specified in the configuration:
  • 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

• Must exist in the image bucket
• Image dimensions must match those specified in secondaryBackgroundImageConfiguration if enabled
• Mandatory if marked as such

secondaryBackgroundImagePosition

• Must be one of the allowed enums in the configuration
• Must be valid for the content standard

heroImageId

• Must exist in the image bucket
• Image dimensions must match those specified in heroImageConfiguration if enabled
• Mandatory if marked as such

heroImageAltText

• Maximum length is 200 characters

heroMode

• Must be one of the following enums, as specified in the configuration:
  • BANNER_X_HERO_IMAGE_MODE_BLOCK
  • BANNER_X_HERO_IMAGE_MODE_LANDSCAPE
  • BANNER_X_HERO_IMAGE_MODE_PORTRAIT
• Must be valid for the content standard

secondaryHeroImageId

• Must exist in the image bucket
• Image dimensions must match those specified in secondaryHeroImageConfiguration if enabled
• Mandatory if marked as such

secondaryHeroImageAltText

• Maximum length is 200 characters

secondaryHeroMode

• Must be one of the allowed enums in the configuration
• Must be valid for the content standard

additionalFields

Validation depends on the field type:

For color fields:

• If mandatory is false and enabled is true, must be a valid HEX color
• If mandatory is true and enabled is true, must match one of the colorHexOptions

For text fields:

• Must not exceed the maxCharacterLimit
• May have fixed options or dropdowns as defined in the configuration

trackingTagProvider

• No validation required at this time

CTA Fields Special Validations

If CTA is enabled at the content standard level:

• Setting ctaFlag=true requires all three fields (ctaText, ctaTextAccessibility, ctaLink) to be provided
• If limits are set in the content standard, those apply; otherwise, default limits are:

CTA Text:

• BANNER_X_SLOT_TYPE_SINGLE_TILE: 15 characters
• BANNER_X_SLOT_TYPE_DOUBLE_TILE: 15 characters
• BANNER_X_SLOT_TYPE_BANNER: 10 characters
• BANNER_X_SLOT_TYPE_UNSPECIFIED: 1000 characters

CTA Link:

Max 200 characters

CTA TextAccessibility:

Max 200 characters

• If ctaFlag=false, all CTA fields must be null; otherwise, a 400 Bad Request is returned

If CTA is disabled at the content standard level:

• ctaFlag must be set to false, and all CTA fields must be null
• Setting ctaFlag=true or providing CTA field values will result in a 400 Bad Request