Importing FreeWheel Features: Inventory, Geo Data, Platform Targeting, Key Values, Industries, and Brands
- 1 1. Import Inventory
- 1.1 1.1 AdServer IDs
- 1.2 1.2 Manually import Geo Data
- 1.2.1 Example 1 - Type Country
- 1.2.2 Example 2 - State
- 1.2.3 Example 3 - City
- 1.3 1.3 Manually import Platform Targeting
- 1.4 1.4 Import Key Values / Audience Segments
- 1.5 1.5 Import Industries
- 1.6 1.6 Import Brands
- 1.7 1.7 Enhanced Video Import
- 1.8 1.8 Parallel Processes to Check Availability
1. Import Inventory
1.1 AdServer IDs
Please check and if needed add the following values to your AdServer ID Object and field "Type" ADvendio__Type__c picklist before importing AdServer Ids:
Video Group
Series
and make sure it is added to the record type Freewheel to ensure that Video related types will be imported to Category Video.
1.2 Manually import Geo Data
Unfortunately, FreeWheel does not offer the export of geo-targeting data in their API. But this doesn't mean that you can't use Geo Targeting. Those values don't change too often therefore it is worth doing a manual import.
Follow the three steps:
1. Download the data here https://hub.freewheel.tv/display/techdocs/Geography+Data.
2. Make a selection of which data you need - delete data which you don't use
3. Import via Dataloader or equal into the Object AdServer ID. Make sure that the following fields are mapped:
Record Type: FreeWheel
AdServer ID Name = Description or other
AdServer Login: Enter the reference to your AdServer Login
AdServer ID = FreeWheel ID
AdServer Name = Description
Type:
Country
Region
City
DMA
Postal Code
Category: Geography
Active: TRUE - if you using this feature: 3.1.9 Active and inactive inventory items
Parent Id: Enter the reference to the parent:
Country - no parent
State - Country
City - State
Postal Code - Country
DMA - Country
Example 1 - Type Country
Example 2 - State
Example 3 - City
1.3 Manually import Platform Targeting
To import Platform Targeting data into your Org please follow these steps:
Contact Freewheel Support and ask for the Platform Targeting/ISP Targeting data or download it from here.
They will provide you with a CSV file with the data.
After receiving the file please add the following columns to fit your needs:
Copy the Name Column with its values as you will need to map them twice.
Category: Devices,
(optional) If you would like to use a hierarchy within your Targeting values (e.g. Internet Explorer as a parent for Internet Explorer 6, Internet Explorer 7, Internet Explorer 8...) you may update the child values after your first import with a parent ID. Therefore you will need to add a Parent column to your spreadsheet and get the parent IDs from the first Insert to let Dataloader update the correct values.
Create a column with the Freewheel AdServer Login ID in which you would like to sort your targeting values.
Create a column with the Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type).
(optional) If you work with Activated values (3.1.9 Active and inactive inventory items) please create a column Active which you set to true for active and false for inactive values.
After this, you can import the data as AdServer IDs into your ADvendio Org like shown in the Screenshot below (e.g. with Dataloader.io).
→ Make sure that you map the following fields:
Source (your table) | Salesforce field |
---|---|
Platform ID | AdServer ID |
Name1 | AdServer Name |
Name | AdServer ID Name |
Type | Type* |
Category | Category |
Parent | Parent AdServer Id |
AdServer Login | AdServer Login |
Record Type Id | Record Type ID |
Active | Active |
* Please replace type "OS" with "Operating System"
ISP Targeting & Platform Packages
ISP Targeting and Platform Packages are currently not supported by the FreeWheel API, thus can't be pushed from ADvendio to Freewheel.
1.4 Import Key Values / Audience Segments
To import Key Values / Audience Segments please follow these steps:
Contact Freewheel Support and ask for Key Value/Audience Segments data.
They will provide you with a CSV file containing the data.
After receiving the file please import the data into your ADvendio Org (e.g. with Dataloader).
Keys and Values should be imported as AdServer IDs of type key and value. Make sure to import the keys first and then the values as children of the keys. See the field mapping below.
For Audience Segments, please create at least one AdServer ID of the type Audience Segment manually (see example below). Then use this as a parent for your actual Audience Segments, see the field mapping below.
1.4.1 Key AdServer ID
Record Type: Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type)
AdServer ID Name = Description or other
AdServer Login: Enter the ID from the according AdServer Login
AdServer ID = FreeWheel ID
AdServer Name = Description
Type: Key
Category: Key-Values
Active: True
1.4.2 Value AdServer ID
Record Type: Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type)
AdServer ID Name = Description or other
AdServer Login: Enter the ID from the according AdServer Login
AdServer ID = FreeWheel ID
AdServer Name = Description
Type: Value
Category: Key-Values
Active: True
→ Parent Id: Enter the reference to the key AdServer ID
1.4.3 Manually Create Parent Audience Segment:
This is an example of how the manually created parent Audience Segment could look like. As this is only used to structure your data. You are free to name it whatever you like. We recommend using a generic name like "Audience Segment" to keep it simple. This record will be used to group the Audience Segments to display them on the quote and invoice PDF.
Record Type: Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type)
AdServer ID Name = Audience Segment
AdServer Login: Enter the ID from the according AdServer Login
AdServer ID = not needed
AdServer Name = Audience Segment
Type: Audience Segment
Category: Audience Segments
Active: True
1.4.4 Audience Segment AdServer IDs
for the Audience Segments from Freewheel, please map your table as follows:
Record Type: Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type)
AdServer ID Name = Description or other
AdServer Login: Enter the ID from the according AdServer Login
AdServer ID = FreeWheel ID
AdServer Name = Description
Type: Audience Segment Value
Category: Audience Segments
Parent Id: Enter the reference to the Audience Segment AdServer ID created before.
Active: True
Consistent Data
It is recommended to import a column Unique Key for new Keys and Values with the following format: {Name of according AD ServerLogin|AdServer ID } → Example: {ASL-47052|1521}. You can use a custom format as well.
This will help you to keep your data consistent.
1.5 Import Industries
There are two ways for importing industries for your FreeWheel AdServer Login. The first one is to import the MRM industries without a hierarchy.
The second way is importing the MRM Industries in the hierarchy to the groups as you can find it in the FreeWheel UI. Please take note that in ADvendio the industries can only be connected to one parent Ad Server Id (group) at most.
1.5.1 Import Industries without Hierarchy
Search for the file "Public_Industry_ID.csv" in the FreeWheel documentation and download it (Link to documentation: https://hub.freewheel.tv/display/MUG).
Import the file into your spreadsheet program of choice.
Create new columns and add information according to the following information. Please divide between Industry Groups and MRM Industries by the Type column in the file.
MRM Industry AdServer ID
Column on spreadsheet | Value |
---|---|
Active | True |
AdServer ID Name | (Enter the name of the MRM Industry) |
AdServer Login | (Enter the ID from the according AdServer Login) |
AdServer ID | (Enter the ID from FreeWheel) |
AdServer Name | (Enter the name of the MRM Industry) |
Record Type ID | (Enter the Freewheel Record Type ID in the AdServer ID object in ADvendio. Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type) |
Category | Industry |
Type | Industry |
Industry Group AdServer ID
Column on spreadsheet | Value |
---|---|
Active | True |
AdServer ID Name | (Enter the name of the Industry Group) |
AdServer Login | (Enter the ID from the according AdServer Login) |
AdServer ID | (Enter the ID from FreeWheel) |
AdServer Name | (Enter the name of the Industry Group) |
Record Type ID | (Enter the Freewheel Record Type ID in the AdServer ID object in ADvendio. Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type) |
Category | Industry |
Type | Industry Group |
4. Import the new values into the object ADvendio__AdServer_ID__c by using an import tool like the Salesforce data loader. Ensure to map all the columns to the right fields from ADvendio.
5. Congratulations! Your imported industries are ready to be transferred to FreeWheel now.
To use industries in your campaigns please take a look at these two articles: 4.2.5.3 Industry (FreeWheel) and 4.2.12 Advertised Brands and Industries (FreeWheel).
1.5.2 Import Industries with Hierarchy
Search for the file "Public_Industry_ID.csv" in the FreeWheel documentation and download it (link to the documentation: https://hub.freewheel.tv/display/MUG).
Import the file into your spreadsheet program of choice.
Delete all lines with the Type "MRM Industry".
Create new columns and add information according to the table below.
Industry Group AdServer ID
Column on spreadsheet | Value |
---|---|
Active | True |
AdServer ID Name | (Enter the name of the Industry Group) |
AdServer Login | (Enter the ID from the according AdServer Login) |
AdServer ID | (Enter the ID from FreeWheel) |
AdServer Name | (Enter the name of the Industry Group) |
Record Type ID | (Enter the Freewheel Record Type ID in the AdServer ID object in ADvendio. Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type) |
Category | Industry |
Type | Industry Group |
5. Import the new values into the object ADvendio__AdServer_ID__c by using an import tool like the Salesforce data loader. Ensure to map all the columns to the right fields from ADvendio.
6. Look for a second file called "MRM to IAB mappings.xls" at the bottom of this page in the FreeWheel documentation.
7. Import the file into your spreadsheet program of choice and open the second sheet called "MRM to IAB mappings".
8. Create new columns and add information according to the table below.
MRM Industry AdServer ID
Column on spreadsheet | Value |
---|---|
Active | True |
AdServer ID Name | (Enter the name of the MRM Industry) |
AdServer Login | (Enter the ID from the according AdServer Login) |
AdServer ID | (Enter the ID from FreeWheel) |
AdServer Name | (Enter the name of the MRM Industry) |
Record Type ID | (Enter the Freewheel Record Type ID in the AdServer ID object in ADvendio. Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type) |
Category | Industry |
Type | Industry |
Parent AdServer ID | (Map the according Industry Group from the list which you imported first. |
9. Import the new values into the object ADvendio__AdServer_ID__c by using an import tool like the Salesforce dataloader. Ensure to map all the columns to the right fields from ADvendio.
10. Congratulations! Your imported industries are ready to be transferred to FreeWheel now. To use industries in your campaigns please take a look at these two articles: 4.2.5.3 Industry (FreeWheel) and 4.2.12 Advertised Brands and Industries (FreeWheel).
1.6 Import Brands
To import Brands please follow these steps:
Contact FreeWheel Support and provide your network ID to get a CSV file of your brands.
Afterwards please import the data into your ADvendio Org (e.g. with Dataloader).
Please add the following columns to your spreadsheet and import the new values into the object ADvendio__AdServer_ID__c.
Brand AdServer ID
Active: True
AdServer ID Name = FreeWheel name
AdServer Login: Enter the ID from the according AdServer Login
AdServer ID = FreeWheel ID
AdServer Name = FreeWheel name
Category: Brand
Type: Brand
Record Type ID: Freewheel Record Type ID in the AdServer ID object (Here you will find further instructions to find the ID: Salesforce - Find the ID of a record type)
1.7 Enhanced Video Import
Version | 2.120 and up |
---|---|
Supported Adservers | Freewheel |
If you wanted to import all video data from Freewheel, you will need to transfer lots of records. If during this long process, an error occurred, in the past the whole import aborted and needed to be started again. We improved our process to save data in between and start again where the last process ended.
Additionally, this gives you also the opportunity to manually control which videos are imported from Freewheel. There is a new field Ad Server Jobs Information, which stores the date at which the last video transferred was updated. If you haven't used the new import yet, the field remains empty.
If you want to manually enter a value please use the following syntax:
{"Video":{"lastUpdateAt":"2020-01-15T18:00:00Z.."}}
With this example, you will import all videos that have been updated after the 15th of January 2020. This way only the most recent videos are transferred to ADvendio.
1.8 Parallel Processes to Check Availability
From Version 2.95 on we will support parallel processing for "Check Availability".
Please ensure that your API user has the possibility to use up to 20 Requests per second as described here: https://hub.freewheel.tv/display/techdocs/API+Rate+Limitations+FAQs