Snapchat Ads

tap-snapchat-ads from singer-io

Social Media Platform

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

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-snapchat-ads extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-snapchat-ads
  3. Configure the tap-snapchat-ads settings using
    meltano config
    :
  4. meltano config tap-snapchat-ads set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-snapchat-ads test

Next steps

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:

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.

Account IDs (org_account_ids)

  • Environment variable: TAP_SNAPCHAT_ADS_ORG_ACCOUNT_IDS

An array of account IDs to sync.

Client Secret (client_secret)

  • Environment variable: TAP_SNAPCHAT_ADS_CLIENT_SECRET

Your client secret.

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.

Refresh Token (refresh_token)

  • Environment variable: TAP_SNAPCHAT_ADS_REFRESH_TOKEN

Your refresh token.

User Agent (user_agent)

  • Environment variable: TAP_SNAPCHAT_ADS_USER_AGENT

The user agent to send with requests.

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).

Page Size (page_size)

  • Environment variable: TAP_SNAPCHAT_ADS_PAGE_SIZE

The request page size. Default, 500.

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.

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.

Client ID (client_id)

  • Environment variable: TAP_SNAPCHAT_ADS_CLIENT_ID

Your client ID.

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'.

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'.

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

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api