Snapchat Marketing

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

Airbyte Connector

Connector Version:

1.2.3(Last updated 4 days ago)

CDK Version:

4.3.2

Sync Success Rate:

Usage Rate:

This page guides you through the process of setting up the Snapchat Marketing source connector.

Prerequisites

For Airbyte Cloud:

• An existing Snapchat Marketing business account

For Airbyte Open Source:

• Client ID
• Client Secret
• Refresh Token

Setup guide

Step 1: Set up Snapchat

1. Set up a Snapchat Business account

For Airbyte Open Source:

2. Activate Access to the Snapchat Marketing API

3. Add the OAuth2 app:

   • Adding the OAuth2 app requires the redirect_url parameter.
     • If you have the API endpoint that will handle next OAuth process, write it to this parameter.
     • If you do not have the API endpoint, simply use a valid URL.Refer to the discussion here for more information: Snapchat Redirect URL - Clarity in documentation please
   • Save the Client ID and Client Secret

4. Obtain a refresh token using OAuth2 authentication workflow.

   • Open the authorize link in a browser. It will look similar to this:

   https://accounts.snapchat.com/login/oauth2/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=snapchat-marketing-api&state=wmKkg0TWgppW8PTBZ20sldUwerf-m
   • Login & Authorize via UI
   • Locate the code query parameter in the redirect
   • Exchange the code for an access token and refresh token.

   Your request will appear similar to the following:

      curl -X POST \
      -d "code={one_time_use_code}" \
      -d "client_id={client_id}" \
      -d "client_secret={client_secret}"  \
      -d "grant_type=authorization_code"  \
      -d "redirect_uri=redirect_uri"
      https://accounts.snapchat.com/login/oauth2/access_token`

For more information on authenticating into the Snapchat API, read their documentation here You will receive the API key and refresh token in the response. Use this refresh token for the connector.

Step 2: Set up the source connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
3. On the source setup page, select Snapchat Marketing from the Source type dropdown and enter a name for this connector.
4. Click Authenticate your account.
5. In the authentication window, log in and authorize access to your Snapchat account
6. (Optional) Choose a Start Date. All data created on or after this date will be synced. If left blank, all records will be synced.

tip

The Start Date is required for the all streams that use start_time as a key (see Supported Streams section below).

7. (Optional) Choose an End Date. All data created on or before this date will be synced. If left blank, all records will be synced.
8. (Optional) Choose the Action Report Time, which specifies how conversions are reported. The default is set to conversion, and can be modified to impression.
9. (Optional) Choose the 'Swip Up Attribution Window', which specifies the length of the attribution window for swipe up actions. The default is 28 days and can be adjusted.
10. (Optional) Choose the View Attribution Window, which specifies the length of the attribution window for views. The default is 28 days and can be adjusted.
11. Click 'Set up source'

For Airbyte Open Source:

1. Open the Airbyte UI.
2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
3. On the source setup page, select Snapchat Marketing from the Source type dropdown and enter a name for this connector.
4. Add the Client ID, Client Secret, and Refresh Token obtained from the setup.
5. (Optional) Choose a Start Date. All data created on or after this date will be synced. If left blank, all records will be synced.

tip

The Start Date is required for the all streams that use start_time as a key (see Supported Streams section below).

6. (Optional) Choose an End Date. All data created on or before this date will be synced.
7. (Optional) Choose the Action Report Time, which specifies how conversions are reported. The default is set to conversion, and can be modified to impression.
8. (Optional) Choose the 'Swip Up Attribution Window', which specifies the length of the attribution window for swipe up actions. The default is 28 days and can be adjusted.
9. (Optional) Choose the View Attribution Window, which specifies the length of the attribution window for views. The default is 28 days and can be adjusted.
10. Click 'Set up source'

Supported streams and sync modes

Stream	Incremental	Key
AdAccounts	Yes	"id"
Ads	Yes	"id"
AdSquads	Yes	"id"
Campaigns	Yes	"id"
Creatives	Yes	"id"
Media	Yes	"id"
Organizations	Yes	"id"
Segments	Yes	"id"
AdAccounts_Stats_Hourly	Yes	["id", "granularity", "start_time"]
AdAccounts_Stats_Daily	Yes	["id", "granularity", "start_time"]
AdAccounts_Stats_Lifetime	No	["id", "granularity"]
Ads_Stats_Hourly	Yes	["id", "granularity", "start_time"]
Ads_Stats_Daily	Yes	["id", "granularity", "start_time"]
Ads_Stats_Lifetime	No	["id", "granularity"]
AdSquads_Stats_Hourly	Yes	["id", "granularity", "start_time"]
AdSquads_Stats_Daily	Yes	["id", "granularity", "start_time"]
AdSquads_Stats_Lifetime	No	["id", "granularity"]
Campaigns_Stats_Hourly	Yes	["id", "granularity", "start_time"]
Campaigns_Stats_Daily	Yes	["id", "granularity", "start_time"]
Campaigns_Stats_Lifetime	No	["id", "granularity"]

Performance considerations

The Snapchat Marketing API limits requests to 1,000 items per page.

Syncing data with an hourly granularity often generates large data volumes and can take longer times to sync. We recommend syncing at a day granularity.

Reference

Config fields reference

Field

Type

Property name

string

client_id

string

client_secret

string

refresh_token

string

start_date

string

end_date

string

action_report_time

string

swipe_up_attribution_window

string

view_attribution_window

Changelog

Expand to review

Version	Date	Pull Request	Subject
1.2.3	2024-08-12	43826	Fixed the bug with the missing spend field to supported *_stats_* streams
1.2.2	2024-08-10	43539	Update dependencies
1.2.1	2024-08-03	43174	Update dependencies
1.2.0	2024-07-31	42010	Migrate to CDK v4.1.0
1.1.2	2024-07-27	42680	Update dependencies
1.1.1	2024-07-20	42366	Update dependencies
1.1.0	2024-07-16	42009	Migrate to CDK v2.4.0
1.0.3	2024-07-13	41855	Update dependencies
1.0.2	2024-07-10	41547	Update dependencies
1.0.1	2024-07-09	40132	Update dependencies
1.0.0	2024-06-20	39507	Migrate to low-code CDK and add incremental functionality to organizations
0.6.2	2024-05-22	38574	Update authenticator package
0.6.1	2024-04-24	36662	Schema descriptions
0.6.0	2024-04-10	30586	Add attribution_windows,action_report_time as optional configurable params
0.5.0	2024-03-19	36267	Pin airbyte-cdk version to ^0
0.4.0	2024-02-27	35660	Add new fields to streams ads, adsquads, creatives, and media
0.3.2	2024-02-12	35171	Manage dependencies with Poetry.
0.3.0	2023-05-22	26358	Remove deprecated authSpecification in favour of advancedAuth
0.2.0	2023-05-10	25948	Introduce new field in the Campaigns stream schema
0.1.16	2023-04-20	20897	Add missing fields to Basic Stats schema
0.1.15	2023-03-02	22869	Specified date formatting in specification
0.1.14	2023-02-10	22808	Enable default AvailabilityStrategy
0.1.13	2023-01-27	22023	Set AvailabilityStrategy for streams explicitly to None
0.1.12	2023-01-11	21267	Fix parse empty error response
0.1.11	2022-12-23	20865	Handle 403 permission error
0.1.10	2022-12-15	20537	Run on CDK 0.15.0
0.1.9	2022-12-14	20498	Fix output state when no records are read
0.1.8	2022-10-05	17596	Retry 429 and 5xx errors when refreshing access token
0.1.6	2022-07-21	14924	Remove additionalProperties field from specs
0.1.5	2022-07-13	14577	Added stats streams hourly, daily, lifetime
0.1.4	2021-12-07	8429	Update titles and descriptions
0.1.3	2021-11-10	7811	Add oauth2.0, fix stream_state
0.1.2	2021-11-08	7499	Remove base-python dependencies
0.1.1	2021-07-29	5072	Fix bug with incorrect stream_state value
0.1.0	2021-07-26	4843	Initial release supporting the Snapchat Marketing API