The tap-adroll extractor pulls data from AdRoll that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-adroll extractor to your
project using
:meltano add
-
Configure the tap-adroll
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-adroll
meltano config tap-adroll set --interactive
meltano config tap-adroll test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-adroll
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-adroll
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-adroll list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Access Token (access_token)
-
Environment variable:
TAP_ADROLL_ACCESS_TOKEN
Your AdRoll access token.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set access_token [value]
Client ID (client_id)
-
Environment variable:
TAP_ADROLL_CLIENT_ID
Your AdRoll client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set client_id [value]
Client Secret (client_secret)
-
Environment variable:
TAP_ADROLL_CLIENT_SECRET
Your AdRoll client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set client_secret [value]
End Date (end_date)
-
Environment variable:
TAP_ADROLL_END_DATE
Date up to when historical data will be extracted.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set end_date [value]
Lookback Window (lookback_window)
-
Environment variable:
TAP_ADROLL_LOOKBACK_WINDOW
(Default 7 days) The amount of time in days to look back from the start date or date bookmark.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set lookback_window [value]
Refresh Token (refresh_token)
-
Environment variable:
TAP_ADROLL_REFRESH_TOKEN
Your AdRoll refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set refresh_token [value]
Start Date (start_date)
-
Environment variable:
TAP_ADROLL_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-adroll set start_date [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.