Cloud

Build 25.0.9434
  • Facebook Ads
    • はじめに
      • 接続の確立
      • データアクセスのファインチューニング
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Facebook Ads データのクエリ
      • 構築済みレポートの使用
      • テーブル
        • CustomAudiences
        • CustomConversions
      • ビュー
        • Action_Canvas_Component_Report
        • Action_Carousel_Card_Report
        • Action_Conversion_Device_Report
        • Action_Product_Id_Report
        • Action_Reactions_Report
        • Action_Video_Sound_Report
        • Action_Video_View_Type_Report
        • AdAccounts
        • AdCreatives
        • AdImages
        • AdInsights
        • AdInsightsActions
        • AdInsightsAssets
        • AdLabels
        • Ads
        • AdSets
        • Albums
        • AuthorizedAdAccounts
        • Basic_Ad_Report
        • Basic_Ad_Set_Report
        • Basic_All_Levels_Report
        • Basic_Campaign_Report
        • Businesses
        • Campaigns
        • Delivery_Device_Report
        • Delivery_Platform_And_Device_Report
        • Delivery_Platform_Report
        • Delivery_Purchase_Roas_Report
        • Demographic_Age_And_Gender_Report
        • Demographic_Age_Report
        • Demographic_Country_Report
        • Demographic_DMA_Region_Report
        • Demographic_Gender_Report
        • Demographic_Region_Report
        • LeadValues
        • Pages
        • Permissions
      • ストアドプロシージャ
        • AddCustomAudienceUsers
        • CreateAdInsightsReport
        • CreateAdPreview
        • DeleteCustomAudienceUsers
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AccountId
        • AuthenticateAsPage
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AggregateFormat
        • AsyncTimeout
        • AutoDetectPageTokens
        • IgnoreValidationException
        • MaxRows
        • Pagesize
        • PseudoColumns
        • RetryLevel
        • Target
        • TimeIncrement
        • Timeout
        • UploadLinkedMedia
    • Third Party Copyrights

Facebook Ads - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるFacebook Ads へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してFacebook Ads に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Facebook Ads への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Facebook Ads は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのFacebook Ads への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Facebook Ads への接続

接続の確立 は、CData Cloud にデータベースを作成するためのFacebook Ads への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してFacebook Ads からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Facebook Ads に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Facebook Ads への接続

以下はオプションの接続プロパティです。

  • Target:Facebook テーブルのいくつかはターゲットによりフィルタリング可能です。例えば、動画のコメントを取得するには、ターゲットとして動画のID を指定します。このプロパティは、クエリ結果を指定されたターゲットに合致するレコードに限定することを可能にします。Target カラムを使ってクエリ毎にこの制限をかけることができます。
  • AggregateFormat:Cloud は、文字列集合としていくつかのカラムを返します。例えば、エンティティのいいねデータは集計されて返されます。デフォルトでは、Cloud はJSON で集計カラムを返します。集計をXML で返すことも可能です。
  • RetryLevel:このプロパティを使用して、特定の広告インサイトのクエリとエラーに対するクエリの自動再試行を制御します。

Facebook Ads への認証

Facebook Ads はユーザー認証にOAuth 標準を使用しています。

OAuth

[

追加認証のリクエスト

Cloud の使用中に、指定のアクションを行う権限がアプリにありませんというエラーメッセージがFacebook から返されることがあります。 このエラーを解消するには、必要な権限を持つ新しいOAuth アクセストークンを発行する必要があります。認証ステップでScope プロパティを設定します。 利用可能なFacebook アクセス許可のリストはこちらで確認できます。

http://developers.facebook.com/docs/authentication/permissions/

場合によっては、アクセス許可の制限は、リクエスト可能なFacebook Ads OAuth パーミッションが見つからないことが原因ではなく、Page Public Content Access やPage Public Metadata Access のようなOAuth アプリ機能が見つからないことが原因かもしれないことに注意してください。これらの機能はOAuth アプリ全体に紐づいており、ユーザーが要求した個々のOAuth アクセストークンに対して承認や拒否を行うことはできません。埋め込みOAuth アプリでは利用できないアプリ機能へのアクセスが必要な場合は、カスタムOAuth アプリの作成 を検討してください。

AuthenticateAsPage プロパティ

単一ページとして投稿する場合は、AuthenticateAsPage 接続プロパティを使用します。ページのコレクションをクエリする場合は、AuthenticateAsPage を空のままにします。その場合、CData ツールはどのページトークンを使用するかを自動的に検出します。Alternatively, if you would like to disable this automatic detection and thus require usage of AuthenticateAsPage when querying a page, set AutoDetectPageTokens to "False".

次のセクションでは、2つのオプションについて比較します。

ページとして投稿

Facebook Ads に認証した後、あなたのユーザーアカウントで管理するページとして投稿をすることができます。AuthenticateAsPage プロパティを使用するページのID に設定します。Pages ビューをクエリして、あなたのアカウントでアクセスすることが可能なすべてのページのID を見ることができます。

自動ページ

Facebook Ads では、ページが所有するほとんどのリソースに対してページトークンを必要とする多くの変更を最近加えました。これは、複数のページを管理していてすべてのページで同じクエリを実行したい場合(例えばInsights を取得する場合など)に面倒です。CData のツールでこれをシームレスに処理するために、使用するページトークンを自動的に検出する方法を追加しました。これを機能させるには、AuthenticateAsPage を指定せず、AutoDetectPageTokens を"True" のままにします。正しいページトークンは、リクエストでターゲットの一部としてページID が指定されている場合にのみ解決できます。つまり、リクエストによっては手動でAuthenticateAsPage を指定する必要があります。

Setting AutoDetectPageTokens to "False" will disable automatic page token detection.

CData Cloud

データアクセスのファインチューニング

データアクセスのファインチューニング

次のプロパティを使って、Facebook Ads API 機能およびCloud のストラテジーをさらに制御できます。

  • AccountID:何も指定されていない場合に、クエリのTarget 入力に使用する広告アカウントID を指定するには、これを設定します。Target 接続プロパティとTarget クエリ入力の両方が、このプロパティより優先されます。
  • RetryLevel:このプロパティを使用して、特定の種類の広告インサイトのクエリとエラーに対するクエリの再試行を制御します。詳しくは、データモデル のAdInsights ビューおよびAdInsightsActions ビューページを参照してください。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

CData Cloud

データモデル

CData Cloud は、Facebook Ads API をリレーショナルテーブル、ビュー、およびストアドプロシージャとしてモデル化します。 Cloud はFacebook Ads API を使用してサポート対象のフィルタを処理します。Cloud はクライアント側でCloud 内で他のフィルタを処理します。

ビュー

ビュー では、利用可能なビューを説明します。次の2種類のビューが用意されています。

  • Base Views は、Ad Accounts、Campaigns、Businesses、Lead Values などを静的にモデル化するように定義されています。これらは、単独で使用されるのではなく、カスタムレポートを作成するために使用されます。デフォルトでは、これらのビューはすべての時間のデータを1つの行に集計して返します。
  • Predefined Report Views は、Facebook のUI で表示される内容を正確に模倣した標準レポートのセットです。すべてのPredefined Report Views の名前には"report" が付加されています。デフォルトでは、これらのビューは、日ごとの内訳を持つすべての時間のデータ返します。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

Facebook Ads データのクエリ

Cloud は、広告レベル、内訳、日付範囲、アクションコレクション、アクション属性など、独自の方法でビューをフィルタリングできます。また、多くのビューでは、クエリでターゲットを指定する必要があります。 詳しくはFacebook Ads データのクエリ を参照してください。

インサイトレポート

Cloud は、一般的なレポートシナリオを表す、事前構築済みのレポートビューのセレクションを提供します。これらのビューへのクエリは、AdInsights とAdInsightsActions へのクエリよりも簡単です。これは、各レポートビューのクエリが、そのレポートシナリオに関連する内訳とアクションコレクションを含むより複雑なクエリと同等であり、それらを手動で指定する必要がなくなるためです。

これらの事前構築済みレポートのリスト、および追加のレポートビューを定義する手順については、構築済みレポートの使用 を参照してください。

CData Cloud

Facebook Ads データのクエリ

Facebook Ads の広告データは、Cloud によって公開される複数のテーブルとビューを通じて表示され、アクセスされます。これらのテーブルやビューのクエリには、以下に示すような基本的なルールがいくつかあります。

テーブルやビューのクエリに関する詳細については、個々のテーブルやビューのページを参照してください。

ターゲットの指定

広告に関連する多くのビューで、データを取得する特定の広告またはアカウントオブジェクトを識別するために、クエリ時にターゲットを指定する必要があります。たとえば、Ads ビューをクエリする場合、特定の広告アカウントを指す条件としてTarget カラムを指定する必要があります。
SELECT * FROM Ads WHERE Target = 'act_123456'
Target は、クエリで動的に指定することもできます。
SELECT * FROM Ads WHERE Target IN (SELECT ID FROM AdAccounts)
クエリでTarget が指定されず、Target 接続プロパティが設定されていない場合、AccountID 接続プロパティを使用して広告クエリのデフォルトターゲットが決定されます。いずれも設定されていない場合は、Facebook Ads から返された最初のアカウントID が使用されます。

インサイトビュー

広告の分析、パフォーマンス、レポートデータは、AdInsights およびAdInsightsActions ビューからアクセスできます。これらのビューへのクエリには、前項で説明したようにTarget が必要ですが、レポーティング機能のためのより詳細なクエリ構文もサポートしています。

時間範囲

広告レポートや分析を取得しようとする場合は、クエリでDateStart とDateEnd、またはDatePreset を使用して、広告データの時間範囲を制御します。
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d' AND TimeIncrement='monthly'
広告データの時間範囲を指定する場合は、TimeIncrement を使用して、各結果行に要約される広告データの期間を制御します。たとえば、TimeIncrement が"monthly に設定されている場合、各結果行は広告データの月次ロールアップに対応します。

広告レベル

クエリに指定されたTarget は、どの広告アカウントの広告データを取得するかを制御します。Level を使用して、広告オブジェクトの結果をレポートするレベルを制御します。レベルは、ad、adset、campaign、またはaccount に設定できます。

内訳

Facebook Ads は、広告インサイトデータをクエリするための多くの内訳を提供します。これらの内訳は、AdInsights およびAdInsightsActions ビューを通じて公開され、使用できます。クエリに対して返される各行は、クエリで指定された内訳の1つの組み合わせのレポートデータに対応します。内訳の組み合わせに対して返される集計データは、クエリで指定された広告オブジェクトターゲットと広告オブジェクトレベルによって制限されます。

Facebook Ads では、同時に選択できる内訳に制限を課しているため、デフォルトでは、Cloud に指定されるクエリの内訳にも同様の制限を課しています。必要であれば、IgnoreValidationException プロパティによってこの内部強制を無効にすることができます。このプロパティを"True" に設定すると、内訳に関する内部的な制限が回避され、指定された内訳の組み合わせがそのままFacebook に渡されます。

内訳の組み合わせについての詳細はデータモデル を参照してください。

アクションコレクション

AdInsightsActions ビューにはActionCollection カラムもあり、広告に帰属するアクションの種類を指定することができます。

アクション属性

AdInsightsActions ビューには、ActionAttributionWindows カラムもあり、Facebook Ads がレポートを生成する際に、広告オブジェクトにどのようにアクションを関連付けるかを制御することができます。ActionAttributionWindows は、アクションと期間の組み合わせを定義する組み合わせのリストから指定されます。たとえば、ActionAttributionWindows のデフォルト値は「7d_click,1d_view」で、広告オブジェクトをクリックしてから7日以内、または表示してから1日以内に実行された関連アクションが、広告オブジェクトに帰属し、レポートされることを意味します。

CData Cloud

構築済みレポートの使用

Facebook Ads にクエリを実行して広告インサイトのデータを取得する方法はいくつかあり、AdInsights およびAdInsightsActions ビューは、これらすべてのクエリ方法を容易にします。データモデルとクエリの操作を簡単にするには、AdInsights またはAdInsightsActions 用に記述するクエリに対応する、事前定義済みの簡易レポートを使用するか、CreateAdInsightsReport ストアドプロシージャを使用して独自の広告インサイトレポートを定義します。

事前定義済みレポートの使用

ドライバーには次の事前定義済みレポートが含まれます。

  • AdInsights_ByActionReaction_90DayIncr
  • AdInsights_ByAge_90DayIncr
  • AdInsights_ByAgeAndGender_90DayIncr
  • AdInsights_ByCarousel_90DayIncr
  • AdInsights_ByCountry_90DayIncr
  • AdInsights_ByDevicePlatform_90DayIncr
  • AdInsights_ByDMA_90DayIncr
  • AdInsights_ByGender_90DayIncr
  • AdInsights_ByProductId_90DayIncr
  • AdInsights_ByPublisherPlatform_90DayIncr
  • AdInsights_ByRegion_90DayIncr
  • AdInsights_ByVideoSound_90DayIncr
  • AdInsights_ByVideoType_90DayIncr
  • AdInsights_TargetedLevel_90DayIncr

これらのビューへのクエリは、クエリする内訳とアクションコレクションがすでに定義されているという点で、AdInsights とAdInsightsActions へのクエリよりも簡単です。ただし、これらのビューへのクエリにはTarget 広告オブジェクトの指定が必要であり、Level およびActionAttributionWindows フィルタを使用することもできます。

SELECT * FROM AdInsights_ByActionReaction_90DayIncr WHERE Target='act_12345' AND Level='adset'

ビューの命名スキームは、ビューでクエリされる内訳と、ビューで使用されるデフォルトの時間増分を定義しています。ビューは、可能な限り過去にさかのぼって広告データをクエリしようと試みます。デフォルトのビューの時間範囲と時間増分は、クエリの入力で変更できます。

CreateAdInsightsReport を使用したカスタムレポートの定義

Cloud に付属する定義済みレポートにないフィールドを定期的に要求する必要がある場合や、ユーザー向けにシンプルな広告レポートを作成する場合は、必要なデータを簡単にクエリできるように、独自のカスタム広告レポートを定義できます。このためには、CreateAdInsightsReport ストアドプロシージャを使用します。

ストアドプロシージャは、指定された出力オプションに応じてスキーマファイルを出力します。生成されたレポートの出力パスにLocation 接続プロパティを設定し、Cloud でクエリ可能なテーブルとして公開します。

次のストアドプロシージャの呼び出し例では、指定したフィールド、内訳、アクション内訳、およびアクションコレクションを使用して、カスタム広告インサイトレポートを作成します。

EXEC CreateAdInsightsReport @ReportName = 'AdInsights_CreatedReport', @Fields = 'AccountCurrency,AdAccountId', @Breakdowns = 'Country', @ActionBreakdowns='ActionType,ActionDestination',@ActionCollection='Actions,UniqueActions', @OutputDirectory='LOCATION'"
この例では、@OutputDirectory パラメータはLocation 接続プロパティで指定された場所に設定されます。

CData Cloud

テーブル

Cloud はFacebook Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Facebook Ads テーブル

Name Description
CustomAudiences Query information about custom audiences defined for your ad accounts.
CustomConversions Query information about custom conversions defined for your ad accounts.

CData Cloud

CustomAudiences

Query information about custom audiences defined for your ad accounts.

Table Specific Information

Custom audiences in Facebook Ads represent an advertiser-defined audience to deliver ads to.

SELECT

The ExternalEventSource column is not returned by default, as it requires additional permissions for the underlying AdPixels object. To retrieve information for this column, it should be set in the query projection explicitly:

SELECT Id, Name, ExternalEventSource FROM CustomAudiences

Note: Listing CustomAudiences while selecting ExternalEventSource will only return CustomAudiences where the currently authenticated app has access to the underlying AdsPixel object.

Insert

When inserting CustomAudiences, at least a Name, Subtype, and CustomerFileSource must be specified:

INSERT INTO CustomAudiences (Name, Subtype, CustomerFileSource) VALUES ('Custom Audience', 'CUSTOM', 'USER_PROVIDED_ONLY')

Note: To insert users to a Custom Audience, the AddCustomAudienceUsers stored procedure must be used.

Delete

When deleting CustomAudiences, the Id of the object should be specified.

DELETE FROM CustomAudiences WHERE Id='123456'

Note: To delete users from a Custom Audience, the DeleteCustomAudienceUsers stored procedure must be used.

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the custom audience.

Account_ID String True

The ID of the custom audience's ad account.

Name String False

The name of the custom audience.

Description String False

The description of the custom audience.

Subtype String False

The subtype of the custom audience. Valid values are: CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, SUBSCRIBER_SEGMENT, EXCLUSION

TimeCreated Datetime True

Creation time of the custom audience.

TimeUpdated Datetime True

Last updated time of the custom audience.

TimeContentUpdated Datetime True

Last update of people in this custom audience. Only supported for Customer List Custom Audiences.

Rule String False

Audience rules to be applied on the referrer URL.

RuleAggregation String False

Aggregation on top of the audience rule.

ApproximateCountLowerBound Integer True

Lower bound of the approximate number of people in this audience.

ApproximateCountUpperBound Integer True

Upper bound of the approximate number of people in this audience.

PixelID String False

ID of pixel which is collecting events for Website Custom audience.

RetentionDays Integer False

Number of days to retain user in this audience. Can be any value between 1 and 180 days. Defaults to forever if left unspecified. Only available for Customer File Custom Audience.

CustomerFileSource String False

Source of customer information in the uploaded file.

DataSource String True

JSON dictionary to indicate the method by which the custom audience was created.

DeliveryStatus String True

JSON dictionary which indicates whether an audience can be used in ads.

ExternalEventSource String True

JSON dictionary containing the pixel id whose traffic generated the custom audience.

OperationStatus String True

JSON dictionary containing status code and description of last operation.

PermissionForActions String True

JSON dictionary of permissions (string) to boolean value if the custom audience has that permission.

IsValueBased Boolean False

Whether the audience is used to seed value based lookalike.

OptOutLink String False

Opt-out URL for audience members who choose not to be targeted.

Pseudo-Columns

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

Name Type Description
EnableFetchOrCreate Boolean

When set to true during INSERT, this parameter causes any identical custom audience to be fetched. Prevents INSERT of duplicate audience.

UseInCampaigns Boolean

Controls whether this custom audience will be used in campaigns. Defaults to true.

Prefill Boolean

If true, website traffic recorded prior to audience creation will be used to initialize this audience. If false, only website traffic garnered after the creation of this audience will be used.

DatasetId Integer

ID of offline conversion dataset associated with this audience.

ContentType String

Specifies content type for TRAVEL claim objective. Mandatory if creating audience with TRAVEL claim objective. Valid values are: AUTOMOTIVE_MODEL, DESTINATION, FLIGHT, GENERIC, HOME_LISTING, HOTEL, JOB, LOCAL_SERVICE_BUSINESS, MEDIA_TITLE, OFFLINE_PRODUCT, PRODUCT, VEHICLE, VEHICLE_OFFER

ClaimObjective String

Specifies objective of audiences with CLAIM subtype. Valid values are: AUTOMOTIVE_MODEL, COLLABORATIVE_ADS, HOME_LISTING, MEDIA_TITLE, PRODUCT, TRAVEL, VEHICLE, VEHICLE_OFFER.

EventSourceGroup Integer

Specifies event source group if using TRAVEL claim objective.

ProductSetId Integer

Id of the Product Set to target with this audience.

OriginAudienceId Integer

Id of origin Custom Audience. Origin audience must have a minimum size of 100.

CData Cloud

CustomConversions

Query information about custom conversions defined for your ad accounts.

Table Specific Information

Custom conversions in Facebook represent conversion events to optimize ad delivery.

Insert

When inserting CustomConversions, at least a name must be specified:

INSERT INTO CustomConversions (Name) VALUES ('TestConversion')

If inserting to the Rule or AdvancedRule columns, the rule configuration should be specified as a JSON aggregate:

INSERT INTO CustomConversions (Name, EventSourceId, Rule, CustomEventType) 
VALUES 
 ('test',
 '871481174114636',
 '{"and":[{"event":{"eq": "Purchase"}},{"value":{"gt":100}}]}',
 'PURCHASE')

See the Facebook Marketing API documentation on CustomConversions for all available Rule configurations.

Update

When updating CustomConversions, the ID of the object must be specified in the WHERE clause:

UPDATE CustomConversions SET Name='test1' WHERE ID='123abc'

Note: The Facebook Marketing API only supports updates on the DefaultConversionValue, Name, and Description columns.

Delete

When deleting CustomConversions, the Id of the object should be specified:

DELETE FROM CustomConversions WHERE ID='123abc'

Columns

Name Type ReadOnly Description
ID [KEY] String True

The ID of the custom conversion

Account_ID String True

The ID of the custom conversion's ad account

BusinessID String True

ID of business that owns the custom conversion

BusinessName String True

Name of business that owns the custom conversion

CreationTime Datetime True

Time at which the conversion was created

CustomEventType String False

The type of the conversion event

使用できる値は次のとおりです。ADD_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, COMPLETE_REGISTRATION, CONTENT_VIEW, INITIATED_CHECKOUT, LEAD, PURCHASE, SEARCH, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, LISTING_INTERACTION, FACEBOOK_SELECTED, OTHER

DataSourcesId String True

ID for event sources of the custom conversion

DataSourcesName String True

Name for event sources of the custom conversion

DataSourcesSourceType String True

Source type for event sources of the custom conversion

DefaultConversionValue Decimal False

When conversion is URL based, the default conversion value associated to each conversion

Description String False

Description of the custom conversion

EventSourceType String True

Event source type of the custom conversion, e.g. pixel, app, etc.

FirstTimeFired Datetime True

Time at which the pixel was first fired

IsArchived Boolean True

Whether this conversion is archived. Archived conversions are no longer tracked in the system.

IsUnavailable Boolean True

Whether this conversion is unavailable

LastFiredTime Datetime True

Time at which the pixel was last fired

Name String False

Name of the custom conversion

OfflineConversionDataSet String True

The offline event set that contains events

PixelID String True

ID of the pixel that will send events

RetentionDays Integer True

Retention period for advanced rule

Rule String False

Rule of the custom conversion

Pseudo-Columns

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

Name Type Description
EventSourceId String

Event source Id.

AdvancedRule String

Advanced ruleset for the custom conversion being created allowing multiple sources.

ActionSourceType String

Action source type the custom conversion is created from.

使用できる値は次のとおりです。app, chat, email, other, phone_call, physical_store, system_generated, website, business_messaging

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Facebook Ads ビュー

Name Description
Action_Canvas_Component_Report Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.
Action_Carousel_Card_Report Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.
Action_Conversion_Device_Report Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.
Action_Product_Id_Report Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.
Action_Reactions_Report Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.
Action_Video_Sound_Report Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.
Action_Video_View_Type_Report Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.
AdAccounts ユーザーが利用できる広告アカウントをクエリします。広告アカウント情報へのアクセスには、ads_read アクセス許可が必要です。
AdCreatives Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.
AdImages Images associated with an ad account
AdInsights 広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。
AdInsightsActions 広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。
AdInsightsAssets Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.
AdLabels 広告ラベルに関する情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。
Ads 特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。
AdSets 特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告セット情報へのアクセスには、ads_read アクセス許可が必要です。
Albums ターゲットに関連付けられたアルバムをクエリします。通常、アルバム情報へのアクセスには、user_photos アクセス許可が必要です。
AuthorizedAdAccounts 指定されたアプリにおいてビジネスの広告を運営する権限を付与された広告アカウント。このビューの利用には、あなたのユーザーID で少なくとも1つのビジネスが設定されている必要があります。
Basic_Ad_Report Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Ad_Set_Report Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_All_Levels_Report Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Campaign_Report Ad Report focused on ads and providing information on parent campaigns and ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Businesses Facebook ユーザーのビジネスをクエリします。ビジネス情報へのアクセスには、business_management アクセス許可が必要です。
Campaigns 特定の広告アカウントのキャンペーン情報をクエリします。キャンペーン情報へのアクセスには、ads_read アクセス許可が必要です。
Delivery_Device_Report Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_And_Device_Report Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_Report Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Purchase_Roas_Report Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_And_Gender_Report Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_Report Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Country_Report Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_DMA_Region_Report Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.
Demographic_Gender_Report Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.
Demographic_Region_Report Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.
LeadValues リードに関する情報をクエリします。リード情報へのアクセスには、ads_read アクセス許可が必要です。
Pages 提供されたID に基づいてページをクエリします。
Permissions ユーザーが現在のアプリケーションに付与した権限をクエリします。

CData Cloud

Action_Canvas_Component_Report

Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionCanvasComponentName String Name of a component within a Canvas ad.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Carousel_Card_Report

Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionCarouselCardId String The ID of the specific carousel card that people engaged with when they saw your ad.
ActionCarouselCardName String The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Conversion_Device_Report

Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionDevice String The device on which the conversion event you are tracking occurred.
DevicePlatform String The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Product_Id_Report

Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
AdId String The Id of the Ad associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ProductId String The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Reactions_Report

Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
AdId String The Id of the Ad associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: ActionValues, MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionReaction String The number of reactions on your ads or boosted posts.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Video_Sound_Report

Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: Video30SecWatchedActions, VideoAvgTimeWatchedActions, VideoP100WatchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoThruplayWatchedActions
ActionVideoSound String The sound status (on/off) when user watches your video ad.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Action_Video_View_Type_Report

Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionValue Integer Metric value of default attribution window.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection String The action collection to retrieve. The available values are: Video30SecWatchedActions, VideoAvgTimeWatchedActions, VideoP100WatchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoThruplayWatchedActions
ActionVideoType String Video metrics breakdown.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

AdAccounts

ユーザーが利用できる広告アカウントをクエリします。広告アカウント情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook のAdAccounts は、広告を作成するために利用できるFacebook のアカウントです。そのようなアカウントのID は、"act_" 形式で返されます。また、別のテーブル用のリクエストにターゲットとして指定される場合は、"act_" が接頭辞として付けているID のみを指定する必要があります。

Select

広告アカウントをクエリする場合は、結果をフィルタするには、ID またはTarget が指定できます。次に例を示します。

SELECT * FROM AdAccounts WHERE Id = 'act_123456'

Facebook Business Manager を使用してクライアントのAdAccounts を管理する場合、ビジネスアクセスできるすべての広告アカウントID は次のように表示されます。

SELECT Id FROM AdAccounts WHERE Target IN (SELECT Id FROM Businesses)

ID が指定されていない場合は、ユーザーアカウントに利用可能なアカウントが一覧表示されます。

Columns

Name Type Description
ID [KEY] String 広告アカウントのID。
Target String ビジネスID などの広告アカウントを取得するターゲット。
AccountId String Facebookで直接見ている広告アカウントのID。
AccountStatus Integer アカウントのステータス。有効値:1 = アクティブ、2 = 無効、3 = 未承認、7 = 審査中、9 = 猶予期間中、101 = 非アクティブ、100 = 削除保留中。
Age Double 広告アカウントの開始日から現在までの期間(日単位)。
AmountSpent Integer 選択されたアカウントの合計消化金額。リセット可能。
Balance Integer 未払い残高。
BusinessCity String ビジネスアドレスに使用するの市区町村。
BusinessCountryCode String ビジネスアドレスに使用する国コード。
BusinessName String ビジネスに使用するアカウント名。
BusinessState String ビジネスアドレスに使用する州名の略称。
BusinessStreet String アカウント用のビジネスアドレスに使用する所在地住所の1行目。
BusinessStreet2 String アカウント用のビジネスアドレスに使用する所在地住所の2行目。
BusinessZip String ビジネスアドレスに使用する郵便番号。
Capabilities String 広告アカウントに許可する機能。
CreatedTime Datetime アカウントの作成時刻。
Currency String アカウント設定に指定されている通貨。
MinCampaignGroupSpendCap String キャンペーングループの最小予算。
Name String アカウントの名前。アカウント名が設定されない場合、このフィールドが空になります。
OffsitePixelsTosAccepted String コンバージョントラッキング利用規約に同意したかどうかを示します。
OwnerId String 広告アカウントオーナーのFacebookID。
SpendCap Integer アカウントの最大予算。最大予算を過ぎると、キャンペーンが停止されます。「0」が設定されている場合、最大予算がない意味です。
TimezoneId String 時間帯のID。
TimezoneName String 時間帯の名前。
TimezoneOffsetHoursUTC Double 協定世界時と現地時間の差異。

CData Cloud

AdCreatives

Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.

テーブル固有の情報

Facebook のAdCreatives は、Facebook の特定のAds のクリエイティブのコレクションです。

Select

広告クリエイティブをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットとしては、広告アカウント、広告セット、または広告を指定できます。次に例を示します。

SELECT * FROM AdCreatives WHERE Target = 'adid'

Columns

Name Type Description
ID [KEY] String The Id of Ad Creative.
Target String The Ad Account Id or Campaign Id to get Ad Sets of.
Name String The name of the Ad Creative.
ApplinkTreatment String Deep link fallback behavior for dynamic product ads if the app is not installed.

使用できる値は次のとおりです。deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only

Body String The body of the ad.
CallToActionType String The call to action button text and header text of legacy ads.

使用できる値は次のとおりです。OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, BOOK_TRAVEL, LISTEN_MUSIC, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, CALL_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, GET_DIRECTIONS, MESSAGE_PAGE, SUBSCRIBE, SELL_NOW, DONATE_NOW, GET_QUOTE, CONTACT_US, RECORD_NOW, VOTE_NOW, REGISTER_NOW, OPEN_MOVIES

EffectiveInstagramMediaId String The ID of an Instagram post to use in an ad.
ImageHash String Image hash for an image you can use in creatives.
ImageUrl String A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library.
InstagramPermalinkUrl String Instagram permalink.
InstagramUserId String The ID of an Instagram user for creating ads.
LinkOgId String The Open Graph (OG) ID for the link in this creative if the landing page has OG tags.
LinkUrl String Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
ObjectId String The ID of the promoted_object or object that is relevant to the ad and ad type.
ObjectStoryId String The ID of a page post to use in an ad.
ObjectType String The type of object that is being advertised.

使用できる値は次のとおりです。APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID

ObjectUrl String Destination URL for a link ads not connected to a page.
PageId String The actor ID (Page ID) of this creative.
ProductSetId String The ID of the product set for this creative.
RunStatus String The run status of this creative.

使用できる値は次のとおりです。ACTIVE, DELETED

SourceInstagramMediaId String The ID of an Instagram post for creating ads.
TemplateUrl String The Tracking URL for dynamic product ads.
ThumbnailUrl String The URL to a thumbnail for this creative.
Title String Title for a link ad (not connected to a Page).
UrlTags String A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only.
UsePageActorOverride Boolean If this is true, we will show the page actor for mobile app ads.
AdLabels String Ad Labels that are associated with this creative.
ObjectStorySpecLinkData String The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecPhotoData String The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecVideoData String The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTextData String The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTemplateData String The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.

Pseudo-Columns

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

Name Type Description
ThumbnailHeight String Rendered height of thumbnails provided in thumbnail_url, in pixels. Default 64.
ThumbnailWidth String Rendered width of thumbnails provided in thumbnail_url, in pixels. Default 64.

CData Cloud

AdImages

Images associated with an ad account

テーブル固有の情報

Facebook の広告画像は、広告クリエイティブで使用できる個別の画像を表します。

Select

When querying ad images, a Target can be specified so that ad images are queried for the correct ad account. If no Target is specified, the driver will query from the first ad account it finds for your user account:

SELECT * FROM AdImages WHERE Target = 'act_123456'

Columns

Name Type Description
ID String The Id of image.
Target String The target ad account to pull images from.
AccountId String The id of the ad account of the image.
CreatedTime Datetime The datetime the image was created.
Creatives String The name of the Ad the lead originates from.
hash String The unique hash of the image.
height Integer The height of the image.
width Integer The width of the image.
AssociatedWithCreatives Boolean Whether the image is associated with any ad creatives.
name String The filename of the image.
OriginalHeight Integer The height of the original uploaded image
OriginalWidth Integer The width of the original uploaded image
Status String The status of the image.
PermalinkUrl String The permanent URL of the image to use in ad creatives.

CData Cloud

AdInsights

広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook AdInsights ではレポートから取得できる情報と同等のものが要求できます。

Select

AdInsights を要求する場合は、Target を含める必要があります。Target は、インサイトを取得するエレメントを指定します。 対象Target は、AdAccount、Campaign、AdSet、またはAd です。次に例を示します。
SELECT * FROM AdInsights WHERE Target = 'act_123456'

Adinsights に対するSELECT * クエリでデフォルトで常にフェッチされるカラム:

  • Target
  • DateStart
  • DateEnd
  • AccountCurrency
  • AdAccountId
  • AdAccountName
  • Impressions
  • Spend

指標カラム

Adinsights レポートでSELECT * クエリを実行する場合、すべての指標カラムがFacebook から取得されるわけではありません。これは、カラムメタデータが過去のリクエストで取得された場合、特定のカラムが "0" またはNULL 値を返す可能性があることを意味します。このデータをフェッチするには、SELECT * を使用するのではなく、クエリのSELECT 部分にこれらのカラムを含める必要があります。

Adinsights でこの挙動を示す可能性のある指標カラムは、以下のとおりです。

  • BuyingType
  • Clicks
  • ConversionRateRanking
  • CostPerEstimatedAdRecallers
  • CostPerInlineLinkClick
  • CostPerInlinePostEngagement
  • CostPerUniqueClick
  • CostPerUniqueInlineLinkClick
  • CPC
  • CPM
  • CPP
  • CTR
  • EstimatedAdRecallRate
  • EstimatedAdRecallers
  • Frequency
  • Impressions
  • InlineLinkClicks
  • InlineLinkClicksCounter
  • InlinePostEngagement
  • InstantExperienceClicksToOpen
  • InstantExperienceClicksToStart
  • InstantExperienceOutboundClicks
  • Objective
  • QualityRanking
  • Reach
  • Spend
  • UniqueClicks
  • UniqueCTR
  • UniqueInLineLinkClicks
  • UniqueInLineLinkClickCounter
  • UniqueLinkClicksCounter
  • Checkins
  • EventResponses
  • LinkClicks
  • OfferSaves
  • OutboundClicks
  • PageEngagements
  • PageLikes
  • PageMentions
  • PagePhotoViews
  • PostComments
  • PostEngagements
  • PostShares
  • PostReactions
  • PageTabViews
  • Video3SecondViews

Date Preset

データ範囲を指定するには、DateStart とDateEnd、またはDatePreset のいずれかを使用します。 DatePreset で使用できる値は次のとおりです。

  • maximum
  • today
  • yesterday
  • this_week_sun_today
  • this_week_mon_today
  • last_week_sun_sat
  • last_week_mon_sun
  • last_3d
  • last_7d
  • last_14d
  • last_28d
  • last_30d
  • last_90d
  • this_month
  • last_month

次に例を示します。

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d'

各レポート行に何日を含めるかを指定するには、TimeIncrement を使用します。次に例を示します。

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d' AND TimeIncrement = '7'

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d' AND TimeIncrement = 'monthly'

インサイトを取得するレベルを指定するには、Level カラムを使用します。有効な値は、ad、adset、campaign、account です。次に例を示します。

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND Level = 'campaign'

Note: DatePreset およびブレークダウンはFacebook によって頻繁に変更されることがあります。Facebook 側の変更により、上のリストは古くなっている可能性があります。最新のブレークダウンおよび、date presets を参照するには、https://developers.facebook.com/docs/marketing-api/insights/ でFacebook のドキュメントのパラメータとブレークダウンを参照してください。

ブレークダウンカラム

ブレークダウンカラムが多く存在します。一般的には、一度に1つのブレークダウンカラムしか選択できません。SELECT * を使うと、ブレークダウンカラムは使われません。利用可能なブレークダウンカラムは次のとおりです。

  • Age:Gender と一緒に選択することができます。
  • Country
  • FrequencyValue
  • Gender:Age と一緒に選択することができます。
  • HStatsByAdvertiserTZ (Hourly Stats by Advertizer Timezone)
  • HStatsByAudienceTZ (Hourly Stats by Audience Timezone)
  • ImpressionDevice:PublisherPlatform、またはPublisherPlatform とPlatformPosition の両方と一緒に選択することができます。
  • PlatformPosition:PublisherPlatform と一緒に選択される必要があります。ImpressionDevice と一緒に選択することもできます。
  • PublisherPlatform:PlatformPosition、ImpressionDevice、またはPlatformPosition とImpressionDevice 両方と一緒に選択できます。
  • ProductId
  • Region

他の多くのカラムは、標準SQL WHERE clause modifiers と使うことができます。次に例を示します。

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000

Facebook Ads では、同時に選択できるブレークダウンに制限を課しているため、デフォルトでは、Cloud に指定されるクエリのブレークダウンにも同様の制限を課しています。必要に応じて、IgnoreValidationException をTrue に設定することで、ブレークダウン制限事項の内部施行をバイパスすることができます。この場合、指定されたすべてのブレークダウンの組み合わせがそのままFacebook に渡されます。

Note: DatePreset およびブレークダウンはFacebook によって頻繁に変更されることがあります。Facebook 側の変更により、上のリストは古くなっている可能性があります。最新のブレークダウンおよび、date presets を参照するには、https://developers.facebook.com/docs/marketing-api/insights/ でFacebook のドキュメントのパラメータとブレークダウンを参照してください。

クエリサイズの管理

Sometimes if a query is too large for Facebook to process on its end, you might receive this error: Please reduce the amount of data you're asking for, then retry your request. The error appears to be triggered by individually dense fields, and not the page size.

If the Cloud encounters this error when first executing certain types of queries, the driver attempts to retry the query at the next lowest level of ad object, down to the level defined in RetryLevel, as long as the query does not include the Level parameter. (If the Level parameter is specified in a query, the driver does not attempt to retry beyond the ad object level specified by Level. For further information, see RetryLevel.) Note that since spreading queries across more granular ad objects increases the number of requests executed for the query, it can decrease query performance.

If you continue to receive this error, try either reducing the date range of the query, or removing expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. If you get the same error, reduce the remaining columns by half and try again. If you do not get an error, add back half of the columns you just removed, and try again.

Columns

Name Type Description
Target String インサイトを取得するアカウント、キャンペーン、広告グループ、広告のID。
DatePreset String DateStart およびDateEnd を指定する代替手段。日付の範囲は前もって指定された値に基づき自動的に計算されます。

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date インサイトの取得開始日。これは、Facebook UI のReport Start フィールドです。これは、Facebook UI のReport Start フィールドです。
DateEnd Date インサイトの取得終了日。これは、Facebook UI のReport End フィールドです。これは、Facebook UI のReport End フィールドです。
TimeIncrement String データの集計日数。整数(1-90)、月一回、または毎日(all_days)。この値は範囲またはプリセット日を、より小さなインクリメントに分割します。

デフォルト値は1です。

Level String 結果を表示するレベル。

使用できる値は次のとおりです。ad, adset, campaign, account

AccountCurrency String 広告アカウントで使用されている通貨。
ActionAttributionWindows String アクションのアトリビューションウィンドウが何であるかを決定するカンマ区切りのリスト。例えば、28d_click は、API が誰かが広告をクリックしてから28日後に起こったアクションのすべてを返します。デフォルトオプションは、[1d_view,28d_click] を意味します。使用できる値は、1d_view、7d_view、28d_view、1d_click、7d_click、28d_click、default です。
AdAccountId String レポート行と関連のある広告アカウントのID。
AdAccountName String レポート行と関連のある広告アカウントの名前。
CampaignId String レポート行と関連のあるキャンペーンのID。
CampaignName String レポート行と関連のあるキャンペーンの名前。
AdSetId String レポート行と関連のある広告セットのID。
AdSetName String レポート行と関連のある広告セットの名前。
AdId String レポート行と関連のある広告のID。
AdName String レポート行と関連のある広告の名前。
BuyingType String ターゲット広告がキャンペーンで支払われる方法。
Clicks Long 広告がクリックされた合計回数。これには、何を宣伝しているかによってページのいいね!、イベント応答、アプリのインストールを含めることができます。これは、Facebook UI のClicks (All) フィールドです。
ConversionRateRanking String コンバージョン率ランキング。
CostPerEstimatedAdRecallers Decimal 2日以内に要求された場合にあなたの広告を思い出す人一人の想定コストの平均。
CostPerInlineLinkClick Decimal 広告内のリンクのクリックあたりの平均コスト。
CostPerInlinePostEngagement Decimal 投稿のエンゲージメントあたりの平均コスト。
CostPerUniqueClick Decimal 複数広告のユニーククリックあたりの平均コスト。かかった費用をユニーククリック数で割って計算します。
CostPerUniqueInlineLinkClick Decimal インラインリンクのユニーククリックごとに支払った平均コスト。
CPC Decimal 複数広告のクリックあたりの平均コスト。かかった費用をクリック数で割って計算します。
CPM Decimal 広告で1,000インプレッションを獲得するために支払った平均コスト。
CPP Decimal 広告をユニークユーザー1,000人に表示するために支払った平均コスト。
CTR Double クリックされた回数をインプレッション数で割ったもの。これは、Facebook UI のCTR (All) % フィールドです。
EstimatedAdRecallRate Double 広告をrecall したユーザーの推定人数を、広告を表示した人数で割ったもの。
EstimatedAdRecallers Double 2日以内に要求された場合にあなたの広告を思い出すと想定される人の数。
Frequency Double 広告が一人に対して表示された平均回数。
Impressions Long 広告が表示された回数。モバイルアプリでは、広告が初めて表示されたときにカウントします。その他のFacebook インターフェースでは、広告が初めてニュースフィードに表示されたとき、または右カラムに表示されるたびにカウントします。
InlineLinkClicks Long 広告内のリンクがクリックされた合計回数。
InlineLinkClicksCounter Double リンクへのインラインクリックのクリックスルー率。
InlinePostEngagement Long 投稿のエンゲージメントの総数。
InstantExperienceClicksToOpen Long instant_experience_clicks_to_open
InstantExperienceClicksToStart Long instant_experience_clicks_to_start
InstantExperienceOutboundClicks Long instant_experience_outbound_clicks
Objective String キャンペーンに設定した目標。広告で達成したいことを目的は反映します。
QualityRanking String 品質ランキング。
Reach Long 広告が表示された人数。
Spend Decimal これまでに使った費用の合計。
UniqueClicks Long 広告をクリックしたユニークユーザーの合計人数。例えば、3人が同じ広告を5回見たら、ユニーククリックは3となります。
UniqueCTR Double 広告をクリックした人数を、広告を表示した人数で割ったもの。例えば、ユニーククリック数が20で広告が1,000ユニークユーザーに表示された場合、ユニーククリックスルー率は2% となります。
UniqueInlineLinkClicks Long 広告のユニークインラインリンククリック数。これは、Facebook UI のUnique Clicks to Link フィールドです。
UniqueInlineLinkClickCounter Double リンクへのユニークインラインクリックのクリックスルー率。
UniqueLinkClicksCounter Double リンクへのクリックのユニーククリックスルー率。広告のリンクをクリックしてFacebook から離れた人数を、広告を表示した人数で割ったものです。例えば、リンクへのユニーククリック数が20で広告が1,000ユニークユーザーに表示された場合、ユニーククリックスルー率は2% となります。
TotalPostbacks String 総ポストバック数。API の制限により、このフィールドは追加フィールドで選択できないため、クエリのプロジェクションにワイルドカードが使用されている場合は含まれません。
TotalPostbacksDetailed String 総ポストバック数の詳細。API の制限により、このフィールドは追加フィールドで選択できないため、クエリのプロジェクションにワイルドカードが使用されている場合は含まれません。
Checkins Int 広告に起因するチェックイン数。
EventResponses Int 広告に起因するイベントレスポンス数。
LinkClicks Int 広告に起因するリンクのクリック数。
OfferSaves Int 広告に起因する受信オファー数。
OutboundClicks Int 広告に起因するアウトバウンドクリック数。
PageEngagements Int 広告に起因するページのエンゲージメント数。
PageLikes Int 広告に起因するページのいいね数。
PageMentions Int 広告に起因するページのメンション数。
PagePhotoViews Int 広告に起因する写真ビュー数。
PostComments Int 広告に起因する投稿のコメント数。
PostEngagements Int 広告に起因する投稿のエンゲージメント数。
PostShares Int 広告に起因する投稿のシェア数。
PostReactions Int 広告に起因する投稿のリアクション数。
PageTabViews Int 広告に起因するタブビュー数。
Video3SecondViews Int 広告に起因する動画のビュー数。少なくとも3秒、または動画が3秒未満の場合は動画全体が再生された場合に、再生回数がカウントされます。
PixelAddToCart Int ピクセルカート追加数。
PixelPurchase Int ピクセル 購入数。
Age String この行の指標の年齢範囲。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
Country String この行の指標の国。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DevicePlatform String 広告の表示に使うデバイスまたはプラットフォーム。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
DMA String 指定されたマーケティング範囲。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
FrequencyValue String リーチ&フリークエンシーキャンペーンの広告が一人に表示された回数。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
Gender String この行の指標の性別。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
HStatsByAdvertiserTZ String 広告主にスタッツが記録される期間。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
HStatsByAudienceTZ String オーディエンスにスタッツが記録される期間。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImpressionDevice String
PlacePageId String 対応する場合に使われる場所ページ。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
PlatformPosition String プラットフォーム上の位置。
ProductId String 広告で宣伝されているプロダクトID。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
PublisherPlatform String 広告が掲載されたプラットフォーム。
Region String 広告が表示された地域。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AdFormatAsset String Ad format asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
BodyAssetId String Body asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
BodyAssetText String Body asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
CallToActionAssetId String Call to action asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
CallToActionAssetName String Call to action asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DescriptionAssetId String Description asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DescriptionAssetText String Description asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetId String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetHash String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetUrl String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
TitleAssetId String Title asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
TitleAssetText String Title asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetId String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetWebsiteUrl String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetDisplayUrl String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetId String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetVideoId String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetUrl String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetThumbnailUrl String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetVideoName String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AppId String The ID of the application associated with the ad account or campaign requested.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacks フィールドでのみサポートされます。
IsConversionIdModeled String Whether the conversion_bits are modeled.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacksDetailed フィールドでのみサポートされます。
SkanCampaignId String The raw campaign ID received as a part of Skan postback from iOS 15+.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacksDetailed フィールドでのみサポートされます。
SkanConversionId String The assigned Conversion ID of the event and or event bundle configured in the application's SKAdNetwork configuration schema.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacks フィールドでのみサポートされます。
UserSegmentKey String User segment of Advantage+ Shopping Campaigns.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AdEffectiveStatus String 広告アカウントより低いレベルでインサイトを取得する際にサポートされているステータスの入力専用リスト。有効な値の例については、AdStatus にリストされている値を参照してください。
UseAsync Boolean インサイトの取得に非同期呼び出しを使用する必要があるかどうかを示すboolean。
DefaultSummary Boolean デフォルトサマリーを取得するかどうかを示すboolean。

CData Cloud

AdInsightsActions

広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

AdInsightsActions は、AdInsights からのActions カラムのブレークダウンを表します。AdInsights のクエリについての一般的な情報は、AdInsights を参照してください。

Select

AdInsightsActions を要求する場合は、Target を含める必要があります。Target は、インサイトを取得するエレメントを指定します。 対象Target は、AdAccount、Campaign、AdSet、またはAd です。 次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'
Adinsightsactions に対するSELECT * クエリでデフォルトで常にフェッチされるカラム:

  • Target
  • DateStart
  • DateEnd
  • AdAccountId
  • AdAccountName

指標カラム

Adinsightsactions レポートでSELECT * クエリを実行する場合、すべての指標カラムがFacebook から取得されるわけではありません。これは、カラムメタデータが過去のリクエストで取得された場合、特定のカラムが "0" またはNULL 値を返す可能性があることを意味します。

Adinsightsaction でこの挙動を示す可能性のある指標カラムは、以下のとおりです。

  • ActionType
  • ActionValue
  • Action1dClick
  • Action1dView
  • Action7dClick
  • Action7dView
  • Action28dClick
  • Action28dView
  • ActionDDA

ActionAttributionWindows

アトリビューションウィンドウのカンマ区切りのリストを入力するには、ActionAttributionWindows を使用します。次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND level = 'ad' AND ActionAttributionWindows = '1d_view,7d_view,28d_click'

ActionCollection

AdInsightsActions から取得する特定のコレクションを指定するには、ActionCollection を使用します。 コレクションが指定されない場合、ドライバーはデフォルトでActions を使用します。 それぞれのインプットは、アクションのコレクションが返されるAdInsights からの使用可能なカラムを表します。

複数のコレクションを指定するには、IN 句でActionCollection を使用します。

次に例を示します。

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions', 'UniqueActions')

ブレークダウンカラム

AdInsights からの有効なセレクションクライテリアと同様に、Adinsightsactions レポートでもブレークダウンが使用可能です。ブレークダウンについて、詳しくはAdInsights を参照してください。

AdInsightsActions で利用可能なその他のブレークダウンは以下のとおりです。

  • ActionType
  • ActionCanvasComponentName
  • ActionCarouselCardId
  • ActionCarouselCardName
  • ActionDestination
  • ActionDevice
  • ActionLinkClickDestination
  • ActionReaction
  • ActionTargetId
  • ActionVideoSound
  • ActionVideoType

Managing Query Size

Sometimes if a query is too large for Facebook to process on its end, you might receive this error: Please reduce the amount of data you're asking for, then retry your request. The error appears to be triggered by individually dense fields, and not the page size.

If the Cloud encounters this error when first executing certain types of queries, the driver attempts to retry the query at the next lowest level of ad object, down to the level defined in RetryLevel, as long as the query does not include the Level parameter. (If the Level parameter is specified in a query, the driver does not attempt to retry beyond the ad object level specified by Level. For further information, see RetryLevel.) Note that since spreading queries across more granular ad objects increases the number of requests executed for the query, it can decrease query performance.

If you continue to receive this error, try either reducing the date range of the query, or removing expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. If you get the same error, reduce the remaining columns by half and try again. If you do not get an error, add back half of the columns you just removed, and try again.

Columns

Name Type Description
Target String インサイトを取得するアカウント、キャンペーン、広告グループ、広告のID。
DatePreset String DateStart およびDateEnd を指定する代替手段。日付の範囲は前もって指定された値に基づき自動的に計算されます。

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date インサイトの取得開始日。これは、Facebook UI のReport Start フィールドです。これは、Facebook UI のReport Start フィールドです。
DateEnd Date インサイトの取得終了日。これは、Facebook UI のReport End フィールドです。これは、Facebook UI のReport End フィールドです。
TimeIncrement String データの集計日数。整数(1-90)、月一回、または毎日(all_days)。この値は範囲またはプリセット日を、より小さなインクリメントに分割します。

デフォルト値は1です。

Level String 結果を表示するレベル。

使用できる値は次のとおりです。ad, adset, campaign, account

ActionAttributionWindows String アクションのアトリビューションウィンドウが何であるかを決定するカンマ区切りのリスト。例えば、28d_click は、API が誰かが広告をクリックしてから28日後に起こったアクションのすべてを返します。デフォルトオプションは、[1d_view,7d_click] を意味します。使用できる値は、1d_view、7d_view、28d_view、1d_click、7d_click、28d_click、default です。
ActionCollection String 取得するアクションのコレクション。利用可能な値は次のとおりです。ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas

デフォルト値はActionsです。

AdAccountId String レポート行と関連のある広告アカウントのID。
AdAccountName String レポート行と関連のある広告アカウントの名前。
CampaignId String レポート行と関連のあるキャンペーンのID。
CampaignName String レポート行と関連のあるキャンペーンの名前。
AdSetId String レポート行と関連のある広告セットのID。
AdSetName String レポート行と関連のある広告セットの名前。
AdId String レポート行と関連のある広告のID。
AdName String レポート行と関連のある広告の名前。
TotalPostbacks String 総ポストバック数。API の制限により、このフィールドは追加フィールドで選択できないため、クエリのプロジェクションにワイルドカードが使用されている場合は含まれません。
TotalPostbacksDetailed String 総ポストバック数の詳細。API の制限により、このフィールドは追加フィールドで選択できないため、クエリのプロジェクションにワイルドカードが使用されている場合は含まれません。
ActionType String 広告が表示された後に広告、ページ、アプリ、イベント内で起こったアクションの種類(広告がクリックされなかった場合も含む)。
ActionValue Double
Action1dClick String 広告をクリックした1日後のアトリビューションウィンドウのMetric 値。
Action1dView String 広告を見た1日後のアトリビューションウィンドウのMetric 値。
Action7dClick String 広告をクリックした7日後のアトリビューションウィンドウのMetric 値。
Action7dView String 広告を見た7日後のアトリビューションウィンドウのMetric 値。
Action28dClick String 広告をクリックした28日後のアトリビューションウィンドウのMetric 値。
Action28dView String 広告を見た28日後のアトリビューションウィンドウのMetric 値。
ActionDDA String データドリブンモデルに基づくアトリビューションウィンドウのMetric 値。
ActionCanvasComponentName String Canvas 広告内のコンポーネント名。
ActionCarouselCardId String あなたの広告を見た時の人々のカルーセルカードのID。
ActionCarouselCardName String あなたの広告を見た際の特定のカルーセルカード。カードはヘッドラインから特定されます。
ActionDestination String あなたの広告をクリックした後の人々の行先。
ActionDevice String トラッキングしているコンバージョンイベントが起こったデバイス。
ActionReaction String あなたの広告もしくはブーストされた投稿へのリアクションの数。
ActionTargetId String あなたの広告をクリックした後の行先のID。
ActionVideoSound String 動画広告を見た際の音の(on/off) ステータス。
ActionVideoType String 動画指標のブレークダウン。
ConversionDestination String Conversion destination.
SignalSourceBucket String Signal source bucket.
StandardEventContentType String Standard canvas component name.
Age String この行の指標の年齢範囲。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
Country String この行の指標の国。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DevicePlatform String 広告の表示に使うデバイスまたはプラットフォーム。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
DMA String 指定されたマーケティング範囲。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
FrequencyValue String リーチ&フリークエンシーキャンペーンの広告が一人に表示された回数。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
Gender String この行の指標の性別。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
HStatsByAdvertiserTZ String 広告主にスタッツが記録される期間。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
HStatsByAudienceTZ String オーディエンスにスタッツが記録される期間。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImpressionDevice String 広告の表示に使うデバイス。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
PlacePageId String 対応する場合に使われる場所ページ。このブレークダウンカラムは他のブレイクダウンカラムとは同時に選択できない場合があります。
PlatformPosition String プラットフォーム上の位置。
ProductId String 広告で宣伝されているプロダクトID。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
PublisherPlatform String 広告が掲載されたプラットフォーム。
Region String 広告が表示された地域。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AdFormatAsset String Ad format asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
BodyAssetId String Body asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
BodyAssetText String Body asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
CallToActionAssetId String Call to action asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
CallToActionAssetName String Call to action asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DescriptionAssetId String Description asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
DescriptionAssetText String Description asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetId String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetHash String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
ImageAssetUrl String Image asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
TitleAssetId String Title asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
TitleAssetText String Title asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetId String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetWebsiteUrl String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
LinkUrlAssetDisplayUrl String Link url asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetId String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetVideoId String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetUrl String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetThumbnailUrl String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
VideoAssetVideoName String Video asset level breakdown.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AppId String The ID of the application associated with the ad account or campaign requested.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacks フィールドでのみサポートされます。
IsConversionIdModeled String Whether the conversion_bits are modeled.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacksDetailed フィールドでのみサポートされます。
SkanCampaignId String The raw campaign ID received as a part of Skan postback from iOS 15+.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacksDetailed フィールドでのみサポートされます。
SkanConversionId String The assigned Conversion ID of the event and or event bundle configured in the application's SKAdNetwork configuration schema.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。TotalPostbacks フィールドでのみサポートされます。
UserSegmentKey String User segment of Advantage+ Shopping Campaigns.これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。
AdEffectiveStatus String 広告アカウントより低いレベルでインサイトを取得する際にサポートされているステータスの入力専用リスト。有効な値の例については、AdStatus にリストされている値を参照してください。
UseAsync Boolean インサイトの取得に非同期呼び出しを使用する必要があるかどうかを示すboolean。

CData Cloud

AdInsightsAssets

Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Ad or Ad Set for which to get insights. Note that the asset breakdowns cannot target an Ad Account.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range is automatically calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

AccountCurrency String The currency that is being used by the ad account.
ActionAttributionWindows String A comma separated list that determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId String The Id of the Ad Account that is associated with the report row.
AdAccountName String The name of the Ad Account that is associated with the report row.
CampaignId String The Id of the Campaign that is associated with the report row.
CampaignName String The name of the Campaign that is associated with the report row.
AdSetId String The Id of the Ad Set that is associated with the report row.
AdSetName String The name of the Ad Set that is associated with the report row.
AdId String The Id of the Ad that is associated with the report row.
AdName String The name of the Ad that is associated with the report row.
BuyingType String The method by which target ads are paid for in your campaigns.
Clicks Long The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field.
ConversionRateRanking String The conversion rate ranking.
CostPerEstimatedAdRecallers Decimal The average cost per additional person that we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick Decimal The average cost per click on links in the ad.
CostPerInlinePostEngagement Decimal The average cost per engagement on the post.
CostPerUniqueClick Decimal The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick Decimal The average you paid for each unique inline link click.
CPC Decimal The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM Decimal The average cost that you've paid to have 1,000 impressions on your ad.
CPP Decimal The average cost that you've paid to have your ad served to 1,000 unique people.
CTR Double The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
EstimatedAdRecallRate Double The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers Double The additional number of people that we estimate will remember seeing your ads if asked within 2 days.
Frequency Double The average number of times that your ad was served to each person.
Impressions Long The number of times that your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks Long Total number of clicks on links in the ad.
InlineLinkClicksCounter Double The click-through rate for inline clicks to link.
InlinePostEngagement Long The total number of engagements on the post.
InstantExperienceClicksToOpen Long instant_experience_clicks_to_open
InstantExperienceClicksToStart Long instant_experience_clicks_to_start
InstantExperienceOutboundClicks Long instant_experience_outbound_clicks
Objective String The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
QualityRanking String The quality ranking.
Reach Long The number of people your ad was served to.
Spend Decimal The total amount you've spent so far.
UniqueClicks Long The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it counts as 3 unique clicks.
UniqueCTR Double The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks Long The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter Double The click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter Double The unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
Checkins Int The number of checkins attributed to the Ad.
EventResponses Int The number of event responses attributed to the Ad.
LinkClicks Int The number of link clicks attributed to the Ad.
OfferSaves Int The number of receive offers attributed to the Ad.
OutboundClicks Int The number of outbound clicks attributed to the Ad.
PageEngagements Int The number of page enagements attributed to the Ad.
PageLikes Int The number of page likes attributed to the Ad.
PageMentions Int The number of page mentions attributed to the Ad.
PagePhotoViews Int The number of photo views attributed to the Ad.
PostComments Int The number of post comments attributed to the Ad.
PostEngagements Int The number of post engagements attributed to the Ad.
PostShares Int The number of post shares attributed to the Ad.
PostReactions Int The number of post reactions attributed to the Ad.
PageTabViews Int The number of tab views attributed to the Ad.
Video3SecondViews Int The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played.
PixelAddToCart Int Pixel adds to cart.
PixelPurchase Int Pixel purchases.
Age String The age range for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Gender String The gender for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetId String Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetText String Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetId String Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetText String Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetId String Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetHash String Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetUrl String Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetId String Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetText String Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetId String Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetName String Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetId String Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetWebsiteUrl String Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetDisplayUrl String Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetId String Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoId String Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetUrl String Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetThumbnailUrl String Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoName String Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdFormatAsset String Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdEffectiveStatus String An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.
DefaultSummary Boolean A boolean indicating if we should get the default summary.

CData Cloud

AdLabels

広告ラベルに関する情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。

Columns

Name Type Description
ID [KEY] String 広告ラベルのID。
Target String ラベルを取得する広告アカウントID。
Name String 広告ラベルの名前。
CreatedTime Datetime 広告ラベルの作成時刻。
UpdatedTime Datetime 広告ラベルが最後に更新された時刻。

CData Cloud

Ads

特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook のAds は、作成された個々の広告です。

Select

広告アカウントをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。次に例を示します。

SELECT * FROM Ads WHERE Target = 'act_123456'

さらに、> または >= 演算子とともにUpdatedTime を使うことで、特定の日付より新しいレコードのみを取得できます。次に例を示します。

SELECT * FROM Ads WHERE Target = 'act_123456' AND UpdatedTime > '01/01/2016' 

Columns

Name Type Description
ID [KEY] String 広告のID。
Target String 広告の取得元になる広告アカウントID、キャンペーンID、または広告セットID。
Name String 広告の名前。
AdStatus String 広告のステータス。

使用できる値は次のとおりです。ACTIVE, PAUSED, CAMPAIGN_PAUSED, CAMPAIGN_GROUP_PAUSED, CREDIT_CARD_NEEDED, DISABLED, DISAPPROVED, PENDING_REVIEW, PREAPPROVED, PENDING_BILLING_INFO, ARCHIVED, DELETED

BidInfo String 広告セットから取得された入札情報の値。
BidType String 広告セットから取得された入札タイプの値。

使用できる値は次のとおりです。CPM, CPC, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA

CampaignId String 広告が含まれるキャンペーンのID。
AdSetId String 広告が含まれる広告セットのID。
AdCreativeId String 広告と関連のある広告クリエイティブのID。
ConfiguredStatus String 広告のコンフィギュレーションステータス。'Status' の利用を推奨します。

使用できる値は次のとおりです。ACTIVE, PAUSED, DELETED, ARCHIVED

CreatedTime Datetime 広告の作成時刻。
UpdatedTime Datetime 広告が最後に更新された時刻。
ConversionSpecs String 広告のコンバージョン仕様。
FailedDeliveryChecks String 広告が表示されないことを回避するための確認。
Recommendations String 広告に推薦がある場合はこのフィールドに含まれます。ない場合は、このフィールドは空になります。
TrackingSpecs String 広告のトラッキング仕様。NONE に設定されていない場合、デフォルト値は目的、または広告に基づき設定されます。
AdActiveTime String 広告が最近アクティブになった時間。
AdScheduleEndTime Datetime 個々の広告の終了時間を定義するオプションのパラメータ。終了時間が定義されていない場合、広告はキャンペーンのスケジュールで実行されます。
AdScheduleStartTime Datetime 個々の広告の開始時間を定義するオプションのパラメータ。開始時間が定義されていない場合、広告はキャンペーンのスケジュールで実行されます。
BidAmount Integer オークションで使用されるこの広告への入札額。
LastUpdatedByAppId String 広告の直近の更新に使用されたアプリを示します。
PreviewShareableLink String ユーザーがさまざまな配置の広告をプレビューできるようにするリンク。
SourceAdId String この広告のコピー元の広告ID。

CData Cloud

AdSets

特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告セット情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook のAdSets は、Facebook 内のAds のコレクションです。

Select

広告セットをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットとしては、広告アカウントまたはキャンペーンを指定できます。次に例を示します。

SELECT * FROM AdSets WHERE Target = 'act_123456'

Columns

Name Type Description
ID [KEY] String 広告セットのID。
Target String 広告セットの取得元になる広告アカウントIDまたはキャンペーンID。
Name String 広告セットの名前。
BudgetRemaining Integer この広告セットのために残っている予算。
CampaignId String この広告セットが含まれる広告キャンペーン。
AdSetStatus String 広告セットのステータス。

使用できる値は次のとおりです。ACTIVE, PAUSED, ARCHIVED, DELETED

BillingEvent String 広告セットが使っている請求イベント。APP_INSTALLS:アプリがインストールされたときに支払う。CLICKS:広告のどこかがクリックされたときに支払う。IMPRESSIONS:広告が表示されたときに支払う。LINK_CLICKS:広告のリンクがクリックされたときに支払う。OFFER_CLAIMS:クーポンが発行されたときに支払う。PAGE_LIKES:ページがいいね!されたときに支払う。POST_ENGAGEMENT:投稿が読まれたときに支払う。VIDEO_VIEWS:動画が視聴されたときに支払う。
CreatedTime Datetime 広告セットの作成時刻。
DailyBudget Integer アカウントの通貨で定義されている広告セットの毎日の予算。24時間を超える広告セットでのみ指定できます。
LifetimeBudget Decimal アカウントの通貨で定義されている広告セットのライフタイムの予算。
EndTime Datetime 広告セットの終了日。
StartTime Datetime 広告セットの開始日。
UpdatedTime Datetime 広告セットが最後に更新された時刻。
Recommendations String 広告セットに推薦がある場合はこのフィールドに含まれます。ない場合は、このフィールドは空になります。
TargetingGenders Integer 性別によってリーチするオーディエンス。0=すべて、1=男性、2=女性。

使用できる値は次のとおりです。0, 1, 2

TargetingAgeMax Integer 広告の対象となる最大年齢層。設定する場合、65以下。
TargetingAgeMin Integer 広告の対象となる最低年齢層。設定する場合、13以上。設定しないと、デフォルトで18に設定されます。
TargetingCountries String 広告の対象となる国。
TargetingLocationTypes String 広告の対象となる地域。
TargetingRegions String 広告の対象となる都道府県、市区町村、地域。
TargetingCities String 広告の対象となる都市を半径と距離でターゲットする。
TargetingZips String 広告の対象となる郵便番号。
TargetingCustomLocations String 広告の対象となるカスタム地域。
TargetingGeoMarkets String 広告の対象となるDesignated Market Areas(指定マーケット地域)。キーの形式はDMA:NUMBER(例、DMA:501)です。
TargetingInterests String 広告の対象となる趣味・関心。
TargetingBehaviors String 広告の対象となる行動。
TargetingDevicePlatforms String 広告の対象となるデバイスプラットフォーム。
TargetingPublisherPlatforms String 広告の対象となるパブリッシャープラットフォーム。
TargetingInstagramPositions String 広告の対象となるInstagram のポジション。
TargetingPageTypes String 広告の対象となるページの種類。有効値は、デスクトップ、フィード、デスクトップ・フィード、モバイル、右列、右列・モバイル、ホーム、モバイルフィード・外部、デスクトップ・モバイル・外部、フィード・外部、右列・モバイル・外部です。
LearningStageInfoStatus String 広告セットの情報収集期間の進捗状況。

CData Cloud

Albums

ターゲットに関連付けられたアルバムをクエリします。通常、アルバム情報へのアクセスには、user_photos アクセス許可が必要です。

Columns

Name Type Description
ID [KEY] String アルバムのID。
Target String アルバムの取得元になるターゲットのIdまたはユーザー名。
Name String アルバムの名前。
FromId String アルバムを所有するユーザーのID。
FromName String アルバムを所有するユーザーの名前。
FromPicture String アルバムの所有者のユーザーの写真。
FromCategory String アルバムの所有者のユーザーのカテゴリ。FromCategory は、他のFrom* フィールドが選択されていない場合にのみ取得できます。
Description String アルバムの説明。
Location String アルバムの場所。
Link String Facebook内のこのアルバムへのリンク。
CoverPhoto String アルバムのカバー写真のID。
Privacy String アルバムのプライバシー設定。
Count Integer アルバム内の写真の数。
Type String アルバムのタイプ。profile、mobile、wall、normal、またはalbum。
CommentsCount Integer アルバムに対するコメントの数。
CommentsData String コメントデータの集計。
CreatedTime Datetime アルバムがアップロードされた時刻。
UpdatedTime Datetime アルバムが最後に更新された時刻。

CData Cloud

AuthorizedAdAccounts

指定されたアプリにおいてビジネスの広告を運営する権限を付与された広告アカウント。このビューの利用には、あなたのユーザーID で少なくとも1つのビジネスが設定されている必要があります。

テーブル固有の情報

Facebook のAuthorizedAdAccounts は、Facebook ビジネス向けに指定されたアプリケーションで宣伝できる広告アカウントを表します。このビューを正しく動作させるには、Facebook にビジネスを設定する必要があります。

Select

AuthorizedAdAccounts のクエリには、Target を指定する必要があり、オプションでビジネスを指定できます。次に例を示します。

SELECT * FROM AdAccounts WHERE Target = 'ApplicationId' AND Business = 'BusinessId'

ビジネスが指定されていない場合、すべての使用可能なビジネスからの結果が返されます。

Columns

Name Type Description
ID [KEY] String 広告アカウントのID。
Target String 認可された広告アカウントから要求するアプリID。
AccountId String Facebookで直接見ている広告アカウントのID。

Pseudo-Columns

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

Name Type Description
Business String 認可された広告アカウントを取得するビジネスのID。

CData Cloud

Basic_Ad_Report

Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
AdSetId String The Id of the Ad Set associated with the report row.
AdSetName String The name of the Ad Set associated with the report row.
AdId String The Id of the Ad associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Basic_Ad_Set_Report

Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
AdSetId String The Id of the Ad Set associated with the report row.
AdSetName String The name of the Ad Set associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Basic_All_Levels_Report

Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
AdSetId String The Id of the Ad Set associated with the report row.
AdSetName String The name of the Ad Set associated with the report row.
AdId String The Id of the Ad associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Basic_Campaign_Report

Ad Report focused on ads and providing information on parent campaigns and ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Businesses

Facebook ユーザーのビジネスをクエリします。ビジネス情報へのアクセスには、business_management アクセス許可が必要です。

Columns

Name Type Description
ID [KEY] String ビジネスのID。
Name String ビジネスの名前。
PrimaryPage String ビジネスのprimary ページ。
TimezoneId String ビジネスのタイムゾーンID。
Link String ビジネスのリンク。
CreatedTime Datetime ビジネスが追加された時刻。
UpdatedTime Datetime ビジネスが更新された時刻。

CData Cloud

Campaigns

特定の広告アカウントのキャンペーン情報をクエリします。キャンペーン情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook のCampaigns は、個々のAds またはAdSets が含まれている広告キャンペーンです。

Select

キャンペーンをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットは、広告アカウントである必要があります。次に例を示します。

SELECT * FROM Campaigns WHERE Target = 'act_123456'

Columns

Name Type Description
ID [KEY] String キャンペーンのID。
Target String キャンペーンを取得するためのターゲットまたは広告アカウントID。
Name String キャンペーンの名前。
BuyingType String このフィールドの値を基に、Facebook が将来に配信、価格設定、制限に関する最適化を行います。このキャンペーンに付属するすべての広告セットが購入タイプに一致する必要があります。

使用できる値は次のとおりです。AUCTION, FIXED_CPM, RESERVED

ConfiguredStatus String このステータスがPAUSED である場合、すべてのアクティブな広告セットおよび広告は停止され、CAMPAIGN_PAUSED ステータスが有効になります。'Status' の利用を推奨します。

使用できる値は次のとおりです。ACTIVE, PAUSED, DELETED, ARCHIVED

EffectiveStatus String キャンペーンの有効なステータス。例えば、キャンペーン下のすべての広告セットが停止されている場合、有効なステータスはADSET_PAUSED です。

使用できる値は次のとおりです。ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED

Status String このステータスがPAUSED である場合、すべてのアクティブな広告セットおよび広告は停止され、CAMPAIGN_PAUSED ステータスが有効になります。フィールドは'configured_status' と同じ値を返し、こちらの利用が推奨されます。

使用できる値は次のとおりです。ACTIVE, PAUSED, DELETED, ARCHIVED

CreatedTime Datetime キャンペーンの作成時刻。
Objective String この報告キャンペーンの目標。指定されている場合、API はキャンペーンの下で作成された広告グループがその目的と一致することを検証します。

使用できる値は次のとおりです。CANVAS_APP_ENGAGEMENT, CANVAS_APP_INSTALLS, EVENT_RESPONSES, MOBILE_APP_ENGAGEMENT, MOBILE_APP_INSTALLS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, WEBSITE_CLICKS, WEBSITE_CONVERSIONS

SpendCap Int キャンペーンの上限費用。これ以上費用を使わない上限です。設定した通貨のサブユニットの整数値で表わされます。
DailyBudget Int キャンペーンの毎日の予算。
BudgetRemaining Int キャンペーンの残りの予算。
LifetimeBudget Int キャンペーンのライフタイムの予算。
BidStrategy String キャンペーンの入札戦略。以下のいずれかになります:LOWEST_COST_WITHOUT_CAP、LOWEST_COST_WITH_BID_CAP、COST_CAP。
StartTime Datetime キャンペーンの開始日。
StopTime Datetime キャンペーンの終了日。
UpdatedTime Datetime キャンペーンが最後に更新された時刻。

CData Cloud

Delivery_Device_Report

Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
DevicePlatform String The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Delivery_Platform_And_Device_Report

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
PublisherPlatform String The platforms the ads were published on.
DevicePlatform String The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Delivery_Platform_Report

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
PublisherPlatform String The platforms the ads were published on.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Delivery_Purchase_Roas_Report

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: ActionValues, MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
PublisherPlatform String The platforms the ads were published on.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_Age_And_Gender_Report

Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
Age String The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Gender String The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_Age_Report

Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
Age String The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_Country_Report

Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
Country String The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_DMA_Region_Report

Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
DMA String The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_Gender_Report

Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
Gender String The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

Demographic_Region_Report

Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.

Columns

Name Type Description
Target String The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

DateStart Date The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd Date The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は1です。

Level String The level to represent the results at.

使用できる値は次のとおりです。ad, adset, campaign, account

ActionType String The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue Integer Metric value of default attribution window.
AdAccountId String The Id of the Ad Account associated with the report row.
CampaignId String The Id of the Campaign associated with the report row.
CampaignName String The name of the Campaign associated with the report row.
Reach Integer The number of people who saw your ads at least once.
Impressions Integer The number of times your ads were on screen.
Frequency Double The average number of times each person saw your ad. This value is estimated.
Spend Double The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm Double The average cost for 1,000 impressions.
Cpc Double The average cost for each click (all).
Ctr Double The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks Integer The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr Integer The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick Double The average cost of each inline link click.
ActionCollection String The action collection to retrieve. The available values are: Actions, CostPerActionType
Region String The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync Boolean A boolean indicating if an asynchronous call should be used for retrieving the insights.

CData Cloud

LeadValues

リードに関する情報をクエリします。リード情報へのアクセスには、ads_read アクセス許可が必要です。

テーブル固有の情報

Facebook のLeadValue はLead Ad からの個々のvalue を表します。Lead を説明するvalue のタイプはさまざまで、車のモデルなどのカスタム情報から、名前やメールなどの一般的な情報まで幅広くあります。

Select

リードバリューをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ID はそれぞれのLead のID を表しますが、ターゲットはLead Ad である必要があります。次に例を示します。

SELECT * FROM LeadValues WHERE Target = 'lead_ad_id'

SELECT * FROM LeadValues WHERE Id = 'lead_id'

SELECT * FROM LeadValues WHERE Target IN (SELECT id FROM Ads WHERE Target = 'campaign_id')

多くのvalue は単一のLead id から返される場合があることに注意してください。Lead 自体は、Lead Ad のコレクションであり、Lead value はそれぞれのLead のコレクションです。

Columns

Name Type Description
ID String リードのID。
Target String リードの取得元になるターゲットまたは広告のID。
AdId String リードが発生した広告のID。
AdName String リードが発生した広告の名前。
AdSetId String リードと関連のある広告セットのID。
AdSetName String リードと関連のある広告セットの名前。
CampaignId String リードと関連のあるキャンペーンのID。
CampaignName String リードと関連のあるキャンペーンの名前。
FormId String リードが発生したフォームのID。
FieldName String リードデータのフィールドの名前。
FieldValues String リードデータの特定フィールドの値。
IsOrganic Boolean リードがオーガニックかどうかを示すboolean。
CreatedTime Datetime リードの作成時刻。

CData Cloud

Pages

提供されたID に基づいてページをクエリします。

テーブル固有の情報

Facebook のPages は、1人のユーザーによって作成され、1人以上のユーザーによって維持されるページです。ユーザーと同様に、ページはID または画面名で参照できます。

Select

ページをクエリする場合、指定がない場合にはあなたが管理しているページがデフォルトで表示されます。そうでない場合は、ページのID を指定できます。次に例を示します。

SELECT * FROM Pages WHERE Id = 'facebook'

Columns

Name Type Description
ID [KEY] String ページのID。
Username String ページのユーザー名がある場合は、そのユーザー名。
Name String ページの名前。
Category String ページのカテゴリ。
Categories String 複数のカテゴリがある場合は、ページに関連付けられたカテゴリの集計。
Link String ページへのリンク。
Picture String ページに対応するページのプロフィール写真へのリンク。
CoverId String ページのカバー写真のID。
CoverSource String ページのカバー写真のURL。
CoverOffsetY String ページのカバー写真のy軸オフセット。
CoverOffsetX String ページのカバー写真のx軸オフセット。
About String ページに関する基本情報。
Description String ページの説明がある場合は、その説明。
GeneralInfo String ページから提供される一般情報。
LocationStreet String ページの番地。
LocationCity String ページの市区町村。
LocationState String ページの状態。
LocationCountry String ページの国。
LocationZip String ページの郵便番号。
LocationLatitude String ページの緯度。
LocationLongitude String ページの経度。
StoreNumber Integer この場所ページの一意ストア番号(該当する場合)。
Phone String ページの電話番号がある場合は、その電話番号。
Website String ページのWebサイトへのリンク。
Likes Integer ページをいいね!した人の数。
Checkins Integer ページに関連付けられたスポットにチェックインしたユーザーの総数。
TalkingAboutCount Integer ページを話題にしているユーザーの数。
WereHereCount Integer このページの場所にいたユーザーの数(該当する場合)。
CanPost Boolean 認証ユーザーがページに対応するページに投稿できるかどうかを示すboolean。
IsPublished Boolean ページに対応するページが公開されているかどうかを示すboolean。
IsCommunityPage Boolean これがコミュニティページかどうかを示すboolean。
PublicTransit String ページで公共交通を利用できる場合は、その公共交通。
ParkingStreet Boolean 路上駐車できるかどうかを示すboolean。
ParkingLot Boolean 駐車場があるかどうかを示すboolean。
ParkingValet Boolean 係員付き駐車サービスがあるかどうかを示すboolean。
PromotionEligible Boolean 投稿の宣伝適格ステータス。manage_pages アクセス許可が必要です。また、自身がページの管理者である必要があります。
PromotionIneligibleReason String 投稿の宣伝に不適格の理由。manage_pages アクセス許可が必要です。また、自身がページの管理者である必要があります。
Founded String 企業の設立日。企業に適用。
Mission String 企業の使命。企業に適用。
Products String この企業の製品。企業に適用。
Hours String 営業時間の集計。ビジネスとスポットに適用。
Attire String ビジネスの服装規定。レストランまたはナイトライフに適用。有効な値は、Casual、Dressy、またはUnspecified。
AcceptsCashOnly Boolean 支払いオプションとして現金だけを受け付けるかどうか。レストランまたはナイトライフに適用。
AcceptsVisa Boolean 支払いオプションとしてVisa を受け付けるかどうか。レストランまたはナイトライフに適用。
AcceptsAmericanExpress Boolean 支払いオプションとしてAmerican Expressを受け付けるかどうか。レストランまたはナイトライフに適用。
AcceptsMasterCard Boolean 支払いオプションとしてMasterCardを受け付けるかどうか。レストランまたはナイトライフに適用。
AcceptsDiscover Boolean 支払いオプションとしてDiscoverを受け付けるかどうか。レストランまたはナイトライフに適用。
PriceRange String ビジネスの価格帯。レストランまたはナイトライフに適用。有効な値は、\$ (0-10)、\$\$ (10-30)、\$\$\$ (30-50)、\$\$\$\$ (50+)、またはUnspecified です。
TakesReservations Boolean レストランで予約が必要かどうか。レストランにのみ適用。
AllowsWalkins Boolean レストランで予約が不要かどうか。レストランにのみ適用。
AllowsGroups Boolean レストランで団体を受け入れるかどうか。レストランにのみ適用。
AllowsKids Boolean レストランで子供を受け入れるかどうか。レストランにのみ適用。
ProvidesTakeout Boolean レストランで持ち帰りサービスがあるかどうか。レストランにのみ適用。
ProvidesDelivery Boolean レストランでデリバリーサービスがあるかどうか。レストランにのみ適用。
ProvidesCatering Boolean レストランでケータリングサービスがあるかどうか。レストランにのみ適用。
HasWaiters Boolean レストランでウエイターがいるかどうか。レストランにのみ適用。
HasOutdoorSeating Boolean レストランで屋外座席があるかどうか。レストランにのみ適用。
ServesBreakfast Boolean レストランで朝食メニューがあるかどうか。レストランにのみ適用。
ServesLunch Boolean レストランで昼食メニューがあるかどうか。レストランにのみ適用。
ServesDinner Boolean レストランで夕食メニューがあるかどうか。レストランにのみ適用。
ServesCoffee Boolean レストランでカフェメニューがあるかどうか。レストランにのみ適用。
ServesDrinks Boolean レストランでアルコールメニューがあるかどうか。レストランにのみ適用。
CulinaryTeam String 調理チーム。レストランまたはナイトライフに適用。
PharmaSafetyInfo String 薬剤安全情報。製薬会社に適用。
Affiliation String この人の略歴。人物紹介ページに適用。
Birthday String この人の誕生日。人物紹介ページに適用。
PersonalInfo String 個人情報。人物紹介ページに適用。
PersonalInterests String 個人の趣味・関心。人物紹介ページに適用。
ArtistsWeLike String バンドが好きなアーティスト。バンドに適用。
BandInterests String バンドの趣味・関心。バンドに適用。
BandMembers String バンドのメンバー。バンドに適用。
Bio String バンドの略歴。バンドに適用。
BookingAgent String バンドのマネージャー。バンドに適用。
GeneralManager String ゼネラルマネージャー。レストランまたはナイトライフに適用。バンドに適用。
Hometown String バンドの出身地。バンドに適用。
PressContact String バンドのプレス窓口。バンドに適用。
RecordLabel String バンドのレコードレーベル。バンドに適用。
Awards String 映画またはテレビ番組の受賞情報。映画およびテレビ番組に適用。
DirectedBy String 映画またはテレビ番組のディレクター。映画およびテレビ番組に適用。
Genre String 映画またはテレビ番組のジャンル。映画およびテレビ番組に適用。
Influences String バンドが影響を受けたもの。バンドに適用。
PlotOutline String 映画またはテレビ番組のあらすじ。映画およびテレビ番組に適用。
ProducedBy String 映画のプロデューサー。映画に適用。
ReleaseData String 映画の公開日。映画およびテレビ番組に適用。
ScreenplayBy String 映画の脚本家。映画およびテレビ番組に適用。
Starring String 映画またはテレビ番組のキャスト。映画およびテレビ番組に適用。
Studio String 撮影スタジオ。映画に適用。
Network String テレビ番組を放送するテレビネットワーク。テレビ番組に適用。
Schedule String テレビ番組の放送スケジュール。テレビ番組に適用。
Season String テレビ番組の現行シーズン。テレビ番組に適用。
WrittenBy String テレビ番組の脚本家。テレビ番組に適用。
Built String 自動車の製造年に関する情報。自動車に適用。
Features String 自動車の機能。自動車に適用。
MPG String 自動車の燃費(マイル/ガロン)。自動車に適用。
Members String この組織のメンバー。チーム組織の紹介ページに適用。
InstagramBusinessAccountId String The business instagram account id associated with this page.

Pseudo-Columns

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

Name Type Description
offset String 最初に返す結果。結果の手動ページングで使用されます。

CData Cloud

Permissions

ユーザーが現在のアプリケーションに付与した権限をクエリします。

Columns

Name Type Description
PermissionName [KEY] String 権限の名前。
Status String 要求された権限のステータス。

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Facebook Ads の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにFacebook Ads から関連するレスポンスデータを返します。

CData Cloud - Facebook Ads ストアドプロシージャ

Name Description
AddCustomAudienceUsers Updates a custom audience to add the specified users.
CreateAdInsightsReport Generates a report schema for ad insights.
CreateAdPreview Creates a schema file for an app insight.
DeleteCustomAudienceUsers Deletes a specified set of users from a custom audience.

CData Cloud

AddCustomAudienceUsers

Updates a custom audience to add the specified users.

Procedure Specific Info

Configuration

Interacting with custom audience users requires configuring both a schema and payload. The PayloadSchema maps out the PII that will be represented in PayloadData.

PayloadSchema can be set as a single key, resulting in a 1-dimensional array in PayloadData:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='123456789123456789',
	@PayloadSchema='EMAIL_SHA256',
	@PayloadData='["31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66", "7df7e024c945682f00f2c6410593f407dec0e870af2a9147a62ac459db35d6b8", ...]'

PayloadSchema can also be set as a JSON array with multiple keys, resulting in a 2-dimensional array in PayloadData:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "LN"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman"
					],
					[
						"[email protected]",
						"Exampletoo"
					],
					...
				  ]'

To apply the "Limited Data Use" flag to users, it should be specified with the special "DATA_PROCESSING_OPTIONS" key in PayloadSchema, and must be provided as a nested array member in PayloadData. If using LDU and non-LDU rows in the same payload, an empty array should be used where LDU is disabled:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "DATA_PROCESSING_OPTIONS"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman",
						["LDU"]
					],
					[
						"[email protected]",
						"Exampletoo",
						[]
					],
					...
				  ]'

Session Management

Facebook Ads only allows a maximum of 10000 users to be added to a custom audience in a single request. If more than 10000 (or PageSize, if set) rows are present in PayloadData, the Cloud will break the provided PayloadData down into multiple requests. Note that the SessionId parameter must be set in this case.

Hashing and Normalization

Facebook Ads has strict hashing and normalization rules for Customer File Custom Audience User information submitted through the API. The Cloud will handle hashing data (where appropriate) if the HashData parameter is set to true, but not normalizing data. See the Facebook Ads API docs for more information on the necessary data normalization.

Note: For single-key schema, only pre-hashed datatypes (E.G. 'EMAIL_SHA256') are supported by the Facebook Ads API. The Cloud expects these data types to already be hashed when provided.

Input

Name Type Description
CustomAudienceId String The ID of the custom audience to add users to.
PayloadSchema String Type of information represented by PayloadData. Should be either a single string, or a JSON array with multiple key types. Supported key types are: EXTERN_ID, EMAIL, PHONE, GEN, DOBY, DOBM, DOBD, LN, FN, FI, CT, ST, ZIP, MADID, COUNTRY
PayloadData String JSON array containing keys for each user to add to custom audience. If using multiple key types in schema, should be a two-dimensional array, with each row containing multiple keys in order specified in PayloadSchema.
PayloadAppIds String JSON array of integer app IDs used by users being uploaded. Required if PayloadSchema is a Facebook UID and the IDs were collected by an app integration.
PayloadPageIds String JSON array of integer page IDs used by users being uploaded. Required if schema is a Facebook UID and the IDs were collected by a Page webhook integration.
PayloadDataSourceType String Type of the underlying custom audience. Supported values are: UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE
PayloadDataSourceSubType String SubType of the underlying custom audience. Supported values are: ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, SUBSCRIBER_LIST, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, FACEBOOK_WIFI_EVENTS, AR_EXPERIENCE_EVENTS, AR_EFFECTS_EVENTS, MESSENGER_ONSITE_SUBSCRIPTION, WHATSAPP_SUBSCRIBER_POOL, MARKETPLACE_LISTINGS, AD_CAMPAIGN, GROUP_EVENTS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, SIGNAL_SOURCE, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CUSTOM_DATA_TARGETING, CONTACT_IMPORTER, DATA_FILE
HashData String Boolean value indicating if provider should handle hashing of data. Set to true to have the connector hash the provided data before sending to the service. Defaults to false.
SessionId String Session ID for upload involving more than 'PageSize' users (default of 10000). If PayloadData contains more than 'PageSize' records, set this value to a positive 64-bit integer.
PageSize String Number of records to include in 'PayloadData' in each request. Maximum and default of 10000.

Result Set Columns

Name Type Description
Result String Success or Failure.
NumReceived String Number of custom audience users received as reported by Facebook Marketing API.
NumInvalidEntries String Number of invalid entries in PayloadData as reported by Facebook Marketing API.
InvalidEntrySamples String JSON map representing samples of invalid entries.

CData Cloud

CreateAdInsightsReport

Generates a report schema for ad insights.

Input

Name Type Description
ReportName String The name of the report.
Description String An optional description for the report.
Fields String Comma-delimited list of non-breakdown fields for your report. Available values: AccountCurrency,ActionValue,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,ConversionRateRanking,CostPerEstimatedAdRecallers,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,EstimatedAdRecallRate,EstimatedAdRecallers,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,InstantExperienceClicksToOpen,InstantExperienceClicksToStart,InstantExperienceOutboundClicks,Objective,QualityRanking,Reach,Spend,UniqueClicks,UniqueCTR,UniqueInlineLinkClicks,UniqueInlineLinkClickCounter,UniqueLinkClicksCounter

デフォルト値はAccountCurrency,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,Reach,Spendです。

Breakdowns String Breakdowns for your report. Available values: Age,Country,DevicePlatform,DMA,FrequencyValue,Gender,HStatsByAdvertiserTZ,HStatsByAudienceTZ,ImpressionDevice,PlacePageId,PlatformPosition,ProductId,PublisherPlatform,Region
ActionBreakdowns String Action breakdowns for your report. Available values: ActionCanvasComponentName,ActionCarouselCardId,ActionCarouselCardName,ActionConvertedProductId,ActionDestination,ActionDevice,ActionReaction,ActionTargetId,ActionType,ActionVideoSound,ActionVideoType
ActionCollection String Collections of ads actions stats to return for your report. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas

デフォルト値はActionsです。

ActionAttributionWindows String A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default is [1d_view,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.

デフォルト値はdefaultです。

DatePreset String An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.

使用できる値は次のとおりです。maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month

デフォルト値はmaximumです。

TimeIncrement String The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.

デフォルト値は90です。

OutputDirectory String The directory where the schema file will be written. If no directory is specified, the generated report will be written to the FileData output.

Result Set Columns

Name Type Description
Result String Success or Failure.
SchemaFile String The generated schema file.
Columns String The number of columns found.
FileData String The BASE64 downloaded file content. Only returned if SchemaDirectory and FileStream is not set.

CData Cloud

CreateAdPreview

Creates a schema file for an app insight.

Input

Name Type Description
AdCreativeId String An ID of the ad creative to use for creating the preview from.
AdFormat String The format of the ad to use.

使用できる値は次のとおりです。AUDIENCE_NETWORK_INSTREAM_VIDEO, AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE, AUDIENCE_NETWORK_OUTSTREAM_VIDEO, AUDIENCE_NETWORK_REWARDED_VIDEO, DESKTOP_FEED_STANDARD, FACEBOOK_STORY_MOBILE, INSTAGRAM_STANDARD, INSTAGRAM_STORY, INSTANT_ARTICLE_STANDARD, INSTREAM_VIDEO_DESKTOP, INSTREAM_VIDEO_MOBILE, MARKETPLACE_MOBILE, MESSENGER_MOBILE_INBOX_MEDIA, MOBILE_BANNER, MOBILE_FEED_BASIC, MOBILE_FEED_STANDARD, MOBILE_FULLWIDTH, MOBILE_INTERSTITIAL, MOBILE_MEDIUM_RECTANGLE, MOBILE_NATIVE, RIGHT_COLUMN_STANDARD, SUGGESTED_VIDEO_DESKTOP, SUGGESTED_VIDEO_MOBILE, WATCH_FEED_MOBILE

CreativeFeature String Name of a creative features to preview. Only applies to Marketing API versions 22.0 and above. Supported features include image_templates, image_touchups, video_auto_crop, enhance_cta, text_optimizations, image_background_gen, image_uncrop, and description_automation.
ApplyStandardEnhancements Boolean If set to true, standard enhancements are applied to automatically create multiple variations of your ad and show a personalized variation to each Account Center account based on what they're most likely to respond to. Only applies to Marketing API versions 21.0 and below.

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Url String A url to the preview.

CData Cloud

DeleteCustomAudienceUsers

Deletes a specified set of users from a custom audience.

Procedure Specific Info

Configuration

Interacting with custom audience users requires configuring both a schema and payload. The PayloadSchema maps out the PII that will be represented in PayloadData.

PayloadSchema can be set as a single key, resulting in a 1-dimensional array in PayloadData:

EXECUTE DeleteCustomAudienceUsers 
	@CustomAudienceId='123456789123456789',
	@PayloadSchema='EMAIL_SHA256',
	@PayloadData='["31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66", "7df7e024c945682f00f2c6410593f407dec0e870af2a9147a62ac459db35d6b8", ...]'

PayloadSchema can also be set as a JSON array with multiple keys, resulting in a 2-dimensional array in PayloadData:

EXECUTE DeleteCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "LN"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman"
					],
					[
						"[email protected]",
						"Exampletoo"
					],
					...
				  ]'

To apply the "Limited Data Use" flag to users, it should be specified with the special "DATA_PROCESSING_OPTIONS" key in PayloadSchema, and must be provided as a nested array member in PayloadData. If using LDU and non-LDU rows in the same payload, an empty array should be used where LDU is disabled:

EXECUTE DeleteCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "DATA_PROCESSING_OPTIONS"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman",
						["LDU"]
					],
					[
						"[email protected]",
						"Exampletoo",
						[]
					],
					...
				  ]'

Session Management

Facebook Ads only allows a maximum of 10000 users to be added to a custom audience in a single request. If more than 10000 (or PageSize, if set) rows are present in PayloadData, the Cloud will break the provided PayloadData down into multiple requests. Note that the SessionId parameter must be set in this case.

Hashing and Normalization

Facebook Ads has strict hashing and normalization rules for Customer File Custom Audience User information submitted through the API. The Cloud will handle hashing data (where appropriate) if the HashData parameter is set to true, but not normalizing data. See the Facebook Ads API docs for more information on the necessary data normalization.

Note: For single-key schema, only pre-hashed datatypes (E.G. 'EMAIL_SHA256') are supported by the Facebook Ads API. The Cloud expects these data types to already be hashed when provided.

Input

Name Type Description
CustomAudienceId String The ID of the custom audience to delete from.
PayloadSchema String Type of information represented by PayloadData. Should be either a single string, or a JSON array with multiple key types. Supported key types are: EXTERN_ID, EMAIL, PHONE, GEN, DOBY, DOBM, DOBD, LN, FN, FI, CT, ST, ZIP, MADID, COUNTRY
PayloadData String JSON array containing keys for each user to add to custom audience. If using multiple key types in schema, should be a two-dimensional array, with each row containing multiple keys in order specified in PayloadSchema.
PayloadAppIds String JSON array of integer app IDs used by users being uploaded. Required if PayloadSchema is a Facebook UID and the IDs were collected by an app integration.
PayloadPageIds String JSON array of integer page IDs used by users being uploaded. Required if schema is a Facebook UID and the IDs were collected by a Page webhook integration.
PayloadDataSourceType String Type of the underlying custom audience. Supported values are: UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE
PayloadDataSourceSubType String SubType of the underlying custom audience. Supported values are: ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, SUBSCRIBER_LIST, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, FACEBOOK_WIFI_EVENTS, AR_EXPERIENCE_EVENTS, AR_EFFECTS_EVENTS, MESSENGER_ONSITE_SUBSCRIPTION, WHATSAPP_SUBSCRIBER_POOL, MARKETPLACE_LISTINGS, AD_CAMPAIGN, GROUP_EVENTS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, SIGNAL_SOURCE, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CUSTOM_DATA_TARGETING, CONTACT_IMPORTER, DATA_FILE
HashData String Boolean value indicating if provider should handle hashing of data. Set to true to have the connector hash the provided data before sending to the service. Defaults to false.
SessionId String Session ID for upload involving more than 'PageSize' users (default of 10000). If PayloadData contains more than 'PageSize' records, set this value to a positive 64-bit integer.
PageSize String Number of records to include in 'PayloadData' in each request. Maximum and default of 10000.

Result Set Columns

Name Type Description
Result String Success or Failure.
NumReceived String Number of custom audience users received as reported by Facebook Marketing API.
NumInvalidEntries String Number of invalid entries in PayloadData as reported by Facebook Marketing API.
InvalidEntrySamples String JSON map representing samples of invalid entries.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Facebook Ads のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、AdAccounts テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdAccounts' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのFacebook Ads プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、AdAccounts テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAccounts' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AccountId広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。
AuthenticateAsPageFacebook への要求時に認証するページの名前またはID。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
ScopeThe scope to use when authenticating to Facebook.

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
AggregateFormat集計またはコレクションの列を返す場合の形式。
AsyncTimeoutWhen sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown.
AutoDetectPageTokensControls whether the driver attempts to automatically detect the page token to use for a query targeting a page.
IgnoreValidationExceptionIgnore internal validation exception when breakdown combination is not valid.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PagesizeFacebook Ads から返されるページあたりの結果の最大数。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RetryLevelThe most granular ad object level at which the driver will try to retrieve results on retry.
Target何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。
TimeIncrementThe time increment used for ad and other ad object insights reporting.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UploadLinkedMedia新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。
CData Cloud

Authentication

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


プロパティ説明
AccountId広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。
AuthenticateAsPageFacebook への要求時に認証するページの名前またはID。
CData Cloud

AccountId

広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。

データ型

string

デフォルト値

""

解説

Target 接続プロパティは、この接続プロパティよりも優先され、任意の広告アカウント、広告キャンペーン、広告セット、または広告のID を指定するために使用できます。詳しくは、Facebook Ads データのクエリ を参照してください。

CData Cloud

AuthenticateAsPage

Facebook への要求時に認証するページの名前またはID。

データ型

string

デフォルト値

""

解説

データを取得するページのID。ページは認証されたユーザーにより管理されている必要があり、Pages ビューをクエリすることでそれらのすべてのページのID を取得することができます。

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
ScopeThe scope to use when authenticating to Facebook.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

Scope

The scope to use when authenticating to Facebook.

データ型

string

デフォルト値

""

解説

The scope that are used when authenticating to Facebook give your App access to request additional information that may be required for certain tables. Individual scope may be entered in a comma separated list. Leaving it blank will use the defaults. The Scope is only used if you have specified your own OAuthClientId and OAuthClientSecret.

Requesting Additional Permissions

You may find while using the Cloud that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/.

CData Cloud

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

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


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

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


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

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


プロパティ説明
AggregateFormat集計またはコレクションの列を返す場合の形式。
AsyncTimeoutWhen sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown.
AutoDetectPageTokensControls whether the driver attempts to automatically detect the page token to use for a query targeting a page.
IgnoreValidationExceptionIgnore internal validation exception when breakdown combination is not valid.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PagesizeFacebook Ads から返されるページあたりの結果の最大数。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RetryLevelThe most granular ad object level at which the driver will try to retrieve results on retry.
Target何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。
TimeIncrementThe time increment used for ad and other ad object insights reporting.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UploadLinkedMedia新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。
CData Cloud

AggregateFormat

集計またはコレクションの列を返す場合の形式。

Possible Values

JSON, XML

データ型

string

デフォルト値

"JSON"

解説

集計またはコレクションの列を返す場合の形式。

CData Cloud

AsyncTimeout

When sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown.

データ型

string

デフォルト値

"300"

解説

The operations run until they complete successfully or until they encounter an error condition.

If AsyncTimeout expires and the operation is not yet complete, the driver throws an exception.

CData Cloud

AutoDetectPageTokens

Controls whether the driver attempts to automatically detect the page token to use for a query targeting a page.

データ型

bool

デフォルト値

true

解説

By default, the driver automatically detects and uses the appropriate page token for queries targeting a page. Set this property to False to disable automatic detection. When disabled, you must use the AuthenticateAsPage property to specify the ID of the page you intend to query.

CData Cloud

IgnoreValidationException

Ignore internal validation exception when breakdown combination is not valid.

データ型

bool

デフォルト値

false

解説

When set to "True", the supplied breakdown combination for an insights query will be passed directly to Facebook, without any internal attempts at validation by the Cloud. If the supplied combination is invalid, the error message from Facebook Ads will be returned directly to the user. Refer to Facebook documentation on breadown combinations for information on valid combinations.

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

Pagesize

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

データ型

string

デフォルト値

""

解説

Pagesize プロパティは、Facebook Ads から返されるページあたりの結果の最大数に影響を与えます。時折、要求するデータを少なくすることを要求するエラーが出ることがあります。 ページサイズを減らすことでそのようなエラーの発生頻度を下げることが可能です。 最大ページサイズはページあたり100であることが多いです。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

RetryLevel

The most granular ad object level at which the driver will try to retrieve results on retry.

Possible Values

ACCOUNT, CAMPAIGN, ADSET, AD

データ型

string

デフォルト値

"ACCOUNT"

解説

This property only applies if no Target is specified for the submitted query. The RetryLevel property limits the levels of ad objects that the driver will attempt to get data for on retry requests for certain errors. The Insights API for ad insights will return specific errors if the response for an ad insights query from the driver would return too many rows, or have to be computed over too many data points. For these errors, the driver will attempt to retry the query targeting the next most granular level of ad object, up to the level of ad object specified by RetryLevel. The driver's ad object precedence is listed below, from least granular to most granular:

  1. Account
  2. Campaign
  3. AdSet
  4. Ad
If the Level parameter is specified in a query, or if using a view that has a pre-defined value for Level, the driver will not attempt to retry beyond the ad object level specified by Level.

CData Cloud

Target

何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。

データ型

string

デフォルト値

""

解説

何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。

CData Cloud

TimeIncrement

The time increment used for ad and other ad object insights reporting.

データ型

string

デフォルト値

"monthly"

解説

This property controls the time increment for insights reporting, which is the increment of time covered by each row in the insights result set. Valid specifications for the property are as follows:

  1. monthly
  2. all_days
  3. Any integer between 1 and 90 inclusive.
Integer values correspond to the number of days for the increment.

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UploadLinkedMedia

新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。

データ型

bool

デフォルト値

false

解説

UploadLinkedMedia は、投稿を挿入する前にメディアをアップロードするかどうかを決定します。True に設定すると、Link カラムで新しい投稿を挿入しようとすると、ドライバーは最初にURL が写真もしくは動画を参照しているかどうかを判断します。 参照している場合は、最初に写真または動画がアップロードされ、次にそのメディアを含む新しい投稿が作成されます。False の場合、新しい投稿はリンク投稿として作成されます。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434