CookieBannerConfig

idstringrequired

Example: cbcfg_wAspvmEr4ACDZaPUtfwjsA

cookie_site_idstringrequired

Example: csite_wAspvmEr4ACDZaPUtfwjsA

versionintegerrequired

Possible values: >= 1

statusstringrequired

Possible values: [draft, published, archived]

category_purposes objectrequired

essentialstringrequired

Constant value: essential

functionalstringrequired

Constant value: functional

analyticsstringrequired

Constant value: analytics

marketingstringrequired

Constant value: marketing

personalizestringrequired

Constant value: personalize

inventory_snapshotobject[]required

provider_groups_snapshotobject[]required

appearance objectrequired

Apariencia del banner de cookies. Las claves omitidas toman su valor por defecto.

formatstring

Possible values: [banner, modal, corner]

Default value: banner

positionstring

Possible values: [top, bottom, top-left, top-right, bottom-left, bottom-right]

Default value: bottom

themestring

Possible values: [light, dark]

Default value: light

accent_colorstring

Possible values: Value must match regular expression ^#[0-9a-fA-F]{6}$

Default value: #3340cf

button_stylestring

Possible values: [solid, outline, segmented]

Default value: solid

signaturestring

Variante de la firma «Powered by Soyio», o none para ocultarla.

Possible values: [seam, seal, tab, none]

Default value: seam

radiusinteger

Possible values: >= 0 and <= 32

Default value: 14

show_iconboolean

Default value: true

iconstring

Ícono mostrado en el banner y en el acceso a preferencias.

Possible values: [cookie, shield, settings, custom]

Default value: cookie

icon_stylestring

Possible values: [duotone, line, solid]

Default value: duotone

fob_positionstring

Posición del botón flotante para reabrir las preferencias, o none para ocultarlo.

Possible values: [left, right, none]

Default value: right

font_familystringnullable

Possible values: <= 80 characters

dim_backgroundboolean

Default value: true

category_displaystring

Muestra las categorías del panel de preferencias abiertas (expanded) o plegadas (collapsed).

Possible values: [expanded, collapsed]

Default value: expanded

show_cookie_listboolean

Muestra el detalle de cookies de cada categoría en el panel de preferencias.

Default value: true

sizestring

Tamaño del banner y del panel de preferencias.

Possible values: [sm, md, lg]

Default value: md

content objectrequired

Copia editable del banner. Las claves omitidas usan la traducción predeterminada del idioma.

titlestring

Possible values: <= 120 characters

descriptionstring

Possible values: <= 600 characters

customize_labelstring

Possible values: <= 40 characters

reject_labelstring

Possible values: <= 40 characters

accept_all_labelstring

Possible values: <= 40 characters

save_labelstring

Possible values: <= 40 characters

preferences_titlestring

Possible values: <= 120 characters

categories object

essential object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

functional object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

analytics object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

marketing object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

personalize object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

localized_content objectrequired

Copia editable por idioma. Los idiomas o campos omitidos usan las traducciones predeterminadas.

es object

Copia editable del banner. Las claves omitidas usan la traducción predeterminada del idioma.

titlestring

Possible values: <= 120 characters

descriptionstring

Possible values: <= 600 characters

customize_labelstring

Possible values: <= 40 characters

reject_labelstring

Possible values: <= 40 characters

accept_all_labelstring

Possible values: <= 40 characters

save_labelstring

Possible values: <= 40 characters

preferences_titlestring

Possible values: <= 120 characters

categories object

essential object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

functional object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

analytics object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

marketing object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

personalize object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

en object

Copia editable del banner. Las claves omitidas usan la traducción predeterminada del idioma.

titlestring

Possible values: <= 120 characters

descriptionstring

Possible values: <= 600 characters

customize_labelstring

Possible values: <= 40 characters

reject_labelstring

Possible values: <= 40 characters

accept_all_labelstring

Possible values: <= 40 characters

save_labelstring

Possible values: <= 40 characters

preferences_titlestring

Possible values: <= 120 characters

categories object

essential object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

functional object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

analytics object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

marketing object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

personalize object

titlestring

Possible values: <= 80 characters

descriptionstring

Possible values: <= 600 characters

icon_image objectnullable

urluri-referencerequired

filenamestringnullable

sizeintegernullable

mime_typestringnullable

documents object[]

Array [

kindstringrequired

Possible values: [privacy_document, link]

privacy_document_idstringnullable

privacy_document_versionintegernullable

Versión del documento fijada al publicar. Es null en borradores, que usan la última versión.

urlurinullable

labels objectrequired

Texto del enlace por idioma. En documentos de privacidad, si falta se usa el nombre del documento.

esstring

Possible values: <= 80 characters

enstring

Possible values: <= 80 characters

legacy_fieldstringnullable

Campo obsoleto (privacy_policy_url o cookie_policy_url) que controla este enlace, si existe.

Possible values: [privacy_policy_url, cookie_policy_url]

]

privacy_policy_urlurinullabledeprecated

Obsoleto. Usa documents. URL del enlace asociado a este campo.

cookie_policy_urlurinullabledeprecated

Obsoleto. Usa documents. URL del enlace asociado a este campo.

consent_duration_monthsintegernullable

Vigencia del consentimiento en meses. Si es nulo, usa el valor por defecto de la empresa.

Possible values: [3, 6, 12, 13, 24]

integrity_hashstringrequired

HMAC-SHA512 de la configuración versionada.

created_atdate-timerequired

updated_atdate-timerequired

CookieBannerConfig
{
  "id": "cbcfg_wAspvmEr4ACDZaPUtfwjsA",
  "cookie_site_id": "csite_wAspvmEr4ACDZaPUtfwjsA",
  "version": 0,
  "status": "draft",
  "category_purposes": {
    "essential": "essential",
    "functional": "functional",
    "analytics": "analytics",
    "marketing": "marketing",
    "personalize": "personalize"
  },
  "inventory_snapshot": [
    {}
  ],
  "provider_groups_snapshot": [
    {}
  ],
  "appearance": {
    "format": "banner",
    "position": "bottom",
    "theme": "light",
    "accent_color": "#3340cf",
    "button_style": "solid",
    "signature": "seam",
    "radius": 14,
    "show_icon": true,
    "icon": "cookie",
    "icon_style": "duotone",
    "fob_position": "right",
    "font_family": "string",
    "dim_background": true,
    "category_display": "expanded",
    "show_cookie_list": true,
    "size": "md"
  },
  "content": {
    "title": "string",
    "description": "string",
    "customize_label": "string",
    "reject_label": "string",
    "accept_all_label": "string",
    "save_label": "string",
    "preferences_title": "string",
    "categories": {
      "essential": {
        "title": "string",
        "description": "string"
      },
      "functional": {
        "title": "string",
        "description": "string"
      },
      "analytics": {
        "title": "string",
        "description": "string"
      },
      "marketing": {
        "title": "string",
        "description": "string"
      },
      "personalize": {
        "title": "string",
        "description": "string"
      }
    }
  },
  "localized_content": {
    "es": {
      "title": "string",
      "description": "string",
      "customize_label": "string",
      "reject_label": "string",
      "accept_all_label": "string",
      "save_label": "string",
      "preferences_title": "string",
      "categories": {
        "essential": {
          "title": "string",
          "description": "string"
        },
        "functional": {
          "title": "string",
          "description": "string"
        },
        "analytics": {
          "title": "string",
          "description": "string"
        },
        "marketing": {
          "title": "string",
          "description": "string"
        },
        "personalize": {
          "title": "string",
          "description": "string"
        }
      }
    },
    "en": {
      "title": "string",
      "description": "string",
      "customize_label": "string",
      "reject_label": "string",
      "accept_all_label": "string",
      "save_label": "string",
      "preferences_title": "string",
      "categories": {
        "essential": {
          "title": "string",
          "description": "string"
        },
        "functional": {
          "title": "string",
          "description": "string"
        },
        "analytics": {
          "title": "string",
          "description": "string"
        },
        "marketing": {
          "title": "string",
          "description": "string"
        },
        "personalize": {
          "title": "string",
          "description": "string"
        }
      }
    }
  },
  "icon_image": {
    "url": "string",
    "filename": "string",
    "size": 0,
    "mime_type": "string"
  },
  "documents": [
    {
      "kind": "privacy_document",
      "privacy_document_id": "string",
      "privacy_document_version": 0,
      "url": "string",
      "labels": {
        "es": "string",
        "en": "string"
      },
      "legacy_field": "privacy_policy_url"
    }
  ],
  "consent_duration_months": 3,
  "integrity_hash": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}