This integration is powered by Singer's AdRoll tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
AdRoll integration summary
Stitch’s AdRoll integration replicates data using the NextRoll CRUD API. Refer to the Schema section for a list of objects available for replication.
AdRoll feature snapshot
A high-level look at Stitch's AdRoll (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on July 24, 2020 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting AdRoll
Step 1: Add AdRoll as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the AdRoll icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch AdRoll” would create a schema called
stitch_adroll
in the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your AdRoll integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond AdRoll’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
AdRoll integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to access AdRoll
- In Stitch, click the Authorize button. You’ll be prompted to sign into your AdRoll account.
- A screen explaining what you’re authorizing will display. Note: Stitch will only ever read your AdRoll data, and cannot create or modify records in AdRoll.
- Click Sign in with AdRoll to sign into your AdRoll account.
- After the authorization process successfully completes, you’ll be directed back to Stitch.
- Click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For AdRoll integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up AdRoll, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
AdRoll table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the AdRoll integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
Replication Method : |
Full Table |
Primary Key |
eid |
API endpoint : |
The ads
table contains information about the ads and creatives associated with the advertisables in your AdRoll account.
eid
The ad EID. Reference: |
ad_format
|
ad_format_id
|
ad_format_name
|
ad_parameters
|
adgroups
|
advertisable
Reference: |
app_id
|
body
|
body_dynamic
|
brand_name
|
call_to_action
|
created_date
|
destination_url
|
display_url_override
|
has_edits
|
has_future_campaigns
|
has_pending_edits
|
headline
|
headline_dynamic
|
height
|
inventory_type
|
is_active
|
is_fb_dynamic
|
is_liquid
|
is_outlined
|
lead_gen_form_id
|
message
|
message_dynamic
|
multi_share_optimized
|
multiple_products
|
name
|
original_ad
Reference: |
outline_color
|
replacement_ad
|
src
|
status
|
type
|
updated_date
|
valid_clicktag
|
width
|
advertisables
Replication Method : |
Full Table |
Primary Key |
eid |
API endpoint : |
The advertisables
table contains information about the advertisables in your AdRoll account.
eid
The advertisable EID. Reference: |
|
abm_onboarding_status
|
|
account
|
|
account_country_code
|
|
account_is_autobilled
|
|
account_is_prepaid
|
|
account_is_suspended
|
|
account_suspension_reason
|
|
admin_page_permission
|
|
am_email
|
|
approval_state
|
|
attached_users
|
|
blacklisted_sites
|
|
business_unit
|
|
campaign_monitor_client_api_key
|
|
campaign_monitor_client_id
|
|
click_through_conversion_window
|
|
cm_networks
|
|
company_phone
|
|
constant_contact_code
|
|
constant_contact_oauth_url
|
|
country_code
|
|
created_date
|
|
csm_admin
|
|
currency
|
|
default_homepage
|
|
default_utm
|
|
enable_customer_multi_dur_segs
|
|
fb_offsite_pixels_tos_accepted
|
|
fbx_account_id
|
|
fbx_page_id
|
|
fbx_page_url
|
|
has_approved_consent_solution
|
|
has_approved_safari_add_on
|
|
has_created_campaign
|
|
has_offsite_pixels
|
|
has_privacy_policy
|
|
has_sales_and_leads_automation
|
|
hide_optins_page
|
|
homepage_enabled
|
|
iab1_category_id
|
|
iab1_category_name
|
|
iab2_category_id
|
|
iab2_category_name
|
|
iab_content_id
|
|
instagram_actor_id
|
|
ip_address_exclusions
|
|
is_abm_customer
|
|
is_active
|
|
is_b2b
|
|
is_campaign_monitor_syncing
|
|
is_constant_contact_syncing
|
|
is_coop_approved
|
|
is_kpi_eligible
|
|
is_managed
|
|
is_marketo_syncing
|
|
is_salesforce_system_owned
|
|
is_suspended
|
|
is_trusted
|
|
is_twitter_syncing
|
|
liquidads
|
|
logo_url
|
|
magellan_legacy
|
|
magellan_query
|
|
marketo_api_endpoint
|
|
marketo_client_id
|
|
marketo_secret_key
|
|
name
|
|
nbam_admin
|
|
ops
|
|
optimizer
|
|
optimizer_email
|
|
organization
|
|
page_access_request_status
|
|
path_name
|
|
product_name
|
|
recent_theme_color
|
|
reskin_enabled
|
|
revshare_click_percent
|
|
revshare_view_percent
|
|
rollcrawl_enabled
|
|
rollworks_self_serve_ads
|
|
safari_add_on_theme
|
|
saleser
|
|
self_serve_prospecting_enabled
|
|
show_dpa
|
|
show_web_dynamic_ads
|
|
source
|
|
status
|
|
twitter_handle
|
|
uhura_enabled
|
|
updated_date
|
|
url
|
|
use_universal_campaigns
|
|
view_through_conversion_window
|
|
zvelo_category_id
|
|
zvelo_category_name
|
ad_groups
Replication Method : |
Full Table |
Primary Key |
eid |
API endpoint : |
The ad_groups
table contains info about the adgroups contained within the campaigns of your AdRoll account.
eid
The ad group EID. Reference: |
||
ad_optimization
|
||
ads
|
||
campaign
|
||
coops
|
||
created_date
|
||
demographic_targets
|
||
flight_timezone
|
||
geo_targets
|
||
is_cats4gold
|
||
name
|
||
placement_targets
|
||
platform_targets
|
||
segments
|
||
site_exclusions
|
||
space_optimization
|
||
status
|
||
type
|
||
updated_date
|
ad_reports
Replication Method : |
Key-based Incremental |
Replication Key |
date |
Primary Key |
eid : date |
API endpoint : |
The ad_reports
table contains ad-level reporting data from your AdRoll account.
eid
The ad report EID. |
date
The start and end dates of the report. |
ad
Reference: |
ad_size
|
adjusted_click_through_ratio
|
adjusted_cpa
|
adjusted_ctc
|
adjusted_total_conversion_rate
|
adjusted_total_conversions
|
adjusted_view_through_ratio
|
adjusted_vtc
|
advertiser
|
attributed_click_through_rev
|
attributed_rev
|
attributed_view_through_rev
|
billing_cost
|
click_cpa
|
click_through_conversions
|
click_through_ratio
|
clicks
|
cost
|
cpa
|
cpc
|
cpm
|
created_date
|
ctr
|
height
|
impressions
|
paid_impressions
|
prospects
|
roi
|
status
|
total_conversion_rate
|
total_conversions
|
type
|
view_through_conversions
|
view_through_ratio
|
width
|
campaigns
Replication Method : |
Full Table |
Primary Key |
eid |
API endpoint : |
The campaigns
table contains information about the advertising campaigns in your AdRoll account.
eid
The campaign EID. |
|
abm_type
|
|
adgroups
|
|
advertisable
Reference: |
|
bid_strategy
|
|
bid_strategy_target
|
|
bid_type
|
|
budget
|
|
campaign_type
|
|
cpc
|
|
cpm
|
|
created_date
|
|
end_date
|
|
facebook_campaign_objective
|
|
frequency_cap
|
|
is_active
|
|
is_apple
|
|
is_cats4gold
|
|
is_coop
|
|
is_facebook
|
|
is_fb_lookalike
|
|
is_fb_wca
|
|
is_fbx_newsfeed
|
|
is_pubgraph
|
|
is_retargeting
|
|
is_rtb
|
|
max_cpm
|
|
name
|
|
pa_sales_stage_eid
|
|
pricing_strategies
|
|
source
|
|
spend_limit_until
|
|
start_date
|
|
status
|
|
ui_budget_daily
|
|
updated_date
|
|
use_case
|
segments
Replication Method : |
Full Table |
Primary Key |
eid |
API endpoint : |
The segments
table contains information about segments, or the lists of users that visit your AdRoll site.
eid
The segment EID. Reference: |
advertisable_eid
Reference: |
conversion_value
|
created_date
|
display_name
|
duration
|
duration_sec
|
group
|
has_default_rule
|
is_active
|
match_method
|
name
|
parent_id
|
pattern
|
recent_first_match
|
rule
|
rule_id
|
source
|
threshold
|
type
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.