> 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/es/campaign-management-api/bannerxcontentstandard/getbannerxcontentstandard-1.md). # Obtener detalles del estándar de contenido de Banner X ## Get Banner X content standard details > Retrieves Banner X content standard details for the specified content standard ID. ```json {"openapi":"3.0.0","info":{"title":"Content Standard 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":{"v3GetBannerXContentStandardResponse":{"properties":{"contentStandard":{"$ref":"#/components/schemas/v3BannerXContentStandard"}},"type":"object"},"v3BannerXContentStandard":{"properties":{"archived":{"description":"The flag which indicates if the content standard Id is archived.","type":"boolean"},"displayLogoFileId":{"description":"A unique identifier for the file containing the display logo associated with the specific content standard.","type":"string"},"displayName":{"description":"The display name of the content standard ID.","type":"string"},"externalPreviewer":{"$ref":"#/components/schemas/BannerXContentStandardBannerXExternalPreviewerConfiguration"},"id":{"description":"The content standard ID.","type":"string"},"namespace":{"description":"The unique identifier of the namespace.","type":"string"},"pdfFileId":{"description":"A unique identifier for the PDF file that provides detailed information about a specific content standard.","type":"string"},"retailerTeamId":{"description":"The retailer managed team ID.","type":"string"},"slotConfigurations":{"description":"Banner X slot configuration details.","items":{"$ref":"#/components/schemas/v3BannerXSlotConfiguration"},"type":"array"},"websiteAddress":{"description":"The full URL of the webpage.","type":"string"}},"type":"object"},"BannerXContentStandardBannerXExternalPreviewerConfiguration":{"properties":{"url":{"description":"The Url of the BannerX Preview configuration details.","type":"string"},"viewportHeight":{"description":"The dimensional height detail of the preview image in pixels.","format":"int64","type":"string"},"viewportWidth":{"description":"The dimensional width detail of the preview image in pixels.","format":"int64","type":"string"}},"required":["url","viewportHeight","viewportWidth"],"type":"object"},"v3BannerXSlotConfiguration":{"properties":{"bannerXCreatorSettings":{"$ref":"#/components/schemas/BannerXSlotConfigurationBannerXCreatorSettings"},"minClickPrice":{"description":"The minimum cost per click for the particular slot type like Banner, Single_Tile or Double_Tile.","format":"int64","type":"string"},"minImpressionPrice":{"description":"Deprecated: Use min_impression_price_decimal instead. The minimum value of the impression price truncated to integer.","format":"int64","type":"string"},"minImpressionPriceDecimal":{"description":"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).","format":"double","type":"number"},"shouldTargetProducts":{"description":"A flag indicating whether the BannerX slot is configured to target specific products.","type":"boolean"},"slotId":{"description":"A unique identifier for the BannerX slot configuration.","type":"string"},"slotType":{"$ref":"#/components/schemas/BannerXConfigBannerXSlotType"}},"type":"object"},"BannerXSlotConfigurationBannerXCreatorSettings":{"properties":{"additionalField":{"items":{"$ref":"#/components/schemas/BannerXCreatorSettingsSlotAdditionalField"},"type":"array"},"backgroundColorConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsBackgroundColorConfiguration"},"bannerTextConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsSlotTextConfiguration"},"callToActionConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsCallToActionConfiguration"},"companionProductsConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsCompanionProductsConfiguration"},"fieldNameOverrides":{"items":{"$ref":"#/components/schemas/BannerXCreatorSettingsSlotFieldNameOverride"},"type":"array"},"fixedBannerBackgroundColourHexOptions":{"description":"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.","items":{"type":"string"},"type":"array"},"fixedBannerTextColourHexOptions":{"description":"The banner text color options for the created Banner X campaign, with each string representing a color in hexadecimal format.","items":{"type":"string"},"type":"array"},"headingTextConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsSlotTextConfiguration"},"heroImageConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsModeImageConfiguration"},"primaryBackgroundImageConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsPositionImageConfiguration"},"secondaryBackgroundImageConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsPositionImageConfiguration"},"secondaryHeroImageConfiguration":{"$ref":"#/components/schemas/BannerXCreatorSettingsModeImageConfiguration"},"videoConfigurations":{"items":{"$ref":"#/components/schemas/BannerXCreatorSettingsVideoConfiguration"},"type":"array"}},"type":"object"},"BannerXCreatorSettingsSlotAdditionalField":{"properties":{"colorHexOptions":{"description":"The color option of the slot.","items":{"type":"string"},"type":"array"},"enabled":{"description":"The flag to set the slot.","type":"boolean"},"fixedTextOptions":{"description":"The text field of the additional slot.","items":{"type":"string"},"type":"array"},"id":{"description":"The slot ID.","type":"string"},"label":{"description":"The slot label.","type":"string"},"mandatory":{"description":"The flag to set if the slot additional field is mandatory.","type":"boolean"},"maxCharacterLimit":{"description":"The max character limit of the additonal field.","format":"int64","type":"string"},"selectOptions":{"items":{"$ref":"#/components/schemas/SlotAdditionalFieldCampaignCustomTargetingAnswer"},"type":"array"},"type":{"$ref":"#/components/schemas/SlotAdditionalFieldSlotAdditionalFieldType"}},"required":["type","id","label","enabled","mandatory","fixedTextOptions","maxCharacterLimit","colorHexOptions","selectOptions"],"type":"object"},"SlotAdditionalFieldCampaignCustomTargetingAnswer":{"properties":{"label":{"description":"The label of the Campaign being targeted.","type":"string"},"value":{"description":"The value of the campaign being targeted.","type":"string"}},"required":["label","value"],"type":"object"},"SlotAdditionalFieldSlotAdditionalFieldType":{"enum":["SLOT_ADDITIONAL_FIELD_TYPE_TEXT","SLOT_ADDITIONAL_FIELD_TYPE_COLOR","SLOT_ADDITIONAL_FIELD_TYPE_SELECT"],"type":"string"},"BannerXCreatorSettingsBackgroundColorConfiguration":{"properties":{"enable":{"description":"The flag to set the backaground color configuration.","type":"boolean"}},"required":["enable"],"type":"object"},"BannerXCreatorSettingsSlotTextConfiguration":{"properties":{"mandatory":{"type":"boolean"},"maxCharacterLimit":{"description":"The maximum character limit of the Slot text configuration.","format":"int64","type":"string"}},"required":["mandatory"],"type":"object"},"BannerXCreatorSettingsCallToActionConfiguration":{"properties":{"ctaTextCharacterLimit":{"description":"This is the text character limit set for the ctaText field in create Banner X campaign.","format":"int64","type":"string"},"ctaTextEnabled":{"description":"The flag set to enable the call to action text.","type":"boolean"},"ctaTextMandatory":{"description":"The flag set to check if the call to action text is mandatory.","type":"boolean"},"enable":{"description":"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.","type":"boolean"},"fixedTextOptions":{"description":"The fixed text for the link.","items":{"type":"string"},"type":"array"},"linkCharacterLimit":{"description":"This is the text character limit set for the link in create Banner X campaign.","format":"int64","type":"string"},"linkPrefix":{"description":"The link prefix.","type":"string"}},"required":["enable","linkPrefix","linkCharacterLimit","fixedTextOptions","ctaTextCharacterLimit","ctaTextEnabled","ctaTextMandatory"],"type":"object"},"BannerXCreatorSettingsCompanionProductsConfiguration":{"properties":{"enable":{"description":"The boolean value to set the mode of the video configuration.","type":"boolean"},"maxNumberOfProducts":{"description":"The maximum number of products allowed to be provided as companion products for campaign","format":"int64","type":"string"}},"required":["enable"],"type":"object"},"BannerXCreatorSettingsSlotFieldNameOverride":{"properties":{"field":{"description":"The slot field .","type":"string"},"name":{"description":"The slot of the field name.","type":"string"}},"required":["field","name"],"type":"object"},"BannerXCreatorSettingsModeImageConfiguration":{"properties":{"enable":{"description":"The boolean value to set the mode of the image configuration.","type":"boolean"},"imageConstraints":{"description":"The image constraints of the mode image.","items":{"$ref":"#/components/schemas/ModeImageConfigurationModeImageConstraints"},"type":"array"},"mandatory":{"description":"The boolean value to set if the field is mandatory.","type":"boolean"}},"required":["enable","mandatory"],"type":"object"},"ModeImageConfigurationModeImageConstraints":{"properties":{"fixedHeight":{"description":"The flag to set the fixed height of the hero mode image.","type":"boolean"},"fixedWidth":{"description":"The flag to set the fixed width of the hero mode image.","type":"boolean"},"height":{"description":"The height of the hero mode image in pixels.","format":"int64","type":"string"},"maxSize":{"description":"The max size of the hero mode image in pixels.","format":"int64","type":"string"},"mode":{"$ref":"#/components/schemas/v3BannerXConfigBannerXHeroImageMode"},"width":{"description":"The width of the hero mode image.","format":"int64","type":"string"}},"required":["mode"],"type":"object"},"v3BannerXConfigBannerXHeroImageMode":{"enum":["BANNER_X_HERO_IMAGE_MODE_BLOCK","BANNER_X_HERO_IMAGE_MODE_LANDSCAPE","BANNER_X_HERO_IMAGE_MODE_PORTRAIT"],"type":"string"},"BannerXCreatorSettingsPositionImageConfiguration":{"properties":{"enable":{"description":"The flag to set the position of the image.","type":"boolean"},"imageConstraints":{"items":{"$ref":"#/components/schemas/PositionImageConfigurationPositionImageConstraints"},"type":"array"},"mandatory":{"description":"The flag to check if the position image is mandatory.","type":"boolean"}},"required":["enable","mandatory"],"type":"object"},"PositionImageConfigurationPositionImageConstraints":{"properties":{"fixedHeight":{"description":"The flag to set fixed height of the image.","type":"boolean"},"fixedWidth":{"description":"The flag to set fixed width of position.","type":"boolean"},"height":{"description":"The fixed height of the image in pixels.","format":"int64","type":"string"},"maxSize":{"description":"The max size of the image in pixels.","format":"int64","type":"string"},"position":{"$ref":"#/components/schemas/v3BannerXConfigBannerXBackgroundImagePosition"},"width":{"description":"The width of the image in pixels.","format":"int64","type":"string"}},"required":["position"],"type":"object"},"v3BannerXConfigBannerXBackgroundImagePosition":{"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"},"BannerXCreatorSettingsVideoConfiguration":{"properties":{"codecs":{"description":"The list of codecs supported for video","items":{"type":"string"},"type":"array"},"fileTypes":{"description":"The list of file types supported for video","items":{"type":"string"},"type":"array"},"height":{"description":"The height of the video.","format":"int64","type":"string"},"id":{"description":"The unique identifier of video config","type":"string"},"label":{"description":"Human readable short description of video config","type":"string"},"mandatory":{"description":"The boolean value to set if the field is mandatory.","type":"boolean"},"maxBitrate":{"description":"The maximum bitrate of the video in Kbps.","format":"int64","type":"string"},"maxDuration":{"description":"The maximum duration of the video in seconds.","format":"int64","type":"string"},"minBitrate":{"description":"The minimum bitrate of the video in Kbps.","format":"int64","type":"string"},"width":{"description":"The width of the video.","format":"int64","type":"string"}},"required":["id","mandatory"],"type":"object"},"BannerXConfigBannerXSlotType":{"enum":["BANNER_X_SLOT_TYPE_BANNER","BANNER_X_SLOT_TYPE_SINGLE_TILE","BANNER_X_SLOT_TYPE_DOUBLE_TILE"],"type":"string"},"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/banner-x-content-standards/{id}":{"get":{"description":"Retrieves Banner X content standard details for the specified content standard ID.","operationId":"getBannerXContentStandard","parameters":[{"description":"Banner X content standard ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v3GetBannerXContentStandardResponse"}}},"description":"Banner X content standard details for the specified content standard ID."},"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":"Get Banner X content standard details","tags":["bannerXContentStandard"]}}}} ``` --- # 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/es/campaign-management-api/bannerxcontentstandard/getbannerxcontentstandard-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.