In this article you will learn the most important information about the DPS template deprecation. |
---|
In this article
Our template database is continuously updated. We create new templates for new service providers, update existing templates for instance when company names are changing and are deprecating templates to ensure highest clarity.
This article is about the deprecation of templates, what does it actually mean, how to know if a template is deprecated and what to do if one or more of your customers are using deprecated templates.
A deprecated template will continue to operate normally and there is no immediate action required. However:
We recommend avoid using deprecated templates, to migrate existing customers to their new templates and provide only the latest templates to new customers as we stop providing maintenance and support for deprecated templates and won’t update such anymore. |
Examples of deprecated service templates:
Amazon Adsystems (gvWsZJmVT) is deprecated and replaced with Amazon advertising (N2spyFPL)
Google Web Fonts (HkYNq4sdjbm) is deprecated and replaced with Google Fonts (HkPBYFofN)
http://yumpu.com (9BBsmV62) is deprecated and is replaced with yumpu (6LdBYXdAl)
A list of all deprecated Templates is available here. |
All deprecated templates will get a deprecation flag and you will be able to see the template-id that it is being replaced with.
Below you will find more information how the new flags and endpoints will look like, how the crawler will be adjusted and how our Smart Data Protector will deal with deprecated templates.
If you have customers using deprecated templates, we recommend to inform them, make necessary changes on the website if needed and eventually to replace the deprecated templates it’s new template.
If you are providing an option for your customers to select templates from a list (template search), we recommend to filter out any deprecated templates and only provide your customers the latest template (see below for more details - “How to prevent using deprecated Templates”).
If you are providing a crawling service, crawler results will include purely the latest templates for any new CMP configuration (see below for more details - “How will the Crawler Logic change”).
The Objects ConsentTemplate
within each setting remain to contain information about the specific service template.
Two properties are indicating if the specific template is deprecated and what it’s the corresponding new template id is. Deprecated Templates are flagged with Example: Template Amazon Adsystems (gvWsZJmVT) has |
type ConsentTemplate { id: String templateId: String ... isDeprecated: Boolean newTemplateId: String } |
The property |
As the template-IDs and template names will change when replacing a deprecated template by its replaced version.
It might be necessary to make changes on the website. For instance if Tag Management Systems like GTM are being used or direct Javascript implementations using the services names.
Read here for more details.
The existing deprecated template must first be removed from the CMP configuration.
The new template must then be added, either by manually selecting it from your UI or by utilizing the crawler.
The existing endpoints getAllConsentTemplates
and consentTemplates
return the list of all available templates ConsentTemplate
in our database.
Both endpoints allow to filter deprecated templates. By default, outdated templates remain to be included in the result list (no breaking change). Example to retrieve only latest templates:
|
getAllConsentTemplates( skip: Int limit: Int ... includeDeprecated: Boolean = true ): [ConsentTemplate] consentTemplates( first: Int skip: Int includeDeprecated: Boolean = true ): [ConsentTemplate] |
The crawler endpoint getTechnologies
will scan a website and return the latest service templates that were identified on a website.
If a service has deprecated versions, the crawler response will include a list of deprecated template ids. |
type CrawlerResponse { label: String templateId: String deprecatedIds: [ String ] } |
The crawler endpoint addTechnology
scans a website and automatically add services to your CMP configuration.
If your CMP configuration includes deprecated versions of templates, the endpoint won’t add the correct and latest version. This additional logic was implement to avoid having duplicated Services. Example:
|
How can I get help with technical questions?