Breaking Change: Version 2.159 Update of Adswizz Delivery Reports (Site-based and Enhanced Delivery Reports)
Version | 2.159 |
|---|---|
Integration | Adswizz |
What will change?
Coming with Patch release 2.158.4 we will be changing the behaviour of our Delivery Reports for our Adswizz integration.
Site-based Delivery Data change from Zones to Publishers
Please be aware that we will deprecate the old report logic in the future. Then you won’t be able to switch the Sitebased Delivery Imports as described below on the Connection record, and it will only import data based on Publishers. We will provide a dedicated note, once this change will be applied in our release notes, so until then you can switch your sitebased delivery reports.
The change will affect the Site-based Delivery Reports. Prior to this version, our Site-based Delivery import for Adswizz was breaking down your delivery data based on individual Zones and Month / Days (depending on your configuration).
This will be updated: the new Site-based Delivery Report for Adswizz will now aggregate delivery data for Campaign Items, based on Publishers instead. This is a higher level of the hierarchy, meaning there will be more information aggregated into one Delivery Data record in ADvendio.
New Import for Zones: Enhanced Delivery Data
At the same time, we’re enabling the Enhanced Delivery Data feature for Adswizz. This will allow you to import delivery information based on individual Zones.
In order to activate this import, you will need to schedule a monthly delivery report and activate the enhanced delivery data option. Additionally please set up the filter to Inventory, as also highlighted in our Enhanced Delivery Data documentation: https://advendio.atlassian.net/wiki/spaces/SO/pages/711557127
This can be done by pasting the following string into the field ‘Enhanced Delivery Report Filter’:
{
"splitBy":["Inventory"]
}
Why are we doing this?
We are taking these steps to streamline our Adswizz integration further with our other AdServer Integrations.
Usually, the Site-based Delivery Reports are used to import data aggregated on Top-Level Domains or the highest possible aggregation based on inventory criteria. In the case of Adswizz, these would be Publishers instead of Zones.
Additionally, this change will give you more flexibility, as you can just import the detail level you need for your reporting use cases and business processes!
What do you have to do?
Once the new version 2.158.4 or 2.159 is installed you are able to activate the new Reporting of Sitebased Delivery Data, based on Publishers instead of Zones.
To do so, you will need to edit a field called ‘Connection Features’ on your Adswizz Connection record. There you will need to chose the value ‘Enable Publisher Based Reports’. Once this is saved, the next time a Sitebased Delivery Report runs for Adswizz, it will import data in the new format!
Attention: after changing this setting, please go to the Delivery Report Center, delete your currently planned delivery reports and schedule them again, in order to prevent problems with the import!
Due to Salesforce limitations, it is required for you to set up the new field, if you’ve been updating to 2.158.4 from an older version. Otherwise you wont be able to see it in ADvendio. Please see our setup section below for more information.
For the new Enhanced Delivery Data import, you can immediately proceed to schedule it, as described above. No further settings need to be activated.
How can you ensure a smooth migration?
Install the new Patch Version
Prepare your reports, layouts and custom processes for the new imports (depending on whether you need to use the Zone Level data or the new publisher-based data)
Change the field ‘Connection Features’ as described above to enable the
Please always delete and reschedule your site-based delivery reports, when doing a test run. You can do this in our Delivery Report Center.
Run your tests and adjust data accordingly, if you see that further steps need to be done, feel free to switch back, by editing your Adswizz Connection Record and removing the option ‘Enable Publisher Based Reports’ from the Connection Features field.
What will happen with my running Campaign Items
For currently running Campaigns, once the report has been switched, Delivery Data will be imported again in the new format for the complete runtime of that item.
This means for all ongoing and future Campaigns you will be able to report with the new data format. Only Campaigns and Items that finished more than 30 days ago will be ignored by our importing feature.
How to identify DeliveryData in the old format (Zone) vs. new format (Publisher)
If you need to clearly differentiate between Delivery Data records in the old format and the new format, we suggest creating a custom formula field to support you.
Please create a field of the type ‘formula (text)’ on the ADvendio__DeliveryData__c object and paste in the following formula:
TEXT(ADvendio__AdServerID__r.ADvendio__Type__c)
You will now have a new field, which tells you if the Delivery Data is based on a Zone or a Publisher. You can now adjust your processes to filter out the Zone based Delivery Data records.
Setup
If you are updating your old ADvendio version, it might be required to do some setup steps. You will need to create the picklist value for the Connection Features field and need to add it to the page layout of your Adswizz Connection.
To do so, you will need to enter the Salesforce Setup, go to the Object Manager and edit the Connection Object. You can click the edit button on the field Connection Features, in order to modify the picklist values.
Please Make sure to match the exact picklist value as we define it: 'Enable Publisher Based Reports’
Proceed to save the changes. Now modify your Page Layout and add the Connection Features field to your Adswizz Page Layout.