The tap-snapchat-ads extractor pulls data from Snapchat Ads that can then be sent to a destination using a loader.
Alternate Implementations
-
Airbyte
🥉
-
Bytecode IO
-
Gary James
- 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-snapchat-ads extractor to your
project using
:meltano add -
Configure the tap-snapchat-ads
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-snapchat-adsmeltano config tap-snapchat-ads set --interactivemeltano config tap-snapchat-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-snapchat-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-snapchat-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:
client_idclient_secretomit_emptyorg_account_idspage_sizerefresh_tokenrequest_timeoutstart_dateswipe_up_attribution_windowtargeting_country_codesuser_agentview_attribution_window
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-snapchat-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.
Client ID (client_id)
-
Environment variable:
TAP_SNAPCHAT_ADS_CLIENT_ID
Your client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_SNAPCHAT_ADS_CLIENT_SECRET
Your client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set client_secret [value]Omit Empty (omit_empty)
-
Environment variable:
TAP_SNAPCHAT_ADS_OMIT_EMPTY
Omits records with zero data for all metrics for a given date/entity. If there is data for any metric for a given date/entity, all metrics for that date/entity are returned. A string representation of a boolean. Default, 'true'.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set omit_empty [value]Account IDs (org_account_ids)
-
Environment variable:
TAP_SNAPCHAT_ADS_ORG_ACCOUNT_IDS
An array of account IDs to sync.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set org_account_ids [value]Page Size (page_size)
-
Environment variable:
TAP_SNAPCHAT_ADS_PAGE_SIZE
The request page size. Default, 500.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set page_size [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_SNAPCHAT_ADS_REFRESH_TOKEN
Your refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set refresh_token [value]Request Timeout (request_timeout)
-
Environment variable:
TAP_SNAPCHAT_ADS_REQUEST_TIMEOUT
The time for which request should wait to get a response and the default request_timeout is 300 seconds.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set request_timeout [value]Start Date (start_date)
-
Environment variable:
TAP_SNAPCHAT_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-snapchat-ads set start_date [value]Swipe Up Attribution Window (swipe_up_attribution_window)
-
Environment variable:
TAP_SNAPCHAT_ADS_SWIPE_UP_ATTRIBUTION_WINDOW
Attribution window for swipe ups. 1_DAY, 7_DAY, 28_DAY (default).
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set swipe_up_attribution_window [value]Targeting Country Codes (targeting_country_codes)
-
Environment variable:
TAP_SNAPCHAT_ADS_TARGETING_COUNTRY_CODES
Comma-delimited lists of lower-case 2-letter ISO Country Codes for Ads Targeting. Default, 'us'.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set targeting_country_codes [value]User Agent (user_agent)
-
Environment variable:
TAP_SNAPCHAT_ADS_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set user_agent [value]View Attribution Window (view_attribution_window)
-
Environment variable:
TAP_SNAPCHAT_ADS_VIEW_ATTRIBUTION_WINDOW
Attribution window for views. 1_HOUR, 3_HOUR, 6_HOUR, 1_DAY (default), 7_DAY, 28_DAY.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set view_attribution_window [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-brightgreen){kind=icon}
-2-c0c0c4){kind=icon}
