Zum Inhalt

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

Nombre Descripción
Cliente El descriptor de la estructura del recurso tal y como se espera y envía la API.
Dominio 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

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 este campo para no modificar la contraseña.
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

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

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

Propiedad Tipo de datos Lectura Escritura Descripción
name(*) string ✅ ❌ Sólo se permite 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 ✅ ✅
etiqueta embeddingPurposeOfDataCollectionLabel 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.\ ✅ ✅ 41ba25c: Técnicamente necesario cdcbd7c: Anuncios a717ff5: Análisis / Estadísticas 7c19e32: Personalización 6cd2721: Medios sociales 15c61c3: Otros
purposeDescriptions| *Object.\<purposeId, description>* | ✅ | ✅ |41ba25c: Técnicamente necesariocdcbd7c: Anunciosa717ff5: Análisis / Estadísticas7c19e32: Personalización6cd2721: Medios sociales15c61c3`: Otros
changeConsentText string ✅ ✅
moreInformationLabel string ✅ ✅
questionMarkButtonText string ✅ ✅
tcfVendorIntroText string ✅ ✅
tcfPurposeLabel string ✅ ✅
tcfSpecialPurposeLabel string ✅ ✅
tcfFeaturesLabel string ✅ ✅
tcfSpecialFeaturesLabel string ✅ ✅
tcfOptedInRemark string ✅ ✅
tcfThirdPartiesLabel string ✅ ✅
nonTcfPurposesLabel string ✅ ✅
nonTcfVendorsLabel string ✅ ✅
tcfVendorUsesNonCookieStorageText string ✅ ✅
tcfSpecialFeaturesHandledGloballyText string ✅ ✅
tcfStacksListText string ✅ ✅
tcfCookieRefreshText string ✅ ✅
tcfExtendedDisclosureText string ✅ ✅
tcfAssetTypeLabel string ✅ ✅
tcfAssetPurposesLabel string ✅ ✅

(*) Estas propiedades son campos obligatorios.

Tema

Propiedad Tipo de datos Lectura Escritura Descripción
id string ✅ ❌
name(*) string ✅ ✅
default bool ✅ ✅
widgetBlocking bool ✅ ✅
widgetButtons string[] ✅ ✅ Valores permitidos: accept decline cpanel
widgetCloseButton bool ✅ ✅
widgetPosition string ✅ ✅ Valores permitidos: top center bottom bottomleft bottomright
widgetSwitchType string ✅ ✅
showPurposesInMainWindow bool ✅ ✅
settingsAcceptAllButton bool ✅ ✅
settingsCheckAndUncheckAllButtons bool ✅ ✅
settingsFooter bool ✅ ✅
complyWithDoNotTrack bool ✅ ✅
enableOnlyInEu bool ✅ ✅
manipulationPrevention bool ✅ ✅
logoEnabled bool ✅ ✅
logoImage ?string ✅ ✅ Encoding: Base64 Tamaño máximo: 512 KiB Tipos MIME permitidos-: image/jpeg image/png Pase null para eliminar la imagen almacenada.
settingsIconEnabled bool ✅ ✅
settingsIconImage ?string ✅ ✅ Codificación: Base64 Tamaño máximo: 64 KiB Tipos MIME permitidos:-Tipos: 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 ✅ ✅ Formato: "#rrggbb"
primaryButtonForegroundColor(*) string ✅ ✅ Format: "#rrggbb"
primaryButtonBorderColor(*) string ✅ ✅ Format: "#rrggbb"
declineButtonBackgroundColor(*) string ✅ ✅ Format: "#rrggbb"
declineButtonForegroundColor(*) string ✅ ✅ Format: "#rrggbb"
declineButtonBorderColor(*) string ✅ ✅ Format: "#rrggbb"
buttonBackgroundColor(*) string ✅ ✅ Format: "#rrggbb"
buttonForegroundColor(*) string ✅ ✅ Format: "#rrggbb"
buttonBorderColor(*) string ✅ ✅ Format: "#rrggbb"
windowBackgroundColor(*) string ✅ ✅ Format: "#rrggbb"
windowForegroundColor(*) string ✅ ✅ Format: "#rrggbb"
windowLinkColor(*) string ✅ ✅ Format: "#rrggbb"
windowBorderColor(*) string ✅ ✅ Format: "#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.

Incrustación

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 string[] ✅ ✅
iframeMarkers string[] ✅ ✅
hideIframesUntilConsent bool ✅ ✅
excludeUrlsMode string ✅ ✅
excludeFromUrls string[] ✅ ✅
description string ✅ ✅
privacyPolicyUrl string ✅ ✅
whatDataIsCollected string ✅ ✅
purposeOfDataCollection string ✅ ✅
legalBasis string ✅ ✅
placeOfProcessing 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 ..
tcfVendor ?int ✅ ✅ Puede ser un TCF-Vendor-ID 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 int[] ✅ ✅
googleConsentMode string[] ✅ ✅ Valores permitidos: ad_storage analytics_storage functionality_storage personalisation_storage security_storage
assets EmbeddingAsset[] ✅ ✅ Acción de pila en la que se eliminan los activos existentes; así que tenga 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 ✅ ✅
privacyPolicyUrl string ✅ ✅
whatDataIsCollected string ✅ ✅
purposeOfDataCollection string ✅ ✅
legalBasis string ✅ ✅
placeOfProcessing string ✅ ✅
blockedContentTitle string ✅ ✅
blockedContentText string ✅ ✅
blockedContentButtonText string ✅ ✅

EmbeddingAsset

Propiedad Tipo de datos Lectura Escritura Descripción
id string ✅ ❌
name(*) string ✅ ✅
dynamic bool ✅ ✅
storageType string ✅ ✅ 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. de_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.[]

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

Propiedad Tipo de datos Lectura Escritura Descripción
address object ✅ ❌ Estos datos pueden utilizarse, por ejemplo, para actualizar placeholders.
imprintUrl ?string ✅ ❌
privacyPolicyUrl ?string ✅ ❌
availablePresets object[] ✅ ❌
storage object ✅ ❌

OnboardingScanResult.address

Propiedad Tipo de datos Lectura Escritura Descripción
company ?string ✅ ❌ Puede ser, por ejemplo, la empresa o el nombre del operador del sitio, dependiendo de la información que se encuentre en la página de impresión-.
street ?string ✅ ❌
código postal cadena ✅ ❌
ciudad` ?string ✅ ❌

OnboardingScanResult.availablePresets.[]

Propiedad Tipo de datos Lectura Escritura Descripción
id int ✅ ❌ Utilizar como OnboardingPreset.id.
name string ✅ ❌
purpose string ✅ ❌ 41ba25c: Técnicamente necesario cdcbd7c: Anuncios a717ff5: Análisis / Estadísticas 7c19e32: Personalización 6cd2721: Medios sociales 15c61c3: Otros
vendor string ✅ ❌
translations Object.\translation> ✅ ❌ Los idiomas se identifican por el nombre de la propiedad de una traducción.

OnboardingScanResult.availablePresets.translations.[]

Propiedad Tipo de datos Lectura Escritura Descripción
name string ✅ ❌
description string ✅ ❌

OnboardingScanResult.storage

Propiedad Tipo de datos Lectura Escritura Descripción
cookies object[] ✅ ❌
localStorage object[] ✅ ❌
sessionStorage object[] ✅ ❌

OnboardingScanResult.storage.cookies.[]

Propiedad Tipo de datos Lectura Escritura Descripción
name string ✅ ❌
domain string ✅ ❌
path string ✅ ❌

OnboardingScanResult.storage.localStorage.[]

Propiedad Tipo de datos Lectura Escritura Descripción
name string ✅ ❌

OnboardingScanResult.storage.sessionStorage.[]

Propiedad Tipo de datos Lectura Escritura Descripción
name string ✅ ❌

OnboardingPreset

Propiedad Tipo de datos Lectura Escritura Descripción
id(*) int ❌ ✅
active bool ❌ ✅ Activar el recurso inmediatamente al crearlo. (valor por defecto: false)

(*) Estas propiedades son campos obligatorios.

OnboardingPresetResult

Propiedad Tipo de datos Lectura Escritura Descripción
presetId int ✅ ❌
embeddingId string ✅ ❌ El ID del recurso que se acaba de crear.
Propiedad Tipo de datos Lectura Escritura Descripción
name(*) string ❌ ✅
storageType(*) string ❌ ✅ Valores permitidos: cookie localStorage sessionStorage

(*) Estas propiedades son campos obligatorios.

OnboardingEmbedCodeSnippets

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

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 escaneará y gestionará.
domainMaxCount int ❌ ✅ Esta propiedad corresponde a la propiedad Cliente.domainMaxCount.
whitelabelMaxCount int ❌ ✅ Esta propiedad corresponde a la propiedad Client.whitelabelMaxCount.
widgetDisplayMaxCount int ❌ ✅ Esta propiedad corresponde a la propiedad Client.widgetDisplayMaxCount.
locales string[] ❌ ✅ Idiomas a activar: de_DE, en_US, fr_FR, es_ES, it_IT, nl_NL, ja, zh, ...
systemTheme string ❌ ✅ Especifique un tema-ID para utilizar este tema. Defina systemTheme o userTheme.
userTheme string ❌ ✅ Especifique un tema-ID para utilizar este tema. Define systemTheme o userTheme.

(*) Estas propiedades son campos obligatorios.

AioWebsiteResponse

Propiedad Tipo de datos Lectura Escritura Descripción
clientId string ✅ ❌ Cuenta-ID del cliente que gestiona el sitio web.
domainId string ✅ ❌ ID del dominio que representa el sitio web.
embed OnboardingEmbedCodeSnippets ✅ ❌