Componentes

Los siguientes componentes describen la estructura de datos tal y como se espera para las solicitudes a la API de Hosting-y tal y como se puede esperar como respuesta de la API de Hosting-.

Las propiedades en negrita son campos obligatorios y están marcadas con un asterisco.

Resumen

¡<!-- table header=false -- &gt | Nombre | Descripción | | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | Cliente | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | Dominio | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | Locale | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | Theme | Descriptor de la estructura del recurso tal y como se espera y envía la API. | | Marcador de posición | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | Embedding | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | EmbeddingAsset | El descriptor de la estructura del recurso tal y como se espera y envía la API. | | OnboardingScanResult | Descriptor de los datos enviados por la API tras escanear un dominio. | | OnboardingPreset | El descriptor de los datos tal y como se esperan al importar una plantilla. | | OnboardingPresetResult | Descriptor de los datos enviados por la API tras importar una plantilla. | | OnboardingCookie | | | OnboardingEmbedCodeSnippets | El descriptor de los datos enviados por la API al solicitar fragmentos de código-para incrustar CCM19. | | AioWebsiteRequest | | | AioWebsiteResponse | |

Cliente

¡<!-- table header=false -- &gt | Propiedad | Tipo de datos | Lectura | Escritura | Descripción | | ------------------------------ | -------- | ----- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | ✅ | ❌ | | |username(*) | string | ✅ | ✅ | | |password(*) | string | ❌ | ✅ | La contraseña del cliente en texto plano; como alternativa, utilice passwordHash. Sólo se requiere para crear un cliente. Omita el campo para dejar la contraseña sin cambios.| | passwordHash | string | ✅ | ✅ | Una contraseña precalculada-hash (bcrypt: $2y$); password tiene prioridad | | active | bool | ✅ | ✅ | Especifica si el cliente puede iniciar sesión. (valor por defecto: false) | | firstName | string | ✅ | ✅ | | | lastName | string | ✅ | ✅ | | |emailAddress(*) | string | ✅ | ✅ | | | company | string | ✅ | ✅ | | | domainCount | int | ✅ | ❌ | | | domainMaxCount | int | ✅ | ✅ | Número máximo de dominios que un cliente puede gestionar en su cuenta; -1 es ilimitado. (valor por defecto: 0) | | whitelabelCount | int | ✅ | ❌ | | | whitelabelMaxCount | int | ✅ | ✅ | Número máximo de licencias de etiqueta blanca-disponibles para un cliente; -1 es ilimitado. (valor por defecto: 0) | | widgetDisplayCount | int | ✅ | ❌ | | | widgetDisplayMaxCount | int | ✅ | ✅ | Define cuántas veces al mes se carga el widget CCM19-en el frontend; -1 es ilimitado. (valor por defecto: 0) | | autoCreateDomains | bool | ✅ | ✅ | (valor por defecto: false) | | features | object | ✅ | ✅ | Funciones que el cliente está autorizado a utilizar. |

(*) Estas características son campos obligatorios.

Client.features

¡<!-- table header=false -- &gt | Propiedad | Tipo de datos | Lectura | Escritura | Descripción | | ----------------------- | -------- | ----- | --------- | ------------ | | canUseABTests | bool | ✅ | ✅ | | | canUseAnalytics | bool | ✅ | ✅ | | | canUseConsentSharing | bool | ✅ | ✅ | | | canUseDomAPI | bool | ✅ | ✅ | | | canUseIAB | bool | ✅ | ✅ | | | canUseIframeCSS | bool | ✅ | ✅ | | | canUseIframes | bool | ✅ | ✅ | | | canUseIndCSS | bool | ✅ | ✅ | | | canUseMultiDom | bool | ✅ | ✅ | | | canUseOwnLogo | bool | ✅ | ✅ | | | canUseScripts | bool | ✅ | ✅ | | | canUseUserGroupRights | bool | ✅ | ✅ | | | moreThan2Lang | bool | ✅ | ✅ | |

Dominio

¡<!-- table header=false -- &gt | Propiedad | Tipo de datos | Lectura | Escritura | Descripción | | ------------------------------------------------ | ----------- | ----- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | ✅ | ❌ | | |name(*) | string | ✅ | ✅ | Se trata como el campo de entrada domain name de la administración de dominios, por lo que también puede definir la ruta de un sitio web al escribir. Ejemplos: www.mysite.xyz www.mysite.xyz/website2/ https://www.mysite.xyz https://www.mysite.xyz/website2/ Cuando se lee la propiedad,sólo se devuelve el nombre del dominio , es decir, www.mysite.xyz para los ejemplos anteriores. La ruta se encuentra en la propiedad de sólo lectura-path. | | path | string | ✅ | ❌ | Lee la ruta, que puede establecerse con name; por defecto /. | | country | ?string | ✅ | ✅ | ISO 3166-1 alpha-2 Código de país (AT,DE,CH,GB,US etc.); "ZZ" para especificar un país desconocido; o null para acceder a la configuración del perfil del usuario. | | whitelabel | bool | ✅ | ✅ | | | consentStorage | string | ✅ | ✅ | Valores permitidos: cookie localStorage sessionStorage (valor por defecto: localStorage) | | consentCookieLifetime | int | ✅ | ✅ | | | consentCookieSecure | bool | ✅ | ✅ | | | consentResetBeforeDate | fecha | ✅ | ✅ | Formato: "AAAA-MM-DD" | | consentResetOnLegalChange | bool | ✅ | ✅ | | | consentSharingDomains | string[] | ✅ | ✅ | | | consentSharingCrossDomain | bool | ✅ | ✅ | | | frontendWidgetEnabled | bool | ✅ | ✅ | | | frontendWidgetCache | bool | ✅ | ✅ | | | frontendWidgetMinifyCode | bool | ✅ | ✅ | | | managementStructure | string | ✅ | ✅ | Valores permitidos: cookie embedding (valor por defecto: embedding)La estructura de gestión cookie está obsoleta, ya no se proporcionan puntos finales de la API-.| | deleteUnknownCookies | bool | ✅ | ✅ | | | deleteUnknownCookiesForceReload | bool | ✅ | ✅ | | | requireConsentForMandatoryEmbeddings | bool | ✅ | ✅ | | | declineButtonEnforced | bool | ✅ | ✅ | | | allowedScriptMarkers | string[] | ✅ | ✅ | | | blockedScriptMarkers | string[] | ✅ | ✅ | | | evalInlineScripts | bool | ✅ | ✅ | (valor por defecto: false) | | recordScriptsOnWebsite | bool | ✅ | ✅ | | | blockNewScripts | bool | ✅ | ✅ | | | blockFirstPartyScripts | bool | ✅ | ✅ | | | blockInlineScripts | bool | ✅ | ✅ | | | permanentScanEnabled | bool | ✅ | ✅ | | | tcfEnabled | bool | ✅ | ✅ | | | tcfEnableNewVendorsAfterGvlUpdate | bool | ✅ | ✅ | | | tcfVendorBlacklist | int[] | ✅ | ✅ | | | tcfSpecialFeatures | int[] | ✅ | ✅ | | | tcfGoogleAdditionalConsentMode | bool | ✅ | ✅ | | | tcfGoogleAdditionalConsentAdProviders | int[] | ✅ | ✅ | | | tcfUrlMacroAutoAppend | bool | ✅ | ✅ | | | tcfUrlMacroHandling | bool | ✅ | ✅ | | | blockIframes | bool | ✅ | ✅ | | | rememberIframeConsentPerDomain | bool | ✅ | ✅ | | | appendConsentSwitchToIframes | bool | ✅ | ✅ | | | iframeBlockMode | string | ✅ | ✅ | Valores permitidos: blacklist whitelist (valor por defecto:whitelist) | | iframeMarkers | string[] | ✅ | ✅ | | | cookieDeclarationTableHeadingStartLevel | int | ✅ | ✅ | Valores permitidos: 2 3 4 5 (valor por defecto:3) | | cookieDeclarationTablePrependConsentChangeLink | bool | ✅ | ✅ | | | cookieDeclarationTablePrependIntroText | bool | ✅ | ✅ | | | imprintDisplayMode | string | ✅ | ✅ | Valores permitidos: direct link (valor por defecto: link) | | imprintOpenInNewTab | bool | ✅ | ✅ | | | imprintShowWidget | bool | ✅ | ✅ | | | privacyPolicyDisplayMode | string | ✅ | ✅ | Valores permitidos: direct link (valor por defecto: link) | | privacyPolicyOpenInNewTab | bool | ✅ | ✅ | | | privacyPolicyShowWidget | bool | ✅ | ✅ | | | accessibilityDisplayMode | string | ✅ | ✅ | Valores permitidos: direct link | | accessibilityLinkEnabled | bool | ✅ | ✅ | (valor por defecto: false) |

(*) Estas propiedades son campos obligatorios.

Locale

¡<!-- table header=false -- &gt | Propiedad | Tipo de datos | Lectura | Escritura | Descripción | | ------------------------------------------------ | ---------------------------------- | ----- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |name(*) | string | ✅ | ❌ | Sólo permitido para crear un recurso. | | active | bool | ✅ | ✅ | | | widgetTitle | string | ✅ | ✅ | | | widgetIntroText | string | ✅ | ✅ | | | widgetDeclineButtonText | string | ✅ | ✅ | | | widgetFullConsentButtonText | string | ✅ | ✅ | | | widgetSettingsButtonText | string | ✅ | ✅ | | | checkAllButtonText| *string* | ✅ | ✅ | | |uncheckAllButtonText| *string* | ✅ | ✅ | | |imprint| *string* | ✅ | ✅ | | |imprintHtmlCode| *string* | ✅ | ✅ | | |imprintUrl| *string* | ✅ | ✅ | | |privacyPolicy| *string* | ✅ | ✅ | | |privacyPolicyHtmlCode| *string* | ✅ | ✅ | | |privacyPolicyUrl| *string* | ✅ | ✅ | | |accessibility| *string* | ✅ | ✅ | | |accessibilityHtmlCode| *string* | ✅ | ✅ | | |accessibilityUrl| *string* | ✅ | ✅ | | |categoriesTitle| *string* | ✅ | ✅ | | |categoriesCancelButtonText| *string* | ✅ | ✅ | | |categoriesFullConsentButtonText| *string* | ✅ | ✅ | | |categoriesSaveButtonText| *string* | ✅ | ✅ | | |detailsTitle| *string* | ✅ | ✅ | | |detailsCloseButtonText| *string* | ✅ | ✅ | | |embeddingVendorLabel| *string* | ✅ | ✅ | | |embeddingDescriptionLabel| *string* | ✅ | ✅ | | |embeddingPrivacyPolicyUrlLabel| *string* | ✅ | ✅ | | |embeddingLifetimeLabel| *string* | ✅ | ✅ | | |embeddingWhichDataIsCollectedLabel| *string* | ✅ | ✅ | | | etiquetaembeddingPurposeOfDataCollectionLabel| *string* | ✅ | ✅ | | |embeddingLegalBasisLabel| *string* | ✅ | ✅ | | |embeddingPlaceOfProcessingLabel| *string* | ✅ | ✅ | | |embeddingAssetNameLabel| *string* | ✅ | ✅ | | |embeddingAssetLifetimeLabel| *string* | ✅ | ✅ | | |embeddingAssetDescriptionLabel| *string* | ✅ | ✅ | | |blockedContentTitle| *string* | ✅ | ✅ | | |blockedContentDisclaimer| *string* | ✅ | ✅ | | |blockedContentConsentButtonText| *string* | ✅ | ✅ | | |blockedContentConsentSwitchShowExternalContent| *string* | ✅ | ✅ | | |blockedContentConsentSwitchAllowEmbedding| *string* | ✅ | ✅ | | |blockedContentConsentSwitchProviderDetails| *string* | ✅ | ✅ | | |purposeNames| *Object.\<purposeId, name>* | ✅ | ✅ |41ba25c: Técnicamente necesariocdcbd7c: Anunciosa717ff5: Análisis / Estadísticas7c19e32: Personalización6cd2721: Medios sociales15c61c3: Otros | | purposeDescriptions | Object.\ | ✅ | ✅ | 41ba25c: Técnicamente necesario cdcbd7c: Anuncios a717ff5: Análisis / Estadísticas 7c19e32: Personalización 6cd2721: Medios sociales 15c61c3: Otros | | changeConsentText | string | ✅ | ✅ | | | moreInformationLabel | string | ✅ | ✅ | | | questionMarkButtonText | string | ✅ | ✅ | | | tcfVendorIntroText | string | ✅ | ✅ | | | tcfPurposeLabel | string | ✅ | ✅ | | | tcfSpecialPurposeLabel | string | ✅ | ✅ | | | tcfFeaturesLabel | string | ✅ | ✅ | | | tcfSpecialFeaturesLabel | string | ✅ | ✅ | | | tcfOptedInRemark | string | ✅ | ✅ | | | tcfThirdPartiesLabel | string | ✅ | ✅ | | | nonTcfPurposesLabel | string | ✅ | ✅ | --------- || | | | | |
nonTcfVendorsLabel cadena ✅ ✅
tcfVendorUsesNonCookieStorageText cadena ✅ ✅
tcfSpecialFeaturesHandledGloballyText cadena ✅ ✅
tcfStacksListText cadena ✅ ✅
tcfCookieRefreshText cadena ✅ ✅
tcfExtendedDisclosureText cadena ✅ ✅
tcfAssetTypeLabel cadena ✅ ✅
tcfAssetPurposesLabel cadena ✅ ✅

(*) Estos campos son obligatorios.

Tema

<! table header=false > Propiedad Tipo de datos Lectura Escritura Descripción

id cadena ✅ ❌
name (*) cadena ✅ ✅
default bool ✅ ✅
widgetBlocking bool ✅ ✅
widgetButtons string[] ✅ ✅ Valores permitidos: accept decline cpanel
widgetCloseButton bool ✅ ✅
widgetPosition string ✅ ✅ Valores permitidos: top center bottom bottomleft bottomright
widgetSwitchType cadena ✅ ✅
showPurposesInMainWindow bool ✅ ✅
settingsAcceptAllButton bool ✅ ✅
settingsCheckAndUncheckAllButtons bool ✅ ✅
settingsFooter bool ✅ ✅
complyWithDoNotTrack bool ✅ ✅
enableOnlyInEu bool ✅ ✅
manipulationPrevention bool ✅ ✅
logoEnabled bool ✅ ✅
logoImage ?string ✅ ✅ Codificación: Base64. Tamaño máximo: 512 KiB. Tipos MIME permitidos : image/jpeg image/png. Pasa null para eliminar la imagen almacenada. settingsIconEnabled bool ✅ ✅
settingsIconImage ?string ✅ ✅ Codificación: Base64. Tamaño máximo: 64 KiB. Tipos MIME permitidos : image/jpeg image/png. Pasa null para eliminar la imagen almacenada.
settingsIconTarget cadena ✅ ✅ Valores permitidos: main purpose (valor por defecto: purpose)
whitelabel bool ✅ ✅
primaryButtonBackgroundColor (*) string ✅ ✅ Formato: "#rrggbb"
primaryButtonForegroundColor (*) cadena ✅ ✅ Formato: "#rrggbb"
primaryButtonBorderColor (*) cadena ✅ ✅ Formato: "#rrggbb"
declineButtonBackgroundColor (*) cadena ✅ ✅ Formato: "#rrggbb"
declineButtonForegroundColor (*) cadena ✅ ✅ Formato: "#rrggbb"
declineButtonBorderColor (*) cadena ✅ ✅ Formato: «#rrggbb»
buttonBackgroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
buttonForegroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
buttonBorderColor (*) cadena ✅ ✅ Formato: «#rrggbb»
windowBackgroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
windowForegroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
windowLinkColor (*) cadena ✅ ✅ Formato: «#rrggbb»
windowBorderColor (*) cadena ✅ ✅ Formato: «#rrggbb»
iframeBlockerBackgroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
iframeBlockerForegroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
iframeBlockerButtonBackgroundColor (*) cadena ✅ ✅ Formato: «#rrggbb»
iframeBlockerButtonForegroundColor (*) cadena ✅ ✅ Formato: "#rrggbb"
customCss cadena ✅ ✅
customCssForIframeBlocker cadena ✅ ✅

(*) Estos campos son obligatorios.

Marcador de posición

<! table header=false > Propiedad Tipo de datos Lectura Escritura Descripción

name (*) cadena ✅ ❌ Solo se permite para crear un recurso. value (*) cadena ✅ ✅

(*) Estos campos son obligatorios.

Incrustación

<! table header=false > Propiedad Tipo de datos Lectura Escritura Descripción

id cadena name (*) active bool purpose (*) vendor cadena scriptHtmlCode cadena scriptLoaderGroup cadena scriptMarkers cadena[] iframeMarkers string[] hideIframesUntilConsent bool excludeUrlsMode string excludeFromUrls cadena[] description cadena privacyPolicyUrl cadena whatDataIsCollected cadena purposeOfDataCollection legalBasis cadena placeOfProcessing cadena translations Object.\ ✅ tcfVendor ?int tcfPurposes int[] tcfSpecialFeatures int[] googleConsentMode string[] assets EmbeddingAsset[] ✅ ✅ Acción por lotes en la que se eliminan los activos existentes ; por lo tanto, hay que tener cuidado. Recomendado para solicitudes POST .

(*) Estos campos son obligatorios.

Embedding.translations.[]

<! table header=false > Propiedad Tipo de datos Lectura Escritura Descripción

description cadena ✅ ✅
privacyPolicyUrl cadena ✅ ✅
whatDataIsCollected cadena ✅ ✅
purposeOfDataCollection cadena ✅ ✅
legalBasis cadena ✅ ✅
placeOfProcessing cadena ✅ ✅
blockedContentTitle cadena ✅ ✅
blockedContentText cadena ✅ ✅
blockedContentButtonText cadena ✅ ✅

EmbeddingAsset

<! table header=false > Propiedad Tipo de datos Lectura Escritura Descripción

id cadena ✅ ❌
name (*) cadena ✅ ✅
dynamic bool ✅ ✅
storageType string || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | |-- --| | | | | || --------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | |- || | | | | || | | | |- || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | |-- --| | | | | || ---------------- | -------- | ----- | --------- | ------------------------------------------- || | | | | || | | | | |-- --| | | | | || ------------------------- | ----------------------------------------------------------------- | ----- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || |translation> | | |- || | | | |-- || | | | | || | | | | || | | | | || |- | | |- |-- --| | | | | || -------------------------- | -------- | ----- | --------- | ------------------------------------------| | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | || | | | | |--- --| | | | | || --------------- | ----------------------------------------------------------------------- | ----- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || | | | | || | | | | || | | | | || | | ✅ | ✅ | Valores permitidos: cookie localStorage sessionStorage indexedDb webSql other | | lifetime | string | ✅ | ✅ | | | description | string | ✅ | ✅ | | | translations | Object.\translation> | ✅ | ✅ | Use locale-names para definir cada traducción como una propiedad independiente. en_DE en_US fr_FR es_ES pt_PT it_IT nl_NL pl_PL ru_RU zh yes cs .. |

(*) Estas propiedades son campos obligatorios.

EmbeddingAsset.translations.[]

¡