# AdRoll (v20-07-2020)

Information note **AdRoll extraction is supported by Stitch**   
This integration is certified by Stitch. For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport).

## AdRoll integration summary

Stitch’s AdRoll integration replicates data using the [AdRoll CRUD API](https://developers.adroll.com/docs/crud-api/index.html). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Deprecated on July 24, 2020 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Remove icon<br><br>This version of the integration isn't available via the API.<br><br><br>Not available |
| **Singer GitHub repository** | Not applicable |  |  |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Remove icon<br><br>Anchor Scheduling is not supported for this integration. The only available replication scheduling method is the Replication Frequency setting.<br><br><br>Unsupported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Remove icon<br><br>Advanced Scheduling is not supported for this integration.<br><br><br>Unsupported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon<br><br>Table-level resets are not supported for this integration. Resets are only supported at the integration level.<br><br><br>Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon<br><br>Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.<br><br><br>Unsupported |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Remove icon<br><br>Table selection is not supported for this integration. All available table and fields will be automatically selected for replication.<br><br><br>Unsupported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Remove icon<br><br>Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.<br><br><br>Unsupported |
| **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Remove icon<br><br>As this integration doesn't support table or column selection, all available tables and columns are automatically replicated.<br><br><br>Unsupported |  |  |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Remove icon<br><br>This feature is not supported for this version of the integration.<br><br><br>Unsupported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>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

1. [Sign into your Stitch account](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Click the **AdRoll** icon.

4. 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.

5. 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide.

### Step 4: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) 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.**

Information note

**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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.

## AdRoll table reference

Information note

**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\_reports Replication Method: Key-based Incremental Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key. Primary Key: eid Contains Nested Structures?: No The adroll\_ad\_reports table contains ad-level reporting data. Table Info & Attributes

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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-report-ad) 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

Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.

  
**Primary Key:** `eid`   
**Contains Nested Structures?:** Yes

If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.

The `adroll_ads` table contains about the ads, or creatives, associated with the advertisables in your account.

[Table Info & Attributes](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#adroll_ads-data)

### 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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-advertisable-get_ads) 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

Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.

  
**Primary Key:** `eid`   
**Contains Nested Structures?:** No

The `adroll_advertisables` table contains about the advertisables (typically the parent object for a brand) in your {{ integration.display\_name }} account.

[Table Info & Attributes](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#adroll_advertisables-data)

### 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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-advertisable-get) 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

Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.

  
**Primary Key:** `eid`   
**Contains Nested Structures?:** Yes

If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.

The `adroll_campaigns` table contains about the advertising campaigns in your account.

[Table Info & Attributes](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#adroll_campaigns-data)

### 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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-advertisable-get_campaigns) 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

Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.

  
**Primary Key:** `eid`   
**Contains Nested Structures?:** No

The `adroll_segments` table contains about segments, or the lists of users that visit your site.

[Table Info & Attributes](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#adroll_segments-data)

### 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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-advertisable-get_segments) 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

#### adroll\_ad\_groups

**Replication Method:** Full Table

Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.

  
**Primary Key:** `eid`   
**Contains Nested Structures?:** Yes

If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.

The `adroll_ad_groups` table contains info about the adgroups contained within the campaigns of your {{ integration.display\_name }} account.

[Table Info & Attributes](https://help.qlik.com/en-US/stitch/integrations/saas/adroll/v20-07-2020#adroll_ad_groups-data)

### 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](https://developers.adroll.com/docs/crud-api/reference.html#get--api-v1-advertisable-get_adgroups) 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