tap-snapchat-ads - Meltano Hub

Snapchat Ads

tap-snapchat-ads (gthesheep variant)🥈

Social Media Platform

The tap-snapchat-ads extractor pulls data from Snapchat Ads that can then be sent to a destination using a loader.

Alternate Implementations

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
```
:

meltano add extractor tap-snapchat-ads --variant gthesheep

Configure the tap-snapchat-ads settings using

meltano config

:

meltano config tap-snapchat-ads set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-snapchat-ads 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-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:

about
catalog
discover
schema-flattening
state
stream-maps

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_id
client_secret
refresh_token
start_date
swipe_up_attribution_window
targeting_country_codes
user_agent
view_attribution_window

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list 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

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

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

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

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]

Targeting Country Codes (targeting_country_codes)

Environment variable: TAP_SNAPCHAT_ADS_TARGETING_COUNTRY_CODES
Default Value: []

List of lower - case 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]

User Agent (user_agent)

Environment variable: TAP_SNAPCHAT_ADS_USER_AGENT

User agent

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
Default Value: 1_DAY

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]

Expand To Show SDK Settings

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]

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]

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]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-snapchat-ads extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-snapchat-ads --variant gthesheep

Maintenance Status

Repo

https://github.com/GtheSheep/tap-snapchat-ads

Maintainer

Keywords