Last update: 2024-11-07
This guide leads you through the process of migrating from using Structured Data Files v7.1 to v8 and explains the changes between the two versions that may impact your integration.
See the release notes for an exhaustive list of differences between v7.1 and v8.
Migrate your Structured Data Files version
To migrate to Structured Data Files (SDFs) v8 from a previous version:
- Update your resources and SDF generation actions to use v8.
- Update Ad resource logic to identify a type upon creation.
- Add new logic for reading, creating, and updating Demand Gen resources.
Update Structured Data Files version
To use a new Structured Data Files version, update the assigned version in your parent Partner and Advertiser resources and use the new version when creating individual download tasks in the Display & Video 360 API.
Update parent resource settings
A default Structured Data Files version is set at the partner and advertiser resource level. This version is used as the default when downloading Structured Data Files through the interface or API.
Set in the interface
At the partner level
- Navigate to the intended partner.
- Expand the Partner settings menu in the left-hand navigation and navigate to the Basic details page.
- Update the SDF version configuration in the Structured Data Files section to v8.
At the advertiser level
- Navigate to the intended advertiser.
- Expand the Advertiser settings menu in the left-hand navigation and navigate to the Basic details page.
- Update the SDF version configuration in the Structured Data Files section to v8. If the default version is set at the Partner level, this setting may not be editable.
Set in the API
- At the partner level
- You cannot set the default SDF version at the Partner level in the API.
- At the advertiser level
- Make an
advertisers.patch
request to update thedataAccessConfig.sdfConfig.sdfConfig.version
toSDF_VERSION_8
and, if needed,dataAccessConfig.sdfConfig.overridePartnerSdfConfig
toTrue
.
Update sdfdownloadtasks.create
requests in the API
When making a sdfdownloadtasks.create
request using the
Display & Video 360 API, set the version
field of the
request body to SDF_VERSION_8
.
Specify type in Ad resources
v8 adds an Ad Type
column to Ad files, which surfaces the type of
Ad represented by each row. This new column is required and will be populated
for existing resources when downloading v8 Ad files.
When updating existing Ads, the value of this column shouldn't be changed.
When creating new Ads, you must populate this column with one of the values listed in the column description.
Update logic for Demand Gen resources
v8 supports the creation, retrieval, and updating of Demand Gen campaigns using Line Item, Ad Group, and Ad files. Demand Gen resources use different logic for timestamp verification, require the population of additional columns, and are limited by new restrictions across the three file types.
Timestamp verification
For all non-Demand-Gen line items, the Timestamp
column of a Line
Item file is populated at download with the last time a line item
was modified. This value is used when updating a line item using SDF to verify
that a line item has not been updated since the original file was downloaded. If
so, the update fails.
For Demand Gen line items, the Timestamp
column and the accompanying
verification works differently. For Demand Gen line item entries, the column is
populated with the current time at download. On upload, Display & Video 360
checks if it has been more than 24 hours since the given timestamp. If it has
been more than 24 hours, the original file entry is considered stale and the
update fails. If this happens, download the file again and make your updates
based on the more recent version. This new verification method does not prevent
you from overwriting changes made in the last 24 hours. To avoid accidental
overwrites, only include Demand Gen line items that you want to update in files
that you upload.
Required columns
The following file types have columns that are now required for certain Demand Gen resources, in addition to the columns that are required for all entities of that file type.
Line Item
Required columns for the following
Line Item
Type column values
|
||||
Demand Gen |
|
Ad
Required columns for the following
Ad
Ad Type column values
|
|||||||||
Demand Gen Carousel |
|
||||||||
Demand Gen Image |
|
||||||||
Demand Gen Product |
|
||||||||
Demand Gen Video |
|
Updated restrictions
In addition to the new required columns for certain Demand Gen Line Items and Ads, multiple columns across Line Item, Ad Group, and Ad file types have new use restrictions that apply to Demand Gen resources.
These restrictions are numerous and specific to the columns in question, so this guide doesn't provide an exhaustive list of restrictions. We recommend that you closely read the v8 reference documentation for Line Item, Ad Group, and Ad file types before creating or updating Demand Gen resources using SDF upload.