In this article you will learn the most important information about the DPS Deprecation. |
|---|
In this article
What is happening
As our template database is continuously being updated, we created new templates for service providers that have changed their names, split up their products or merged services. We will now start marking these Data Processing Service templates as deprecated, to ensure more clarity.
All our services will continue to operate normally and there is no immediate action required.
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 will stop providing maintenance and support for deprecated templates.
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.
What is going to change?
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.
What should I do with my existing client configurations?
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.
What should I do with new client configurations?
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”).
How do I know if my clients configuration is using Deprecated Service Templates? How do I know whats the new Template?
The Objects ConsentTemplate within each setting remain to contain information about the specific service template.
NEW Two new properties are added, indicating if the specific template is deprecated and what it’s the corresponding new template id is.
Deprecated Templates are flagged with isDeprecated: true.
Example:
Template Amazon Adsystems (gvWsZJmVT) will have isDeprecated:true and newTemplateId: “N2spyFPL”.
type ConsentTemplate {
id: String
templateId: String
...
isDeprecated: Boolean
newTemplateId: String
}
The property newTemplateId can be null in case the template is not deprecated or doesn’t has a newer Template.
Are changes on the Website necessary? What about Smart-Data-Protector? Do I need to change my Tag Management System?
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.
How can I replace deprecated Templates by it’s new Template?
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.
How to prevent using deprecated Templates?
The existing endpoints getAllConsentTemplates and consentTemplates return the list of all available templates ConsentTemplate in our database.
NEW Both endpoints now 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:
consentTemplates (includeDeprecated: false)getAllConsentTemplates (includeDeprecated: false)
getAllConsentTemplates( skip: Int limit: Int ... includeDeprecated: Boolean = true ): [ConsentTemplate] consentTemplates( first: Int skip: Int includeDeprecated: Boolean = true ): [ConsentTemplate]
How will the crawler logic change?
The crawler endpoint getTechnologies will scan a website and return the latest service templates that were identified on a website.
NEW 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 will scan a website and automatically add services to your CMP configuration.
NEW 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:
If the configuration already contains Amazon Adsystems (gvWsZJmVT), the endpoint won’t add Amazon advertising (N2spyFPL).
If Amazon Adsystems (gvWsZJmVT) was not yet part of the CMP configuration, the endpoint will add Amazon advertising (N2spyFPL).