The CData Sync App provides a straightforward way to continuously pipeline your Snapchat Ads data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Snapchat Ads connector can be used from the CData Sync application to pull data from Snapchat Ads and move it to any of the supported destinations.
The Sync App leverages the Snapchat Ads API to enable bidirectional access to Snapchat Ads.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
To simplify routine queries, you can also set AccountId to provide a default AccountId. This eliminates the need to provide it manually as part of the WHERE clause. (If the AccountId is not specified and no account ID is explicitly supplied in the WHERE clause, the Sync App looks for the first account from the list returned by the Accounts view.)
The following subsections describe how to authenticate to Snapchat Ads from three common authentication flows:
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Snapchat Ads, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Snapchat Ads Sync App.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
| Scope | Description |
| System | List views and columns. Required for read access. |
| Tenant Non-Configurable | Access and execute reports as a service. |
| Snapchat Ads Owned Scope | Include items or components owned and managed by Snapchat Ads. Required for read access. |
This section details a selection of advanced features of the Snapchat Ads Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Snapchat Ads APIs.
Views describes the available views. Views are statically defined to model Categories, OrderLineItems, and more.
Tables describes the available tables. Tables are statically defined to model Customers, Orders, Refunds.
Stored Procedures are function-like interfaces to Snapchat Ads. Stored procedures allow you to execute operations to Snapchat Ads, including calculating sales tax and validating addresses.
The Sync App models the data in Snapchat Ads as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Accounts | Lists all the ad accounts for the specified Organization. |
| AudienceSegments | Lists all Snap Audience Match segments within a specified ad account. |
| BillingCenters | Lists all the billing centers for the specified Organization. |
| Campaigns | Lists all campaigns within a specified ad account. |
| Members | Lists all members for a specific organization. |
Lists all the ad accounts for the specified Organization.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Accounts WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Accounts WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Accounts WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
SELECT * FROM Accounts WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-28d2-40f8-982b-c353c67934cb')
INSERT INTO Accounts (Name, Type, OrganizationId, Currency, TimeZone, BillingType, BillingCenterId, RestrictedDeliverySignalsRegulation, AgencyRepresentingClient, ClientPayingInvoices, Test, FundingSourceIds, ClientBasedInCountry, AgencyClientName, AgencyClientEmail, AgencyClientAddressLine1, AgencyClientCity, AgencyClientAdministrativeDistrictLevel1, AgencyClientCountry, AgencyClientZipCode, AgencyClientTaxId) VALUES ('delicieux aliments pour chiens', 'PARTNER', 'ca67fb1a-2653-495d-9446-c9e8a30f6232', 'EUR', 'Europe/Paris', 'REVOLVING', '6e0f4532-3702-4f0b-9889-9fe5d0614afd', false, true, false, true, '["5ca1687a-f2b4-437d-8554-a85403a714c5"]', 'FR', 'Madamemoiselle Poodle', '[email protected]', '101 Boulevard la Fayette', 'Paris', 'FR-O', 'FR', '62100', 'FR12345678900')
UPDATE Accounts SET Name = 'Updated name', AgencyClientName = 'Updated agency client name' WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
ID of the AD account. | |
| OrganizationId | String | False |
The ID of the organization. | |
| Advertiser | String | False |
Name of the Advertiser. | |
| Currency | String | False |
Account currency. The allowed values are AUD, CAD, EUR, GBP, USD. | |
| FundingSourceIds | String | False |
Array of Funding Source IDs. | |
| BillingType | String | False |
Type of billing. The allowed values are IO, REVOLVING. | |
| BillingCenterId | String | False |
The billing center ID. | |
| Name | String | False |
Account name. | |
| Test | Bool | False |
Indicates Ad Account is a test ad account, test ad accounts can never serve live ads. | |
| CreatedAt | Datetime | False |
The creation date of the entity. | |
| UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
| Timezone | String | False |
Account timezone, remember to take the time differences into account when you set up your application. The allowed values are Africa/Cairo, Africa/Johannesburg, America/Anchorage, America/Cancun, America/Chicago, America/Dawson, America/Dawson_Creek, America/Denver, America/Edmonton, America/Halifax, America/Hermosillo, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Montevideo, America/New_York, America/Phoenix, America/Rainy_River, America/Regina, America/Tijuana, America/Toronto, America/Vancouver, Asia/Amman, Asia/Beirut, Asia/Dubai, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jerusalem, Asia/Kamchatka, Asia/Krasnoyarsk, Asia/Magadan, Asia/Nicosia, Asia/Omsk, Asia/Qatar, Asia/Riyadh, Asia/Shanghai, Asia/Singapore, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Atlantic/Canary, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Berlin, Europe/Brussels, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Rome, Europe/Samara, Europe/Stockholm, Europe/Vienna, Europe/Vilnius, Europe/Warsaw, Europe/Zurich, Pacific/Auckland, Pacific/Honolulu, UTC. | |
| Type | String | False |
Account type. The allowed values are DIRECT, PARTNER. | |
| Status | String | False |
Account status. | |
| LifetimeSpendCap | Decimal | False |
Required if BillingType is set to IO, the lifetime spend cap of the account. | |
| AdvertiserOrganizationId | String | True |
Organization ID of the Advertiser selected. | |
| PayingAdvertiserName | String | False |
Name of the paying advertiser/political entity, required if the Ad Account will contain political/advocacy ads. | |
| RestrictedDeliverySignalsRegulation | String | False |
Required if the Ad Account will contain ads for Credit, Housing or Employment, this attribute is immutable once set to true. | |
| AgencyRepresentingClient | Bool | False |
Whether the agency is representing a client or not. | |
| ClientBasedInCountry | String | False |
Required if AgencyRepresentingClient is true and if Advertiser is based in France or targeting Ads to audiences in France. The allowed values are FR. | |
| ClientPayingInvoices | Bool | False |
Required if AgencyRepresentingClient is true and if Advertiser is based in France or targeting Ads to audiences in France. | |
| DeliveryStatus | String | True |
Delivery status. | |
| AgencyClientName | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientEmail | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientAddressLine1 | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientCity | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientAdministrativeDistrictLevel1 | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientCountry | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientZipCode | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. | |
| AgencyClientTaxId | String | False |
Client metadata is required if AgencyRepresentingClient is true and if the Advertiser is based in France or is targeting Ads to audiences in France. |
Lists all Snap Audience Match segments within a specified ad account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AudienceSegments WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM AudienceSegments WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM AudienceSegments WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM AudienceSegments WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')
INSERT INTO AudienceSegments (Name, Description, SourceType, RetentionInDays, AccountId) VALUES ('all the sams in the world', 'all the sams in the world', 'FIRST_PARTY', 180, '422588db-75f3-47d1-be3b-92e296d33f68')
UPDATE AudienceSegments SET Name = 'Updated name', Description = 'Updated description', RetentionInDays = 60 WHERE Id = '5689640350646272'
DELETE AudienceSegments WHERE Id = '4873877536079576'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
ID of the audience segment. | |
| AccountId | String | False |
Accounts.Id |
Ad Account ID. |
| Description | String | False |
Audience Segment Description. | |
| Name | String | False |
Audience Segment name. | |
| CreatedAt | Datetime | False |
The creation date of the entity. | |
| UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
| RetentionInDays | Int | False |
Number of days to retain audience members. The default value is 9999. | |
| SourceType | String | False |
Data source type. The allowed values are FIRST_PARTY, ENGAGEMENT, PIXEL, MOBILE, FOOT_TRAFFIC_INSIGHTS. | |
| ApproximateNumberUsers | Int | True |
Approximate number of users in the segment. | |
| Status | String | True |
Status of the segment. | |
| UploadStatus | String | True |
Upload status of the segment. The allowed values are NO_UPLOAD, PROCESSING, COMPLETE. | |
| TargetableStatus | String | True |
Status of whether this segment can be targeted. The allowed values are NOT_READY, TOO_FEW_USERS, READY. |
Lists all the billing centers for the specified Organization.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM BillingCenters WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM BillingCenters WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM BillingCenters WHERE Id = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM BillingCenters WHERE Id IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '9f7c-a1d5-4579-9f7c-331deb8082b8')
INSERT INTO BillingCenters (OrganizationId, Name, EmailAddress, AddressLine1, Locality, AdministrativeDistrictLevel1, Country, PostalCode, AlternativeEmailAddresses) VALUES ('ca67fb1a-2653-495d-9446-c9e8a30f6232', 'Kianjous Billing Center', '[email protected]', '10 Honey Bear Road', 'London', 'GB-LND', 'GB', 'NW1 4RY', '["[email protected]"]')
UPDATE BillingCenters SET Name = 'Updated Billing Center Name' WHERE Id = '19247038-c858-4802-b786-40c162228e18'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
ID of the billing center. | |
| OrganizationId | String | False |
The ID of the organization. | |
| Name | String | False |
Name of the Billing Center. | |
| CreatedAt | Datetime | False |
The creation date of the entity. | |
| UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
| EmailAddress | String | False |
Email address. | |
| AddressLine1 | String | False |
Address line 1. | |
| Locality | String | False |
Locality. | |
| AdministrativeDistrictLevel1 | String | False |
District. | |
| Country | String | False |
Country. | |
| PostalCode | String | False |
Post code. | |
| AlternativeEmailAddresses | String | False |
Array of email addresses. |
Lists all campaigns within a specified ad account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Campaigns WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM Campaigns WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Campaigns WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'
SELECT * FROM Campaigns WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb', 'c353c67934cb-5f433224-28d2-40f8-982b')
INSERT INTO Campaigns (Name, AccountId, Status, StartTime, RegulationsRestrictedDeliverySignals, MeasurementSpecIOSAppId, MeasurementSpecAndroidAppURL) VALUES ('Cool Campaign', '422588db-75f3-47d1-be3b-92e296d33f68', 'PAUSED', '2016-08-11 22:03:58.869', true, '1234', 'com.snapchatads.android')
UPDATE Campaigns SET Name = 'Cool Campaign (Updated)', RegulationsRestrictedDeliverySignals = false WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'
DELETE Campaigns WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Campaign ID. | |
| AccountId | String | False |
Accounts.Id |
Ad Account ID. |
| DailyBudget | Decimal | False |
Daily Spend Cap. | |
| EndTime | Datetime | False |
End time. | |
| Name | String | False |
Campaign name. | |
| CreatedAt | Datetime | False |
The creation date of the entity. | |
| UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
| StartTime | Datetime | False |
Start time. | |
| Status | String | False |
Campaign status. The allowed values are ACTIVE, PAUSED. | |
| LifetimeSpendCap | Decimal | False |
Lifetime spend cap for the campaign. | |
| MeasurementSpecIOSAppId | String | False |
The IOS app to be tracked for this campaign. | |
| MeasurementSpecAndroidAppURL | String | False |
The Android app to be tracked for this campaign. | |
| Objective | String | False |
[DEPRECATED] Objective of the Campaign. The field is deprecated. Use ObjectiveType and PromotionType for creating records instead. The default value is BRAND_AWARENESS. | |
| ObjectiveType | String | False |
Objective type of the Campaign. The default value is AWARENESS_AND_ENGAGEMENT. | |
| PromotionType | String | False |
Promotion type of the Campaign. | |
| RegulationsRestrictedDeliverySignals | Bool | False |
Required for Campaigns that run Ads for Credit, Housing, Employment (CHE). | |
| RegulationsCandidateBallotInformation | String | False |
The candidate / ballot field is optional, but may be required in certain states. | |
| DeliveryStatus | String | True |
Delivery status. |
Lists all members for a specific organization.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Members WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM Members WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Members WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM Members WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')
INSERT INTO Members (OrganizationId, Email, DisplayName) VALUES ('ca67fb1a-2653-495d-9446-c9e8a30f6232', '[email protected]', 'Member 0')
UPDATE Members SET DisplayName = 'Member 0 (Updated Name)' WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'
DELETE Members WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
Member Id. | |
| OrganizationId | String | False |
The ID of the organization. | |
| DisplayName | String | False |
Name of the user. | |
| CreatedAt | Datetime | False |
The creation date of the entity. | |
| UpdatedAt | Datetime | False |
The date when the entity was last updated. | |
| MemberStatus | String | False |
Name of the Advertiser. The allowed values are INVITED, MEMBER. | |
| String | False |
Email address of the user. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AccountStats | Lists the spend metric for the specified Ad Account. |
| Ads | Lists all ads within a specified ad account. |
| AdSquads | Lists all ad squads within a specified ad account. |
| AdSquadStats | Lists all ad squad stats. |
| AdStats | Lists all ad stats. |
| AdvancedDemographics | Lists all Advanced Demographics targeting options. |
| AudienceInsights | Lists all audience insights based on the targeting options. |
| CampaignStats | Lists all campaign stats. |
| Creatives | Retrieves all creatives associated with an ad account |
| DemographicsAgeGroups | Lists all age group targeting options. |
| DemographicsGender | Lists all gender targeting options. |
| DemographicsLanguages | Lists all language targeting options. |
| DeviceCarriers | Lists all device carrier targeting options. |
| DeviceConnectionTypes | Lists all device connection type targeting options. |
| DeviceMakes | Lists all device make targeting options. |
| DeviceOSTypes | Lists all device OS type targeting options. |
| DeviceOSVersions | Lists all device OS version targeting options. |
| FundingSources | Lists all funding sources for the specified Organization. |
| GeolocationCountries | Lists all country targeting options. |
| GeolocationMetros | Lists all metro/dma targeting options. |
| GeolocationRegions | Lists all region/state targeting options. |
| GeolocationZipCodes | Lists all of zipcode targeting options. |
| Invoices | Lists all invoices for a given Ad Account. |
| LocationCategories | Lists all location categories. |
| NielsenInterests | Lists all Nielsen Interests targeting options. |
| Organizations | Lists all the organizations where the authenticated user has access. |
| PlacedVisitationSegmentsInterests | Lists all interest targeting based on Placed Visitation Segments. |
| SnapLifeStyleCategoriesInterests | Lists all Snap Lifestyle Categories targeting options. |
Lists the spend metric for the specified Ad Account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AccountStats WHERE StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AccountStats WHERE Granularity = 'LIFETIME' AND AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
Note: If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.
| Name | Type | References | Description |
| AccountId | String | The Id of the entity to query. | |
| StartTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| EndTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| FinalizedDataEndTime | Datetime | This defines the time up until when reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly. | |
| IntervalStartTime | Datetime | Start time of the current interval. This applies only to Granularity DAY and HOUR. | |
| IntervalEndTime | Datetime | End time of the current interval. This applies only to Granularity DAY and HOUR. | |
| Granularity | String | Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.
The allowed values are LIFETIME, TOTAL, DAY, HOUR. The default value is DAY. | |
| Spend | Decimal | Amount Spent. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| RetrieveSampleStats | Bool | Whether to return sample (fake) stats or not. |
Lists all ads within a specified ad account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Ads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM Ads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Ads WHERE AdSquadId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM Ads WHERE AdSquadId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
SELECT * FROM Ads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM Ads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-8f19507f6bdd-69b96ded-4871-4750')
| Name | Type | References | Description |
| Id [KEY] | String | ID of the ad. | |
| AccountId | String |
Accounts.Id | Ad Account ID. |
| AdSquadId | String |
AdSquads.Id | Ad Squad ID. |
| CreativeId | String | Creative ID. | |
| Name | String | Ad name. | |
| CreatedAt | Datetime | The creation date of the entity. | |
| UpdatedAt | Datetime | The date when the entity was last updated. | |
| PayingAdvertiserName | String | Name of the paying advertiser/political entity. | |
| ReviewStatus | String | Ad Review Status.
The allowed values are PENDING, APPROVED, REJECTED. | |
| ReviewStatusReason | String | List of Ad Review Rejection Reasons. | |
| Status | String | Ad status.
The allowed values are ACTIVE, PAUSED. | |
| Type | String | Ad type.
The allowed values are SNAP_AD, LONGFORM_VIDEO, APP_INSTALL, REMOTE_WEBPAGE, DEEP_LINK, STORY, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, FILTER, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, LENS_LONGFORM_VIDEO, COLLECTION. | |
| DeliveryStatus | String | Delivery status. |
Lists all ad squads within a specified ad account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AdSquads WHERE AccountId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM AdSquads WHERE AccountId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM AdSquads WHERE CampaignId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM AdSquads WHERE CampaignId IN ('2e8231d37-a1d5-4579-9f7c-331deb8082b8', 'ads2345-a1d5-4579-9f7c-2e874d37')
SELECT * FROM AdSquads WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM AdSquads WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '8f19507f6bdd-69b96ded-4871-4750-83ba')
| Name | Type | References | Description |
| Id [KEY] | String | ID of the ad squad. | |
| AccountId | String |
Accounts.Id | Ad account ID. |
| CampaignId | String |
Campaigns.Id | Campaign ID. |
| Bid | Decimal | Max Bid. | |
| BillingEvent | String | Billing Event. | |
| DailyBudget | Decimal | Daily Budget. | |
| LifetimeBudget | Decimal | Lifetime budget. | |
| EndTime | Datetime | End time. | |
| Name | String | Ad Squad name. | |
| CreatedAt | Datetime | The creation date of the entity. | |
| UpdatedAt | Datetime | The date when the entity was last updated. | |
| OptimizationGoal | String | Optimization Goal.
The allowed values are IMPRESSIONS, SWIPES, APP_INSTALLS, VIDEO_VIEWS, VIDEO_VIEWS_15_SEC, USES, STORY_OPENS, PIXEL_PAGE_VIEW, PIXEL_ADD_TO_CART, PIXEL_PURCHASE, PIXEL_SIGNUP, APP_ADD_TO_CART, APP_PURCHASE, APP_SIGNUP. | |
| ConversionWindow | String | Conversion window optimization, requires optimization_goal is one of APP_INSTALLS, APP_PURCHASE, APP_SIGNUP, APP_ADD_TO_CART, APP_REENGAGE_OPEN.
The allowed values are SWIPE_28DAY_VIEW_1DAY, SWIPE_7D. | |
| Placement | String | Placement. | |
| StartTime | Datetime | Start time. | |
| Status | String | Ad Squad status.
The allowed values are ACTIVE, PAUSED. | |
| Targeting | String | Targeting spec. | |
| Type | String | Ad Squad Type.
The allowed values are SNAP_ADS, LENS, FILTER. | |
| CapAndExclusionConfig | String | The frequency cap and exclusion spec. | |
| AdSchedulingConfig | String | The schedule for running ads. | |
| BidStrategy | String | Bidding strategy for this Ad Squad.
The allowed values are AUTO_BID, LOWEST_COST_WITH_MAX_BID, MIN_ROAS, TARGET_COST. | |
| RoasValue | Decimal | The desired ROAS used with the MIN_ROAS BidStrategy. | |
| PixelId | String | Pixel to be associated with the Ad Squad. | |
| MeasurementProviderNames | String | approved measurement provider.
The allowed values are MOAT_SS, DOUBLEVERIFY. | |
| DeliveryConstraint | String | Type of delivery. | |
| PacingType | String | Type of pacing.
The allowed values are STANDARD, ACCELERATED. The default value is STANDARD. | |
| DeliveryStatus | String | Delivery status. |
Lists all ad squad stats.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM AdSquadStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM AdSquadStats WHERE AdSquadId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'
Note: You must specify either CampaignId or AdSquadId. If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.
If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.
| Dimension | Dimension Category |
| Country | geos |
| Region | geos |
| DMA | geos |
| Gender | demographics |
| Age | demographics |
| InterestCategoryId | interests |
| InterestCategoryName | interests |
| OS | devices |
| Make | devices |
| Name | Type | References | Description |
| CampaignId | String |
Campaigns.Id | The campaign Id. |
| AdSquadId | String |
AdSquads.Id | The ad squad id. |
| StartTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| EndTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| FinalizedDataEndTime | Datetime | This defines the time up until when reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly. | |
| IntervalStartTime | Datetime | Start time of the current interval. This applies only to Granularity DAY and HOUR. | |
| IntervalEndTime | Datetime | End time of the current interval. This applies only to Granularity DAY and HOUR. | |
| Granularity | String | Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime. | |
| Dimension | String | You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined. | |
| SwipeUpAttributionWindow | String | Attribution window for swipe ups. | |
| ViewAttributionWindow | String | Attribution window for views. | |
| Country | String | ISO country code. | |
| Region | String | Region. | |
| DMA | Int | DMA numeric code. | |
| Gender | String | Gender. | |
| Age | String | Age bucket. | |
| InterestCategoryId | String | SnapchatAds User Lifestyle Interest Category Id. | |
| InterestCategoryName | String | SnapchatAds User Lifestyle Interest Category Name. | |
| OS | String | Device Operating System. | |
| Make | String | Device Make (e.g., Apple, Samsung) | |
| Impressions | Int | Impression Count. | |
| Swipes | Int | Swipe-Up Count. | |
| ViewTimeMillis | Long | Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds). | |
| ScreenTimeMillis | Long | Total Time Spent on top Snap Ad (milliseconds). | |
| Quartile1 | Int | Video Views to 25%. | |
| Quartile2 | Int | Video Views to 50%. | |
| Quartile3 | Int | Video Views to 75%. | |
| ViewCompletion | Int | Video Views to completion. | |
| Spend | Decimal | Amount Spent. | |
| VideoViews | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds of consecutive watch time or a swipe up action on the Top Snap. | |
| AndroidInstalls | Int | Number of Android App Installs. | |
| AndroidInstallsApp | Int | Number of Android App Installs. | |
| AndroidInstallsWeb | Int | Number of Android App Installs. | |
| AndroidInstallsSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsAppSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsWebSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsView | Int | Number of Android App Installs. | |
| AndroidInstallsAppView | Int | Number of Android App Installs. | |
| AndroidInstallsWebView | Int | Number of Android App Installs. | |
| AttachmentAvgViewTimeMillis | Long | Average Attachment View Time (milli-seconds). | |
| AttachmentFrequency | Double | Average number of Attachment Views per User Reached. | |
| AttachmentQuartile1 | Int | Long Form Video Views to 25%. | |
| AttachmentQuartile2 | Int | Long Form Video Views to 50%. | |
| AttachmentQuartile3 | Int | Long Form Video Views to 75%. | |
| AttachmentTotalViewTimeMillis | Long | Total Attachment View Time (milli-seconds). | |
| AttachmentUniques | Int | Number of unique attachment impressions. | |
| AttachmentViewCompletion | Int | Long Form Video Views to completion. | |
| AttachmentVideoViews | Int | Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration. | |
| AvgViewTimeMillis | Long | Use avg_screen_time_millis instead. Average Top Snap view time per User Reached. | |
| AvgScreenTimeMillis | Long | Average Top Snap view time across all impressions. | |
| Frequency | Double | Average number of Impressions per User Reached. | |
| IosInstalls | Int | Number of iOS App Installs. | |
| IosInstallsApp | Int | Number of iOS App Installs. | |
| IosInstallsWeb | Int | Number of iOS App Installs. | |
| IosInstallsSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsAppSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsWebSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsView | Int | Number of iOS App Installs. | |
| IosInstallsAppView | Int | Number of iOS App Installs. | |
| IosInstallsWebView | Int | Number of iOS App Installs. | |
| SwipeUpPercent | Double | % of Impressions that Swiped-Up. | |
| TotalInstalls | Int | Total number of App Installs. | |
| TotalInstallsApp | Int | Total number of App Installs. | |
| TotalInstallsWeb | Int | Total number of App Installs. | |
| TotalInstallsSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsAppSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsWebSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsView | Int | Total number of App Installs. | |
| TotalInstallsAppView | Int | Total number of App Installs. | |
| TotalInstallsWebView | Int | Total number of App Installs. | |
| Uniques | Int | Number of unique impressions. | |
| VideoViewsTimeBased | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups. | |
| VideoViews15s | Int | The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it?s shorter than 15 seconds, or a swipe up action on the ad. | |
| StoryOpens | Int | Number of times users tapped on the ad tile in the feed to view the Story Ad. | |
| StoryCompletes | Int | Number of times users viewed through to the last Snap of your Story Ad. | |
| PositionImpressions | Int | The impression number for this story ad position. | |
| PositionUniques | Int | The unique viewer numbers for this story ad position. | |
| PositionFrequency | Double | The frequency for this story ad position. | |
| PositionScreenTimeMillis | Long | The total view time in milliseconds for this story ad position. | |
| PositionSwipeUpPercent | Double | The swipe up rate for this story ad position. | |
| AvgPositionScreenTimeMillis | Long | The average view time for this story ad position. | |
| Shares | Int | Number of times lens/filter was shared in a Chat or Story. | |
| Saves | Int | Number of times lens/filter was saved to Memories. | |
| ConversionPurchases | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValue | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSave | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckout | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCart | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContent | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBilling | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUps | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearches | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletes | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpens | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViews | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribe | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClick | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorial | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInvite | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLogin | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShare | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserve | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlocked | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlist | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCredits | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRate | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrial | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1 | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2 | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3 | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4 | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5 | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1View | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2View | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3View | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4View | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5View | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesApp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueApp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveApp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutApp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartApp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentApp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingApp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsApp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesApp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesApp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensApp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsApp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeApp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickApp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewApp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialApp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteApp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginApp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareApp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveApp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedApp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistApp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsApp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateApp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialApp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewApp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1App | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2App | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3App | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4App | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5App | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWeb | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWeb | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWeb | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWeb | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWeb | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWeb | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWeb | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWeb | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWeb | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWeb | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWeb | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWeb | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWeb | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWeb | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWeb | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWeb | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWeb | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWeb | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWeb | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWeb | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWeb | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWeb | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWeb | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWeb | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWeb | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWeb | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1Web | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2Web | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3Web | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4Web | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5Web | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ConversionSourceTypes | String | Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total' | |
| RetrieveSampleStats | Bool | Whether to return sample (fake) stats or not. |
Lists all ad stats.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND BreakDownMetricsByPosition = true
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM AdStats WHERE CampaignId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND BreakDownMetricsByPosition = true
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM AdStats WHERE AdId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'
SELECT * FROM AdStats WHERE AccountId IN ('68053bcd-675c-4dc7-a622-dc2ca218dcfe', '77553bcd-675c-4dc7-a622-dc2ca218dcag');
Note: You must specify either CampaignId, AdId or AccountId. When the AccountId filter is applied, the driver first retrieves the CampaignIds linked to that AccountId. It then retrieves and displays the statistics for each CampaignId. If a time window is not specified, the stats for the last seven days or the last 31 days are returned based on the specified granularity.
If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.
| Dimension | Dimension Category |
| Country | geos |
| Region | geos |
| DMA | geos |
| Gender | demographics |
| Age | demographics |
| InterestCategoryId | interests |
| InterestCategoryName | interests |
| OS | devices |
| Make | devices |
| Name | Type | References | Description |
| CampaignId | String |
Campaigns.Id | The campaign Id. |
| AdId | String |
Ads.Id | The ad id. |
| AccountId | String |
Accounts.Id | The account id. |
| PlatformPosition | String | The platform position. | |
| StartTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| EndTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| FinalizedDataEndTime | Datetime | This defines the time up until when reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly. | |
| IntervalStartTime | Datetime | Start time of the current interval. This applies only to Granularity DAY and HOUR. | |
| IntervalEndTime | Datetime | End time of the current interval. This applies only to Granularity DAY and HOUR. | |
| Granularity | String | Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime. | |
| Dimension | String | You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined. | |
| SwipeUpAttributionWindow | String | Attribution window for swipe ups. | |
| ViewAttributionWindow | String | Attribution window for views. | |
| Country | String | ISO country code. | |
| Region | String | Region. | |
| DMA | Int | DMA numeric code. | |
| Gender | String | Gender. | |
| Age | String | Age bucket. | |
| InterestCategoryId | String | SnapchatAds User Lifestyle Interest Category Id. | |
| InterestCategoryName | String | SnapchatAds User Lifestyle Interest Category Name. | |
| OS | String | Device Operating System. | |
| Make | String | Device Make (e.g., Apple, Samsung) | |
| Impressions | Int | Impression Count. | |
| Swipes | Int | Swipe-Up Count. | |
| ViewTimeMillis | Long | Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds). | |
| ScreenTimeMillis | Long | Total Time Spent on top Snap Ad (milliseconds). | |
| Quartile1 | Int | Video Views to 25%. | |
| Quartile2 | Int | Video Views to 50%. | |
| Quartile3 | Int | Video Views to 75%. | |
| ViewCompletion | Int | Video Views to completion. | |
| Spend | Decimal | Amount Spent. | |
| VideoViews | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds of consecutive watch time or a swipe up action on the Top Snap. | |
| AndroidInstalls | Int | Number of Android App Installs. | |
| AndroidInstallsApp | Int | Number of Android App Installs. | |
| AndroidInstallsWeb | Int | Number of Android App Installs. | |
| AndroidInstallsSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsAppSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsWebSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsView | Int | Number of Android App Installs. | |
| AndroidInstallsAppView | Int | Number of Android App Installs. | |
| AndroidInstallsWebView | Int | Number of Android App Installs. | |
| AttachmentAvgViewTimeMillis | Long | Average Attachment View Time (milli-seconds). | |
| AttachmentFrequency | Double | Average number of Attachment Views per User Reached. | |
| AttachmentQuartile1 | Int | Long Form Video Views to 25%. | |
| AttachmentQuartile2 | Int | Long Form Video Views to 50%. | |
| AttachmentQuartile3 | Int | Long Form Video Views to 75%. | |
| AttachmentTotalViewTimeMillis | Long | Total Attachment View Time (milli-seconds). | |
| AttachmentUniques | Int | Number of unique attachment impressions. | |
| AttachmentViewCompletion | Int | Long Form Video Views to completion. | |
| AttachmentVideoViews | Int | Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration. | |
| AvgViewTimeMillis | Long | Use avg_screen_time_millis instead. Average Top Snap view time per User Reached. | |
| AvgScreenTimeMillis | Long | Average Top Snap view time across all impressions. | |
| Frequency | Double | Average number of Impressions per User Reached. | |
| IosInstalls | Int | Number of iOS App Installs. | |
| IosInstallsApp | Int | Number of iOS App Installs. | |
| IosInstallsWeb | Int | Number of iOS App Installs. | |
| IosInstallsSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsAppSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsWebSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsView | Int | Number of iOS App Installs. | |
| IosInstallsAppView | Int | Number of iOS App Installs. | |
| IosInstallsWebView | Int | Number of iOS App Installs. | |
| SwipeUpPercent | Double | % of Impressions that Swiped-Up. | |
| TotalInstalls | Int | Total number of App Installs. | |
| TotalInstallsApp | Int | Total number of App Installs. | |
| TotalInstallsWeb | Int | Total number of App Installs. | |
| TotalInstallsSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsAppSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsWebSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsView | Int | Total number of App Installs. | |
| TotalInstallsAppView | Int | Total number of App Installs. | |
| TotalInstallsWebView | Int | Total number of App Installs. | |
| Uniques | Int | Number of unique impressions. | |
| VideoViewsTimeBased | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups. | |
| VideoViews15s | Int | The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it?s shorter than 15 seconds, or a swipe up action on the ad. | |
| StoryOpens | Int | Number of times users tapped on the ad tile in the feed to view the Story Ad. | |
| StoryCompletes | Int | Number of times users viewed through to the last Snap of your Story Ad. | |
| PositionImpressions | Int | The impression number for this story ad position. | |
| PositionUniques | Int | The unique viewer numbers for this story ad position. | |
| PositionFrequency | Double | The frequency for this story ad position. | |
| PositionScreenTimeMillis | Long | The total view time in milliseconds for this story ad position. | |
| PositionSwipeUpPercent | Double | The swipe up rate for this story ad position. | |
| AvgPositionScreenTimeMillis | Long | The average view time for this story ad position. | |
| Shares | Int | Number of times lens/filter was shared in a Chat or Story. | |
| Saves | Int | Number of times lens/filter was saved to Memories. | |
| ConversionPurchases | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValue | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSave | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckout | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCart | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContent | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBilling | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUps | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearches | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletes | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpens | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViews | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribe | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClick | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorial | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInvite | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLogin | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShare | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserve | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlocked | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlist | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCredits | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRate | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrial | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1 | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2 | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3 | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4 | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5 | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1View | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2View | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3View | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4View | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5View | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesApp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueApp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveApp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutApp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartApp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentApp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingApp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsApp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesApp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesApp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensApp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsApp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeApp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickApp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewApp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialApp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteApp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginApp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareApp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveApp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedApp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistApp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsApp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateApp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialApp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewApp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1App | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2App | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3App | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4App | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5App | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWeb | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWeb | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWeb | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWeb | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWeb | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWeb | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWeb | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWeb | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWeb | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWeb | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWeb | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWeb | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWeb | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWeb | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWeb | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWeb | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWeb | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWeb | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWeb | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWeb | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWeb | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWeb | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWeb | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWeb | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWeb | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWeb | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1Web | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2Web | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3Web | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4Web | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5Web | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| BreakDownMetricsByPosition | String | Whether to break down metrics by position or not. | |
| ConversionSourceTypes | String | Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total' | |
| RetrieveSampleStats | Bool | Whether to return sample (fake) stats or not. |
Lists all Advanced Demographics targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM AdvancedDemographics
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the target option. | |
| Name | String | The name of the target option. | |
| Path | String | The path of the target option. | |
| Source | String | The source of the target option. |
Lists all audience insights based on the targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'
SELECT * FROM AudienceInsights WHERE AccountId = '40b748fb-d16f-4b2a-8d63-a3547d01ba57' AND DimensionCategory = 'demo' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'
Note: AccountId, BaseSpecCountryCode and TargetingSpecCountryCode are required. OR logical operator and NOT clause are supported server side. Targeting options must be grouped based on the dimension category.
| Targeting Option | Dimension Category |
| AgeGroup | demographics |
| MinAge | demographics |
| MaxAge | demographics |
| Gender | demographics |
| Language | demographics |
| AdvancedDemographics | demographics |
| DeviceConnectionType | devices |
| DeviceOSType | devices |
| DeviceOSVersionMin | devices |
| DeviceOSVersionMax | devices |
| DeviceCarrierId | devices |
| DeviceMake | devices |
| CountryCode | geos |
| RegionId | geos |
| MetroId | geos |
| ZipCode | geos |
| LocationCategoryId | locations |
| LocationProximity | locations |
| LocationProximityUnit | locations |
| Latitude | locations |
| Longitude | locations |
| Radius | locations |
| Unit | locations |
| SegmentId | segments |
| InterestCategoryId | interests |
United States, Male+Female, All Age Ranges
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'
United States, Male, Age Groups 21-34
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us'AND TargetingSpecAgeGroup IN ('21-24', '25-34') AND TargetingSpecGender = 'MALE'
Canada, Female, 13-20, iOS
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'ca' AND TargetingSpecMinAge = '13' AND TargetingSpecMaxAge = '20' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecDeviceOSType = 'iOS'
UK, Male+Female, Age 25, WIFI Only
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'uk' AND TargetingSpecMinAge = '25' AND TargetingSpecMaxAge = '25' AND TargetingSpecDeviceConnectionType = 'WIFI'
United States - All States Except Arizona or Texas, M+F, All Ages
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND (TargetingSpecCountryCode = 'us' AND NOT(TargetingSpecCountryCode = 'us' AND TargetingSpecRegionId IN (3, 44)))
United States, Female, 18-34, 'Fashion & Style Gurus' OR 'Film & TV Fans'
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecAgeGroup IN ('18-20', '21-24', '25-34') AND TargetingSpecInterestCategoryId IN ('SLC_7', 'SLC_8')
United States, All genders/ages, 'Comedy Fans'
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'SLC_36'
United States, Male, 18-20, member of SAM segment ID '12345'
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND TargetingSpecSegmentId = '12345'
United States, Male, 18-20, NOT a member of SAM segment ID '98765'
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecGender = 'MALE' AND TargetingSpecAgeGroup = '18-20' AND NOT TargetingSpecSegmentId = '98765'
United States, AT&T
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceCarrierId = 'US_ATT'
United States, 21-24, (College Graduates OR Married People), Apparel Shoppers
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecInterestCategoryId = 'DLXS_1' AND TargetingSpecAdvancedDemographics IN ('DLXD_100', 'DLXD_300') AND TargetingSpecAgeGroup = '21-24' AND TargetingSpecRegulatedContent = false
United States, metros New York or Los Angeles only
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecMetroId IN ('501', '803')
USA, Female, Spanish speaking, 13-17, iOS version 10.3.2
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecAgeGroup = '13-17' AND TargetingSpecGender = 'FEMALE' AND TargetingSpecLanguage = 'es' AND TargetingSpecDeviceOSType = 'ios' AND TargetingSpecDeviceOSVersionMin = '9.0' AND TargetingSpecDeviceOSVersionMax = '10.3.2'
Zipcode Targeting
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecZipCode IN ('90291', '90026')
Device Make: All iPhone 7 plus and iPhone 6s Plus users
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecDeviceMake IN ('Apple/iPhone 7 Plus/', 'Apple/iPhone 6s Plus/')
Location Categories: Targeting Sports Arenas, Fitness Centers
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND TargetingSpecLocationCategoryId IN ('LOI_15004', 'LOI_15002') AND TargetingSpecLocationProximityUnit = 'MILES' AND TargetingSpecLocationProximity = 1
Location Point Radius: Targeting 500 meter radius around Nordstrom locations in Seattle/Bellevue
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND ((TargetingSpecLatitude = 47.612447 AND TargetingSpecLongitude = -122.336751 AND TargetingSpecRadius = 500) OR (TargetingSpecLatitude = 47.617102 AND TargetingSpecLongitude = -122.203961 AND TargetingSpecRadius = 50 AND TargetingSpecUnit = 'KILOMETERS'))
Multi-country targeting: Targeting the US and Canada
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' OR TargetingSpecCountryCode = 'ca'
Snap Lifestyle Category inclusion of SLC_1, SLC_124 and exclusion of SLC_2
SELECT * FROM AudienceInsights WHERE AccountId = '02a1dac6-ffa2-49d9-b5b6-37bc31b9f3c2' AND BaseSpecCountryCode = 'us' AND TargetingSpecCountryCode = 'us' AND (TargetingSpecInterestCategoryId IN ('SLC_1', 'SLC_124') AND NOT TargetingSpecInterestCategoryId = 'SLC_2')
| Name | Type | References | Description |
| Id [KEY] | String | The insight Id. | |
| AccountId | String |
Accounts.Id | The account Id. |
| Name | String | The insight name. | |
| DimensionCategory | String | The dimension category of the insight. | |
| Distribution | String | The distribution type of the insight. | |
| TargetAudienceSizeMinimum | String | The minimum size of the target audience. | |
| TargetAudienceSizeMaximum | String | The maximum size of the target audience. | |
| ReferenceAudienceSizeMinimum | String | The minimum size of the target Reference. | |
| ReferenceAudienceSizeMaximum | String | The maximum size of the target audience. | |
| TargetAudiencePercent | Decimal | The target audience percent. | |
| ReferenceAudiencePercent | Decimal | The reference audience percent. | |
| TargetIndexToReference | Decimal | The target index to reference. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| BaseSpecAgeGroup | String | Age group targeting option. | |
| TargetingSpecAgeGroup | String | Age group targeting option. | |
| BaseSpecMinAge | String | Minimum age targeting option. | |
| TargetingSpecMinAge | String | Minimum age targeting option. | |
| BaseSpecMaxAge | String | Maximum targeting option. | |
| TargetingSpecMaxAge | String | Maximum targeting option. | |
| BaseSpecGender | String | Gender targeting option. | |
| TargetingSpecGender | String | Gender targeting option. | |
| BaseSpecLanguage | String | Language targeting option. | |
| TargetingSpecLanguage | String | Language targeting option. | |
| BaseSpecAdvancedDemographics | String | Advanced demographics targeting option. | |
| TargetingSpecAdvancedDemographics | String | Advanced demographics targeting option. | |
| BaseSpecDeviceConnectionType | String | Device connection type targeting option. | |
| TargetingSpecDeviceConnectionType | String | Device connection type targeting option. | |
| BaseSpecDeviceOSType | String | Device OS type targeting option. | |
| TargetingSpecDeviceOSType | String | Device OS type targeting option. | |
| BaseSpecDeviceOSVersionMin | String | Device OS min version targeting option. | |
| TargetingSpecDeviceOSVersionMin | String | Device OS min version targeting option. | |
| BaseSpecDeviceOSVersionMax | String | Device OS max version targeting option. | |
| TargetingSpecDeviceOSVersionMax | String | Device OS max version targeting option. | |
| BaseSpecDeviceCarrierId | String | Device carrier ID targeting option. | |
| TargetingSpecDeviceCarrierId | String | Device carrier ID targeting option. | |
| BaseSpecDeviceMake | String | Device make targeting option. | |
| TargetingSpecDeviceMake | String | Device make targeting option. | |
| BaseSpecCountryCode | String | Country code targeting option. | |
| TargetingSpecCountryCode | String | Country code targeting option. | |
| BaseSpecRegionId | String | Region/State ID targeting option. | |
| TargetingSpecRegionId | String | Region/State ID targeting option. | |
| BaseSpecMetroId | String | Metro/DMA ID targeting option. | |
| TargetingSpecMetroId | String | Metro/DMA ID targeting option. | |
| BaseSpecZipCode | String | ZipCode targeting option. | |
| TargetingSpecZipCode | String | ZipCode targeting option. | |
| BaseSpecLocationCategoryId | String | Location category ID targeting option. | |
| TargetingSpecLocationCategoryId | String | Location category ID targeting option. | |
| BaseSpecLocationProximity | Int | Proximity to selected location categories. | |
| TargetingSpecLocationProximity | Int | Proximity to selected location categories. | |
| BaseSpecLocationProximityUnit | String | Unit to be used for radius. | |
| TargetingSpecLocationProximityUnit | String | Unit to be used for radius. | |
| BaseSpecLatitude | Decimal | Latitude in decimal degrees. | |
| TargetingSpecLatitude | Decimal | Latitude in decimal degrees. | |
| BaseSpecLongitude | Decimal | Longitude in decimal degrees. | |
| TargetingSpecLongitude | Decimal | Longitude in decimal degrees. | |
| BaseSpecRadius | Int | Radius in meters (minimum 96 meters and maximum 100000 meters). | |
| TargetingSpecRadius | Int | Radius in meters (minimum 96 meters and maximum 100000 meters). | |
| BaseSpecUnit | String | Unit to be used for radius. | |
| TargetingSpecUnit | String | Unit to be used for radius. | |
| BaseSpecSegmentId | String | Segment ID targeting option. | |
| TargetingSpecSegmentId | String | Segment ID targeting option. | |
| BaseSpecInterestCategoryId | String | Interest category ID targeting option. | |
| TargetingSpecInterestCategoryId | String | Interest category ID targeting option. | |
| BaseSpecRegulatedContent | Bool | Flag to mark content within the Ad Squad as Regulated Content. | |
| TargetingSpecRegulatedContent | Bool | Flag to mark content within the Ad Squad as Regulated Content. | |
| BaseSpecEnableTargetingExpansion | Bool | Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting. | |
| TargetingSpecEnableTargetingExpansion | Bool | Boolean, enabling this allows SnapchatAds to expand the audience beyond the selected targeting. |
Lists all campaign stats.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Dimension = 'Country'
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND Granularity = 'LIFETIME'
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM CampaignStats WHERE AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57' AND ConversionSourceTypes = 'app'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Dimension = 'Country'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND Granularity = 'LIFETIME'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND SwipeUpAttributionWindow = '1_DAY' AND ViewAttributionWindow = '1_HOUR'
SELECT * FROM CampaignStats WHERE CampaignId = '8adc3db7-8148-4fbf-999c-8d2266369d74' AND ConversionSourceTypes = 'app'
Note: You must specify either AccountId or CampaignId. If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.
If you do not specify a wildcard column and specify one of the dimensions from the table below in the SELECT projection the stats will breakdown according to the specified dimension. You can not specify dimensions with different dimension categories. You can only query one dimension at a time unless you are querying (age and gender) or (InterestCategoryId and InterestCategoryName) which may be combined.
| Dimension | Dimension Category |
| Country | geos |
| Region | geos |
| DMA | geos |
| Gender | demographics |
| Age | demographics |
| InterestCategoryId | interests |
| InterestCategoryName | interests |
| OS | devices |
| Make | devices |
| Name | Type | References | Description |
| AccountId | String |
Accounts.Id | The account Id. |
| CampaignId | String |
Campaigns.Id | The campaign Id. |
| StartTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| EndTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| FinalizedDataEndTime | Datetime | This defines the time up until when reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly. | |
| IntervalStartTime | Datetime | Start time of the current interval. This applies only to Granularity DAY and HOUR. | |
| IntervalEndTime | Datetime | End time of the current interval. This applies only to Granularity DAY and HOUR. | |
| Granularity | String | Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime. | |
| Dimension | String | You can get reporting insights based on different geographic, demographic, interest-based, and device-based dimensions. You can only query one dimension at a time unless you are querying age and gender which may be combined. | |
| SwipeUpAttributionWindow | String | Attribution window for swipe ups. | |
| ViewAttributionWindow | String | Attribution window for views. | |
| Country | String | ISO country code. | |
| Region | String | Region. | |
| DMA | Int | DMA numeric code. | |
| Gender | String | Gender. | |
| Age | String | Age bucket. | |
| InterestCategoryId | String | SnapchatAds User Lifestyle Interest Category Id. | |
| InterestCategoryName | String | SnapchatAds User Lifestyle Interest Category Name. | |
| OS | String | Device Operating System. | |
| Make | String | Device Make (e.g., Apple, Samsung) | |
| Impressions | Int | Impression Count. | |
| Swipes | Int | Swipe-Up Count. | |
| ViewTimeMillis | Long | Use screen_time_millis instead. Total Time Spent on top Snap Ad (milliseconds). | |
| ScreenTimeMillis | Long | Total Time Spent on top Snap Ad (milliseconds). | |
| Quartile1 | Int | Video Views to 25%. | |
| Quartile2 | Int | Video Views to 50%. | |
| Quartile3 | Int | Video Views to 75%. | |
| ViewCompletion | Int | Video Views to completion. | |
| Spend | Decimal | Amount Spent. | |
| VideoViews | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds of consecutive watch time or a swipe up action on the Top Snap. | |
| AndroidInstalls | Int | Number of Android App Installs. | |
| AndroidInstallsApp | Int | Number of Android App Installs. | |
| AndroidInstallsWeb | Int | Number of Android App Installs. | |
| AndroidInstallsSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsAppSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsWebSwipeUp | Int | Number of Android App Installs. | |
| AndroidInstallsView | Int | Number of Android App Installs. | |
| AndroidInstallsAppView | Int | Number of Android App Installs. | |
| AndroidInstallsWebView | Int | Number of Android App Installs. | |
| AttachmentAvgViewTimeMillis | Long | Average Attachment View Time (milli-seconds). | |
| AttachmentFrequency | Double | Average number of Attachment Views per User Reached. | |
| AttachmentQuartile1 | Int | Long Form Video Views to 25%. | |
| AttachmentQuartile2 | Int | Long Form Video Views to 50%. | |
| AttachmentQuartile3 | Int | Long Form Video Views to 75%. | |
| AttachmentTotalViewTimeMillis | Long | Total Attachment View Time (milli-seconds). | |
| AttachmentUniques | Int | Number of unique attachment impressions. | |
| AttachmentViewCompletion | Int | Long Form Video Views to completion. | |
| AttachmentVideoViews | Int | Long Form Video Attachment Views, viewed for at least 10 consecutive seconds or reached 97% of the Long Form Video duration. | |
| AvgViewTimeMillis | Long | Use avg_screen_time_millis instead. Average Top Snap view time per User Reached. | |
| AvgScreenTimeMillis | Long | Average Top Snap view time across all impressions. | |
| Frequency | Double | Average number of Impressions per User Reached. | |
| IosInstalls | Int | Number of iOS App Installs. | |
| IosInstallsApp | Int | Number of iOS App Installs. | |
| IosInstallsWeb | Int | Number of iOS App Installs. | |
| IosInstallsSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsAppSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsWebSwipeUp | Int | Number of iOS App Installs. | |
| IosInstallsView | Int | Number of iOS App Installs. | |
| IosInstallsAppView | Int | Number of iOS App Installs. | |
| IosInstallsWebView | Int | Number of iOS App Installs. | |
| SwipeUpPercent | Double | % of Impressions that Swiped-Up. | |
| TotalInstalls | Int | Total number of App Installs. | |
| TotalInstallsApp | Int | Total number of App Installs. | |
| TotalInstallsWeb | Int | Total number of App Installs. | |
| TotalInstallsSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsAppSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsWebSwipeUp | Int | Total number of App Installs. | |
| TotalInstallsView | Int | Total number of App Installs. | |
| TotalInstallsAppView | Int | Total number of App Installs. | |
| TotalInstallsWebView | Int | Total number of App Installs. | |
| Uniques | Int | Number of unique impressions. | |
| VideoViewsTimeBased | Int | The total number of impressions that meet the qualifying video view criteria of at least 2 seconds, not including swipe ups. | |
| VideoViews15s | Int | The total number of impressions that meet the qualifying video view criteria of at least 15 seconds, or 97% completion if it?s shorter than 15 seconds, or a swipe up action on the ad. | |
| StoryOpens | Int | Number of times users tapped on the ad tile in the feed to view the Story Ad. | |
| StoryCompletes | Int | Number of times users viewed through to the last Snap of your Story Ad. | |
| PositionImpressions | Int | The impression number for this story ad position. | |
| PositionUniques | Int | The unique viewer numbers for this story ad position. | |
| PositionFrequency | Double | The frequency for this story ad position. | |
| PositionScreenTimeMillis | Long | The total view time in milliseconds for this story ad position. | |
| PositionSwipeUpPercent | Double | The swipe up rate for this story ad position. | |
| AvgPositionScreenTimeMillis | Long | The average view time for this story ad position. | |
| Shares | Int | Number of times lens/filter was shared in a Chat or Story. | |
| Saves | Int | Number of times lens/filter was saved to Memories. | |
| ConversionPurchases | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValue | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSave | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckout | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCart | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContent | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBilling | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUps | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearches | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletes | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpens | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViews | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribe | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClick | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorial | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInvite | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLogin | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShare | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserve | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlocked | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlist | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCredits | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRate | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrial | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1 | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2 | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3 | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4 | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5 | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5SwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1View | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2View | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3View | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4View | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5View | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesApp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueApp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveApp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutApp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartApp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentApp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingApp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsApp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesApp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesApp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensApp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsApp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeApp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickApp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewApp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialApp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteApp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginApp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareApp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveApp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedApp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistApp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsApp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateApp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialApp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewApp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1App | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2App | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3App | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4App | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5App | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesAppView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueAppView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveAppView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutAppView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartAppView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentAppView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingAppView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsAppView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesAppView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesAppView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensAppView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsAppView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeAppView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickAppView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewAppView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialAppView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteAppView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginAppView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareAppView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveAppView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedAppView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistAppView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsAppView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateAppView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialAppView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewAppView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1AppView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2AppView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3AppView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4AppView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5AppView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWeb | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWeb | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWeb | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWeb | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWeb | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWeb | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWeb | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWeb | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWeb | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWeb | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWeb | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWeb | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWeb | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWeb | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWeb | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWeb | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWeb | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWeb | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWeb | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWeb | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWeb | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWeb | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWeb | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWeb | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWeb | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWeb | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1Web | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2Web | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3Web | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4Web | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5Web | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebSwipeUp | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebSwipeUp | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebSwipeUp | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebSwipeUp | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebSwipeUp | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebSwipeUp | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebSwipeUp | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebSwipeUp | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebSwipeUp | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebSwipeUp | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebSwipeUp | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebSwipeUp | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebSwipeUp | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebSwipeUp | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebSwipeUp | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebSwipeUp | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebSwipeUp | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebSwipeUp | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebSwipeUp | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebSwipeUp | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebSwipeUp | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebSwipeUp | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebSwipeUp | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebSwipeUp | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebSwipeUp | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebSwipeUp | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebSwipeUp | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. | |
| ConversionPurchasesWebView | Int | Number of attributed 'PURCHASE' conversion events. | |
| ConversionPurchasesValueWebView | Decimal | Value of attributed 'PURCHASE' conversion events (microcurrency in Ad Account's currency). | |
| ConversionSaveWebView | Int | Number of attributed 'SAVE' conversion events. | |
| ConversionStartCheckoutWebView | Int | Number of attributed 'START_CHECKOUT' conversion events. | |
| ConversionAddCartWebView | Int | Number of attributed 'ADD_CART' conversion events. | |
| ConversionViewContentWebView | Int | Number of attributed 'VIEW_CONTENT' conversion events. | |
| ConversionAddBillingWebView | Int | Number of attributed 'ADD_BILLING' conversion events. | |
| ConversionSignUpsWebView | Int | Number of attributed 'SIGN_UP' conversion events. | |
| ConversionSearchesWebView | Int | Number of attributed 'SEARCH' conversion events. | |
| ConversionLevelCompletesWebView | Int | Number of attributed 'LEVEL_COMPLETE' conversion events. | |
| ConversionAppOpensWebView | Int | Number of attributed 'APP_OPEN' conversion events. | |
| ConversionPageViewsWebView | Int | Number of attributed 'PAGE_VIEW' conversion events. | |
| ConversionSubscribeWebView | Int | Number of attributed 'SUBSCRIBE' conversion events. | |
| ConversionAdClickWebView | Int | Number of attributed 'AD_CLICK' conversion events. | |
| ConversionAdViewWebView | Int | Number of attributed 'AD_VIEW' conversion events. | |
| ConversionCompleteTutorialWebView | Int | Number of attributed 'COMPLETE_TUTORIAL' conversion events. | |
| ConversionInviteWebView | Int | Number of attributed 'INVITE' conversion events. | |
| ConversionLoginWebView | Int | Number of attributed 'LOGIN' conversion events. | |
| ConversionShareWebView | Int | Number of attributed 'SHARE' conversion events. | |
| ConversionReserveWebView | Int | Number of attributed 'RESERVE' conversion events. | |
| ConversionAchievementUnlockedWebView | Int | Number of attributed 'ACHIEVEMENT_UNLOCKED' conversion events. | |
| ConversionAddToWishlistWebView | Int | Number of attributed 'ADD_TO_WISHLIST' conversion events. | |
| ConversionSpendCreditsWebView | Int | Number of attributed 'SPENT_CREDITS' conversion events. | |
| ConversionRateWebView | Int | Number of attributed 'RATE' conversion events. | |
| ConversionStartTrialWebView | Int | Number of attributed 'START_TRIAL' conversion events. | |
| ConversionListViewWebView | Int | Number of attributed 'LIST_VIEW' conversion events. | |
| CustomEvent1WebView | Int | Number of attributed 'CUSTOM_EVENT_1' conversion events. | |
| CustomEvent2WebView | Int | Number of attributed 'CUSTOM_EVENT_2' conversion events. | |
| CustomEvent3WebView | Int | Number of attributed 'CUSTOM_EVENT_3' conversion events. | |
| CustomEvent4WebView | Int | Number of attributed 'CUSTOM_EVENT_4' conversion events. | |
| CustomEvent5WebView | Int | Number of attributed 'CUSTOM_EVENT_5' conversion events. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ConversionSourceTypes | String | Conversion source breakout by platform. Possible values are web,app,total. The default value is set to 'web,app,total' | |
| RetrieveSampleStats | Bool | Whether to return sample (fake) stats or not. |
Retrieves all creatives associated with an ad account
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Creatives WHERE Id = 'c1e6e929-acec-466f-b023-852b8cacc18f'
SELECT * FROM Creatives WHERE AccountId = '331deb8082b8-a1d5-4579-9f7c-2e874d37'
| Name | Type | References | Description |
| Id [KEY] | String | ID of the creative. | |
| UpdatedAt | Datetime | The date when the entity was last updated. | |
| CreatedAt | Datetime | The creation date of the entity. | |
| Name | String | Creative name. | |
| Headline | String | Creative headline. | |
| AccountId | String |
Accounts.Id | Creative Account ID. |
| Type | String | Creative type.
The allowed values are SNAP_AD, APP_INSTALL, LONGFORM_VIDEO, WEB_VIEW, DEEP_LINK, AD_TO_LENS, AD_TO_CALL, AD_TO_MESSAGE, PREVIEW, COMPOSITE, FILTER, LENS, LENS_WEB_VIEW, LENS_APP_INSTALL, LENS_DEEP_LINK, LENS_LONGFORM_VIDEO, COLLECTION. | |
| PackagingStatus | String | Packaging Status.
The allowed values are PENDING, SUCCESS, IN_PROGRESS. | |
| ReviewStatus | String | Review Status. | |
| Shareable | Boolean | Allow Users to Share with Friends | |
| TopSnapMediaId | String | Top Snap Media ID. | |
| CallToAction | String | Call to Action.
The allowed values are BLANK, INSTALL_NOW, WATCH, VIEW_MORE, WATCH_EPISODE, DOWNLOAD, PLAY, SHOP_NOW, SIGN_UP, USE_APP, APPLY_NOW, BOOK_NOW, BUY_TICKETS, GET_NOW, LISTEN, MORE, ORDER_NOW, READ, SHOW, SHOWTIMES, VIEW, OPEN_APP, TRY. | |
| TopSnapCropPosition | String | Top Snap Crop Position.
The allowed values are OPTIMIZED, MIDDLE, TOP, BOTTOM. | |
| LongformVideoProperties | String | Long Form Video Properties. | |
| AppInstallProperties | String | App Install Properties. | |
| WebViewProperties | String | Web View Properties. |
Lists all age group targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DemographicsAgeGroups
| Name | Type | References | Description |
| Id [KEY] | String | ID of the target option. | |
| Name | String | The name of the target option. |
Lists all gender targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DemographicsGender
| Name | Type | References | Description |
| Id [KEY] | String | ID of the target option. | |
| Name | String | The name of the target option. |
Lists all language targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DemographicsLanguages
| Name | Type | References | Description |
| Id [KEY] | String | ID of the target option. | |
| Name | String | The name of the target option. |
Lists all device carrier targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DeviceCarriers
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the targeting option. | |
| Name | String | The name of the targeting option. | |
| ValidCountry | String | The valid country of the targeting option. |
Lists all device connection type targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DeviceConnectionTypes
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the target option. | |
| Name | String | The name of the target option. |
Lists all device make targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DeviceMakes
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the targeting option. | |
| Name | String | The name of the targeting option. |
Lists all device OS type targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DeviceOSTypes
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the targeting option. | |
| Name | String | The name of the targeting option. |
Lists all device OS version targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM DeviceOSVersions
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the targeting option. | |
| DeviceOSType | String |
DeviceOSTypes.Name | The device OS type. |
| Name | String | The name of the targeting option. |
Lists all funding sources for the specified Organization.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM FundingSources WHERE OrganizationId = '2e874d37-a1d5-4579-9f7c-331deb8082b8'
SELECT * FROM FundingSources WHERE OrganizationId IN ('2e874d37-a1d5-4579-9f7c-331deb8082b8', '331deb8082b8-a1d5-4579-9f7c-2e874d37')
SELECT * FROM FundingSources WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM FundingSources WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-69b96ded-4871-4750-8f19507f6bdd')
| Name | Type | References | Description |
| Id [KEY] | String | ID of the funding source. | |
| OrganizationId | String | The id of the organization. | |
| CreatedAt | Datetime | Date of creation. | |
| UpdatedAt | Datetime | Date of last update. | |
| Type | String | Funding Source type.
The allowed values are LINE_OF_CREDIT, CREDIT_CARD, COUPON, PAYPAL. | |
| Status | String | Status of the funding source.
The allowed values are ACTIVE, REDEEMED, SPENT, EXPIRED, DELETED. | |
| BudgetSpent | Decimal | Budget Spent. | |
| Currency | String | Account currency.
The allowed values are USD, CAD, GBP, AUD, EUR. | |
| TotalBudget | Decimal | Total Budget. | |
| AvailableCredit | Decimal | Total available credit. | |
| CardType | String | Credit Card Type.
The allowed values are AMEX, DINERS_CLUB, DISCOVER, JCB, MAESTRO, MASTERCARD, VISA, UNKNOWN. | |
| Name | String | Name of the Credit Card. | |
| Last4 | Int | Last 4 digits of the Credit Card. | |
| ExpirationYear | Int | Expiration year of the Credit Card. | |
| ExpirationMonth | Int | Expiration month of the Credit Card. | |
| DailySpendLimit | Decimal | Daily spend limit for Credit Card. | |
| DailySpendLimitCurrency | String | Currency for the DailySpendLimit.
The allowed values are USD, CAD, GBP, AUD, EUR. | |
| Value | Decimal | Value of the COUPON. | |
| StartDate | Datetime | Start date of the COUPON. | |
| EndDate | Datetime | End date of the COUPON. | |
| String | Email associated with Paypal. |
Lists all country targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM GeolocationCountries
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the country. | |
| Name | String | The country name. | |
| Code | String | The country code. | |
| Latitude | Decimal | The country latitude. | |
| Longitude | Decimal | The country longitude. | |
| ContinentId | String | The continent ID. | |
| ContinentName | String | The name of the continent. |
Lists all metro/dma targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM GeolocationMetros WHERE CountryCode = 'ca'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the metro. | |
| CountryCode | String |
GeolocationCountries.Code | The country code.
The default value is us. |
| Name | String | The metro name. | |
| Regions | String | The metro regions. | |
| Latitude | Decimal | The metro latitude. | |
| Longitude | Decimal | The metro longitude. |
Lists all region/state targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM GeolocationRegions WHERE CountryCode = 'ca'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the region. | |
| CountryCode | String |
GeolocationCountries.Code | The country code.
The default value is us. |
| Name | String | The region name. | |
| Code | String | The region code. | |
| Latitude | Decimal | The region latitude. | |
| Longitude | Decimal | The region longitude. |
Lists all of zipcode targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM GeolocationZipCodes WHERE CountryCode = 'ca'
| Name | Type | References | Description |
| Code [KEY] | String | The zip code. | |
| CountryCode | String |
GeolocationCountries.Code | The country code.
The default value is us. |
| CityName | String | The city name. |
Lists all invoices for a given Ad Account.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Invoices WHERE AccountId = '4b591696-3017-4852-85d2-dc7d50157153'
SELECT * FROM Invoices WHERE AccountId = '4b591696-3017-4852-85d2-dc7d50157153' AND Id = '861b7c55-7e35-4348-918f-3758db350b80'
| Name | Type | References | Description |
| Id [KEY] | String | Invoice ID. | |
| AccountId [KEY] | String |
Accounts.Id | Ad Account ID. |
| OrganizationId | String | The ID of the organization. | |
| NetsuiteFileId | String | Snap Internal ID. | |
| CustomerName | String | Customer name. | |
| CustomerNetsuiteId | String | Snap Internal ID. | |
| DocumentNumber | Int | Document number. | |
| LineLastModified | Datetime | The date when the line was last updated. | |
| LastModified | Datetime | The date when the invoice was last updated. | |
| Amount | Decimal | Invoice amount. | |
| Currency | String | Currency of the invoice.
The allowed values are AUD, CAD, EUR, GBP, USD, SEK, DKK, NOK. | |
| BillingPeriod | String | Specifies the billing period. | |
| DueDate | Datetime | Due date of the invoice. | |
| CreatedAt | Datetime | The creation date of the invoice. | |
| InvoiceStatus | String | Indicates whether the invoice has been collected.
The allowed values are COLLECTED, SENT_FOR_COLLECTION. | |
| InvoiceContent | String | Bytestream (Base64), this Bytestream can turned into a PDF. |
Lists all location categories.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM LocationCategories
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the location category. | |
| Name | String | The location category name. | |
| ParentId | String | The parent id of the location category. | |
| Path | String | The path of the location category. | |
| Source | String | The source of the location category. |
Lists all Nielsen Interests targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM NielsenInterests
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the Nielsen interest. | |
| Name | String | The Nielsen interest name. | |
| ParentId | String | The parent Id of the Nielsen interest. | |
| Path | String | The path of the Nielsen interest. | |
| Source | String | The source of the Nielsen interest. |
Lists all the organizations where the authenticated user has access.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Organizations WHERE Id = '69b96ded-4871-4750-83ba-8f19507f6bdd'
SELECT * FROM Organizations WHERE Id IN ('69b96ded-4871-4750-83ba-8f19507f6bdd', '83ba-69b96ded-4871-4750-8f19507f6b')
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier of the organization. | |
| Name | String | The organization name. | |
| CreatedAt | Datetime | Identifies the date and time when the organization was created. | |
| UpdatedAt | Datetime | Identifies the date and time when the organization was updated. | |
| AddressLine1 | String | Address line 1. | |
| Locality | String | Locality. | |
| AdministrativeDistrictLevel1 | String | AdministrativeDistrictLevel. | |
| Country | String | Country. | |
| PostalCode | String | Zip/Postal Code. | |
| ContactEmail | String | Contact email. | |
| ContactName | String | Contact name. | |
| ContactPhone | String | Contact phone. | |
| Type | String | The organization type. | |
| State | String | The organization state. | |
| Roles | String | Roles. | |
| ConfigurationSettings | String | Configuration settings. |
Lists all interest targeting based on Placed Visitation Segments.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
The following queries are processed server side:
SELECT * FROM PlacedVisitationSegmentsInterests
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the interest. | |
| Name | String | The interest name. | |
| ParentId | String | The parent id of the interest. | |
| Path | String | The path of the interest. | |
| Source | String | The source of the interest. |
Lists all Snap Lifestyle Categories targeting options.
The Sync App will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM SnapLifeStyleCategoriesInterests WHERE CountryCode = 'ca'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the targeting option. | |
| CountryCode | String |
GeolocationCountries.Code | The country code. |
| Name | String | The name of the lifestyle category. | |
| ParentId | String | The parent ID of the lifestyle category. | |
| Path | String | The path of the lifestyle category. | |
| Source | String | The source of the lifestyle category. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Snapchat Ads.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Snapchat Ads, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddAudienceSegmentUsers | Add specific users to an audience segment. |
| CreateLookalikeSegment | Create a Snap Audience Match Lookalike Segment within a specified ad account. |
| RemoveAudienceSegmentUsers | Remove specific users or all users from specified Snap Audience Match segment |
Add specific users to an audience segment.
You can add users to a specific audience segment by specifying a list of identifiers:
EXECUTE AddAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', Identifiers = '001-234-567-8910,+44 844 412 4653'
You can add users to a specific audience segment by specifying a CSV file with a list of identifiers:
EXECUTE AddAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', CSVFilePath = 'C:\\identifiers.csv'
| Name | Type | Required | Description |
| AudienceSegmentId | String | True | The Id of the audience segment. |
| IdentifierType | String | True | The identifier type.
The allowed values are EMAIL, MOBILE_ADVERTISER_ID, PHONE. |
| Identifiers | String | False | Comma-separated list of email, phone number or mobile identifiers. |
| CSVFilePath | String | False | The path of the csv file. |
| Name | Type | Description |
| Success | Bool | Whether the request was successful or not. |
| NumberOfUploadedUsers | Int | The number of the uploaded users. |
Create a Snap Audience Match Lookalike Segment within a specified ad account.
EXECUTE CreateLookalikeSegment AccountId = '8adc3db7-8148-4fbf-999c-8d2266369d74', SeedSegmentId = '5677923948298240', Country = 'US', Type = 'REACH', Name = 'lookalikes of all the sams in the world', Description = 'similar to all the sams in the world', RetentionInDays = '180'
| Name | Type | Required | Description |
| AccountId | String | True | Ad Account ID. |
| SeedSegmentId | String | True | Seed Audience Segment ID. |
| Country | String | True | ISO-2 Country Code. |
| Type | String | False | The type of Lookalike to be created.
The allowed values are BALANCE, SIMILARITY, REACH. The default value is BALANCE. |
| Name | String | True | Audience Segment name. |
| RetentionInDays | Int | True | Number of days to retain audience members. |
| Description | String | False | Audience Segment Description. |
| Name | Type | Description |
| SegmentId | String | The ID of the newly created Lookalike Segment. |
Gets an authentication token from SnapchatAds.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB.
The default value is APP. |
| Verifier | String | False | The verifier token returned by GitHub after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
| Scope | String | False | The scope or permissions you are requesting.
The default value is snapchat-marketing-api. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to GitHub authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from GitHub. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
Gets the GitHub authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to SnapchatAds.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL that GitHub will return to after the user has authorized your app. |
| Scope | String | False | The scope or permissions you are requesting.
The default value is snapchat-marketing-api. |
| State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to GitHub authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
Refreshes the OAuth access token used for authentication with Zuora.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | Set this to the token value that expired. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from Zuora. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | This is the same as the access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Remove specific users or all users from specified Snap Audience Match segment
You can remove users from a specific audience segment by specifying a list of identifiers:
EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', Identifiers = '001-234-567-8910,+44 844 412 4653'
You can remove users from a specific audience segment by specifying a CSV file with a list of identifiers:
EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', IdentifierType = 'PHONE', CSVFilePath = 'C:\\identifiers.csv'
You can also remove all users from a specific audience segment:
EXECUTE RemoveAudienceSegmentUsers AudienceSegmentId = '5603670370513719', RemoveAllUsers = true
| Name | Type | Required | Description |
| AudienceSegmentId | String | True | The Id of the audience segment. |
| IdentifierType | String | False | The identifier type.
The allowed values are EMAIL, MOBILE_ADVERTISER_ID, PHONE. |
| Identifiers | String | False | Comma-separated list of email, phone number or mobile identifiers. |
| CSVFilePath | String | False | The path of the csv file. |
| RemoveAllUsers | Bool | False | Whether to delete all users or not. |
| Name | Type | Description |
| Success | Bool | Whether the request was successful or not. |
| NumberOfUploadedUsers | Int | The number of the uploaded users. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AccountId | Identifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| RetrieveSampleStats | Whether to return sample (fake) stats or not. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AccountId | Identifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view. |
Identifier of the default advertising account. If left empty the driver will try to get the first account from the list returned by the Accounts view.
This Id is used to get analytic stats for the account that is identified by this Id. The Accounts view can be used to list available accounts with their specific Ids. If left empty the driver will try to get the first account from the list returned by the Accounts view.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Snapchat Ads. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Snapchat Ads. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Snapchat Ads. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\SnapchatAds Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| RetrieveSampleStats | Whether to return sample (fake) stats or not. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the number of concurrent requests.
This property allows you to issue multiple requests simultaneously, thereby improving performance.
The Snapchat Ads API has a rate limit of 10000 requests per minute for Snapchat Ads Professional plans and 25000 per minute for the Snapchat Ads Premium plans.
Because of the Snapchat Ads API limits, the Sync App is restricted to making an http request for each row in order to collect as much data as possible.
To improve the performance of the Sync App consider increasing this value based on the machine's resources.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Snapchat Ads.
When processing a query, instead of requesting all of the queried data at once from Snapchat Ads, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Whether to return sample (fake) stats or not.
Set to false to exclude sample stats.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Campaigns WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.