The tap-twitter-ads extractor pulls data from Twitter Ads that can then be sent to a destination using a loader.
Alternate Implementations
-
Bytecode IO
- Stitch Data (default)🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-twitter-ads extractor to your
project using
:meltano add -
Configure the tap-twitter-ads
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-twitter-adsmeltano config tap-twitter-ads set --interactivemeltano config tap-twitter-ads testNext 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-twitter-ads
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-twitter-ads 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:
access_tokenaccess_token_secretaccount_idsattribution_windowconsumer_keyconsumer_secretcountry_codespage_sizereportsrequest_timeoutstart_dateuser_agentwith_deleted
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-twitter-ads 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_TWITTER_ADS_ACCESS_TOKEN
OAuth 1.0a credentials - Access Token
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set access_token [value]Access Token Secret (access_token_secret)
-
Environment variable:
TAP_TWITTER_ADS_ACCESS_TOKEN_SECRET
OAuth 1.0a credentials - Access Token Secret
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set access_token_secret [value]Account IDs (account_ids)
-
Environment variable:
TAP_TWITTER_ADS_ACCOUNT_IDS
Comma-delimited list of Twitter Ad Account IDs.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set account_ids [value]Attribution Window (attribution_window)
-
Environment variable:
TAP_TWITTER_ADS_ATTRIBUTION_WINDOW
Number of days for latency look-back period to allow analytical reporting numbers to stabilize.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set attribution_window [value]Consumer Key (consumer_key)
-
Environment variable:
TAP_TWITTER_ADS_CONSUMER_KEY
OAuth 1.0a credentials - Consumer Key
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set consumer_key [value]Consumer Secret (consumer_secret)
-
Environment variable:
TAP_TWITTER_ADS_CONSUMER_SECRET
OAuth 1.0a credentials - Consumer Secret
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set consumer_secret [value]Country Codes (country_codes)
-
Environment variable:
TAP_TWITTER_ADS_COUNTRY_CODES
Comma-delimited list of ISO 2-letter country codes for targeting and segmentation. (e.g. "US, CA, MX, DE")
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set country_codes [value]Page Size (page_size)
-
Environment variable:
TAP_TWITTER_ADS_PAGE_SIZE
An optional parameter to configure custom page_size.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set page_size [value]Reports (reports)
-
Environment variable:
TAP_TWITTER_ADS_REPORTS
Object array of specified reports with name, entity, segment, and granularity.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set reports [value]Request Timeout (request_timeout)
-
Environment variable:
TAP_TWITTER_ADS_REQUEST_TIMEOUT
To configure the read and connect timeout for twitter-ads client. Default is 300 seconds.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set request_timeout [value]Start Date (start_date)
-
Environment variable:
TAP_TWITTER_ADS_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-twitter-ads set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_TWITTER_ADS_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set user_agent [value]With Deleted (with_deleted)
-
Environment variable:
TAP_TWITTER_ADS_WITH_DELETED
Specifies whether to include logically deleted records in the results.
Configure this setting directly using the following Meltano command:
meltano config tap-twitter-ads set with_deleted [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
