The tap-snapchat-ads extractor pulls data from Snapchat Ads that can then be sent to a destination using a loader.
Available Variants
- airbyte
- bytecodeio
- gthesheep
- singer-io (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-ads --variant gthesheepmeltano 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
- state
- discover
- about
- stream-maps
- schema-flattening
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_secretrefresh_tokenstart_dateswipe_up_attribution_windowview_attribution_windowuser_agenttargeting_country_codesstream_mapsstream_map_configflattening_enabledflattening_max_depth
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
Client ID used to authenticate against the API.
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
Client secret used to authenticate against the API.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set client_secret [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_SNAPCHAT_ADS_REFRESH_TOKEN
Refresh token used to authenticate against the API.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_SNAPCHAT_ADS_START_DATE
Start date for stats collection.
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 -
Default Value:
28_DAY
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]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]User Agent (user_agent)
-
Environment variable:
TAP_SNAPCHAT_ADS_USER_AGENT
User agent to set on requests
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set user_agent [value]Targeting Country Codes (targeting_country_codes)
-
Environment variable:
TAP_SNAPCHAT_ADS_TARGETING_COUNTRY_CODES
List of lowercase 2-letter ISO Country Codes for Ads Targeting
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set targeting_country_codes [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_SNAPCHAT_ADS_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set stream_maps [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_SNAPCHAT_ADS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set stream_map_config [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_SNAPCHAT_ADS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_SNAPCHAT_ADS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-snapchat-ads set flattening_max_depth [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}
