DFP Integration v2.1
29 Pages • 6,325 Words • PDF • 1.4 MB
Uploaded at 2021-09-24 15:55
This document was submitted by our user and they confirm that they have the consent to share it. Assuming that you are writer or own the copyright of this document, report to us by using this DMCA report button.
AdPoint DFP Integration
Prepared by Lineup Systems Limited
July 2017
DISCLAIMER: The information contained in or accompanying this document is intended for the use of the stated recipient only. It contains confidential, proprietary or legally privileged information. The recipient must not, directly or indirectly, use, disclose, distribute, print, or copy any part of this document.
Page 1/29
ADPOINT/DFP INTEGRATION DOCUMENT PURPOSE This document outlines the AdPoint online functionality in relation to the DFP Adserver integration. It details how AdPoint can be synchronized with DFP as well as how the inventory availability checks, Ad pushing and the impressions update functionality work. It will refer and link to additional specifications/enhancements that have been created over the period that AdPoint has been integrated to Google’s DoubleClick for Publishers. It will also document how AdPoint data entities (ad sizes, ad types, targeting criteria, etc.) are pushed to DFP along with detailed mappings. As a reference, the Google API is very well documented and maintained. Contact Neil Rigby for a DFP account to use, to gain access to non-public content. https://developers.google.com/doubleclick-publishers/docs/start
DIGITAL DASHBOARD OVERVIEW The Digital Dashboard is accessed from the Production tab and is one of the main access points for DFP related functionality. As AdPoint supports a number of different Adserver implementations, this page makes use of AdPoint’s Plugin architecture. This plugin architecture allows custom user interface components to be created and used from within the AdPoint interface. The purpose of the Digital Dashboard is to provide a front end User Interface to the API between AdPoint and DFP, for both the actions of pushing data to the Adserver, in the form of Orders and Ads and pulling data from the Adserver to synchronise configuration data within AdPoint. Access to the Digital Dashboard is user permission based and is classed as a report.
ACTIONS FORM This enables the user to export/print the search results, providing the ads are approved.
Page 2/29
rd
There is also the feature to imports a formatted CSV file with 3 party impressions for financial and delivery reconciliation. This was not an integration piece and the specification is found here https://jira.lineup.com/browse/ADPOINT-3242 / https://jira.lineup.com/browse/ADPOINT-2979. ADSERVER SERVICE FORM Advertiser Export – click on the 'Export' button below to export all advertisers from your Ad Server. The advertisers will be downloaded as a CSV file to your browser. Agencies Exports – click on the 'Export' button below to export all agencies from your Adserver. The agencies will be downloaded as a CSV file to your browser. Contacts Export – click on the 'Export' button below to export all contacts from your Ad Server. The contacts will be downloaded as a CSV file to your browser. Ad Types Import – click on the 'Import' button below to create the Ad Types in Adpoint that relate to DFP. Note, these would be the Online Ad Types, and the action simply creates these there isn’t actually an import via the API taking place. As such the Online Ad Types created are: BULK BUMPER CLICK_TRACKING HOUSE LEGACY_DFP NETWORK PRICE_PRIORITY SPONSORSHIP STANDARD Sites Import – This represents Level One Ad Units in DFP. Click on the 'Import' button below to import the Ad Units into AdPoint from the Adserver. You may filter Sites by using the ‘Site filter’ free text field and typing the name or part of the name of the Ad Unit. The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The drop down selection will enable you to choose the Network to bind the site to. There is also a check box that allows you to only import active sites (Ad Units). This is defaulted to ON. As this may take a long time (dependent on the number of Ad Units defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Zones Import - This represents Level Two, Three, Four and Five Ad Units in DFP. Click on the 'Import' button below to import the Ad Units into AdPoint from the Adserver. You may filter Zones by using the ‘Zone filter’ free text field and typing the name or part of the name of the Ad Unit.
Page 3/29
The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The Network drop down selection will enable you to choose the Network to bind the zones to. You can use the free text field for Sites to have predictive text filters the list of Sites in the box below, clicking on Add to include them in the box below this. There is also a check box that allows you to only import active zones (Ad Units). This is defaulted to ON. As this may take a long time (dependent on the number of Ad Units defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Audience Segments – The DFP adserver possesses many Audience Segment native to it. Click on the ‘Import’ button to import segments into AdPoint as Targeting Groups and their Items. There is also a check box that allows you to only import active Audience Segments. This is defaulted to OFF. As this may take a long time (dependent on the number of Audience Segments in DFP) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Custom Targeting Import – The ‘From Adserver’ function here will interrogate DFP and import all active Custom Criteria (keys and values) from the Adserver in AdPoint as Targeting Groups and their Items. AdPoint can also send Custom Criteria to the DFP Adserver. The CSV file will need to consist of the Targeting Group Name and the Targeting Group Key Values (Items). As this may take a long time (dependent on the number of Customer Criteria in DFP) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. DFP Geo-Targeting Import – click on the 'Import' button below to import locations into ad-point from your Ad Server. As this may take a few minutes you can chose to be notified by email when this operation has completed. You can choose to import Countries, Regions/States/Provinces and Cities from the Adserver. You can also use the Country filter field to select single countries as required. Use the ‘*’ for wildcards. Placements – This represents Placement targeting in DFP. Click on the 'Import' button below to import the Placements into AdPoint from the Adserver. You may filter Placements by using the filter free text field and typing the name or part of the name of the Placement. The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The drop down selection will enable you to choose the Network to bind the site to. As this may take a long time (dependent on the number of Placements defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Using this import creates a new Online Site called “Placement targeting” which contains Ad Units for each placement. Once utilised, you will be able to push ads that target these Ad Units (placements) and they will be pushed to DFP as Placements. The forecasting on the check availability plug-in will also forecast based on Placement targeting as well as Ad Unit targeting. Device Targeting – click on the 'Import' button below to import all the content related to Device Targeting from your Ad Server. This will fill the Device targeting plugin with all the operating system, browser, and
Page 4/29
handset targeting that DFP supports. As this may take a few minutes you can chose to be notified by email when this operation has completed. As this may take a long time you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. PUSH LIST SELECTION FORM This form enables the user to search for relevant orders to push to the Adserver. AdPoint tracks which Ads need to be pushed to DFP. Ads that get returned will be filtered by the search criteria set by the user in the selection form, these include:
Network
Effective date from
Effective date to
Start date from
Start date to
Order # (AdPoint ID)
Include/Exclude Pre-Booked and Blacklisted ads
Sales Package(s)
Sales Rep
Invoicing Office
Stopper/Filler/Barter ads
Pushable ads
Ad Status
Order Status
Ad Type
Billing option
Imp. Date range
SAVED SEARCHES Presuming the user makes several different types of search to produce approved ads for pushing, they can save the Search parameters for easy access later.
Page 5/29
PUSH LIST The push list selection form allows you to filter the push list and view a sub-set of it. Using the customise button you can alter the columns displayed in this grid. The “Selection” column contains a check-box. To push Ads to DFP check this box and click the “Push selected” button. This will push these Ads to the DFP adapter where they will be send to DFP and the DFP ID will be stored in the External ID field in AdPoint.
Generally, the ads that are excluded from the Push List still require Approval from the Approvals workflow, ensuring that unapproved ads cannot be sent to the Adserver to be sent live, if for example the customer’s Credit check has not been approved. However, there were workflows and systems settings and permissions that will allow ad to be pushed without all approvals being made and these are set in the related properties of AdPoint.
THE API (SEE MAPPING )
Page 6/29
CHECK AVAILABILITY (INVENTORY FORECASTS) Availability check, or show avails, are already an important part on any digital ad booking workflow. Typically, that acts as a guide to sales people and approval tools to operational people. Most are undertaken at the ad level but in some instances in larger Orders the option to run an availability check against all the ads at once is possible and managed by another plugin in Order Details. AD LEVEL CHECK AVAIL ABILITY When users want to make an Availability check from the Online Ad booking form, they can click the link “Check availability”. This will bring up a pre-populated form which behind the scenes will make a forecast call to DFP to query the available and matched inventory for the parameters selected on the ad booking form, in turn that is governed by the initial selection of Sales Package. The Contending Ads will also be populated by querying DFP and will be displayed on demand by clicking on the Load button, whereby the results are fetched again by interrogating DFP. Likewise, Contending Ads in AdPoint, that are not pushed yet, can be displayed on demand by clicking of the Load button in a similar fashion. ORDER LEVEL CHECK AVAILABILITY When users want to make an Availability check from the Order Details page, they can click the link “Run Report” button. This will bring up a pre-populated form which behind the scenes will make a forecast call to DFP to query the available and matched inventory for the parameters selected on the ad booking form, in turn that is governed by the initial selection of Sales Package. The Contending Ads will also be populated by querying DFP and will be displayed on demand by clicking on the Load button, whereby the results are fetched again by interrogating DFP. Likewise, Contending Ads in AdPoint, that are not pushed yet, can be displayed on demand by clicking of the Load button in a similar fashion.
Page 7/29
It should be noted here that the data is similar in layout (and identical in results) as you would see directly in DFP. Only the formatting is altered for AdPoint.
Page 8/29
ADSERVER SETTINGS PL UGIN
This plugin allows administrators to change various settings for the Adserver integration. It acts in part to manage the behaviour of various Customer Specific enhancements (Integration only) and enables others to option them or not. It is the mainstay of all CodeSpace built enhancements upon request by customers since the integration piece was first made. In December, 2016 the plugin consists of the following tabs and panels:
DFP (Note, I am ignoring the AdTech tab in this DFP centric document. You will find the details of this in the equivalent AdTech Integration document). o
Network
o
Teams
Material Settings o
Display Creative Rules
Page 9/29
Workflow o
Push Rules
o
Ad Statuses
o
Order Statuses
Inventory Reservation o
Inventory Reservation
o
Ad Statuses
Page 10/29
o
Pricing o
Email
CPA Settings
Integration o
Imports
o
Import History
o
Scheduling
Page 11/29
Other Settings o
Miscellaneous
Below is a list of all the settings and a description for what they do and how they work:
Setting
Tab/Panel
Integration Version
DFP/Network
Network Code API Version Push Pricing Rules
DFP/Network DFP/Network. DFP Network
Description Version of the Ad Server integration that is installed in this AdPoint instance The DFP network ID. The DFP API version used in the integration. Some customers utilise certain pricing rules that are managed by the integration for their own custom
Page 12/29
Ad Exchange web property code Ad Unit levels
DFP/Network
Use Adserver totals for impressions import
DFP/Network
Trafficker Role
DFP/Network
Sales Person Role
DFP/Network
Team Mode Predefined teams
DFP/Teams DFP/Teams
Team custom field name Display creative rules
DFP/Teams
AdPoint Network name
Workflow/Push rules
Match customers in the Adserver by
Workflow/Push rules
Push Priority
Workflow/Push rules
Push current time and start date
Workflow/Push rules
Push minimum quantity
Workflow/Push rules
Display creatives override Creative rotation override Push Basic Price as
Workflow/Push rules
DFP/Network
Material Settings
Workflow/Push rules Workflow/Push rules
requirement. Any custom rules will be listed here, for example News Australia and others work any booked discounts into the CPM of the pushed in DFP, hence CPM as Net (minus Discount %) to allow DFP to manage competing Ad Exchange ads to deliver more evenly against display ads The web property code to use when pushing Ad Exchange ads. The number of levels of ad units to import from DFP. Leave blank to import all levels. If set to ON, then the impression import will use Total impressions/clicks instead of Adserver impressions/clicks. This means it will include impressions from other Adservers, e.g. Ad Exchange. When new Traffickers are automatically created in DFP they will be created with this role. When new Sales people are automatically created in DFP they will be created with this role. Sets the mode to use for DFP teams. Enter a ; separated list of teams that will be used for every order that is pushed. If a value is set here, then the team name(s) will be set in the custom filed with this name in DFP. This will allow the user to create rules based on the selection of Online Product Type and the Display Creatives Mode. There is no limit on the amount that can be made. If one or more network is selected, then only ads that have been created in those networks in AdPoint can be pushed to DFP. If none are selected, then any network is allowed. This tells the API how to lookup advertisers in DFP when pushing ads. If set to name then the API will search for an advertiser with the same name as the customer in AdPoint, if one is not found then a new advertiser will be created in DFP. If set to “AdPoint customer id” then the API will lookup an advertiser in DFP that has the “external id” field in DFP set to the AdPoint ID of the customer. If one is not found, then the ad cannot be pushed. The other options are dynamic based on the External customer fields setup in the AdPoint settings page. These allow for matching of customers and advertisers based on another type of ID field (e.g. an external system ID). If set to “On” then ad priority will be pushed to DFP, otherwise ads will always be created in DFP with the default priority for their ad type. Setting this to ON will push the current date and time as a Start Date. Only works on lines with a Start Date in the past. If set to ON then the minimum quantity field in DFP will be set to the AdPoint quantity value if the online ad type is SPONSORSHIP, the pricing type is CPM and the sales package has the “Is CPMBuyout” flag set. Use this setting to apply the selected value as the “Display Creatives” setting for all line items that are pushed to DFP. Use this setting to apply the selected value as the “Creative rotation” setting for all line items that are pushed to DFP. If enabled, then the ad Basic Price field in AdPoint will get
Page 13/29
Value CPM Allow pushing cancelled ads
Workflow/Push rules
Ad statuses during push
Workflow/Ad Statuses
New status after ad is pushed
Workflow/Ad Statuses
Delivering ad status
Workflow/Ad Statuses
Completed ad status
Workflow/Ad Statuses
Order status before delivering
Workflow/ Order Statuses
Order status once delivering
Workflow/Order Statuses
Reservations Mode
Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Ad statuses Inventory Reservation/Ad statuses Inventory Reservation/Email
Expiry Override (hours) Release unplaced inventory (days) Exclude weekends from expiry period. Ad status after reservation expiry Ad status when not enough inventory Email specific addresses Email sales rep Email booking person CPA Impressions value CPA Rate Import site only
pushed to the Value CPM field in DFP. If enabled the integration will allow Cancelled ads to be pushed. Otherwise an error will be returned if a cancelled ad is pushed. If this is set to a status, then when an ad is pushed the system will change the status of the ad from this value to the status in the next setting. If this setting is not status or if the ad status does not match this setting value, then the status of the ad will not be changed after the ad is pushed. The status to change the ad to in AdPoint after it has been pushed successfully to DFP. The status change will only be triggered if the status of the ad before pushing was the value in the previous setting. The status of the ad once it has started delivering impressions. The status of the ad once it has completed. The integration will not change the ad status to this one but needs to know what it is so when impressions are imported and the ad is completed the status does not get changed back to the Delivering ad status. The Order status will only be changed to the delivering status if it is in the status when impressions start coming back from the Adserver for any ads in the order. The status of the order once AdPoint has begun to pull impressions back for any of the ads in the order from the Adserver. The setting sets which reservation mode to use.
Enter a value here to override the customer group expiry settings for all reservations. Only applicable to the “Based on customer groups Reservations mode”. If an ad has not changed status to an underlying Placed one, then inventory for it will be automatically released the configured number of days before it is due to start. If enabled, then reservation expiry dates that fall between Friday 1900 and Monday 0000 hours will be moved into the next week so they will never fall on a weekend. If this is set then an inventory reservation expires the ad status will be changed to this value. When a reservation fails due to insufficient inventory, the ad status will be changed to the configured selection.
Inventory Reservation/Email Inventory Reservation/Email Pricing/CPA Settings
Enter one of more email addresses (separated with a | character) who will have received all reservation related emails. If set to ON, then the sales rep for the order will be emailed with inventory related emails. If set to ON, then the booking person for the order will be emailed with inventory related emails. The number of impressions to use for CAP pricing.
Pricing/CPA Settings Integration/Imports
The rate to use for CPA pricing. If set to ON, then site level impressions and click data will
Page 14/29
stats Import site and zone stats
Integration/Imports
Import ad size stats
Integration/Imports
Import custom targeting stats
Integration/Imports
Campaign dashboard chart mode Match line items by
Integration/Imports
Custom Field Name
Integration/Imports
Data import period (days)
Integration/Scheduling
Import Schedule
Integration/Scheduling
Interval Import History
Integration/Scheduling Integration/Import History
High Impact INTR Values Clear ads suspended for invoicing hours
Other Settings/ Miscellaneous Other Settings/ Miscellaneous
Creative dimensions to use Alert Email recipients Self-service ad custom attribute Placeholder ad type
Other Settings/ Miscellaneous Other Settings/ Miscellaneous Other settings/ Miscellaneous Other Settings/ Miscellaneous
Integration/Imports
be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the site and zone level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the ad size level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the custom targeting level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. Cumulative will show the total impressions delivered up to and including each date. Daily will show only the impressions delivered each day. If set to “Line Item ID” then impressions will be allocated to ads in AdPoint that have a matching external ID. If set to “Custom Field ID” then impressions will be allocated to the AdPoint Ad ID that is entered in the custom field for this in DFP. The name of the custom field in DFP that is used to store the AdPoint Ad ID. The number of days prior to the current date to include for in the imports. This is to allow the import to pick up alterations in the Adserver based up black lists. Import impressions/clicks either at fixed intervals or at a specific time of the day. The interval to wait between each import. This is a listing of each scheduled import showing the Run Date, Name of the item, the status and what time it finished. Any error messages will be shown too. This is a pipe (|) separated list of values that signify an ad is High Impact for the sponsorship availability calendar. After quantity amounts, have been adjusted in the invoicing tool, once this configured number of hours has passed AdPoint will automatically reset the adjusted quantities to their current amounts. This sets whether to use Production or Billable dimensions when pushing creative sizes and sets to you adserver. A pipe (|) separated list of email addresses to send alert emails to. The custom ad attribute used to identify self-service ads in AdPoint. The Ad Type that is used to identify Placeholder ads.
Page 15/29
EXPLANATION OF ADPOI NT ONLINE DATA ENTITIES Rate Card Though Digital rate cards are rarely a set of pricing rules they do form an idea of how the pricing will be formed as part of the configuration. The requirements surrounding CPM, Sponsorships and remnant management will be exposed here used for configuration of price items, cost centres, accounting requirement, extras and discounts. Ad Types Are invariably bespoke to the business and will typically represent descriptive groups of ads, for example, Overlays, Rich Media, Expandable Executions, Takeovers, etc. Used in configuration and reporting. Ad Sizes Ad sizes are used in the pricing ad Ads (Line Items) and are linked to Sales Packages, Ad Units and Placements. AdPoint caters for standard single creative, variable multi sizes and master and companion ads. Ad sizes definition is a mandatory configuration point. Sites and Zones Sites and Zones map to DFP AD Units and are used within Sales Packages for targeting. Dependant on the Publisher’s configuration of DFP’s Ad Unit schema AdPoint will be configured to represent the content driven targeting of the sites and their channels across the Network. Ad Unit Mapping, and their part in the set-up of AdPoint Sales Packages and Pricing tends to be the single largest configuration point of integration – and on-going management. Additional Targeting Lists Any customised key value targeting used by the Publisher will be managed using DFP’s Custom Criteria. Consisting of groups and their items, examples will include page types, positional targeting and third party key targeting (audience and contextual). Workflow Maps Process illustration is useful in providing a guide to mapping incumbent workflows to the replacement, incoming new solution, usually enhancing the configuration requirements and priorities.
Page 16/29
ADPOINT TO DFP DATA MAPPINGS ORDER LEVEL MAPPINGS The following table describes the order level field mappings from Adpoint to DFP.
AdPoint UI Field
AdPoint BO
Order Name
OnlineAdDFPRecord.Order.Order.Name
Order ID (IO #)
OnlineAdDFPRecord.Order.Id
Order Starts On
OnlineAdDFPRecord.StartDateTime
Order Ends On
OnlineAdDFPRecord.EndDateTime
Customer
Google API Field
Google UI Field
Order.Name
Name (new Proposal)
Order. poNumber
PO Number
Order.startDateTime
Campaign Starts
This must be in the future
Order.endDateTime
Campaign Ends
This must be in the future and later than the start date
Order.advertiserId
Company
Advertisers that don’t already exist in DFP will be created via the CompanyService specifying CompanyType.ADVERTISER
OnlineAdDFPRecord.AdvertiserIdentifier Sales agent
Order.salespersonId
If sales agents don’t exist in DFP they are created using the UserService with RoleType.Salesperson
Order. traffickerId
If traffickers don’t exist in DFP they are created using the UserService with RoleType.Trafficker
OnlineAdDFPRecord. SalesAgents Primary trafficker Secondary trafficker
OnlineAdDFPRecord.PrimaryTraffickers OnlineAdDFPRecord.SecondaryTraffickers
Notes
Order. secondaryTraffickerIds
Page 17/29
AD LEVEL MAPPINGS The following table describes the ad level field mappings from Adpoint to DFP.
AdPoint UI Field
AdPoint BO
Google API Field
Google UI Field
Notes
Network
OnlineAdDFPRecord.Network.External ID
n/a
n/a
Ad Name
OnlineAdDFPRecord.OnlineAd.Name
lineItem.Name
Name
Ad Starts On
OnlineAdDFPRecord.StartDateTime
lineItem.startDateTime
Start Date
This must be in the future
Ad Ends On
OnlineAdDFPRecord.EndDateTime
lineItem.endDateTime
End Date
This must be in the future and later than the start date
n/a
n/a
lineItem.allowOverbook
This is defaulted to true
n/a
n/a
lineItem.reserveAtCreation
This will be set to true if the ad is being pushed as an inventory reservation (see reservations spec)
The configuration for the DFP adaptor determines which Network is connected to DFP. Only Ads belonging to that network will be pushed.
Sales package priority
OnlineAdDFPRecord.SalesPackagePrio rity
lineItem.priority
If this isn’t set then this is defaulted based on DFP settings for the lineItemType. See https://developers.google.com/doubleclickpublishers/docs/reference/v201302/LineItemService.LineItem# priority
Ref.#
OnlineAdDFPRecord.OnlineAd.AdPoint ID
lineItem.Externalid
The AdPoint Ad ID
External#
OnlineAdDFPRecord.OnlineAd.Externa lID
lineItem.id
This field stores the id for the lineitem, when pushing an ad if this value is set then this will be the id of the lineitem to update. If it is blank then a new lineitem will be created in DFP
Online Ad Type
OnlineAdDFPRecord.OnlineAdTypeNa me
lineItem.lineItemType
Type
eg. Standard, Sponsorship, AdSense etc.
Page 18/29
Placing Instructions
OnlineAdDFPRecord.PlacingInstruction
Specification
OnlineAdDFPRecord.CostType.Abbrea viation
lineItem.notes
lineItem.costType
Values in DFP are: CPM/CPC/CPD. AdPoint CPA basic prices will be mapped to CPD
n/a
CPL basic prices are used on NWL as CPD Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For Aus. dollars, $1 is 1,000,000 micros
Cost per Unit
OnlineDetailDFPRecord.BasicPrice
lineItem.costPerUnit.microA mount
Currency
OnlineDetailDFPRecord.CurrencyCodeI ntl
lineItem.costPerUnit.currenc yCode
Quantity
OnlineAdDFPRecord.ImpressionsOrder ed
lineItem.unitsBought
Quantity
Share of voice
OnlineAdDFPRecord. ShareOfVoiceTypeValue
lineItem.unitsBought
Quantity
Note: the same field is used in DFP for impression/click quantity and % goal for sponsorships ads
If cost type is CPC then this will be Clicks otherwise Impressions
Discounts are always pushed as LineItemDiscountType.ABSOLUTE_VALUE
Rate
n/a
n/a
lineItem.unitType
Quantity Impressio ns or Clicks
Discount
OnlineAdDFPRecord.PriceAmount OnlineAdDFPRecord.PriceTotal
lineItem.discount
Discount
Rotation
OnlineDetailDFPRecord.Rotation
lineItem.creativeRotationTyp e
Rotate Creatives
AdPoint Rotation
DFP Rotation
BestPerforming
CreativeRotationType.OPTIMIZED
NotSpecified
CreativeRotationType.EVEN
Page 19/29
Optimised
CreativeRotationType.OPTIMIZED
Random
CreativeRotationType.EVEN
Sequential
CreativeRotationType.SEQUENTIAL
Weighted
CreativeRotationType.EVEN
lineItem. deliveryRateType
Defaults to DeliveryRateType.EVENLY
OnlineDetailDFPRecord.EnvironmentT ype.ExternalID
lineItem.targetPlatform
Set to WEB or MOBILE based on EnvironmentType in AdPoint
Ad Size INTL Code
OnlineDetailDFPRecord.EnvironmentT ype.ExternalID
lineItem. environmentType
Set to EnvironmentType.VIDEO_PLAYER based on EnvironmentType in AdPoint, otherwise set to BROWSER
Width
OnlineDetailDFPRecord.Material[].Wid th
lineItem.creativePlaceholders [].Width
Target Ad Unit Size
Width of one or more materials are mapped to creativePlaceholders
Height
OnlineDetailDFPRecord.Material[].Hei ght
lineItem.creativePlaceholders [].Height
Target Ad Unit Size
Height of one or more materials are mapped to creativePlaceholders Defaults to CreativeSizeType.PIXEL.
lineItem.creativePlaceholders [].creativeSizeType
If creative is 0x0 dimensions we set this to CreativeSizeType.INTERSTITIAL Standard Single Format = ONLY_ONE
Online product type in AdSize
Standard Multi Format = ONE_OR_MORE lineItem. roadblockingType
Variable Multi Format = ONE_OR_MORE Master/Companion = CREATIVE_SET NOTE: roadblocking type cannot be set for VAST video ads
Online
lineItem.
Display
Set to the default of CompanionDeliveryOption.UNKNOWN
Page 20/29
product type in AdSize
companionDeliveryOption
companio ns
unless online product type is Master/Companion or VAST video then set to: VAST: CompanionDeliveryOption.OPTIONAL Master/Companion: CompanionDeliveryOption.ALL
Frequency caps
OnlineDetailDFPRecord.OnlineAdFreq uency
lineItem.frequencyCaps
Frequency caps
Allows for frequency capping of impression delivery (e.g. 1000 impressions per day, 10 impressions per hour)
Page 21/29
TARGETING LEVEL MAPPINGS The following table describes the targeting level field mappings from AdPoint to DFP.
AdPoint UI Field
AdPoint BO
Google API Field
Google UI Field
Notes AdPoint sites are top level ad units within DFP
Site
OnlineAdDFPRecord.BasicObjectZone.SiteExternalID
lineItem.targeting.inventoryTargeting.targetedAdUnits
Ad Unit
Note we default includeDescendants=true
AdPoint zones are ad units that sit directly underneath zones in DFP Zone
OnlineAdDFPRecord.BasicObjectZone.ExternalID
lineItem.targeting.inventoryTargeting.targetedAdUnits
Ad Unit
Ad Targeting Groups & Items
OnlineAdDFPRecord.KeyValues
lineItem.targeting.customTargeting
Custom Targeting
Key/Value pairs are converted into CustomCriteriaSets
Country
OnlineAdDFPRecord.Countries
lineItem.targeting.geoTargeting.targetedLocations
Geography (Country)
DFP entity: CountryLocation
State
OnlineAdDFPRecord.States
lineItem.targeting.geoTargeting.targetedLocations
Geography (Region)
DFP entity: RegionLocation
City
OnlineAdDFPRecord.Cities
lineItem.targeting.geoTargeting.targetedLocations
Geography (City)
DFP entity: CityLocation
Page 22/29
Note we default includeDescendants=true
Operating System
OnlineAdDFPRecord.OperatingSystem
lineItem.targeting.technologyTargeting.operatingSystemTa rgeting
Operating System
DFP entity: OperatingSystem
Browser
OnlineAdDFPRecord.Browser
lineItem.targeting.technologyTargeting.browserTargeting
Browser
DFP entity: Browser
Day of Week
OnlineAdDFPRecord.DaysOfWeek
lineItem.targeting.dayPartTargeting.dayParts
Day and Time
lineItem.targeting.dayPartTargeting.dayParts
Day and Time
Time of Day
OnlineAdDFPRecord.TimeOfDay
Page 23/29
Times of day are mapped into startTime and endTime properties of DFP entity: DayPart
IMPRESSION COUNT UPDATES On a configurable schedule we will update all Ads in Adpoint using the ReportService using the dimensions Dimension.LINE_ITEM_ID, Dimension.LINE_ITEM_NAME and Dimension.DATE.
Report field
AdPoint
Notes
Column.AD_SERVER_IMPRESSIONS
AdsOnline.ImpressionsActual in the database
AdPoint Ad is looked up via the lineItem.ID which is stored as an external ID in AdPoint
Column.AD_SERVER_CLICKS Column.AD_SERVER_CTR
Page 24/29
NEWS LIMITED ADSIZE CONFIGURATIONS To support the News Limited specific Avails Calendar as well as pushing VAST video Ads we need to make use of the INTL code field on the Ad Size definitions. The list needs to be configured to have: MI Code Name
MI Code
High Impact
HI
High Impact – VAST
VAHI
VAST
VA
Low Impact
LI
These properties must then be set appropriately against all the defined Ad Sizes.
Page 25/29
CONFIGURATION REFERENCE This is used as a tool to guide the configuration of AdPoint to meet the business’s immediate needs. It may also be used to track and record any issues that may surface through the data input.
Item
Description
Remarks
Networks
Likewise print ads, also online ads have a structure containing some edition, section, ad size and price list. The naming is just different. The Edition in Online ads world is called Network. Each Network contains several sites or at least one site which is identified with the network. Sub networks can be used with online ads in order to better specify the placement of an ad. The sub network is an additional attribute, which can be selected in the online ad form. Create the online Ad Sizes relevant to the sites or groups of sites in the Network. Each Ad Sizes will represent the width and height settings of the digital ad. You can build single standard ad sizes, as well as grouped multiples typically for sponsored takeovers where, for example, a Leaderboard, MPU and Skyscraper are combined. Sales Packages are combinations for Sites and Channels belonging to the Network. When integrated with an adserver these are representative of the tags that will have been created and added to the HTML/JS ad tags open the web page. Sales Package can be grouped and managed as necessary using Sales Package Groups. Manage your online sales package groups.
Configuration Point
N/A
Likely Irrelevant
Sale Channels (potentially)
Configuration Point
Target Ad Unit Size
Configuration Point
Inventory (inclusive of Placements and Ad Units)
Configuration Point
N/A
Configuration Point
N/A
Sub Networks
Ad Sizes
Sales Packages
Sales Package Groups Sales Package Groups Binding
Date Finalised
DoubleClick Equivalent
Page 26/29
Ad Types
Ad Statuses
Custom Ad Attributes
Bundles
Ad Types are ad attributes, which are used to indicate what type of sale the ad is. It is used in the reports for analyses of sales by ad types. Ad types are locally defined. Each office can define own set of ad types. There are four built-in statuses in Settings. These statuses are "Cancelled", "Confirmed", "Placed" and "Pre-booked". Ad status for a new proposal ad is always "New ad". When a proposal ad is imported to Ad, the status will change to "Confirmed" or "Pre-booked" according the traffic manager's decision. When an ad is published, the status should be change to "Placed". For example only ads having the status "Placed" are used for the report Sales results. If an ad should not be published but it is in the system already, the ad should be "Cancelled". It is possible to cancel an ad from ad form or multiply from Order Detail. Ad types can be defined in "Tools" "Settings". Custom ad attributes can be used in the Display ad form and in the Online ad form as an additional ad property by which users can filter ads in reports. The attributes are displayed in the box "Additional information". Bundles are used to monitor the cross sale ads in the Ad-Point system. By setting and using the bundle feature you can easily find out how many ads in individual edition were booked (sold) by local office and how many were booked (sold) by other office.
Configuration Point
Sales Channels (potentially) Otherwise, N/A
Configuration Point
Status
Configuration Point
N/A
Configuration Point
N/A
Page 27/29
Promotions and Projects
Promotions and Projects are used for entering campaigns running for a strictly specified period of time. When an ad is assigned to some promotion or a project, it can get a special discount for example. Ads belonging to the promotion or the project can also be filtered in several reports. List the sites for adserver targeting relevant to your business. List the zones/channels/sections belonging to Sites or groups of Sites, for adserver targeting relevant to your business. List the online ad type priorities for use in the trafficking of ads to the adserver. List the material types for use in trafficking of ads to the adserver. List the ad targeting groups for online ads relevant to your business.
Configuration Point
N/A
Configuration Point
These are top level Ad Units in DFP
Configuration Point
Zones are Ad Units which sit under top level Site Ad Units
Fixed list.
These can be pulled in via the Adserver API N/A
Ad Targeting Items
List the ad targeting items for online ads relevant to your business.
Configuration Point
Basic Prices
A basic price is a setting which defines Gross price of the ad. It is defined for the combination of edition, colour, section and ad size, based on which the basic price is offered when booking the ad. The Extras list entered from the "Price Settings" box shows the list of all existing extra price items used with all add patterns (print ads, classifieds, radio and online ads). It is possible to filter
Configuration Point
Online Sites
Online Zones
Online Ad Types Online Product Types Ad Targeting Groups
Extras
Fixed list.
Configuration Point
Configuration Point
These can be configured and pushed to the Adserver using the Digital Dashboard – Custom Targeting in DoubleClick These can be configured and pushed to the Adserver using the Digital Dashboard – Custom Targeting in DoubleClick Finance (inclusive of Currency, Billing Source, VAT, Pricing Source, Pricing Model and Budget)
Finance (inclusive of Currency, Agency Commissions, and Adjustments)
Page 28/29
Discounts
Price Items
the extras or enter a new one for any type of ad pattern. Via the button "Report - Price items" you can also open the Price items report, where you can filter both extras and discounts. The Discounts list entered from the "Price Settings" box shows the list of all existing discount price items used with all add patterns (print ads, classifieds, radio and online ads). It is possible to filter the discounts or enter a new one for any type of ad pattern. Via the button "Report - Price items" you can also open the Price items report, where you can filter both extras and discounts. Price items are extras or discounts applied on ads and ad quotes. One price item can be defined only for 1 ad pattern (Display/Print ads, Online ads, Radio ads and Classified ads). There can be several price items defined in settings but maximum of eight price items can be applied on an ad quote or an ad at once.
Configuration Point
Finance (inclusive of Currency, Agency Commissions, and Adjustments)
Configuration Point
Finance (inclusive of Currency, Billing Source, VAT, Pricing Source, Pricing Model, Agency Commissions, Budget and Adjustments
Page 29/29
Prepared by Lineup Systems Limited
July 2017
DISCLAIMER: The information contained in or accompanying this document is intended for the use of the stated recipient only. It contains confidential, proprietary or legally privileged information. The recipient must not, directly or indirectly, use, disclose, distribute, print, or copy any part of this document.
Page 1/29
ADPOINT/DFP INTEGRATION DOCUMENT PURPOSE This document outlines the AdPoint online functionality in relation to the DFP Adserver integration. It details how AdPoint can be synchronized with DFP as well as how the inventory availability checks, Ad pushing and the impressions update functionality work. It will refer and link to additional specifications/enhancements that have been created over the period that AdPoint has been integrated to Google’s DoubleClick for Publishers. It will also document how AdPoint data entities (ad sizes, ad types, targeting criteria, etc.) are pushed to DFP along with detailed mappings. As a reference, the Google API is very well documented and maintained. Contact Neil Rigby for a DFP account to use, to gain access to non-public content. https://developers.google.com/doubleclick-publishers/docs/start
DIGITAL DASHBOARD OVERVIEW The Digital Dashboard is accessed from the Production tab and is one of the main access points for DFP related functionality. As AdPoint supports a number of different Adserver implementations, this page makes use of AdPoint’s Plugin architecture. This plugin architecture allows custom user interface components to be created and used from within the AdPoint interface. The purpose of the Digital Dashboard is to provide a front end User Interface to the API between AdPoint and DFP, for both the actions of pushing data to the Adserver, in the form of Orders and Ads and pulling data from the Adserver to synchronise configuration data within AdPoint. Access to the Digital Dashboard is user permission based and is classed as a report.
ACTIONS FORM This enables the user to export/print the search results, providing the ads are approved.
Page 2/29
rd
There is also the feature to imports a formatted CSV file with 3 party impressions for financial and delivery reconciliation. This was not an integration piece and the specification is found here https://jira.lineup.com/browse/ADPOINT-3242 / https://jira.lineup.com/browse/ADPOINT-2979. ADSERVER SERVICE FORM Advertiser Export – click on the 'Export' button below to export all advertisers from your Ad Server. The advertisers will be downloaded as a CSV file to your browser. Agencies Exports – click on the 'Export' button below to export all agencies from your Adserver. The agencies will be downloaded as a CSV file to your browser. Contacts Export – click on the 'Export' button below to export all contacts from your Ad Server. The contacts will be downloaded as a CSV file to your browser. Ad Types Import – click on the 'Import' button below to create the Ad Types in Adpoint that relate to DFP. Note, these would be the Online Ad Types, and the action simply creates these there isn’t actually an import via the API taking place. As such the Online Ad Types created are: BULK BUMPER CLICK_TRACKING HOUSE LEGACY_DFP NETWORK PRICE_PRIORITY SPONSORSHIP STANDARD Sites Import – This represents Level One Ad Units in DFP. Click on the 'Import' button below to import the Ad Units into AdPoint from the Adserver. You may filter Sites by using the ‘Site filter’ free text field and typing the name or part of the name of the Ad Unit. The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The drop down selection will enable you to choose the Network to bind the site to. There is also a check box that allows you to only import active sites (Ad Units). This is defaulted to ON. As this may take a long time (dependent on the number of Ad Units defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Zones Import - This represents Level Two, Three, Four and Five Ad Units in DFP. Click on the 'Import' button below to import the Ad Units into AdPoint from the Adserver. You may filter Zones by using the ‘Zone filter’ free text field and typing the name or part of the name of the Ad Unit.
Page 3/29
The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The Network drop down selection will enable you to choose the Network to bind the zones to. You can use the free text field for Sites to have predictive text filters the list of Sites in the box below, clicking on Add to include them in the box below this. There is also a check box that allows you to only import active zones (Ad Units). This is defaulted to ON. As this may take a long time (dependent on the number of Ad Units defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Audience Segments – The DFP adserver possesses many Audience Segment native to it. Click on the ‘Import’ button to import segments into AdPoint as Targeting Groups and their Items. There is also a check box that allows you to only import active Audience Segments. This is defaulted to OFF. As this may take a long time (dependent on the number of Audience Segments in DFP) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Custom Targeting Import – The ‘From Adserver’ function here will interrogate DFP and import all active Custom Criteria (keys and values) from the Adserver in AdPoint as Targeting Groups and their Items. AdPoint can also send Custom Criteria to the DFP Adserver. The CSV file will need to consist of the Targeting Group Name and the Targeting Group Key Values (Items). As this may take a long time (dependent on the number of Customer Criteria in DFP) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. DFP Geo-Targeting Import – click on the 'Import' button below to import locations into ad-point from your Ad Server. As this may take a few minutes you can chose to be notified by email when this operation has completed. You can choose to import Countries, Regions/States/Provinces and Cities from the Adserver. You can also use the Country filter field to select single countries as required. Use the ‘*’ for wildcards. Placements – This represents Placement targeting in DFP. Click on the 'Import' button below to import the Placements into AdPoint from the Adserver. You may filter Placements by using the filter free text field and typing the name or part of the name of the Placement. The * character can be used as a wildcard in names. Multiple filters can be captured by separating values with a; character. Example: mywebsite*;otherwebsite*;specificwebsite.com. The drop down selection will enable you to choose the Network to bind the site to. As this may take a long time (dependent on the number of Placements defined) you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. Using this import creates a new Online Site called “Placement targeting” which contains Ad Units for each placement. Once utilised, you will be able to push ads that target these Ad Units (placements) and they will be pushed to DFP as Placements. The forecasting on the check availability plug-in will also forecast based on Placement targeting as well as Ad Unit targeting. Device Targeting – click on the 'Import' button below to import all the content related to Device Targeting from your Ad Server. This will fill the Device targeting plugin with all the operating system, browser, and
Page 4/29
handset targeting that DFP supports. As this may take a few minutes you can chose to be notified by email when this operation has completed. As this may take a long time you can choose to be notified by email when this operation has completed and the notification will be sent to the email address associated to the user account logged into AdPoint. PUSH LIST SELECTION FORM This form enables the user to search for relevant orders to push to the Adserver. AdPoint tracks which Ads need to be pushed to DFP. Ads that get returned will be filtered by the search criteria set by the user in the selection form, these include:
Network
Effective date from
Effective date to
Start date from
Start date to
Order # (AdPoint ID)
Include/Exclude Pre-Booked and Blacklisted ads
Sales Package(s)
Sales Rep
Invoicing Office
Stopper/Filler/Barter ads
Pushable ads
Ad Status
Order Status
Ad Type
Billing option
Imp. Date range
SAVED SEARCHES Presuming the user makes several different types of search to produce approved ads for pushing, they can save the Search parameters for easy access later.
Page 5/29
PUSH LIST The push list selection form allows you to filter the push list and view a sub-set of it. Using the customise button you can alter the columns displayed in this grid. The “Selection” column contains a check-box. To push Ads to DFP check this box and click the “Push selected” button. This will push these Ads to the DFP adapter where they will be send to DFP and the DFP ID will be stored in the External ID field in AdPoint.
Generally, the ads that are excluded from the Push List still require Approval from the Approvals workflow, ensuring that unapproved ads cannot be sent to the Adserver to be sent live, if for example the customer’s Credit check has not been approved. However, there were workflows and systems settings and permissions that will allow ad to be pushed without all approvals being made and these are set in the related properties of AdPoint.
THE API (SEE MAPPING )
Page 6/29
CHECK AVAILABILITY (INVENTORY FORECASTS) Availability check, or show avails, are already an important part on any digital ad booking workflow. Typically, that acts as a guide to sales people and approval tools to operational people. Most are undertaken at the ad level but in some instances in larger Orders the option to run an availability check against all the ads at once is possible and managed by another plugin in Order Details. AD LEVEL CHECK AVAIL ABILITY When users want to make an Availability check from the Online Ad booking form, they can click the link “Check availability”. This will bring up a pre-populated form which behind the scenes will make a forecast call to DFP to query the available and matched inventory for the parameters selected on the ad booking form, in turn that is governed by the initial selection of Sales Package. The Contending Ads will also be populated by querying DFP and will be displayed on demand by clicking on the Load button, whereby the results are fetched again by interrogating DFP. Likewise, Contending Ads in AdPoint, that are not pushed yet, can be displayed on demand by clicking of the Load button in a similar fashion. ORDER LEVEL CHECK AVAILABILITY When users want to make an Availability check from the Order Details page, they can click the link “Run Report” button. This will bring up a pre-populated form which behind the scenes will make a forecast call to DFP to query the available and matched inventory for the parameters selected on the ad booking form, in turn that is governed by the initial selection of Sales Package. The Contending Ads will also be populated by querying DFP and will be displayed on demand by clicking on the Load button, whereby the results are fetched again by interrogating DFP. Likewise, Contending Ads in AdPoint, that are not pushed yet, can be displayed on demand by clicking of the Load button in a similar fashion.
Page 7/29
It should be noted here that the data is similar in layout (and identical in results) as you would see directly in DFP. Only the formatting is altered for AdPoint.
Page 8/29
ADSERVER SETTINGS PL UGIN
This plugin allows administrators to change various settings for the Adserver integration. It acts in part to manage the behaviour of various Customer Specific enhancements (Integration only) and enables others to option them or not. It is the mainstay of all CodeSpace built enhancements upon request by customers since the integration piece was first made. In December, 2016 the plugin consists of the following tabs and panels:
DFP (Note, I am ignoring the AdTech tab in this DFP centric document. You will find the details of this in the equivalent AdTech Integration document). o
Network
o
Teams
Material Settings o
Display Creative Rules
Page 9/29
Workflow o
Push Rules
o
Ad Statuses
o
Order Statuses
Inventory Reservation o
Inventory Reservation
o
Ad Statuses
Page 10/29
o
Pricing o
CPA Settings
Integration o
Imports
o
Import History
o
Scheduling
Page 11/29
Other Settings o
Miscellaneous
Below is a list of all the settings and a description for what they do and how they work:
Setting
Tab/Panel
Integration Version
DFP/Network
Network Code API Version Push Pricing Rules
DFP/Network DFP/Network. DFP Network
Description Version of the Ad Server integration that is installed in this AdPoint instance The DFP network ID. The DFP API version used in the integration. Some customers utilise certain pricing rules that are managed by the integration for their own custom
Page 12/29
Ad Exchange web property code Ad Unit levels
DFP/Network
Use Adserver totals for impressions import
DFP/Network
Trafficker Role
DFP/Network
Sales Person Role
DFP/Network
Team Mode Predefined teams
DFP/Teams DFP/Teams
Team custom field name Display creative rules
DFP/Teams
AdPoint Network name
Workflow/Push rules
Match customers in the Adserver by
Workflow/Push rules
Push Priority
Workflow/Push rules
Push current time and start date
Workflow/Push rules
Push minimum quantity
Workflow/Push rules
Display creatives override Creative rotation override Push Basic Price as
Workflow/Push rules
DFP/Network
Material Settings
Workflow/Push rules Workflow/Push rules
requirement. Any custom rules will be listed here, for example News Australia and others work any booked discounts into the CPM of the pushed in DFP, hence CPM as Net (minus Discount %) to allow DFP to manage competing Ad Exchange ads to deliver more evenly against display ads The web property code to use when pushing Ad Exchange ads. The number of levels of ad units to import from DFP. Leave blank to import all levels. If set to ON, then the impression import will use Total impressions/clicks instead of Adserver impressions/clicks. This means it will include impressions from other Adservers, e.g. Ad Exchange. When new Traffickers are automatically created in DFP they will be created with this role. When new Sales people are automatically created in DFP they will be created with this role. Sets the mode to use for DFP teams. Enter a ; separated list of teams that will be used for every order that is pushed. If a value is set here, then the team name(s) will be set in the custom filed with this name in DFP. This will allow the user to create rules based on the selection of Online Product Type and the Display Creatives Mode. There is no limit on the amount that can be made. If one or more network is selected, then only ads that have been created in those networks in AdPoint can be pushed to DFP. If none are selected, then any network is allowed. This tells the API how to lookup advertisers in DFP when pushing ads. If set to name then the API will search for an advertiser with the same name as the customer in AdPoint, if one is not found then a new advertiser will be created in DFP. If set to “AdPoint customer id” then the API will lookup an advertiser in DFP that has the “external id” field in DFP set to the AdPoint ID of the customer. If one is not found, then the ad cannot be pushed. The other options are dynamic based on the External customer fields setup in the AdPoint settings page. These allow for matching of customers and advertisers based on another type of ID field (e.g. an external system ID). If set to “On” then ad priority will be pushed to DFP, otherwise ads will always be created in DFP with the default priority for their ad type. Setting this to ON will push the current date and time as a Start Date. Only works on lines with a Start Date in the past. If set to ON then the minimum quantity field in DFP will be set to the AdPoint quantity value if the online ad type is SPONSORSHIP, the pricing type is CPM and the sales package has the “Is CPMBuyout” flag set. Use this setting to apply the selected value as the “Display Creatives” setting for all line items that are pushed to DFP. Use this setting to apply the selected value as the “Creative rotation” setting for all line items that are pushed to DFP. If enabled, then the ad Basic Price field in AdPoint will get
Page 13/29
Value CPM Allow pushing cancelled ads
Workflow/Push rules
Ad statuses during push
Workflow/Ad Statuses
New status after ad is pushed
Workflow/Ad Statuses
Delivering ad status
Workflow/Ad Statuses
Completed ad status
Workflow/Ad Statuses
Order status before delivering
Workflow/ Order Statuses
Order status once delivering
Workflow/Order Statuses
Reservations Mode
Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Inventory Reservation Inventory Reservation/Ad statuses Inventory Reservation/Ad statuses Inventory Reservation/Email
Expiry Override (hours) Release unplaced inventory (days) Exclude weekends from expiry period. Ad status after reservation expiry Ad status when not enough inventory Email specific addresses Email sales rep Email booking person CPA Impressions value CPA Rate Import site only
pushed to the Value CPM field in DFP. If enabled the integration will allow Cancelled ads to be pushed. Otherwise an error will be returned if a cancelled ad is pushed. If this is set to a status, then when an ad is pushed the system will change the status of the ad from this value to the status in the next setting. If this setting is not status or if the ad status does not match this setting value, then the status of the ad will not be changed after the ad is pushed. The status to change the ad to in AdPoint after it has been pushed successfully to DFP. The status change will only be triggered if the status of the ad before pushing was the value in the previous setting. The status of the ad once it has started delivering impressions. The status of the ad once it has completed. The integration will not change the ad status to this one but needs to know what it is so when impressions are imported and the ad is completed the status does not get changed back to the Delivering ad status. The Order status will only be changed to the delivering status if it is in the status when impressions start coming back from the Adserver for any ads in the order. The status of the order once AdPoint has begun to pull impressions back for any of the ads in the order from the Adserver. The setting sets which reservation mode to use.
Enter a value here to override the customer group expiry settings for all reservations. Only applicable to the “Based on customer groups Reservations mode”. If an ad has not changed status to an underlying Placed one, then inventory for it will be automatically released the configured number of days before it is due to start. If enabled, then reservation expiry dates that fall between Friday 1900 and Monday 0000 hours will be moved into the next week so they will never fall on a weekend. If this is set then an inventory reservation expires the ad status will be changed to this value. When a reservation fails due to insufficient inventory, the ad status will be changed to the configured selection.
Inventory Reservation/Email Inventory Reservation/Email Pricing/CPA Settings
Enter one of more email addresses (separated with a | character) who will have received all reservation related emails. If set to ON, then the sales rep for the order will be emailed with inventory related emails. If set to ON, then the booking person for the order will be emailed with inventory related emails. The number of impressions to use for CAP pricing.
Pricing/CPA Settings Integration/Imports
The rate to use for CPA pricing. If set to ON, then site level impressions and click data will
Page 14/29
stats Import site and zone stats
Integration/Imports
Import ad size stats
Integration/Imports
Import custom targeting stats
Integration/Imports
Campaign dashboard chart mode Match line items by
Integration/Imports
Custom Field Name
Integration/Imports
Data import period (days)
Integration/Scheduling
Import Schedule
Integration/Scheduling
Interval Import History
Integration/Scheduling Integration/Import History
High Impact INTR Values Clear ads suspended for invoicing hours
Other Settings/ Miscellaneous Other Settings/ Miscellaneous
Creative dimensions to use Alert Email recipients Self-service ad custom attribute Placeholder ad type
Other Settings/ Miscellaneous Other Settings/ Miscellaneous Other settings/ Miscellaneous Other Settings/ Miscellaneous
Integration/Imports
be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the site and zone level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the ad size level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. If set to ON, then the custom targeting level impression and click data will be imported from DFP and displayed in the campaign dashboard plugins. Cumulative will show the total impressions delivered up to and including each date. Daily will show only the impressions delivered each day. If set to “Line Item ID” then impressions will be allocated to ads in AdPoint that have a matching external ID. If set to “Custom Field ID” then impressions will be allocated to the AdPoint Ad ID that is entered in the custom field for this in DFP. The name of the custom field in DFP that is used to store the AdPoint Ad ID. The number of days prior to the current date to include for in the imports. This is to allow the import to pick up alterations in the Adserver based up black lists. Import impressions/clicks either at fixed intervals or at a specific time of the day. The interval to wait between each import. This is a listing of each scheduled import showing the Run Date, Name of the item, the status and what time it finished. Any error messages will be shown too. This is a pipe (|) separated list of values that signify an ad is High Impact for the sponsorship availability calendar. After quantity amounts, have been adjusted in the invoicing tool, once this configured number of hours has passed AdPoint will automatically reset the adjusted quantities to their current amounts. This sets whether to use Production or Billable dimensions when pushing creative sizes and sets to you adserver. A pipe (|) separated list of email addresses to send alert emails to. The custom ad attribute used to identify self-service ads in AdPoint. The Ad Type that is used to identify Placeholder ads.
Page 15/29
EXPLANATION OF ADPOI NT ONLINE DATA ENTITIES Rate Card Though Digital rate cards are rarely a set of pricing rules they do form an idea of how the pricing will be formed as part of the configuration. The requirements surrounding CPM, Sponsorships and remnant management will be exposed here used for configuration of price items, cost centres, accounting requirement, extras and discounts. Ad Types Are invariably bespoke to the business and will typically represent descriptive groups of ads, for example, Overlays, Rich Media, Expandable Executions, Takeovers, etc. Used in configuration and reporting. Ad Sizes Ad sizes are used in the pricing ad Ads (Line Items) and are linked to Sales Packages, Ad Units and Placements. AdPoint caters for standard single creative, variable multi sizes and master and companion ads. Ad sizes definition is a mandatory configuration point. Sites and Zones Sites and Zones map to DFP AD Units and are used within Sales Packages for targeting. Dependant on the Publisher’s configuration of DFP’s Ad Unit schema AdPoint will be configured to represent the content driven targeting of the sites and their channels across the Network. Ad Unit Mapping, and their part in the set-up of AdPoint Sales Packages and Pricing tends to be the single largest configuration point of integration – and on-going management. Additional Targeting Lists Any customised key value targeting used by the Publisher will be managed using DFP’s Custom Criteria. Consisting of groups and their items, examples will include page types, positional targeting and third party key targeting (audience and contextual). Workflow Maps Process illustration is useful in providing a guide to mapping incumbent workflows to the replacement, incoming new solution, usually enhancing the configuration requirements and priorities.
Page 16/29
ADPOINT TO DFP DATA MAPPINGS ORDER LEVEL MAPPINGS The following table describes the order level field mappings from Adpoint to DFP.
AdPoint UI Field
AdPoint BO
Order Name
OnlineAdDFPRecord.Order.Order.Name
Order ID (IO #)
OnlineAdDFPRecord.Order.Id
Order Starts On
OnlineAdDFPRecord.StartDateTime
Order Ends On
OnlineAdDFPRecord.EndDateTime
Customer
Google API Field
Google UI Field
Order.Name
Name (new Proposal)
Order. poNumber
PO Number
Order.startDateTime
Campaign Starts
This must be in the future
Order.endDateTime
Campaign Ends
This must be in the future and later than the start date
Order.advertiserId
Company
Advertisers that don’t already exist in DFP will be created via the CompanyService specifying CompanyType.ADVERTISER
OnlineAdDFPRecord.AdvertiserIdentifier Sales agent
Order.salespersonId
If sales agents don’t exist in DFP they are created using the UserService with RoleType.Salesperson
Order. traffickerId
If traffickers don’t exist in DFP they are created using the UserService with RoleType.Trafficker
OnlineAdDFPRecord. SalesAgents Primary trafficker Secondary trafficker
OnlineAdDFPRecord.PrimaryTraffickers OnlineAdDFPRecord.SecondaryTraffickers
Notes
Order. secondaryTraffickerIds
Page 17/29
AD LEVEL MAPPINGS The following table describes the ad level field mappings from Adpoint to DFP.
AdPoint UI Field
AdPoint BO
Google API Field
Google UI Field
Notes
Network
OnlineAdDFPRecord.Network.External ID
n/a
n/a
Ad Name
OnlineAdDFPRecord.OnlineAd.Name
lineItem.Name
Name
Ad Starts On
OnlineAdDFPRecord.StartDateTime
lineItem.startDateTime
Start Date
This must be in the future
Ad Ends On
OnlineAdDFPRecord.EndDateTime
lineItem.endDateTime
End Date
This must be in the future and later than the start date
n/a
n/a
lineItem.allowOverbook
This is defaulted to true
n/a
n/a
lineItem.reserveAtCreation
This will be set to true if the ad is being pushed as an inventory reservation (see reservations spec)
The configuration for the DFP adaptor determines which Network is connected to DFP. Only Ads belonging to that network will be pushed.
Sales package priority
OnlineAdDFPRecord.SalesPackagePrio rity
lineItem.priority
If this isn’t set then this is defaulted based on DFP settings for the lineItemType. See https://developers.google.com/doubleclickpublishers/docs/reference/v201302/LineItemService.LineItem# priority
Ref.#
OnlineAdDFPRecord.OnlineAd.AdPoint ID
lineItem.Externalid
The AdPoint Ad ID
External#
OnlineAdDFPRecord.OnlineAd.Externa lID
lineItem.id
This field stores the id for the lineitem, when pushing an ad if this value is set then this will be the id of the lineitem to update. If it is blank then a new lineitem will be created in DFP
Online Ad Type
OnlineAdDFPRecord.OnlineAdTypeNa me
lineItem.lineItemType
Type
eg. Standard, Sponsorship, AdSense etc.
Page 18/29
Placing Instructions
OnlineAdDFPRecord.PlacingInstruction
Specification
OnlineAdDFPRecord.CostType.Abbrea viation
lineItem.notes
lineItem.costType
Values in DFP are: CPM/CPC/CPD. AdPoint CPA basic prices will be mapped to CPD
n/a
CPL basic prices are used on NWL as CPD Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For Aus. dollars, $1 is 1,000,000 micros
Cost per Unit
OnlineDetailDFPRecord.BasicPrice
lineItem.costPerUnit.microA mount
Currency
OnlineDetailDFPRecord.CurrencyCodeI ntl
lineItem.costPerUnit.currenc yCode
Quantity
OnlineAdDFPRecord.ImpressionsOrder ed
lineItem.unitsBought
Quantity
Share of voice
OnlineAdDFPRecord. ShareOfVoiceTypeValue
lineItem.unitsBought
Quantity
Note: the same field is used in DFP for impression/click quantity and % goal for sponsorships ads
If cost type is CPC then this will be Clicks otherwise Impressions
Discounts are always pushed as LineItemDiscountType.ABSOLUTE_VALUE
Rate
n/a
n/a
lineItem.unitType
Quantity Impressio ns or Clicks
Discount
OnlineAdDFPRecord.PriceAmount OnlineAdDFPRecord.PriceTotal
lineItem.discount
Discount
Rotation
OnlineDetailDFPRecord.Rotation
lineItem.creativeRotationTyp e
Rotate Creatives
AdPoint Rotation
DFP Rotation
BestPerforming
CreativeRotationType.OPTIMIZED
NotSpecified
CreativeRotationType.EVEN
Page 19/29
Optimised
CreativeRotationType.OPTIMIZED
Random
CreativeRotationType.EVEN
Sequential
CreativeRotationType.SEQUENTIAL
Weighted
CreativeRotationType.EVEN
lineItem. deliveryRateType
Defaults to DeliveryRateType.EVENLY
OnlineDetailDFPRecord.EnvironmentT ype.ExternalID
lineItem.targetPlatform
Set to WEB or MOBILE based on EnvironmentType in AdPoint
Ad Size INTL Code
OnlineDetailDFPRecord.EnvironmentT ype.ExternalID
lineItem. environmentType
Set to EnvironmentType.VIDEO_PLAYER based on EnvironmentType in AdPoint, otherwise set to BROWSER
Width
OnlineDetailDFPRecord.Material[].Wid th
lineItem.creativePlaceholders [].Width
Target Ad Unit Size
Width of one or more materials are mapped to creativePlaceholders
Height
OnlineDetailDFPRecord.Material[].Hei ght
lineItem.creativePlaceholders [].Height
Target Ad Unit Size
Height of one or more materials are mapped to creativePlaceholders Defaults to CreativeSizeType.PIXEL.
lineItem.creativePlaceholders [].creativeSizeType
If creative is 0x0 dimensions we set this to CreativeSizeType.INTERSTITIAL Standard Single Format = ONLY_ONE
Online product type in AdSize
Standard Multi Format = ONE_OR_MORE lineItem. roadblockingType
Variable Multi Format = ONE_OR_MORE Master/Companion = CREATIVE_SET NOTE: roadblocking type cannot be set for VAST video ads
Online
lineItem.
Display
Set to the default of CompanionDeliveryOption.UNKNOWN
Page 20/29
product type in AdSize
companionDeliveryOption
companio ns
unless online product type is Master/Companion or VAST video then set to: VAST: CompanionDeliveryOption.OPTIONAL Master/Companion: CompanionDeliveryOption.ALL
Frequency caps
OnlineDetailDFPRecord.OnlineAdFreq uency
lineItem.frequencyCaps
Frequency caps
Allows for frequency capping of impression delivery (e.g. 1000 impressions per day, 10 impressions per hour)
Page 21/29
TARGETING LEVEL MAPPINGS The following table describes the targeting level field mappings from AdPoint to DFP.
AdPoint UI Field
AdPoint BO
Google API Field
Google UI Field
Notes AdPoint sites are top level ad units within DFP
Site
OnlineAdDFPRecord.BasicObjectZone.SiteExternalID
lineItem.targeting.inventoryTargeting.targetedAdUnits
Ad Unit
Note we default includeDescendants=true
AdPoint zones are ad units that sit directly underneath zones in DFP Zone
OnlineAdDFPRecord.BasicObjectZone.ExternalID
lineItem.targeting.inventoryTargeting.targetedAdUnits
Ad Unit
Ad Targeting Groups & Items
OnlineAdDFPRecord.KeyValues
lineItem.targeting.customTargeting
Custom Targeting
Key/Value pairs are converted into CustomCriteriaSets
Country
OnlineAdDFPRecord.Countries
lineItem.targeting.geoTargeting.targetedLocations
Geography (Country)
DFP entity: CountryLocation
State
OnlineAdDFPRecord.States
lineItem.targeting.geoTargeting.targetedLocations
Geography (Region)
DFP entity: RegionLocation
City
OnlineAdDFPRecord.Cities
lineItem.targeting.geoTargeting.targetedLocations
Geography (City)
DFP entity: CityLocation
Page 22/29
Note we default includeDescendants=true
Operating System
OnlineAdDFPRecord.OperatingSystem
lineItem.targeting.technologyTargeting.operatingSystemTa rgeting
Operating System
DFP entity: OperatingSystem
Browser
OnlineAdDFPRecord.Browser
lineItem.targeting.technologyTargeting.browserTargeting
Browser
DFP entity: Browser
Day of Week
OnlineAdDFPRecord.DaysOfWeek
lineItem.targeting.dayPartTargeting.dayParts
Day and Time
lineItem.targeting.dayPartTargeting.dayParts
Day and Time
Time of Day
OnlineAdDFPRecord.TimeOfDay
Page 23/29
Times of day are mapped into startTime and endTime properties of DFP entity: DayPart
IMPRESSION COUNT UPDATES On a configurable schedule we will update all Ads in Adpoint using the ReportService using the dimensions Dimension.LINE_ITEM_ID, Dimension.LINE_ITEM_NAME and Dimension.DATE.
Report field
AdPoint
Notes
Column.AD_SERVER_IMPRESSIONS
AdsOnline.ImpressionsActual in the database
AdPoint Ad is looked up via the lineItem.ID which is stored as an external ID in AdPoint
Column.AD_SERVER_CLICKS Column.AD_SERVER_CTR
Page 24/29
NEWS LIMITED ADSIZE CONFIGURATIONS To support the News Limited specific Avails Calendar as well as pushing VAST video Ads we need to make use of the INTL code field on the Ad Size definitions. The list needs to be configured to have: MI Code Name
MI Code
High Impact
HI
High Impact – VAST
VAHI
VAST
VA
Low Impact
LI
These properties must then be set appropriately against all the defined Ad Sizes.
Page 25/29
CONFIGURATION REFERENCE This is used as a tool to guide the configuration of AdPoint to meet the business’s immediate needs. It may also be used to track and record any issues that may surface through the data input.
Item
Description
Remarks
Networks
Likewise print ads, also online ads have a structure containing some edition, section, ad size and price list. The naming is just different. The Edition in Online ads world is called Network. Each Network contains several sites or at least one site which is identified with the network. Sub networks can be used with online ads in order to better specify the placement of an ad. The sub network is an additional attribute, which can be selected in the online ad form. Create the online Ad Sizes relevant to the sites or groups of sites in the Network. Each Ad Sizes will represent the width and height settings of the digital ad. You can build single standard ad sizes, as well as grouped multiples typically for sponsored takeovers where, for example, a Leaderboard, MPU and Skyscraper are combined. Sales Packages are combinations for Sites and Channels belonging to the Network. When integrated with an adserver these are representative of the tags that will have been created and added to the HTML/JS ad tags open the web page. Sales Package can be grouped and managed as necessary using Sales Package Groups. Manage your online sales package groups.
Configuration Point
N/A
Likely Irrelevant
Sale Channels (potentially)
Configuration Point
Target Ad Unit Size
Configuration Point
Inventory (inclusive of Placements and Ad Units)
Configuration Point
N/A
Configuration Point
N/A
Sub Networks
Ad Sizes
Sales Packages
Sales Package Groups Sales Package Groups Binding
Date Finalised
DoubleClick Equivalent
Page 26/29
Ad Types
Ad Statuses
Custom Ad Attributes
Bundles
Ad Types are ad attributes, which are used to indicate what type of sale the ad is. It is used in the reports for analyses of sales by ad types. Ad types are locally defined. Each office can define own set of ad types. There are four built-in statuses in Settings. These statuses are "Cancelled", "Confirmed", "Placed" and "Pre-booked". Ad status for a new proposal ad is always "New ad". When a proposal ad is imported to Ad, the status will change to "Confirmed" or "Pre-booked" according the traffic manager's decision. When an ad is published, the status should be change to "Placed". For example only ads having the status "Placed" are used for the report Sales results. If an ad should not be published but it is in the system already, the ad should be "Cancelled". It is possible to cancel an ad from ad form or multiply from Order Detail. Ad types can be defined in "Tools" "Settings". Custom ad attributes can be used in the Display ad form and in the Online ad form as an additional ad property by which users can filter ads in reports. The attributes are displayed in the box "Additional information". Bundles are used to monitor the cross sale ads in the Ad-Point system. By setting and using the bundle feature you can easily find out how many ads in individual edition were booked (sold) by local office and how many were booked (sold) by other office.
Configuration Point
Sales Channels (potentially) Otherwise, N/A
Configuration Point
Status
Configuration Point
N/A
Configuration Point
N/A
Page 27/29
Promotions and Projects
Promotions and Projects are used for entering campaigns running for a strictly specified period of time. When an ad is assigned to some promotion or a project, it can get a special discount for example. Ads belonging to the promotion or the project can also be filtered in several reports. List the sites for adserver targeting relevant to your business. List the zones/channels/sections belonging to Sites or groups of Sites, for adserver targeting relevant to your business. List the online ad type priorities for use in the trafficking of ads to the adserver. List the material types for use in trafficking of ads to the adserver. List the ad targeting groups for online ads relevant to your business.
Configuration Point
N/A
Configuration Point
These are top level Ad Units in DFP
Configuration Point
Zones are Ad Units which sit under top level Site Ad Units
Fixed list.
These can be pulled in via the Adserver API N/A
Ad Targeting Items
List the ad targeting items for online ads relevant to your business.
Configuration Point
Basic Prices
A basic price is a setting which defines Gross price of the ad. It is defined for the combination of edition, colour, section and ad size, based on which the basic price is offered when booking the ad. The Extras list entered from the "Price Settings" box shows the list of all existing extra price items used with all add patterns (print ads, classifieds, radio and online ads). It is possible to filter
Configuration Point
Online Sites
Online Zones
Online Ad Types Online Product Types Ad Targeting Groups
Extras
Fixed list.
Configuration Point
Configuration Point
These can be configured and pushed to the Adserver using the Digital Dashboard – Custom Targeting in DoubleClick These can be configured and pushed to the Adserver using the Digital Dashboard – Custom Targeting in DoubleClick Finance (inclusive of Currency, Billing Source, VAT, Pricing Source, Pricing Model and Budget)
Finance (inclusive of Currency, Agency Commissions, and Adjustments)
Page 28/29
Discounts
Price Items
the extras or enter a new one for any type of ad pattern. Via the button "Report - Price items" you can also open the Price items report, where you can filter both extras and discounts. The Discounts list entered from the "Price Settings" box shows the list of all existing discount price items used with all add patterns (print ads, classifieds, radio and online ads). It is possible to filter the discounts or enter a new one for any type of ad pattern. Via the button "Report - Price items" you can also open the Price items report, where you can filter both extras and discounts. Price items are extras or discounts applied on ads and ad quotes. One price item can be defined only for 1 ad pattern (Display/Print ads, Online ads, Radio ads and Classified ads). There can be several price items defined in settings but maximum of eight price items can be applied on an ad quote or an ad at once.
Configuration Point
Finance (inclusive of Currency, Agency Commissions, and Adjustments)
Configuration Point
Finance (inclusive of Currency, Billing Source, VAT, Pricing Source, Pricing Model, Agency Commissions, Budget and Adjustments
Page 29/29
Related documents
DFP Integration v2.1
29 Pages • 6,325 Words • PDF • 1.4 MB
sol de medianoche completo DFP
448 Pages • 139,470 Words • PDF • 1.2 MB