Componentes
--Los siguientes componentes describen la estructura de datos tal y como se espera para las solicitudes a la API de alojamiento y tal y como se puede esperar como respuesta de la API de alojamiento.
Las propiedades en negrita son campos obligatorios y están marcadas con un asterisco.
Descripción general
| 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 El 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 explorar un dominio. |
| - | OnboardingPreset El descriptor de los datos esperados al importar una plantilla. |
| -- | OnboardingPresetResult El descriptor de los datos enviados por la API después de 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
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
id string ✅ ❌ |
||||
| * | * username(*) string ✅ ✅ |
|||
| * | * password(*) string ❌ ✅ La contraseña del cliente en texto plano; alternativamente use passwordHash. Sólo se requiere para crear un cliente. Omita este campo para no modificar la contraseña.** |
|||
-passwordHash string ✅ ✅ Un hash de contraseña precalculado (bcrypt: $2y$); password tiene prioridad |
||||
active bool ✅ ✅ Indica si el cliente puede iniciar sesión. (valor por defecto: false) |
||||
firstName string ✅✅✅✅ |
||||
lastName string ✅✅✅ |
||||
| * | * emailAddress(*) string ✅ ✅ |
|||
company string ✅✅✅✅ |
||||
| número de dominios 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
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
canUseABTests bool ✅ ✅ |
||||
| canUseAnalytics | ||||
| canUseConsentSharing | ||||
| canUseDomAPI | ||||
| canUseIAB | ||||
| canUseIframeCSS | ||||
| canUseIframes | ||||
| canUseIndCSS | ||||
canUseMultiDom bool ✅ ✅ ✅ |
||||
canUseOwnLogo bool ✅ ✅ |
||||
| canUseScripts | ||||
| canUseUserGroupRights | ||||
moreThan2Lang bool ✅ ✅ ✅ |
Dominio
| 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 del dominio, 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*cadena* ✅ ✅ ISO 3166 1 alpha 2 Código de país (AT,DE,CH,GB,US etc.); "ZZ" para especificar un país desconocido; onull` 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 date ✅ ✅ Format: "YYYY MM DD" |
||||
consentResetOnLegalChange bool ✅ ✅ ✅ |
||||
consentSharingDomains string[] ✅ ✅ ✅ |
||||
consentSharingCrossDomain bool ✅ ✅ ✅ |
||||
frontendWidgetEnabled bool ✅ ✅ ✅ |
||||
frontendWidgetCache bool ✅ ✅ ✅ ✅ *frontendWidgetCache |
||||
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 API. |
||||
deleteUnknownCookies bool ✅✅✅ |
||||
| deleteUnknownCookiesForceReload bool ✅ ✅ ✅ | ||||
requireConsentForMandatoryEmbeddings bool ✅ ✅ ✅ |
||||
declineButtonEnforced bool ✅ ✅ ✅ ✅ |
||||
allowedScriptMarkers string[] ✅ ✅ ✅ ✅ ✅ ✅ *blockedScriptMarkers |
||||
blockedScriptMarkers stringing[] ✅ ✅ ✅ |
||||
evalInlineScripts bool ✅ ✅ (valor por defecto: false) |
||||
recordScriptsOnWebsite bool ✅ ✅ (valor por defecto: false) |
||||
blockNewScripts bool |
</nt | > ✅ ✅ | ||
blockFirstPartyScripts bool ✅ ✅ ✅ |
||||
| bloquear guiones en línea (BlockInlineScripts) | ||||
| permanentScanEnabled" bool ✅ ✅ ✅ ✅ ✅ ✅ bool ✅ ✅ | ||||
tcfEnabled bool ✅ ✅ ✅ |
||||
| tcfEnableNewVendorsAfterGvlUpdate | ||||
tcfVendorBlacklist int[] ✅ ✅ ✅ |
||||
| características especiales | ||||
tcfGoogleAdditionalConsentMode bool ✅ ✅ ✅ |
||||
tcfGoogleAdditionalConsentAdProviders int[] ✅ ✅ ✅ |
||||
tcfUrlMacroAutoAppend bool ✅ ✅ ✅ |
||||
tcfUrlMacroHandling bool ✅ ✅ ✅ |
||||
blockIframes bool ✅ ✅ ✅ ✅ Bloquear marcos |
||||
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 | ||||
| imprintShowWidget | ||||
privacyPolicyDisplayMode string ✅ ✅ Valores permitidos: direct link (valor por defecto: link) |
||||
| privacyPolicyOpenInNewTab bool ✅ ✅ ✅ ✅ *privacyPolicyShowInNewTab | ||||
| privacyPolicyShowWidget" bool ✅ ✅ ✅ ✅ ✅ *privacyPolicyOpenInNewTab | ||||
accessibilityDisplayMode string ✅ ✅ Valores permitidos: direct link |
||||
accessibilityLinkEnabled bool ✅ ✅ (valor por defecto: false) |
(*) Estas propiedades son campos obligatorios.
Locale
| 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 |
||||
| política de privacidad | ||||
| privacyPolicyHtmlCode" string ✅ ✅ ✅ "PrivacyPolicyUrl" *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 ✅ ✅ ✅ |
||||
embeddingPurposeOfDataCollectionLabel string ✅ ✅ ✅ |
||||
etiqueta embeddingLegalBasisLabel string ✅ ✅ ✅ |
||||
etiqueta embeddingPlaceOfProcessingLabel string ✅ ✅ ✅ |
||||
embeddingAssetNameLabel string ✅ ✅ ✅ |
||||
embeddingAssetLifetimeLabel string ✅ ✅ ✅ |
||||
embeddingAssetDescriptionLabel string ✅ ✅ ✅ |
||||
blockedContentTitle string ✅ ✅ ✅ |
||||
blockedContentDisclaimer string ✅ ✅ ✅ ✅ Bloquear contenido |
||||
blockedContentConsentButtonText string ✅ ✅ ✅ ✅ ✅ Bloquear contenido |
||||
blockedContentConsentSwitchShowExternalContent string ✅ ✅ |
||||
blockedContentConsentSwitchAllowEmbedding string ✅ ✅ |
||||
blockedContentConsentSwitchProviderDetails string ✅ ✅ ✅ |
||||
purposeNames *Object.\ * ✅ ✅ 41ba25c: Técnicamente necesario cdcbd7c: Anuncios a717ff5: Análisis / Estadísticas 7c19e32: Personalización 6cd2721: Medios sociales 15c61c3: Otros |
||||
purposeDescriptions*Object.\ * ✅ ✅41ba25c: Técnicamente necesariocdcbd7c: Anunciosa717ff5: Análisis / Estadísticas7c19e32: Personalización6cd2721: Redes Sociales15c61c3`: Otros |
||||
changeConsentText string ✅✅✅ |
||||
moreInformationLabel string ✅ ✅ ✅ más información |
||||
questionMarkButtonText string ✅ ✅ ✅ |
||||
tcfVendorIntroText string ✅ ✅ ✅ |
||||
tcfPurposeLabel string ✅ ✅ ✅ |
||||
tcfSpecialPurposeLabel string ✅ ✅ |
||||
tcfFeaturesLabel string ✅ ✅ ✅ |
||||
tcfSpecialFeaturesLabel string ✅ ✅ |
||||
tcfOptedInRemark string ✅ ✅ ✅ |
||||
tcfThirdPartiesLabel |
<!-- | nt--> string ✅✅✅ | ||
nonTcfPurposesLabel string ✅ ✅ ✅ |
||||
nonTcfVendorsLabel string ✅ ✅ ✅ |
||||
tcfVendorUsesNonCookieStorageText string ✅ ✅ |
||||
tcfSpecialFeaturesHandledGloballyText string ✅ ✅ ✅ |
||||
tcfStacksListText string ✅ ✅✅✅✅✅✅ |
||||
tcfCookieRefreshText string ✅ ✅ ✅ |
||||
tcfExtendedDisclosureText string ✅ ✅ ✅ |
||||
tcfAssetTypeLabel string ✅ ✅ ✅ *tcfExtendedDisclosureText |
||||
tcfAssetPurposesLabel string ✅✅✅✅✅ |
(*) Estas propiedades son campos obligatorios.
Tema
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
id string ✅ ❌ |
||||
| * | * name(*) string ✅ ✅ |
|||
default bool ✅ ✅ |
||||
| widgetBlocking bool ✅ ✅ ✅ ✅ *WidgetBlocking | ||||
widgetButtons string[] ✅ ✅ Valores permitidos: accept decline cpanel |
||||
widgetCloseButton bool ✅ ✅ |
||||
widgetPosition string ✅ ✅ Valores permitidos: top center bottom bottomleft bottomright |
||||
widgetSwitchType string ✅✅✅ |
||||
| mostrarPropósitosEnVentanaPrincipal | ||||
settingsAcceptAllButton bool ✅ ✅ ✅ |
||||
settingsCheckAndUncheckAllButtons bool ✅ ✅ ✅ |
||||
settingsFooter bool ✅ ✅ ✅ ✅ |
||||
| cumplirConNoHacerSeguimiento" bool ✅ ✅ ✅ ✅ | ||||
enableOnlyInEu bool ✅ ✅ ✅ |
||||
| manipulationPrevention` bool ✅ ✅ ✅ ✅ ✅ ✅ ManipulationPrevention | ||||
| logoEnabled` bool ✅ ✅ ✅ ✅ ✅ | ||||
-logoImage cadena ✅ ✅ Codificación: Base64 Tamaño máximo: 512 KiB Tipos MIME permitidos: image/jpeg image/png Pase null para eliminar la imagen almacenada. |
||||
settingsIconEnabled bool ✅✅✅ |
||||
-settingsIconImage cadena ✅ ✅ Codificación: Base64 Tamaño máximo: 64 KiB Tipos MIME permitidos: image/jpeg image/png Pase null para eliminar la imagen almacenada. |
||||
settingsIconTarget string ✅ ✅ Valores permitidos: main purpose (valor por defecto: purpose) |
||||
whitelabel bool ✅ ✅ ✅ |
||||
| * | * primaryButtonBackgroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * primaryButtonForegroundColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * primaryButtonBorderColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * declineButtonBackgroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * declineButtonForegroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * declineButtonBorderColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * buttonBackgroundColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * buttonForegroundColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * buttonBorderColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * windowBackgroundColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * windowForegroundColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * windowLinkColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * windowBorderColor(*) string ✅ ✅ Formato: "#rrggbb" |
|||
| * | * iframeBlockerBackgroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * iframeBlockerForegroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * iframeBlockerButtonBackgroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
| * | * iframeBlockerButtonForegroundColor(*) string ✅ ✅ Format: "#rrggbb" |
|||
customCss string ✅ ✅ |
||||
customCssForIframeBlocker string ✅ ✅ ✅ |
(*) Estas propiedades son campos obligatorios.
Marcador de posición
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| * | * name(*) string ✅ ❌ Sólo se permite crear un recurso. |
|||
| * | * value(*) string ✅ ✅ |
(*) Estas propiedades son campos obligatorios.
Embedding
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
id string ✅ ❌ |
||||
| * | * name(*) string ✅ ✅ |
|||
active bool ✅ ✅ |
||||
| * | * purpose(*) string ✅ ✅ 41ba25c: Técnicamente necesario cdcbd7c: Anuncios a717ff5: Análisis / Estadísticas 7c19e32: Personalización 6cd2721: Medios sociales 15c61c3: Otros |
|||
vendor string ✅✅✅ |
||||
scriptHtmlCode string ✅ ✅ |
||||
scriptLoaderGroup string ✅ ✅ ✅ *scriptMarkers |
||||
scriptMarkers string[] ✅ ✅ ✅ |
||||
iframeMarkers stringing[] ✅ ✅ ✅ |
||||
hideIframesUntilConsent bool ✅ ✅ ✅ |
||||
excludeUrlsMode string ✅ ✅ ✅ ✅ |
||||
excludeFromUrls string[] ✅ ✅ ✅ |
||||
description string ✅✅✅✅ |
||||
privacyPolicyUrl string ✅ ✅✅✅✅ |
||||
whatDataIsCollected string ✅ ✅ ✅ |
||||
| finalidad de la recogida de datos | ||||
| base jurídica string ✅ ✅ ✅ Lugar de tratamiento | ||||
placeOfProcessing string ✅✅✅✅✅✅✅✅ Objeto |
||||
-translations Object.\2705↩ ✅ ✅ Utiliza nombres de localización 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 .. |
||||
--tcfVendor" Int ✅ ✅ Un ID de proveedor TCF válido o "null" para eliminar la referencia. Esta propiedad tiene prioridad sobre la propiedad vendor y la sobrescribe con el nombre del proveedor correspondiente. |
||||
| tcfPurposes int[] ✅ ✅ TcfSpecialFeatures | ||||
| características especiales | ||||
googleConsentMode string[] ✅ ✅ Valores permitidos: ad_storage analytics_storage functionality_storage personalisation_storage security_storage |
||||
| - | assets EmbeddingAsset[] ✅ ✅Stack action where existing assets are removed; así que ten cuidado.-Recomendado para peticiones POST. |
(*) Estas propiedades son campos obligatorios.
Embedding.translations.[]
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
name string ✅ ✅ Traducción opcional para el nombre de la incrustación. |
||||
description string ✅ ✅ Traducción opcional del nombre de la incrustación |
||||
privacyPolicyUrl string ✅ ✅✅ ✅ ✅ |
||||
whatDataIsCollected string ✅ ✅ ✅ |
||||
| finalidad de la recogida de datos | ||||
| base jurídica string ✅ ✅ ✅ Lugar de tratamiento | ||||
| lugar de tratamiento | ||||
blockedContentTitle string ✅ ✅ ✅ |
||||
blockedContentText string ✅ ✅✅ ✅ ✅ ✅ Bloquear contenido |
||||
blockedContentButtonText string ✅ ✅ ✅ |
-## EmbeddingAsset {#activo de incrustación}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
id string ✅ ❌ |
||||
| * | * name(*) string ✅ ✅ |
|||
dynamic bool ✅ ✅ ✅ Tipo de almacenamiento |
||||
storageType string ✅ ✅ Valores permitidos: cookie localStorage sessionStorage indexedDb webSql other |
||||
lifetime string ✅✅✅ |
||||
description string ✅ ✅ ✅ |
||||
| - | -translations Object.\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.[] {#embedding asset.translations.item}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
lifetime string ✅ ✅ Tiempo de vida aproximado de la entrada - por ejemplo, "1 hora" o "5 días". |
||||
-description string ✅ ✅ ¿Para qué se utiliza la entrada (cookie, almacenamiento local, etc.)? |
--## OnboardingScanResult {#resultado del escaneo de embarque}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| -- | address object ✅ ❌ Estos datos pueden utilizarse, por ejemplo, para actualizar placeholders. |
|||
imprintUrl ?string ✅ ❌❌ |
||||
| privacyPolicyUrl" cadena ✅❌ | ||||
| --- | availablePresets object[] ✅ ❌ |
|||
| -- | storage object ✅ ❌ |
--### OnboardingScanResult.address {#resultado escaneo embarque.direccion}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
-company ?string ✅ ❌ Puede ser, por ejemplo, la empresa o el nombre del operador del sitio, en función de la información que se encuentre en la página de impresión. |
||||
| calle cadena ✅❌❌❌❌❌❌❌❌ | ||||
| código postal cadena ✅❌❌❌❌ | ||||
| ciudad cadena ✅❌❌❌❌❌❌❌ |
---### OnboardingScanResult.availablePresets.[] {#resultado del escaneo de Onboarding.presets.item disponibles}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
-id int ✅ ❌ Utilizar como OnboardingPreset.id. |
||||
name string ✅❌❌❌❌❌❌❌❌ |
||||
purpose*string* ✅ ❌41ba25c: Técnicamente necesariocdcbd7c: Anunciosa717ff5: Análisis / Estadísticas7c19e32: Personalización6cd2721: Redes sociales15c61c3`: Otros |
||||
vendor string ✅ ❌ |
||||
| --- | translations Object.\ |
---### OnboardingScanResult.availablePresets.translations.[] {#onboarding scan result.available presets.translations.item}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
name string ✅ ❌ `description |
||||
description string ✅ ❌ |
--### OnboardingScanResult.storage {#resultadoescaneoonboarding.storage}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| -- | cookies object[] ✅ ❌ |
|||
| --- | localStorage object[] ✅ ❌ |
|||
| --- | sessionStorage object[] ✅ ❌ |
--### OnboardingScanResult.storage.cookies.[] {#resultado escaneo #onboarding.storage.cookies.item}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
name string ✅❌❌❌❌❌❌❌ |
||||
| dominio" string ✅ ❌ ✅ string ✅ string ❌ | ||||
path string ✅ ❌ |
---### OnboardingScanResult.storage.localStorage.[] {#resultado del escaneo onboarding.storage.local storage.item}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
nombre cadena ✅ ❌ |
---### OnboardingScanResult.storage.sessionStorage.[] {#resultado del escaneo onboarding.storage.session storage.item}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
nombre cadena ✅ ❌ |
-## OnboardingPreset {#preconfiguración de embarque}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| * | * id(*) int ❌ ✅ |
|||
active bool ❌ ✅ Activar el recurso inmediatamente después de su creación. (valor por defecto: false) |
(*) Estas propiedades son campos obligatorios.
--## OnboardingPresetResult {#resultado de la preconfiguración de embarque}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
presetId int ✅ ❌ |
||||
embeddingId string ✅ ❌ El ID del recurso que se acaba de crear. |
-## OnboardingCookie {#cookie de embarque}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| * | * name(*) string ❌ ✅ |
|||
| * | * storageType(*) string ❌ ✅ Valores permitidos: cookie localStorage sessionStorage |
(*) Estas propiedades son campos obligatorios.
---## OnboardingEmbedCodeSnippets {#Pequeños fragmentos de código de incrustación de onboarding}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
--default string ✅ ❌ Este fragmento de código apunta directamente a la configuración CCM19 de un dominio respectivo. Se utiliza el tema marcado como activo; el idioma se determina automáticamente para cada solicitud. |
||||
-de_DE, en_US, ... string ✅ ❌ Hay una propiedad separada para cada traducción activa, que contiene el fragmento de código para forzar el idioma respectivo. |
--## AioWebsiteRequest {#solicitud de sitio web aio}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
| * | * username(*) string ❌ ✅ El nombre de usuario del cliente que gestionará el sitio web. Si la cuenta no existe, se creará. |
|||
| * | * websiteUrl(*) string ❌ ✅ URL del sitio web que se va a escanear y gestionar. |
|||
domainMaxCount int ❌ ✅ Esta propiedad corresponde a la propiedad Cliente.domainMaxCount. |
||||
whitelabelMaxCount int ❌ ✅ Esta propiedad corresponde a la propiedad Cliente.whitelabelMaxCount. |
||||
esta propiedad corresponde a la propiedad Client.widgetDisplayMaxCount int ❌ ✅. |
||||
locales string[] ❌ ✅ Idiomas a activar: de_DE, en_US, fr_FR, es_ES, it_IT, nl_NL, ja, zh, ... |
||||
-systemTheme string ❌ ✅ Especifica un ID de tema para utilizar este tema. Defina systemTheme o userTheme. |
||||
-userTheme string ❌ ✅ Especifique un ID de tema para utilizar este tema. Defina systemTheme o userTheme. |
(*) Estas propiedades son campos obligatorios.
--## AioWebsiteResponse {#respuesta de sitio web aio}
| Propiedad Tipo de datos Lectura Escritura Descripción | ||||
|---|---|---|---|---|
-clientId string ✅ ❌ ID de la cuenta del cliente que gestiona el sitio web. |
||||
domainId string ✅ ❌ ID del dominio que representa el sitio web. |
||||
| --- | embed OnboardingEmbedCodeSnippets ✅ ❌ ❌ |