Snapchat Ads is currently in beta. The info in this guide is subject to change.
This integration is powered by Singer's snapchat-ads tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
Snapchat Ads integration summary
Stitch’s Snapchat Ads integration replicates data using the Snapchat Ads Marketing API. Refer to the Schema section for a list of objects available for replication.
Snapchat Ads feature snapshot
A high-level look at Stitch's Snapchat Ads (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Beta |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Snapchat Ads
Step 1: Add Snapchat Ads as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Snapchat Ads icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Snapchat Ads” would create a schema called
stitch_snapchat_adsin the destination. Note: Schema names cannot be changed after you save the integration. - If needed, set the following optional parameters:
- Omit Empty: Use this parameter to omit records for a given date or entity if there is no data for any of the metrics. The value can be
trueorfalse. The default value istrue. - Targeting Country Codes: Enter a comma-separated list of lowercase two-letter ISO country codes for ads targeting. The default value is
us. - Swipe Up Attribution Window: Enter the attribution window for swipe-ups. The value can be
1_DAY,7_DAY, or28_DAY. The default value is28_DAY. - View Attribution Window: Enter the attribution window for views. The value can be
1_HOUR,3_HOUR,6_HOUR,1_DAY,7_DAY, or28_DAY. The default value is1_DAY.
- Omit Empty: Use this parameter to omit records for a given date or entity if there is no data for any of the metrics. The value can be
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Snapchat Ads integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Snapchat Ads’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Snapchat Ads integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch
- Next, you’ll be prompted to log into your Snapchat account and approve Stitch’s access to your Snapchat Ads data. Note that we will only ever read your data.
- Click Authorize to connect.
- Sign in with your Snapchat account.
- After your credentials are validated, you’ll be directed back to Stitch and prompted to select the Snapchat Ads accounts you want to for which you want to run extractions.
- When finished, click Check and Save, then click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Snapchat Ads integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Snapchat Ads, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Snapchat Ads table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Snapchat Ads integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
ads
This stream retrieves all Ads under a specified Ad account
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|||
|
ad_squad_id STRING |
|||
|
created_at DATE-TIME |
|||
|
creative_id STRING |
|||
|
id
STRING |
|||
|
name STRING |
|||
|
paying_advertiser_name STRING |
|||
|
render_type STRING |
|||
|
review_status STRING |
|||
|
review_status_reasons
ARRAY |
|||
|
status STRING |
|||
|
third_party_paid_impression_tracking_urls
ARRAY
|
|||
|
third_party_swipe_tracking_urls
ARRAY
|
|||
|
type STRING |
|||
|
updated_at
DATE-TIME |
ad_accounts
This stream retrieves all ad accounts for the specified Organization.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
advertiser STRING |
||||||||
|
advertiser_organization_id STRING |
||||||||
|
agency_client_metadata OBJECT
|
||||||||
|
agency_representing_client STRING |
||||||||
|
billing_type STRING |
||||||||
|
client_based_in_country STRING |
||||||||
|
client_paying_invoices BOOLEAN |
||||||||
|
created_at DATE-TIME |
||||||||
|
currency STRING |
||||||||
|
funding_source_ids
ARRAY |
||||||||
|
id
STRING |
||||||||
|
lifetime_spend_cap_micro INTEGER |
||||||||
|
name STRING |
||||||||
|
organization_id STRING |
||||||||
|
paying_advertiser_name STRING |
||||||||
|
regulations OBJECT
|
||||||||
|
status STRING |
||||||||
|
timezone STRING |
||||||||
|
type STRING |
||||||||
|
updated_at
DATE-TIME |
ad_account_stats_daily
This endpoint retrieves the spend metric for the specified Ad Account at DAY granularity, the spend metric is the only metric available for the ad account entity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
granularity STRING |
|
id
STRING |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
type STRING |
|
view_attribution_window STRING |
ad_account_stats_hourly
This endpoint retrieves the spend metric for the specified Ad Account at HOUR granularity, the spend metric is the only metric available for the ad account entity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
granularity STRING |
|
id
STRING |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
type STRING |
|
view_attribution_window STRING |
ad_squads
This stream retrieves all ad squads within a specified ad account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|||||||
|
auto_bid BOOLEAN |
|||||||
|
bid_micro INTEGER |
|||||||
|
bid_strategy STRING |
|||||||
|
billing_event STRING |
|||||||
|
campaign_id STRING |
|||||||
|
cap_and_exclusion_config OBJECT |
|||||||
|
created_at DATE-TIME |
|||||||
|
daily_budget_micro INTEGER |
|||||||
|
delivery_constraint STRING |
|||||||
|
end_time DATE-TIME |
|||||||
|
id
STRING |
|||||||
|
impression_goal STRING |
|||||||
|
lifetime_budget_micro INTEGER |
|||||||
|
name STRING |
|||||||
|
optimization_goal STRING |
|||||||
|
pacing_type STRING |
|||||||
|
pixel_id STRING |
|||||||
|
placement STRING |
|||||||
|
placement_v2 OBJECT
|
|||||||
|
product_properties OBJECT |
|||||||
|
reach_and_frequency_micro INTEGER |
|||||||
|
reach_and_frequency_status STRING |
|||||||
|
reach_goal STRING |
|||||||
|
start_time DATE-TIME |
|||||||
|
status STRING |
|||||||
|
target_bid BOOLEAN |
|||||||
|
targeting OBJECT
|
|||||||
|
targeting_reach_status STRING |
|||||||
|
type STRING |
|||||||
|
updated_at
DATE-TIME |
ad_squad_stats_daily
This stream retrieves stats for the specified Ad Squad at DAY granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
ad_squad_stats_hourly
This stream retrieves stats for the specified Ad Squad at HOUR granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
ad_stats_daily
This stream retrieves stats for the specified Ad at DAY granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
ad_stats_hourly
This stream retrieves stats for the specified Ad at HOUR granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
audience_segments
This stream retrieves all Customer List segments within a specified ad account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|
approximate_number_users INTEGER |
|
created_at DATE-TIME |
|
description STRING |
|
id
STRING |
|
name STRING |
|
organization_id STRING |
|
retention_in_days INTEGER |
|
source_type STRING |
|
status STRING |
|
targetable_status STRING |
|
updated_at
DATE-TIME |
|
upload_status STRING |
|
visible_to
ARRAY |
billing_centers
Billing Centers allow Businesses to have multiple invoicing locations to choose from. A Billing Center is the contact that will be receiving invoices.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
address_line_1 STRING |
|
administrative_district_level_1 STRING |
|
alternative_email_addresses STRING |
|
country STRING |
|
created_at DATE-TIME |
|
email_address STRING |
|
id
STRING |
|
locality STRING |
|
name STRING |
|
organization_id STRING |
|
postal_code STRING |
|
updated_at
DATE-TIME |
campaigns
This stream retrieves all campaigns within a specified ad account
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|
buy_model STRING |
|
created_at DATE-TIME |
|
daily_budget_micro INTEGER |
|
end_time DATE-TIME |
|
id
STRING |
|
lifetime_spend_cap_micro INTEGER |
|
measurement_spec OBJECT |
|
name STRING |
|
objective STRING |
|
regulations OBJECT |
|
start_time DATE-TIME |
|
status STRING |
|
updated_at
DATE-TIME |
campaign_stats_daily
This stream retrieves stats for the specified Campaign at DAY granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
campaign_stats_hourly
This stream retrieves stats for the specified Campaign at HOUR granularity
|
Key-based Incremental |
|
|
Primary Keys |
id start_time |
|
Replication Key |
end_time |
| Useful links |
|
android_installs INTEGER |
|
android_installs_app INTEGER |
|
android_installs_web INTEGER |
|
attachment_avg_view_time_millis INTEGER |
|
attachment_frequency NUMBER |
|
attachment_impressions INTEGER |
|
attachment_quartile_1 INTEGER |
|
attachment_quartile_2 INTEGER |
|
attachment_quartile_3 INTEGER |
|
attachment_total_view_time_millis INTEGER |
|
attachment_uniques INTEGER |
|
attachment_view_completion INTEGER |
|
avg_screen_time_millis INTEGER |
|
avg_view_time_millis INTEGER |
|
conversion_achievement_unlocked INTEGER |
|
conversion_achievement_unlocked_app INTEGER |
|
conversion_achievement_unlocked_web INTEGER |
|
conversion_ad_click INTEGER |
|
conversion_ad_click_app INTEGER |
|
conversion_ad_click_web INTEGER |
|
conversion_ad_view INTEGER |
|
conversion_ad_view_app INTEGER |
|
conversion_ad_view_web INTEGER |
|
conversion_add_billing INTEGER |
|
conversion_add_billing_app INTEGER |
|
conversion_add_billing_web INTEGER |
|
conversion_add_cart INTEGER |
|
conversion_add_cart_app INTEGER |
|
conversion_add_cart_web INTEGER |
|
conversion_add_to_wishlist INTEGER |
|
conversion_add_to_wishlist_app INTEGER |
|
conversion_add_to_wishlist_web INTEGER |
|
conversion_app_opens INTEGER |
|
conversion_app_opens_app INTEGER |
|
conversion_app_opens_web INTEGER |
|
conversion_complete_tutorial INTEGER |
|
conversion_complete_tutorial_app INTEGER |
|
conversion_complete_tutorial_web INTEGER |
|
conversion_invite INTEGER |
|
conversion_invite_app INTEGER |
|
conversion_invite_web INTEGER |
|
conversion_level_completes INTEGER |
|
conversion_level_completes_app INTEGER |
|
conversion_level_completes_web INTEGER |
|
conversion_list_view INTEGER |
|
conversion_list_view_app INTEGER |
|
conversion_list_view_web INTEGER |
|
conversion_login INTEGER |
|
conversion_login_app INTEGER |
|
conversion_login_web INTEGER |
|
conversion_page_views INTEGER |
|
conversion_page_views_app INTEGER |
|
conversion_page_views_web INTEGER |
|
conversion_purchases INTEGER |
|
conversion_purchases_app INTEGER |
|
conversion_purchases_value INTEGER |
|
conversion_purchases_value_app INTEGER |
|
conversion_purchases_value_web INTEGER |
|
conversion_purchases_web INTEGER |
|
conversion_rate INTEGER |
|
conversion_rate_app INTEGER |
|
conversion_rate_web INTEGER |
|
conversion_reserve INTEGER |
|
conversion_reserve_app INTEGER |
|
conversion_reserve_web INTEGER |
|
conversion_save INTEGER |
|
conversion_save_app INTEGER |
|
conversion_save_web INTEGER |
|
conversion_searches INTEGER |
|
conversion_searches_app INTEGER |
|
conversion_searches_web INTEGER |
|
conversion_share INTEGER |
|
conversion_share_app INTEGER |
|
conversion_share_web INTEGER |
|
conversion_sign_ups INTEGER |
|
conversion_sign_ups_app INTEGER |
|
conversion_sign_ups_web INTEGER |
|
conversion_spend_credits INTEGER |
|
conversion_spend_credits_app INTEGER |
|
conversion_spend_credits_web INTEGER |
|
conversion_start_checkout INTEGER |
|
conversion_start_checkout_app INTEGER |
|
conversion_start_checkout_web INTEGER |
|
conversion_start_trial INTEGER |
|
conversion_start_trial_app INTEGER |
|
conversion_start_trial_web INTEGER |
|
conversion_subscribe INTEGER |
|
conversion_subscribe_app INTEGER |
|
conversion_subscribe_web INTEGER |
|
conversion_view_content INTEGER |
|
conversion_view_content_app INTEGER |
|
conversion_view_content_web INTEGER |
|
custom_event_1 INTEGER |
|
custom_event_1_app INTEGER |
|
custom_event_1_web INTEGER |
|
custom_event_2 INTEGER |
|
custom_event_2_app INTEGER |
|
custom_event_2_web INTEGER |
|
custom_event_3 INTEGER |
|
custom_event_3_app INTEGER |
|
custom_event_3_web INTEGER |
|
custom_event_4 INTEGER |
|
custom_event_4_app INTEGER |
|
custom_event_4_web INTEGER |
|
custom_event_5 INTEGER |
|
custom_event_5_app INTEGER |
|
custom_event_5_web INTEGER |
|
end_time
DATE-TIME |
|
finalized_data_end_time DATE-TIME |
|
frequency NUMBER |
|
granularity STRING |
|
id
STRING |
|
impressions INTEGER |
|
ios_installs INTEGER |
|
ios_installs_app INTEGER |
|
ios_installs_web INTEGER |
|
quartile_1 INTEGER |
|
quartile_2 INTEGER |
|
quartile_3 INTEGER |
|
screen_time_millis INTEGER |
|
spend INTEGER |
|
start_time
DATE-TIME |
|
swipe_up_attribution_window STRING |
|
swipe_up_percent INTEGER |
|
swipes INTEGER |
|
total_installs INTEGER |
|
total_installs_app INTEGER |
|
total_installs_web INTEGER |
|
type STRING |
|
uniques INTEGER |
|
video_views INTEGER |
|
video_views_15s INTEGER |
|
video_views_time_based INTEGER |
|
view_attribution_window STRING |
|
view_completion INTEGER |
|
view_time_millis INTEGER |
creatives
This endpoint retrieves all creatives associated with an ad account
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|
ad_product STRING |
|
ad_to_lens_properties OBJECT |
|
ad_to_message_properties OBJECT |
|
app_install_properties OBJECT |
|
brand_name STRING |
|
call_to_action STRING |
|
collection_properties OBJECT |
|
composite_properties OBJECT |
|
created_at DATE-TIME |
|
deep_link_properties OBJECT |
|
dynamic_render_properties OBJECT |
|
forced_view_eligibility STRING |
|
headline STRING |
|
id
STRING |
|
longform_video_properties OBJECT |
|
name STRING |
|
packaging_status STRING |
|
playback_type STRING |
|
preview_creative_id STRING |
|
preview_properties OBJECT |
|
render_type STRING |
|
review_status STRING |
|
shareable BOOLEAN |
|
top_snap_crop_position STRING |
|
top_snap_media_id STRING |
|
type STRING |
|
updated_at
DATE-TIME |
|
web_view_properties OBJECT |
funding_sources
An Funding Source is owned by an Organization and defines the financial instrument/terms responsible for the ad spend. Funding sources are assigned to an Ad Account in order to pay for the activity within that Ad Account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
available_credit_micro INTEGER |
|
budget_spent_micro INTEGER |
|
card_type STRING |
|
created_at DATE-TIME |
|
currency STRING |
|
daily_spend_limit_currency STRING |
|
daily_spend_limit_micro INTEGER |
|
STRING |
|
end_date DATE-TIME |
|
expiration_month STRING |
|
expiration_year STRING |
|
id
STRING |
|
last_4 STRING |
|
name STRING |
|
organization_id STRING |
|
start_date DATE-TIME |
|
status STRING |
|
total_budget_micro INTEGER |
|
type STRING |
|
updated_at
DATE-TIME |
|
value_micro INTEGER |
media
This stream retrieves all media entities associated with an ad account
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|||
|
created_at DATE-TIME |
|||
|
download_link STRING |
|||
|
file_name STRING |
|||
|
file_size_in_bytes INTEGER |
|||
|
hash STRING |
|||
|
id
STRING |
|||
|
image_metadata OBJECT
|
|||
|
is_demo_media BOOLEAN |
|||
|
lens_package_metadata OBJECT |
|||
|
media_status STRING |
|||
|
name STRING |
|||
|
type STRING |
|||
|
updated_at
DATE-TIME |
|||
|
video_metadata OBJECT |
|||
|
visibility STRING |
members
This stream retrieves the information of all Members of an Organization
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
created_at DATE-TIME |
|
display_name STRING |
|
STRING |
|
id
STRING |
|
member_status STRING |
|
organization_id STRING |
|
updated_at
DATE-TIME |
organizations
This stream retrieves all organizations.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
accepted_term_version STRING |
|
|
address_line_1 STRING |
|
|
administrative_district_level_1 STRING |
|
|
configuration_settings OBJECT
|
|
|
contact_email STRING |
|
|
contact_name STRING |
|
|
contact_phone STRING |
|
|
contact_phone_optin BOOLEAN |
|
|
country STRING |
|
|
created_at DATE-TIME |
|
|
id
STRING |
|
|
locality STRING |
|
|
my_display_name STRING |
|
|
my_invited_email STRING |
|
|
my_member_id STRING |
|
|
name STRING |
|
|
postal_code STRING |
|
|
roles
ARRAY |
|
|
state STRING |
|
|
type STRING |
|
|
updated_at
DATE-TIME |
phone_numbers
This stream retrieves all verified phone numbers for an Ad Account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|
country_code STRING |
|
created_at DATE-TIME |
|
id
STRING |
|
name STRING |
|
numerical_country_code STRING |
|
phone_number STRING |
|
updated_at
DATE-TIME |
|
verification_status STRING |
pixels
This stream retrieves the pixel associated with the specified Ad Account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
ad_account_id STRING |
|
created_at DATE-TIME |
|
effective_status STRING |
|
id
STRING |
|
name STRING |
|
organization_id STRING |
|
pixel_javascript STRING |
|
status STRING |
|
updated_at
DATE-TIME |
|
visible_to
ARRAY |
pixel_domain_stats
This stream retrieves the domains that have fired the pixel in the past 7 days.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
domains
ARRAY
|
||
|
end_time DATE-TIME |
||
|
id
STRING |
||
|
pixel_id STRING |
||
|
start_time DATE-TIME |
||
|
type STRING |
product_catalogs
This stream will retrieve a list of all the catalogs within an organization
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
created_at DATE-TIME |
||
|
default_product_set_id STRING |
||
|
event_sources
ARRAY
|
||
|
id
STRING |
||
|
name STRING |
||
|
organization_id STRING |
||
|
source STRING |
||
|
updated_at
DATE-TIME |
product_sets
This stream will get all the Product Sets within the Catalog.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
catalog_id STRING |
|
created_at DATE-TIME |
|
filter OBJECT |
|
id
STRING |
|
name STRING |
|
updated_at DATE-TIME |
roles
This stream retrieves all Roles assigned within an Organization
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
container_id STRING |
|
container_kind STRING |
|
created_at DATE-TIME |
|
id
STRING |
|
member_id STRING |
|
organization_id STRING |
|
type STRING |
|
updated_at DATE-TIME |
targeting_advanced_demographics
This stream retrieves the list of Advanced Demographics targeting options
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_age_groups
This stream retrieves the list of age group targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_android_versions
This stream retrieves the list of device OS version targeting options. These OS versions can then be used in targeting as os_version_min and os_version_max.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_carriers
This stream retrieves the list of device carrier targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_connection_types
This stream retrieves the list of device connection type targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_countries
This stream retrieves the list of country targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
city OBJECT
|
||||
|
continent OBJECT
|
||||
|
country OBJECT
|
||||
|
country_code STRING |
||||
|
id
STRING |
||||
|
metro OBJECT
|
||||
|
name STRING |
||||
|
parent_id STRING |
||||
|
path STRING |
||||
|
region OBJECT
|
||||
|
source STRING |
||||
|
targeting_group STRING |
||||
|
targeting_type STRING |
targeting_device_makes
This stream retrieves the list of device make targeting options. Please note that specifying a parent level make option like Apple/ in the targeting spec will include all devices of the kind Apple/* like Apple/iPad (3rd Gen)/, Apple/iPhone 4/, Apple/iPhone 7 Plus/ etc.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_genders
This stream retrieves the list of gender targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_dlxc
This stream retrieves the list of Oracle Datalogix DLXC targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_dlxp
This stream retrieves the list of Oracle Datalogix DLXP targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_dlxs
This stream retrieves the list of Oracle Datalogix DLXS Interests targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_nln
This stream retrieves the list of Nielsen interest targeting options
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_plc
This stream retrieves the list of placed visitation segments targeting options by the specified country code
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_interests_scls
This stream retrieves the list of Snap Lifestyle Categories targeting options by the specified country code
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_ios_versions
This stream retrieves the list of device OS version targeting options. These OS versions can then be used in targeting as os_version_min and os_version_max.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_languages
This stream retrieves the list of language targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_location_categories
Location targeting allows an advertiser to target users based on their location.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_metros
This stream retrieves the list of metro/dma targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
city OBJECT
|
||||
|
continent OBJECT
|
||||
|
country OBJECT
|
||||
|
country_code STRING |
||||
|
id
STRING |
||||
|
metro OBJECT
|
||||
|
name STRING |
||||
|
parent_id STRING |
||||
|
path STRING |
||||
|
region OBJECT
|
||||
|
source STRING |
||||
|
targeting_group STRING |
||||
|
targeting_type STRING |
targeting_os_types
This stream retrieves the list of device OS type targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
country_code STRING |
|
id
STRING |
|
name STRING |
|
parent_id STRING |
|
path STRING |
|
source STRING |
|
targeting_group STRING |
|
targeting_type STRING |
targeting_postal_codes
This stream retrieves the list of zipcode targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
city OBJECT
|
||||
|
continent OBJECT
|
||||
|
country OBJECT
|
||||
|
country_code STRING |
||||
|
id
STRING |
||||
|
metro OBJECT
|
||||
|
name STRING |
||||
|
parent_id STRING |
||||
|
path STRING |
||||
|
region OBJECT
|
||||
|
source STRING |
||||
|
targeting_group STRING |
||||
|
targeting_type STRING |
targeting_regions
This stream retrieves the list of region/state targeting options.
|
Full Table |
|
|
Primary Key |
id |
| Useful links |
|
city OBJECT
|
||||
|
continent OBJECT
|
||||
|
country OBJECT
|
||||
|
country_code STRING |
||||
|
id
STRING |
||||
|
metro OBJECT
|
||||
|
name STRING |
||||
|
parent_id STRING |
||||
|
path STRING |
||||
|
region OBJECT
|
||||
|
source STRING |
||||
|
targeting_group STRING |
||||
|
targeting_type STRING |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.