接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Snapchat Ads への接続を作成します。Snapchat Ads アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSnapchat Ads コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Snapchat Ads アカウント

Snapchat Ads はOAuth 標準を使用してユーザーを認証します。OAuth 認証の使用を参照してください。

さらに、オプションでAccountId を設定してデフォルトのAccountId を指定できます（WHERE 句で手動で指定する必要がなくなります）。 AccountId が指定されていない場合、Sync App はAccounts ビューから返されたリストの最初のアカウントを取得しようとします。

高度な機能

このセクションでは、Snapchat Ads Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Snapchat Ads にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Snapchat Ads API へのSQL の実行について詳しく説明します。

主要機能

Sync App はドキュメント、フォルダ、およびグループなどのSnapchat Ads エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSnapchat Ads データをクエリできるようにします。
ストアドプロシージャを使用するとSnapchat Ads の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとSnapchat Ads アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、Categories やOrderLineItems などを静的にモデル化するように定義されています。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Customers、Orders、Refunds を静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャは、Snapchat Ads のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、消費税の計算や住所の検証を含むSnapchat Ads の操作を実行できます。

テーブル

Sync App はSnapchat Ads のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Snapchat Ads テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Snapchat Ads Connector for CData Sync テーブル


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.

Accounts

Lists all the ad accounts for the specified Organization.

Select

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.

Id supports the following operator: =,IN
OrganizationId supports the following operators: =,IN; If no value is specified, the Sync App will try to get the first organization from the list returned by the Organizations view.

The following queries are processed server side:

    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 Id = '5f433224-28d2-40f8-982b-c353c67934cb'
    SELECT * FROM Accounts WHERE Id IN ('5f433224-28d2-40f8-982b-c353c67934cb','c353c67934cb-28d2-40f8-982b-c353c67934cb')

Insert

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

UPDATE Accounts SET Name = 'Updated name', AgencyClientName = 'Updated agency client name' WHERE Id = '5f433224-28d2-40f8-982b-c353c67934cb'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		ID of the AD account.
OrganizationId	String	False	Organizations.Id	The ID of the organization.
Advertiser	String	False		Name of the Advertiser.
Currency	String	False		Account currency. 使用できる値は次のとおりです。AUD, CAD, EUR, GBP, USD
FundingSourceIds	String	False		Array of Funding Source IDs.
BillingType	String	False		Type of billing. 使用できる値は次のとおりです。IO, REVOLVING
BillingCenterId	String	False	BillingCenters.Id	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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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	Organizations.Id	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. 使用できる値は次のとおりです。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.

AudienceSegments

Lists all Snap Audience Match segments within a specified ad account.

Select

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.

Id supports the following operator: =,IN
AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.

The following queries are processed server side:

    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

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

UPDATE AudienceSegments SET Name = 'Updated name', Description = 'Updated description', RetentionInDays = 60 WHERE Id = '5689640350646272'

Delete

DELETE AudienceSegments WHERE Id = '4873877536079576'

Columns


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. デフォルト値は9999です。
SourceType	String	False		Data source type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。NO_UPLOAD, PROCESSING, COMPLETE
TargetableStatus	String	True		Status of whether this segment can be targeted. 使用できる値は次のとおりです。NOT_READY, TOO_FEW_USERS, READY

BillingCenters

Lists all the billing centers for the specified Organization.

Select

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.

Id supports the following operator: =,IN
OrganizationId supports the following operators: =,IN; If no value is specified, the Sync App will try to get the first organization from the list returned by the Organizations view.

The following queries are processed server side:

    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

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

UPDATE BillingCenters Set Name = 'Updated Billing Center Name' WHERE Id = '19247038-c858-4802-b786-40c162228e18'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		ID of the billing center.
OrganizationId	String	False	Organizations.Id	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.

Campaigns

Lists all campaigns within a specified ad account.

Select

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.

Id supports the following operator: =,IN
AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.

The following queries are processed server side:

    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

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

UPDATE Campaigns SET Name = 'Cool Campaign (Updated)', RegulationsRestrictedDeliverySignals = false WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'

Delete

DELETE Campaigns WHERE ID = '1ebd8b15-8100-4cbb-8ad1-04b538bbd043'

Columns


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. 使用できる値は次のとおりです。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		Objective of the Campaign. デフォルト値はBRAND_AWARENESSです。
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.

Members

Lists all members for a specific organization.

Select

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.

Id supports the following operator: =,IN
OrganizationId supports the following operators: =,IN; If no value is specified, the Sync App will try to get the first organization from the list returned by the Organizations view.

The following queries are processed server side:

    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

INSERT INTO Members(OrganizationId,Email,DisplayName) VALUES('ca67fb1a-2653-495d-9446-c9e8a30f6232','[email protected]','Member 0')

Update

Update Members SET DisplayName = 'Member 0 (Updated Name)' WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'

Delete

DELETE Members WHERE Id = '6a0f3939-cd2b-4e35-b539-a9a68ce579e7'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		Member Id.
OrganizationId	String	False	Organizations.Id	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. 使用できる値は次のとおりです。INVITED, MEMBER
Email	String	False		Email address of the user.

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Snapchat Ads Connector for CData Sync ビュー


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.
OracleDatalogixInterests	Lists all Oracle Datalogix 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.

AccountStats

Lists the spend metric for the specified Ad Account.

Select

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.

AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.
StartTime supports the following operator: =
EndTime supports the following operator: =
Granularity supports the following operator: =

The following queries are processed server side:

    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.

Columns


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. 使用できる値は次のとおりです。LIFETIME, TOTAL, DAY, HOUR デフォルト値はDAYです。
Spend	Decimal		Amount Spent.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
RetrieveSampleStats	Bool		Whether to return sample (fake) stats or not.

Ads

Lists all ads within a specified ad account.

Select

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.

Id supports the following operator: =,IN
AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.
AdSquadId supports the following operators: =,IN

The following queries are processed server side:

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

Columns


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. 使用できる値は次のとおりです。PENDING, APPROVED, REJECTED
ReviewStatusReason	String		List of Ad Review Rejection Reasons.
Status	String		Ad status. 使用できる値は次のとおりです。ACTIVE, PAUSED
Type	String		Ad type. 使用できる値は次のとおりです。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.

AdSquads

Lists all ad squads within a specified ad account.

Select

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.

Id supports the following operator: =,IN
AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.
CampaignId supports the following operators: =,IN

The following queries are processed server side:

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

Columns


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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。SWIPE_28DAY_VIEW_1DAY, SWIPE_7D
Placement	String		Placement.
StartTime	Datetime		Start time.
Status	String		Ad Squad status. 使用できる値は次のとおりです。ACTIVE, PAUSED
Targeting	String		Targeting spec.
Type	String		Ad Squad Type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。MOAT_SS, DOUBLEVERIFY
DeliveryConstraint	String		Type of delivery.
PacingType	String		Type of pacing. 使用できる値は次のとおりです。STANDARD, ACCELERATED デフォルト値はSTANDARDです。
DeliveryStatus	String		Delivery status.

AdSquadStats

Lists all ad squad stats.

Select

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.

CampaignId supports the following operators: =,IN
AdSquadId supports the following operators: =,IN
StartTime supports the following operator: =
EndTime supports the following operator: =
Granularity supports the following operator: =
Dimension supports the following operator: =
SwipeUpAttributionWindow supports the following operator: =
ViewAttributionWindow supports the following operator: =
ConversionSourceTypes supports the following operator: =
BreakDownMetricsByPlatform supports the following operator: =

The following queries are processed server side:

    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 BreakDownMetricsByPlatform = true
    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 BreakDownMetricsByPlatform = true
    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

Columns


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.
Platform	String		The specific stats platform.
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-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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'
BreakDownMetricsByPlatform	String		Breaks down metrics by SnapchatAds Client/Audience network.
RetrieveSampleStats	Bool		Whether to return sample (fake) stats or not.

AdStats

Lists all ad stats.

Select

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.

CampaignId supports the following operators: =,IN
AdId supports the following operators: =,IN
StartTime supports the following operator: =
EndTime supports the following operator: =
Granularity supports the following operator: =
Dimension supports the following operator: =
SwipeUpAttributionWindow supports the following operator: =
ViewAttributionWindow supports the following operator: =
ConversionSourceTypes supports the following operator: =
BreakDownMetricsByPlatform supports the following operator: =
BreakDownMetricsByPosition supports the following operator: =

The following queries are processed server side:

    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 BreakDownMetricsByPlatform = true
    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 BreakDownMetricsByPlatform = true
    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'

Note: You must specify either CampaignId or AdId. 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

Columns


Name	Type	References	Description
CampaignId	String	Campaigns.Id	The campaign Id.
AdId	String	Ads.Id	The ad 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.
Platform	String		The specific stats platform.
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-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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'
BreakDownMetricsByPlatform	String		Breaks down metrics by SnapchatAds Client/Audience network.
RetrieveSampleStats	Bool		Whether to return sample (fake) stats or not.

AdvancedDemographics

Lists all Advanced Demographics targeting options.

Select

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

Columns


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.

AudienceInsights

Lists all audience insights based on the targeting options.

Select

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.

AccountId supports the following operator: =
DimensionCategory supports the following operator: =

The following queries are processed server side:

    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

Example Targeting Specs

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

Columns


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-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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.

CampaignStats

Lists all campaign stats.

Select

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.

AccountId supports the following operators: =,IN
CampaignId supports the following operators: =,IN
StartTime supports the following operator: =
EndTime supports the following operator: =
Granularity supports the following operator: =
Dimension supports the following operator: =
SwipeUpAttributionWindow supports the following operator: =
ViewAttributionWindow supports the following operator: =
ConversionSourceTypes supports the following operator: =
BreakDownMetricsByPlatform supports the following operator: =

The following queries are processed server side:

    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 BreakDownMetricsByPlatform = true
    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 BreakDownMetricsByPlatform = true
    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

Columns


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.
Platform	String		The specific stats platform.
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-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


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'
BreakDownMetricsByPlatform	String		Breaks down metrics by SnapchatAds Client/Audience network.
RetrieveSampleStats	Bool		Whether to return sample (fake) stats or not.

Creatives

Retrieves all creatives associated with an ad account

Select

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.

Id supports the following operator: =
AccountId supports the following operator: =; If no value is specified, the Sync App will try to get the first Account from the list returned by the Accounts view.

The following queries are processed server side:

    SELECT * FROM Creatives WHERE Id = 'c1e6e929-acec-466f-b023-852b8cacc18f'
    SELECT * FROM Creatives WHERE AccountId = '331deb8082b8-a1d5-4579-9f7c-2e874d37'

Columns


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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。OPTIMIZED, MIDDLE, TOP, BOTTOM
LongformVideoProperties	String		Long Form Video Properties.
AppInstallProperties	String		App Install Properties.
WebViewProperties	String		Web View Properties.

DemographicsAgeGroups

Lists all age group targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the target option.
Name	String		The name of the target option.

DemographicsGender

Lists all gender targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the target option.
Name	String		The name of the target option.

DemographicsLanguages

Lists all language targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the target option.
Name	String		The name of the target option.

DeviceCarriers

Lists all device carrier targeting options.

Select

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

Columns


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.

DeviceConnectionTypes

Lists all device connection type targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the target option.
Name	String		The name of the target option.

DeviceMakes

Lists all device make targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the targeting option.
Name	String		The name of the targeting option.

DeviceOSTypes

Lists all device OS type targeting options.

Select

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

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the targeting option.
Name	String		The name of the targeting option.

DeviceOSVersions

Lists all device OS version targeting options.

Select

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

Columns


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.

FundingSources

Lists all funding sources for the specified Organization.

Select

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.

Id supports the following operator: =,IN
OrganizationId supports the following operators: =,IN; If no value is specified, the Sync App will try to get the first organization from the list returned by the Organizations view.

The following queries are processed server side:

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

Columns


Name	Type	References	Description
Id [KEY]	String		ID of the funding source.
OrganizationId	String	Organizations.Id	The id of the organization.
CreatedAt	Datetime		Date of creation.
UpdatedAt	Datetime		Date of last update.
Type	String		Funding Source type. 使用できる値は次のとおりです。LINE_OF_CREDIT, CREDIT_CARD, COUPON, PAYPAL
Status	String		Status of the funding source. 使用できる値は次のとおりです。ACTIVE, REDEEMED, SPENT, EXPIRED, DELETED
BudgetSpent	Decimal		Budget Spent.
Currency	String		Account currency. 使用できる値は次のとおりです。USD, CAD, GBP, AUD, EUR
TotalBudget	Decimal		Total Budget.
AvailableCredit	Decimal		Total available credit.
CardType	String		Credit Card Type. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。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.
Email	String		Email associated with Paypal.

GeolocationCountries

Lists all country targeting options.

Select

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

Columns


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.

GeolocationMetros

Lists all metro/dma targeting options.

Select

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.

CountryCode supports the following operator: =

The following queries are processed server side:

    SELECT * FROM GeolocationMetros WHERE CountryCode='ca'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the metro.
CountryCode	String	GeolocationCountries.Code	The country code. デフォルト値はusです。
Name	String		The metro name.
Regions	String		The metro regions.
Latitude	Decimal		The metro latitude.
Longitude	Decimal		The metro longitude.

GeolocationRegions

Lists all region/state targeting options.

Select

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.

CountryCode supports the following operator: =

The following queries are processed server side:

    SELECT * FROM GeolocationRegions WHERE CountryCode = 'ca'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the region.
CountryCode	String	GeolocationCountries.Code	The country code. デフォルト値はusです。
Name	String		The region name.
Code	String		The region code.
Latitude	Decimal		The region latitude.
Longitude	Decimal		The region longitude.

GeolocationZipCodes

Lists all of zipcode targeting options.

Select

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.

CountryCode supports the following operator: =

The following queries are processed server side:

    SELECT * FROM GeolocationZipCodes WHERE CountryCode='ca'

Columns


Name	Type	References	Description
Code [KEY]	String		The zip code.
CountryCode	String	GeolocationCountries.Code	The country code. デフォルト値はusです。
CityName	String		The city name.

Invoices

Lists all invoices for a given Ad Account.

Select

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.

Id supports the following operator: =
AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the Sync App will try to get the first account from the list returned by the Accounts view.

The following queries are processed server side:

    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'

Columns


Name	Type	References	Description
Id [KEY]	String		Invoice ID.
AccountId [KEY]	String	Accounts.Id	Ad Account ID.
OrganizationId	String	Organizations.Id	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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。COLLECTED, SENT_FOR_COLLECTION
InvoiceContent	String		Bytestream (Base64), this Bytestream can turned into a PDF.

LocationCategories

Lists all location categories.

Select

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

Columns


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.

NielsenInterests

Lists all Nielsen Interests targeting options.

Select

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

Columns


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.

OracleDatalogixInterests

Lists all Oracle Datalogix Interests targeting options.

Select

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.

Type supports the following operator: =

The following queries are processed server side:

    SELECT * FROM OracleDatalogixInterests WHERE Type = 'dlxc' 
    SELECT * FROM OracleDatalogixInterests WHERE Type = 'dlxp'

Columns


Name	Type	References	Description
Id [KEY]	String		The ID of the Oracle Datalogix DLXS interest.
Type	String		The Oracle Datalogix interest type 使用できる値は次のとおりです。dlxs, dlxc, dlxp デフォルト値はdlxsです。
Name	String		The Oracle Datalogix interest name.
ParentId	String		The parent id of the Oracle Datalogix interest.
Path	String		The path of the Oracle Datalogix interest.
Source	String		The source of the Oracle Datalogix interest.

Organizations

Lists all the organizations where the authenticated user has access.

Select

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.

Id supports the following operator: =,IN

The following queries are processed server side:

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

Columns


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.

PlacedVisitationSegmentsInterests

Lists all interest targeting based on Placed Visitation Segments.

Select

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

Columns


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.

SnapLifeStyleCategoriesInterests

Lists all Snap Lifestyle Categories targeting options.

Select

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.

CountryCode supports the following operator: =

The following queries are processed server side:

    SELECT * FROM SnapLifeStyleCategoriesInterests WHERE CountryCode = 'ca'

Columns


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.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
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.

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
MaxThreads	Specifies the number of concurrent requests.
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Snapchat Ads から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RetrieveSampleStats	Whether to return sample (fake) stats or not.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
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.

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.

解説

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.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はSnapchat Ads への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SnapchatAds Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
MaxThreads	Specifies the number of concurrent requests.
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Snapchat Ads から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RetrieveSampleStats	Whether to return sample (fake) stats or not.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

MaxThreads

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.

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

Snapchat Ads から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Snapchat Ads から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

RetrieveSampleStats

Whether to return sample (fake) stats or not.

解説

Set to false to exclude sample stats.

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Campaigns WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"