AdBook

The Switchboard AdBook connector provides automated ingestion of campaign and advertiser reports. The connector can be used to pull a daily report, or a report based on a custom date range.

Prerequisites
Scheduling
Report Types
- AdBook Daily Report
  - Switchboard Script Syntax
  - Parameters
- AdBook Custom Date Range Report
  - Switchboard Script Syntax
  - Parameters

Prerequisites

To configure access to the AdBook Connector, you need:

Your AdBook username and password
Hostname: The URL used to log-in to the AdBook API. For Example: adbook03.fattail.com

To obtain the AdBook username, contact your AdBook Account Manager.

NOTE

Use the same password that is used to login to the system. Switchboard recommends using a dedicated account.

Scheduling

The AdBook Connector can be scheduled to ingest data in one of the two ways:

Daily Schedule
- To configure this schedule, use the delay_hours parameter.
- By default, the connector will run once at 6am PT.
Hourly Schedule
- To configure this schedule, use the period_hours parameter.

Report Types

AdBook Daily Report - Use the import type adbook_ng
AdBook Custom Date Range Report - Use the import type adbook_ng:custom_date

AdBook Daily Report

Switchboard Script Syntax

import adbook_daily_report from {
   type: "adbook_ng";
   key: "adbook_key";
   host: "adbook03.fattail.com";
   include_cancelled_line_items: true;
   apply_exchange_rate_conversions: true;
   fields: [
       "(Campaign) Ad Server Campaign ID",
       "(Campaign) Advertising Rep Cost Centre",
       "(Campaign) Advertising Rep Finance Region",
       "(Campaign) Advertising Rep Name",
       "(Campaign) Agency ID",
       "(Campaign) Agency Name",
       "(Campaign) Booking Country",
       "(Campaign) Campaign Creation Date",
       "(Campaign) Campaign ID",
       "(Campaign) Campaign Name",
       "(Campaign) Client ID",
       "(Campaign) Client Name",
       "(Campaign) Contract Date",
       "(Campaign) CRM ID",
       "(Campaign) Currency Conversion",
       "(Campaign) Currency",
       "(Campaign) Delivery Date",
       "(Campaign) FT Ad Operations",
       "(Campaign) Invoicee Oracle ID",
       "(Campaign) IO Status",
       "(Campaign) Sector Code",
       "(Campaign) Sector",
       "(Drop) 3rd Party Ad Server Buffered Impressions",
       "(Drop) Ad Server Drop ID",
       "(Drop) Campaign Goals",
       "(Drop) Cancellation Status",
       "(Drop) Current Rate Card Name",
       "(Drop) DFP Inventory Size Type",
       "(Drop) Drop Creation Date",
       "(Drop) Drop ID",
       "(Drop) End Date",
       "(Drop) Exchange Rate",
       "(Drop) Impressions Sold",
       "(Drop) Line Item Name",
       "(Drop) Pay Type",
       "(Drop) Position ID",
       "(Drop) Position Path",
       "(Drop) Position Path Split",
       "(Drop) Price Type",
       "(Drop) Price",
       "(Drop) Priority",
       "(Drop) Sold Amount",
       "(Drop) Start Date",
       "(Position) Do Not Invoice From AdBook",
       "(Position) Finance Account Code",
       "(Position) Finance Account Name",
       "(Position) Finance Product Code",
       "(Position) Finance Product Name",
       "(Position) FT Media Type",
       "(Position) Measured On Time",
       "(Position) Position Analysis Code",
       "(Position) Position Analysis Name",
       "(Position) Position Cost Centre Code",
       "(Position) Position Cost Centre Name",
       "(Position) Product Group",
       "(Position) Revenue Stream",
       "(Position) Smart Match"
   ];
   } using {
       "Campaign_Ad Server Campaign ID": integer;
       "Campaign_Advertising Rep Cost Centre": string;
       "Campaign_Advertising Rep Finance Region": string;
       "Campaign_Advertising Rep Name": string;
       "Campaign_Agency ID": integer;
       "Campaign_Agency Name": string;
       "Campaign_Booking Country": string;
       "Campaign_Campaign Creation Date": date;
       "Campaign_Campaign ID": integer;
       "Campaign_Campaign Name": string;
       "Campaign_Client ID": integer;
       "Campaign_Client Name": string;
       "Campaign_Contract Date": date;
       "Campaign_CRM ID": string;
       "Campaign_Currency Conversion": boolean;
       "Campaign_Currency": string;
       "Campaign_Delivery Date": date;
       "Campaign_FT Ad Operations": string;
       "Campaign_Invoicee Oracle ID": integer;
       "Campaign_IO Status": string;
       "Campaign_Sector Code": string;
       "Campaign_Sector": string;
       "Drop_3rd Party Ad Server Buffered Impressions": integer;
       "Drop_Ad Server Drop ID": integer;
       "Drop_Campaign Goals": string;
       "Drop_Cancellation Status": string;
       "Drop_Creation Date": string;
       "Drop_Current Rate Card Name": string;
       "Drop_DFP Inventory Size Type": string;
       "Drop_Drop ID": integer;
       "Drop_End Date": date;
       "Drop_Exchange Rate": float;
       "Drop_Impressions Sold": integer;
       "Drop_Line Item Name": string;
       "Drop_Pay Type": string;
       "Drop_Position ID": integer;
       "Drop_Position Path": string;
       "Drop_Position Path 1": string;
       "Drop_Position Path 2": string;
       "Drop_Position Path 3": string;
       "Drop_Position Path 4": string;
       "Drop_Position Path 5": string;
       "Drop_Position Path 6": string;
       "Drop_Price Type": string;
       "Drop_Price": float;
       "Drop_Priority": string;
       "Drop_Sold Amount": float;
       "Drop_Start Date": date;
       "Position_Do Not Invoice From AdBook": string;
       "Position_Finance Account Code": string;
       "Position_Finance Account Name": string;
       "Position_Finance Product Code": string;
       "Position_Finance Product Name": string;
       "Position_FT Media Type": string;
       "Position_Measured On Time": boolean;
       "Position_Position Analysis Code": string;
       "Position_Position Analysis Name": string;
       "Position_Position Cost Centre Code": string;
       "Position_Position Cost Centre Name": string;
       "Position_Product Group": string;
       "Position_Revenue Stream": string;
       "Position_Smart Match": boolean;
   };

Parameters

Parameter	Description	Required/Optional?
metrics	A list of requested metrics: Atlas Clicks Atlas Impressions DFA Clicks DFA Impressions EyeWonder Clicks EyeWonder Impressions Flashtalking Clicks Flashtalking Impressions Innovid Clicks Innovid Impressions Interpolls Clicks Interpolls Impressions Medialets Clicks Medialets Impressions MediaMind Clicks MediaMind Impressions MediaPlex Clicks MediaPlex Impressions Mojo Clicks Mojo Impressions Pointroll Clicks Pointroll Impressions Unicast Clicks Unicast Impressions United Virtualities Clicks United Virtualities Impressions	Required
fields	A list of requested fields. Campaign_Ad Server Campaign ID Campaign_Advertising Rep Cost Centre Campaign_Advertising Rep Finance Region Campaign_Advertising Rep Name Campaign_Agency ID Campaign_Agency Name Campaign_Booking Country Campaign_Campaign Creation Date Campaign_Campaign ID Campaign_Campaign Name Campaign_Client ID Campaign_Client Name Campaign_Contract Date Campaign_CRM ID Campaign_Currency Conversion Campaign_Currency Campaign_Delivery Date Campaign_FT Ad Operations Campaign_Invoicee Oracle ID Campaign_IO Status Campaign_Sector Code Campaign_Sector Drop_3rd Party Ad Server Buffered Impressions Drop_Ad Server Drop ID Drop_Campaign Goals Drop_Cancellation Status Drop_Creation Date Drop_Current Rate Card Name Drop_DFP Inventory Size Type Drop_Drop ID Drop_End Date Drop_Exchange Rate (float) Drop_Impressions Sold Drop_Line Item Name Drop_Pay Type Drop_Position ID Drop_Position Path Drop_Position Path 1 Drop_Position Path 2 Drop_Position Path 3 Drop_Position Path 4 Drop_Position Path 5 Drop_Position Path 6 Drop_Price Type Drop_Price Drop_Priority Drop_Sold Amount Drop_Start Date Position_Do Not Invoice From AdBook Position_Finance Account Code Position_Finance Account Name Position_Finance Product Code Position_Finance Product Name Position_FT Media Type Position_Measured On Time Position_Position Analysis Code Position_Position Analysis Name Position_Position Cost Centre Code Position_Position Cost Centre Name Position_Product Group Position_Revenue Stream Position_Smart Match	Required
host	host: "adbook03.fattail.com";	At least one value is required.
filters	A list of requested filters: Client Publisher MediaType Media MediaElement OrderStatus SalesRep AccountManager	At least one value is required.
include_cancelled_line_items	Boolean Value For Example: include_cancelled_line_items: true	At least one value is required.
apply_exchange_rate_conversions	Boolean Value For Example: apply_exchange_rate_conversions: true	At least one value is required.
report_detail_mode	A list of requested report_detail_mode: ContentTargetingDelivery CreativeAssignmentDelivery Drop DropCreativeDelivery GeoTargetingDelivery Package PackageDetail Summary	At least one value is required.

AdBook Custom Date Range Report

Switchboard Script Syntax

import adbook_custom_date_range from {
   type: "adbook_ng:custom_date";
   key: "adbook_key";
   host: "adbook03.fattail.com";
   include_cancelled_line_items: true;
   apply_exchange_rate_conversions: true;
   start_date: "1/1/2018";
   end_date: "12/31/2099";
   fields: [
       "(Campaign) Ad Server Campaign ID",
       "(Campaign) Advertising Rep Cost Centre",
       "(Campaign) Advertising Rep Finance Region",
       "(Campaign) Advertising Rep Name",
       "(Campaign) Agency ID",
       "(Campaign) Agency Name",
       "(Campaign) Booking Country",
       "(Campaign) Campaign Creation Date",
       "(Campaign) Campaign ID",
       "(Campaign) Campaign Name",
       "(Campaign) Client ID",
       "(Campaign) Client Name",
       "(Campaign) Contract Date",
       "(Campaign) CRM ID",
       "(Campaign) Currency Conversion",
       "(Campaign) Currency",
       "(Campaign) Delivery Date",
       "(Campaign) FT Ad Operations",
       "(Campaign) Invoicee Oracle ID",
       "(Campaign) IO Status",
       "(Campaign) Sector Code",
       "(Campaign) Sector",
       "(Drop) 3rd Party Ad Server Buffered Impressions",
       "(Drop) Ad Server Drop ID",
       "(Drop) Campaign Goals",
       "(Drop) Cancellation Status",
       "(Drop) Current Rate Card Name",
       "(Drop) DFP Inventory Size Type",
       "(Drop) Drop Creation Date",
       "(Drop) Drop ID",
       "(Drop) End Date",
       "(Drop) Exchange Rate",
       "(Drop) Impressions Sold",
       "(Drop) Line Item Name",
       "(Drop) Pay Type",
       "(Drop) Position ID",
       "(Drop) Position Path",
       "(Drop) Position Path Split",
       "(Drop) Price Type",
       "(Drop) Price",
       "(Drop) Priority",
       "(Drop) Sold Amount",
       "(Drop) Start Date",
       "(Position) Do Not Invoice From AdBook",
       "(Position) Finance Account Code",
       "(Position) Finance Account Name",
       "(Position) Finance Product Code",
       "(Position) Finance Product Name",
       "(Position) FT Media Type",
       "(Position) Measured On Time",
       "(Position) Position Analysis Code",
       "(Position) Position Analysis Name",
       "(Position) Position Cost Centre Code",
       "(Position) Position Cost Centre Name",
       "(Position) Product Group",
       "(Position) Revenue Stream",
       "(Position) Smart Match"
   ];
   } using {
       "Campaign_Ad Server Campaign ID": integer;
       "Campaign_Advertising Rep Cost Centre": string;
       "Campaign_Advertising Rep Finance Region": string;
       "Campaign_Advertising Rep Name": string;
       "Campaign_Agency ID": integer;
       "Campaign_Agency Name": string;
       "Campaign_Booking Country": string;
       "Campaign_Campaign Creation Date": date;
       "Campaign_Campaign ID": integer;
       "Campaign_Campaign Name": string;
       "Campaign_Client ID": integer;
       "Campaign_Client Name": string;
       "Campaign_Contract Date": date;
       "Campaign_CRM ID": string;
       "Campaign_Currency Conversion": boolean;
       "Campaign_Currency": string;
       "Campaign_Delivery Date": date;
       "Campaign_FT Ad Operations": string;
       "Campaign_Invoicee Oracle ID": integer;
       "Campaign_IO Status": string;
       "Campaign_Sector Code": string;
       "Campaign_Sector": string;
       "Drop_3rd Party Ad Server Buffered Impressions": integer;
       "Drop_Ad Server Drop ID": integer;
       "Drop_Campaign Goals": string;
       "Drop_Cancellation Status": string;
       "Drop_Creation Date": string;
       "Drop_Current Rate Card Name": string;
       "Drop_DFP Inventory Size Type": string;
       "Drop_Drop ID": integer;
       "Drop_End Date": date;
       "Drop_Exchange Rate": float;
       "Drop_Impressions Sold": integer;
       "Drop_Line Item Name": string;
       "Drop_Pay Type": string;
       "Drop_Position ID": integer;
       "Drop_Position Path": string;
       "Drop_Position Path 1": string;
       "Drop_Position Path 2": string;
       "Drop_Position Path 3": string;
       "Drop_Position Path 4": string;
       "Drop_Position Path 5": string;
       "Drop_Position Path 6": string;
       "Drop_Price Type": string;
       "Drop_Price": float;
       "Drop_Priority": string;
       "Drop_Sold Amount": float;
       "Drop_Start Date": date;
       "Position_Do Not Invoice From AdBook": string;
       "Position_Finance Account Code": string;
       "Position_Finance Account Name": string;
       "Position_Finance Product Code": string;
       "Position_Finance Product Name": string;
       "Position_FT Media Type": string;
       "Position_Measured On Time": boolean;
       "Position_Position Analysis Code": string;
       "Position_Position Analysis Name": string;
       "Position_Position Cost Centre Code": string;
       "Position_Position Cost Centre Name": string;
       "Position_Product Group": string;
       "Position_Revenue Stream": string;
       "Position_Smart Match": boolean;
   };

Parameters

Parameter	Description	Required/Optional?
start_date	datetime	Required.
end_date	datetime	Required.
metrics	A list of requested metrics: Atlas Clicks Atlas Impressions DFA Clicks DFA Impressions EyeWonder Clicks EyeWonder Impressions Flashtalking Clicks Flashtalking Impressions Innovid Clicks Innovid Impressions Interpolls Clicks Interpolls Impressions Medialets Clicks Medialets Impressions MediaMind Clicks MediaMind Impressions MediaPlex Clicks MediaPlex Impressions Mojo Clicks Mojo Impressions Pointroll Clicks Pointroll Impressions Unicast Clicks Unicast Impressions United Virtualities Clicks United Virtualities Impressions	Required
fields	A list of requested fields. Campaign_Ad Server Campaign ID Campaign_Advertising Rep Cost Centre Campaign_Advertising Rep Finance Region Campaign_Advertising Rep Name Campaign_Agency ID Campaign_Agency Name Campaign_Booking Country Campaign_Campaign Creation Date Campaign_Campaign ID Campaign_Campaign Name Campaign_Client ID Campaign_Client Name Campaign_Contract Date Campaign_CRM ID Campaign_Currency Conversion Campaign_Currency Campaign_Delivery Date Campaign_FT Ad Operations Campaign_Invoicee Oracle ID Campaign_IO Status Campaign_Sector Code Campaign_Sector Drop_3rd Party Ad Server Buffered Impressions Drop_Ad Server Drop ID Drop_Campaign Goals Drop_Cancellation Status Drop_Creation Date Drop_Current Rate Card Name Drop_DFP Inventory Size Type Drop_Drop ID Drop_End Date Drop_Exchange Rate (float) Drop_Impressions Sold Drop_Line Item Name Drop_Pay Type Drop_Position ID Drop_Position Path Drop_Position Path 1 Drop_Position Path 2 Drop_Position Path 3 Drop_Position Path 4 Drop_Position Path 5 Drop_Position Path 6 Drop_Price Type Drop_Price Drop_Priority Drop_Sold Amount Drop_Start Date Position_Do Not Invoice From AdBook Position_Finance Account Code Position_Finance Account Name Position_Finance Product Code Position_Finance Product Name Position_FT Media Type Position_Measured On Time Position_Position Analysis Code Position_Position Analysis Name Position_Position Cost Centre Code Position_Position Cost Centre Name Position_Product Group Position_Revenue Stream Position_Smart Match	Required
report_date_pattern	datetime	At least one value is required.
host	host: "adbook03.fattail.com";	At least one value is required.
filters	A list of requested filters: Client Publisher MediaType Media MediaElement OrderStatus SalesRep AccountManager	At least one value is required.
include_cancelled_line_items	Boolean Value For Example: include_cancelled_line_items: true	At least one value is required.
apply_exchange_rate_conversions	Boolean Value For Example: apply_exchange_rate_conversions: true	At least one value is required.
report_detail_mode	A list of requested report_detail_mode: ContentTargetingDelivery CreativeAssignmentDelivery Drop DropCreativeDelivery GeoTargetingDelivery Package PackageDetail Summary	At least one value is required.