This integration is certified by Stitch. For support, contact Stitch support.
AdRoll integration summary
Stitch’s AdRoll integration replicates data using the AdRoll 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 (v20-07-2017) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Deprecated on July 24, 2020 |
Supported by | |
Stitch plan |
Standard |
API availability |
Not available |
Singer GitHub repository |
Not applicable |
||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Unsupported |
Advanced Scheduling |
Unsupported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Unsupported |
Column selection |
Unsupported |
Select all |
Unsupported |
||
TRANSPARENCY | |||
Extraction Logs |
Unsupported |
Loading Reports |
Supported |
Connecting AdRoll
Step 1: Create an AdRoll User for Stitch
While you can use your own credentials to connect AdRoll to Stitch, we recommend creating a separate user for us. This will make it easier for you to manage users and audit events in your AdRoll account.
We require a General User role - which is the default - to be able to replicate your AdRoll data. Note that Stitch does not need billing access. If you need help creating an AdRoll user, you can find instructions here in AdRoll’s support docs.
Step 2: 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. - Enter the email address and username for the Stitch AdRoll user.
Step 3: 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 4: 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:
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.
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 20-07-2017 of this integration.
adroll_ad_groups
Replication Method: Full Table
Primary Key: eid
Contains Nested Structures?:
Yes
adroll_ad_groups
table contains info about the adgroups contained within the campaigns of your {{ integration.display_name }} account.adroll_ad_groups & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
adroll_ad_groups Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Adgroup ID (
eid
)Ad info
*
ad_optimization
campaign
created_date
flight_timezone
name
Segment info
*
space_optimization
status
type
updated_date
adroll_ad_reports
Replication Method: Key-based Incremental
Primary Key: eid
Contains Nested Structures?:
No
adroll_ad_reports
table contains ad-level reporting data.Each row in this table contains totals for the ad, by date.
adroll_ad_reports Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Ad ID (
eid
)ad
ad_size
adjusted_click_through_ratio
adjusted_cpa
adjusted_cpa_usd
adjusted_ctc
adjusted_total_conversion_rate
adjusted_total_conversions
adjusted_view_through_ratio
adjusted_vtc
advertiser
click_cpa
click_cpa_usd
click_through_conversions
click_through_ratio
clicks
cost
cost_usd
cpa
cpa_usd
cpc
cpc_usd
cpm
cpm_usd
created_date
ctr
date
height
impressions
paid_impressions
prospects
status
total_conversion_rate
total_conversions
type
view_through_conversions
view_through_ratio
width
adroll_ads
Replication Method: Full Table
Primary Key: eid
Contains Nested Structures?:
Yes
adroll_ads
table contains about the ads, or creatives, associated with the advertisables in your account.adroll_ads & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
adroll_ads Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Ad ID (
eid
)ad_format
ad_format_id
ad_format_name
Ad Group info
*
advertisable
call_to_action
created_date
destination_url
has_edits
has_future_campaigns
has_pending_edits
height
inventory_type
is_active
is_fb_dynamic
is_outlined
name
original_ad
outline_color
src
status
type
updated_date
valid_clicktag
width
adroll_advertisables
Replication Method: Full Table
Primary Key: eid
Contains Nested Structures?:
No
adroll_advertisables
table contains about the advertisables (typically the parent object for a brand) in your {{ integration.display_name }} account.adroll_advertisables Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Advertisable ID (
id
)is_active
name
organization
status
url
product_name
click_through_conversion_window
view_through_conversion_window
created_date
updated_date
attached_users
*
blacklisted_sites
enable_customer_multi_dur_segs
is_coop_approved
is_publisher
cm_networks
iab1_category_id
iab1_category_name
iab2_category_id
iab2_category_iname
zvelo_category_id
zvelo_category_name
approval_state
has_privacy_policy
ops
optimizer
saleser
liquidads
adroll_campaigns
Replication Method: Full Table
Primary Key: eid
Contains Nested Structures?:
Yes
adroll_campaigns
table contains about the advertising campaigns in your account.adroll_campaigns & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
adroll_campaigns Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Campaign ID (
eid
)adgroups
*
advertisable
budget
ui_budget_daily
created_date
cpc
cpm
end_date
is_active
is_facebook
is_fbx_newsfeed
is_retargeting
is_fb_wca
is_apple
max_cpm
name
promotion
pricing_strategies
start_date
status
updated_date
is_coop
is_pubgraph
spend_limit_until
created_date
updated_date
adroll_segments
Replication Method: Full Table
Primary Key: eid
Contains Nested Structures?:
No
adroll_segments
table contains about segments, or the lists of users that visit your site.adroll_segments Attributes
While we try to include everything AdRoll has here, this may not be a full list of attributes. Refer to AdRoll's documentation for a full list and description of each attribute.
Segment ID (
eid
)display_name
name
type
match_method
pattern
threshold
duration
conversion_value
group
mobile
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.