Description: This article is aimed at our Sell Side customers, explaining how to format and upload impression mappings data.
Note: To view how to upload data impression mappings files for Buy Side, see our article Uploading Data Impression Mappings Files.
Formatting your file
You can upload the data in a flat CSV file or an Excel file. Ensure your file is cumulative, i.e., inclusive of all historical mappings.
Your file must be formatted correctly and according to our guidelines:
How should I format my impression data mappings file? | |
✓ Include all required columns | ✕ Use special characters in the field value, e.g., !,@,% |
✓ Ensure all columns have a header | ✕ Mix data formats in a column |
✓ Ensure headers and field values match those in the examples exactly, including case | |
✓ Include only a header row and data within the file |
To view an example file in the platform, go to Data > Impressions > Upload Impression Mappings File.
Complete the fields in your data file according to the table below:
Title | Column Name | Description | Format | Accepted Values | Notes |
Impression Type |
impression_type |
This column will only accept a value of vod. |
Text |
vod |
This column will always have vod. |
Impression Field |
impression_field |
Values as shown in your impression pixel. |
Text |
placementgroup, publisher, creative, campaign, network | |
Field Value
|
field_value |
This is the actual value that was returned via the impression pixel from your publishers. |
Text |
Value that currently appears in the InnovidXP platform. | |
Mapped Value |
mapped_value |
Value to replace field value. |
Text |
Value that should appear in the InnovidXP platform. | |
Discard Flag |
discard_flag |
Leave blank |
Leave Blank |
Leave Blank |
This column needs to remain in the mapping file & should not be used. |
Delete Flag
|
delete_flag |
To delete the impressions associated with the field_value, enter TRUE. Leave blank if you are not discarding impressions. |
TRUE |
If discarding, enter TRUE. If leaving values as they are, leave this blank. | If you map these out, you cannot un-map them. You would have to reach out to InnovidXP Support to pull impression back from the event log. |
Date From |
date_from |
Start date of the creative. |
Date |
YYYY-mm-dd, dd/mm/YYYY | |
Date To |
date_to |
End date of the creative. |
Date |
YYYY-mm-dd, dd/mm/YYYY | |
Ordinal To Rename From |
ordinal_to_rename_from |
Leave blank | Leave blank | Leave blank |
This column needs to be in the mapping file but will not be used.
|
Uploading your file
Pulling unmapped IDs
- Open the client-specific InnovidXP platform and navigate to the Analysis tab
- Adjust the date range to reflect the time period of impressions you want to update
- In the Rows drop-down, add your applicable metrics ( the different macros available in the pixel that is in use). Once these have been added, you will see the unmapped IDs for each macro available based on the impression pixel.
- Once loaded, the data will be visible in the UI, and you can download the data as a .csv by selecting the download icon.
- This data can be used to match with your mapping IDs provided by your internal AdOps.
Populating the impression mapping file
Existing advertisers: If this advertiser has already had impression mapping applied, you must use the most recent mapping file that you have. Ensure your file is cumulative, i.e., inclusive of all historical mappings. Start at point 1 below. Note: We recommend using ‘Save As’ each time you download a file with the most recent date in the file name, example: “AdvertiserABC_ mm/dd/yyyy”. New advertisers: If the advertiser is new, you must populate the Impression Mapping Template file located here. Note: There are 9 columns with specific headers within this file. The order or names of these must not be changed. Start at point 2 below. |
- Using the Mapping Values provided by your internal AdOps team, match these values to the IDs in the file.
Note: We recommend using spreadsheet functions like a vlookup to easily match IDs to Values without manual effort. - Type vod into the impression_type column.
- Use the macros below in the Impression Mapping Template in the impression_field column.
These might vary based on any custom naming used for the advertiser.
InnovidXP UI Naming InnovidXP Mapping File Naming campaign campaign creative creative placement group placementgroup targeting tactic/saleshouse network publisher publisher - Unmapped IDs, pulled from the InnovidXP Analysis section, must be added to the field_value column
- Add what the platform must reflect to the mapped_value column.
- Disregard the discard_flag column. You will not use it, but it should not be deleted.
- If you want to remove impressions associated with the field_value from the platform, “TRUE” must be entered into the delete_flag column. Leave the cell blank if you are not deleting impressions.
- Enter the start date (dd/mm/yyyy) of mapping in the date_from column.
- Enter the end date (dd/mm/yyyy) of mapping in the date_to column
- Once the file is updated with all the unmapped IDs and the mapped values, save the file.
Note: We recommend naming the file with the specific client name, such as “AdvertiserABC_ mm/dd/yyyy” to help identify the most recent file
Uploading your Mapping File
- In the InnovidXP platform, navigate to your client-specific platform and navigate to Data > Spots > Upload Bespoke File.
- Choose impressionmap as the upload type.
- Select the Choose File button and upload the most recent mappings file that you worked on.
A grey message box will indicate if the upload was successful. - When the file has been successfully processed and the platform has been updated, you will receive an email.
- Review the platform to ensure that the mappings have been applied
Reach out to InnovidXP Support with any questions