AdRoll ON THIS PAGE
AdRoll is an ecommerce marketing platform that gives growing D2C brands the power to connect with customers wherever they are.
AdRoll integration replicates data using the NextRoll API .
See the
Schema section for a list of objects available for replication.
Feature snapshot
A high-level look at this connector, including useful links, and supported features.
Preparing for authentication To access your data, you need to authenticate the connection with your account credentials.
Information note Make sure that the account you use has read access to the tables you want to fetch.
To generate your client ID and secret:
Log into your AdRoll account. Click your user email in the upper-right corner, then click Apps . Select New Apps to start registration. Enter a meaningful App name . Enable Starter API Access ; it is recommended to select Basic API Key Access due to NextRoll's API rate limits. Set Callback URL to https://connector.qlik.com/auth/oauth/v3.htm . Click Save . Copy and paste your client ID and secret into a secured file. Creating the connection For more information, see Connecting to SaaS applications .
Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify .
Tip note You may need to scroll down to see this field.
When status is Verified , the authentication is verified.
Provide a name for the connection in Connection name .
Select Open connection metadata to define metadata for the connection when it has been created.
Connection settings Setting Description Data gateway
Select a Data Movement gateway if required by your use case.
Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway . If you have another subscription tier and do not want to use Data Movement gateway , select None .
For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement .
Start Date Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.
Lookback Window Lookback window is the period during which recent data changes are checked and captured at each sync. Default is 7 days. Client ID Client ID. Client Secret Client secret. End Date The end date defines the last day included in data extraction in yyyy-mm-dd format. Default is the current day.
SchemaInformation note Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 1.
Depending on your destination, table and column names may not appear as they are outlined below.
ad_groups
The ad_groups table contains info about the adgroups contained within the campaigns of your AdRoll account.
ad_groups table foreign keys Join ad_groups with on ads ad_groups.eid = ads.adgroups.id ad_groups.ads.id = ads.eid ad_groups.ads.id = ads.original_ad campaigns ad_groups.eid = campaigns.adgroups.items ad_reports ad_groups.ads.id = ad_reports.ad segments ad_groups.segments.id = segments.eid
ad_groups table schema
ad_optimization
STRING
ads
ARRAY
This is a nested data structure:
campaign
STRING
coops
ARRAY
This is a nested data structure.
created_date
DATE-TIME
demographic_targets
ARRAY
This is a nested data structure.
eid
STRING
flight_timezone
STRING
geo_targets
ARRAY
This is a nested data structure.
is_cats4gold
BOOLEAN
name
STRING
placement_targets
ARRAY
This is a nested data structure.
platform_targets
ARRAY
This is a nested data structure.
segments
ARRAY
This is a nested data structure:
id: STRING is_negative: BOOLEAN
site_exclusions
ARRAY
This is a nested data structure.
space_optimization
STRING
status
STRING
type
STRING
updated_date
DATE-TIME
ad_reports
The ad_reports table contains ad-level reporting data from your AdRoll account.
Replication Method
CDC
Primary Keys
eid
date
Replication Key
date
Useful links
AdRoll API method
ad_reports table foreign keys Join ad_reports with on ad_groups ad_reports.ad = ad_groups.ads.id ads ad_reports.ad = ads.eid ad_reports.ad = ads.original_ad
ad_reports table schema
ad
STRING
ad_size
STRING
adjusted_click_through_ratio
NUMBER
adjusted_cpa
NUMBER
adjusted_ctc
INTEGER
adjusted_total_conversion_rate
NUMBER
adjusted_total_conversions
INTEGER
adjusted_view_through_ratio
NUMBER
adjusted_vtc
INTEGER
advertiser
STRING
attributed_click_through_rev
NUMBER
attributed_rev
NUMBER
attributed_view_through_rev
NUMBER
billing_cost
NUMBER
click_cpa
NUMBER
click_through_conversions
INTEGER
click_through_ratio
NUMBER
clicks
INTEGER
cost
NUMBER
cpa
NUMBER
cpc
NUMBER
cpm
NUMBER
created_date
STRING
ctr
NUMBER
date
DATE-TIME
eid
STRING
height
INTEGER
impressions
INTEGER
paid_impressions
INTEGER
prospects
INTEGER
roi
NUMBER
status
STRING
total_conversion_rate
NUMBER
total_conversions
INTEGER
type
STRING
view_through_conversions
INTEGER
view_through_ratio
NUMBER
width
INTEGER
ads
The ads table contains information about the ads and creatives associated with the advertisables in your AdRoll account.
ads table foreign keys Join ads with on ad_groups ads.adgroups.id = ad_groups.eid ads.eid = ad_groups.ads.id ads.original_ad = ad_groups.ads.id campaigns ads.adgroups.id = campaigns.adgroups.items ad_reports ads.eid = ad_reports.ad ads.original_ad = ad_reports.ad
ads table schema
ad_format
STRING
ad_format_id
INTEGER
ad_format_name
STRING
ad_parameters
ARRAY
This is a nested data structure.
adgroups
ARRAY
This is a nested data structure:
advertisable
STRING
app_id
STRING
body
STRING
body_dynamic
STRING
brand_name
STRING
call_to_action
STRING
created_date
DATE-TIME
destination_url
STRING
display_url_override
STRING
eid
STRING
has_edits
BOOLEAN
has_future_campaigns
BOOLEAN
has_pending_edits
BOOLEAN
headline
STRING
headline_dynamic
STRING
height
INTEGER
inventory_type
STRING
is_active
BOOLEAN
is_fb_dynamic
BOOLEAN
is_liquid
STRING
is_outlined
BOOLEAN
lead_gen_form_id
STRING
message
STRING
message_dynamic
STRING
multi_share_optimized
STRING
multiple_products
STRING
name
STRING
original_ad
STRING
outline_color
STRING
replacement_ad
STRING
src
STRING
status
STRING
type
STRING
updated_date
DATE-TIME
valid_clicktag
BOOLEAN
width
INTEGER
advertisables
The advertisables table contains information about the advertisables in your AdRoll account.
advertisables table foreign keys Join advertisables with on campaigns advertisables.eid = campaigns.advertisable segments advertisables.eid = segments.advertisable_eid
advertisables table schema
abm_onboarding_status
STRING
account
STRING
account_country_code
STRING
account_is_autobilled
BOOLEAN
account_is_prepaid
BOOLEAN
account_is_suspended
BOOLEAN
account_suspension_reason
STRING
admin_page_permission
BOOLEAN
am_email
STRING
approval_state
STRING
attached_users
ARRAY
This is a nested data structure.
blacklisted_sites
ARRAY
This is a nested data structure.
business_unit
STRING
campaign_monitor_client_api_key
STRING
campaign_monitor_client_id
STRING
click_through_conversion_window
INTEGER
cm_networks
STRING
company_phone
STRING
constant_contact_code
STRING
constant_contact_oauth_url
STRING
country_code
STRING
created_date
DATE-TIME
csm_admin
STRING
currency
STRING
default_homepage
STRING
default_utm
STRING
eid
STRING
enable_customer_multi_dur_segs
BOOLEAN
fb_offsite_pixels_tos_accepted
BOOLEAN
fbx_account_id
INTEGER
fbx_page_id
STRING
fbx_page_url
STRING
has_approved_consent_solution
BOOLEAN
has_approved_safari_add_on
BOOLEAN
has_created_campaign
BOOLEAN
has_offsite_pixels
BOOLEAN
has_privacy_policy
BOOLEAN
has_sales_and_leads_automation
BOOLEAN
hide_optins_page
BOOLEAN
homepage_enabled
BOOLEAN
iab1_category_id
INTEGER
iab1_category_name
STRING
iab2_category_id
INTEGER
iab2_category_name
STRING
iab_content_id
INTEGER
instagram_actor_id
STRING
ip_address_exclusions
ARRAY
This is a nested data structure.
is_abm_customer
BOOLEAN
is_active
BOOLEAN
is_b2b
BOOLEAN
is_campaign_monitor_syncing
BOOLEAN
is_constant_contact_syncing
BOOLEAN
is_coop_approved
STRING
is_kpi_eligible
BOOLEAN
is_managed
BOOLEAN
is_marketo_syncing
BOOLEAN
is_salesforce_system_owned
BOOLEAN
is_suspended
BOOLEAN
is_trusted
BOOLEAN
is_twitter_syncing
BOOLEAN
liquidads
STRING
logo_url
STRING
magellan_legacy
BOOLEAN
magellan_query
BOOLEAN
marketo_api_endpoint
STRING
marketo_client_id
STRING
marketo_secret_key
STRING
name
STRING
nbam_admin
STRING
ops
STRING
optimizer
STRING
optimizer_email
STRING
organization
STRING
page_access_request_status
STRING
path_name
STRING
product_name
STRING
recent_theme_color
STRING
reskin_enabled
BOOLEAN
revshare_click_percent
NUMBER
revshare_view_percent
NUMBER
rollcrawl_enabled
BOOLEAN
rollworks_self_serve_ads
BOOLEAN
safari_add_on_theme
STRING
saleser
STRING
self_serve_prospecting_enabled
BOOLEAN
show_dpa
BOOLEAN
show_web_dynamic_ads
BOOLEAN
source
STRING
status
STRING
twitter_handle
STRING
uhura_enabled
BOOLEAN
updated_date
STRING
url
STRING
use_universal_campaigns
BOOLEAN
view_through_conversion_window
INTEGER
zvelo_category_id
INTEGER
zvelo_category_name
STRING
campaigns
The campaigns table contains information about the advertising campaigns in your AdRoll account.
campaigns table foreign keys Join campaigns with on ad_groups campaigns.adgroups.items = ad_groups.eid ads campaigns.adgroups.items = ads.adgroups.id advertisables campaigns.advertisable = advertisables.eid segments campaigns.advertisable = segments.advertisable_eid
campaigns table schema
abm_type
STRING
adgroups
ARRAY
This is a nested data structure.
advertisable
STRING
bid_strategy
STRING
bid_strategy_target
STRING
bid_type
STRING
budget
NUMBER
campaign_type
STRING
cpc
NUMBER
cpm
NUMBER
created_date
DATE-TIME
eid
STRING
end_date
DATE-TIME
facebook_campaign_objective
STRING
frequency_cap
STRING
is_active
BOOLEAN
is_apple
BOOLEAN
is_cats4gold
BOOLEAN
is_coop
BOOLEAN
is_facebook
BOOLEAN
is_fb_lookalike
BOOLEAN
is_fb_wca
BOOLEAN
is_fbx_newsfeed
BOOLEAN
is_pubgraph
BOOLEAN
is_retargeting
BOOLEAN
is_rtb
BOOLEAN
max_cpm
NUMBER
name
STRING
pa_sales_stage_eid
STRING
pricing_strategies
ARRAY
This is a nested data structure.
source
STRING
spend_limit_until
STRING
start_date
DATE-TIME
status
STRING
ui_budget_daily
BOOLEAN
updated_date
DATE-TIME
use_case
STRING
segments
The segments table contains information about segments, or the lists of users that visit your AdRoll site.
segments table foreign keys Join segments with on advertisables segments.advertisable_eid = advertisables.eid campaigns segments.advertisable_eid = campaigns.advertisable ad_groups segments.eid = ad_groups.segments.id
segments table schema
advertisable_eid
STRING
conversion_value
STRING
created_date
DATE-TIME
display_name
STRING
duration
INTEGER
duration_sec
INTEGER
eid
STRING
group
INTEGER
has_default_rule
BOOLEAN
is_active
BOOLEAN
match_method
STRING
name
STRING
parent_id
STRING
pattern
STRING
product
STRING
recent_first_match
BOOLEAN
rule
STRING
rule_id
INTEGER
source
STRING
threshold
INTEGER
type
STRING