CData Sync App は、Facebook Ads データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Facebook Ads コネクタはCData Sync アプリケーションから使用可能で、Facebook Ads からデータを取得して、サポートされている任意の同期先に移動できます。
デフォルトでは、Sync App は現在のバージョンのFacebook Graph API をビューとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Facebook Ads はユーザー認証にOAuth 標準を使用しています。
Sync App の使用中に、指定のアクションを行う権限がアプリにありませんというエラーメッセージが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 アプリの作成 を検討してください。
次のセクションでは、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.
Facebook Ads の広告データは、Sync App によって公開される複数のビューを通じて表示され、アクセスされます。このビューの詳細については、データモデル を参照してください。Facebook Ads の仕組み上、これらのビューのクエリには、以下に示すような基本的なルールがいくつかあります。どのビューについても、データモデル セクションの該当ページで、そのビューのクエリに関連する詳細について説明します。
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 が必要ですが、レポーティング機能のためのより詳細なクエリ構文もサポートしています。
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 では、同時に選択できる内訳に制限を課しているため、デフォルトでは、Sync App に指定されるクエリの内訳にも同様の制限を課しています。必要であれば、IgnoreValidationException プロパティによってこの内部強制を無効にすることができます。このプロパティを"True" に設定すると、内訳に関する内部的な制限が回避され、指定された内訳の組み合わせがそのままFacebook に渡されます。
内訳の組み合わせについての詳細はデータモデル を参照してください。
AdInsightsActions ビューにはActionCollection カラムもあり、広告に帰属するアクションの種類を指定することができます。
AdInsightsActions ビューには、ActionAttributionWindows カラムもあり、Facebook Ads がレポートを生成する際に、広告オブジェクトにどのようにアクションを関連付けるかを制御することができます。ActionAttributionWindows は、アクションと期間の組み合わせを定義する組み合わせのリストから指定されます。たとえば、ActionAttributionWindows のデフォルト値は「7d_click,1d_view」で、広告オブジェクトをクリックしてから7日以内、または表示してから1日以内に実行された関連アクションが、広告オブジェクトに帰属し、レポートされることを意味します。
Facebook Ads にクエリを実行して広告インサイトのデータを取得する方法はいくつかあり、AdInsights およびAdInsightsActions ビューは、これらすべてのクエリ方法を容易にします。データモデルとクエリの操作を簡単にするには、AdInsights またはAdInsightsActions 用に記述するクエリに対応する、事前定義済みの簡易レポートを使用するか、CreateAdInsightsReport ストアドプロシージャを使用して独自の広告インサイトレポートを定義します。
ドライバーには次の事前定義済みレポートが含まれます。
これらのビューへのクエリは、クエリする内訳とアクションコレクションがすでに定義されているという点で、AdInsights とAdInsightsActions へのクエリよりも簡単です。ただし、これらのビューへのクエリにはTarget 広告オブジェクトの指定が必要であり、Level およびActionAttributionWindows フィルタを使用することもできます。
SELECT * FROM AdInsights_ByActionReaction_90DayIncr WHERE Target='act_12345' AND Level='adset'
ビューの命名スキームは、ビューでクエリされる内訳と、ビューで使用されるデフォルトの時間増分を定義しています。ビューは、可能な限り過去にさかのぼって広告データをクエリしようと試みます。デフォルトのビューの時間範囲と時間増分は、クエリの入力で変更できます。
Sync App に付属する定義済みレポートにないフィールドを定期的に要求する必要がある場合や、ユーザー向けにシンプルな広告レポートを作成する場合は、必要なデータを簡単にクエリできるように、独自のカスタム広告レポートを定義できます。このためには、CreateAdInsightsReport ストアドプロシージャを使用します。
ストアドプロシージャは、指定された出力オプションに応じてスキーマファイルを出力します。生成されたレポートの出力パスにLocation 接続プロパティを設定し、Sync App でクエリ可能なテーブルとして公開します。
次のストアドプロシージャの呼び出し例では、指定したフィールド、内訳、アクション内訳、およびアクションコレクションを使用して、カスタム広告インサイトレポートを作成します。
EXEC CreateAdInsightsReport @ReportName = 'AdInsights_CreatedReport', @Fields = 'AccountCurrency,AdAccountId', @Breakdowns = 'Country', @ActionBreakdowns='ActionType,ActionDestination',@ActionCollection='Actions,UniqueActions', @OutputDirectory='LOCATION'"この例では、@OutputDirectory パラメータはLocation 接続プロパティで指定された場所に設定されます。
次のプロパティを使って、Facebook Ads API 機能およびSync App のストラテジーをさらに制御できます。
このセクションでは、Facebook Ads Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、Facebook Ads API をリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー では、利用可能なビューを説明します。次の2種類のビューが用意されています。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
その他の定義済み日付フィールドも利用可能です:
これらでフィルタリングを行う場合、= 演算子を使用して、日付を期間の初日に設定します。異なる日付を指定するとエラーが返されます。
たとえば、2022年の5月を指定するには、その月の初日を指定して、次の条件を使用します。
month = '2022-05-01'
“Date” は、クエリ結果に日次データを返します。次に例を示します。
SELECT ID, Target, Name, Status, "Date" FROM CData.FacebookAds.Campaigns WHERE "Date" BETWEEN '2022-01-01' and '2023-01-31' and Id = '15526475270_410830705612736_5193593'“Hour” は、選択した日付範囲で時間ごとに集計されたデータを返します。たとえば、2年分のデータをクエリして“Hour” を選択すると、2年分のデータが時間ごとに集計された24行のデータ(1時間ごとに1行)が返されます。
“DayofWeek” は、選択した日付範囲で曜日ごとに集計されたデータを返します。例えば、2年分のデータをクエリして“DayOfWeek” を選択すると、2年分のデータが曜日ごとに集計された7行のデータ(1曜日ごとに1行)が返されます。
“Week” は、選択した日付範囲で週ごとに集計されたデータを返します。例えば、2年分のデータをクエリして“Week” を選択すると、2年分のデータが週ごとに集計された104行のデータ(1週ごとに1行)が返されます。
“Month” は、選択した日付範囲で1月ごとに集計されたデータを返します。例えば、2年分のデータをクエリして“Month” を選択すると、2年分のデータが月ごとに集計された24行のデータ(1月ごとに1行)が返されます。
“MonthofYear” は、選択した日付範囲で月ごとに集計されたデータを返します。たとえば、2年分のデータをクエリして“MonthofYear” を選択すると、2年分のデータが月ごとに集計された12行のデータ(1月ごとに1行)が返されます。
“Quarter” は、選択した日付範囲で四半期ごとに集計されたデータを返します。たとえば、2年分のデータをクエリして“Quarter” を選択すると、8行のデータ(四半期ごとに1行)が返されます。なお、四半期は1月、4月、7月、10月の各月の1日を起算日と定義します。
“Year” は、選択した日付範囲で年ごとに集計されたデータを返します。たとえば、2年分のデータをクエリして“Year” を選択すると、2年分のデータが年ごとに集計された2行のデータ(1年ごとに1行)が返されます。
NOTE: "Date" を選択すると、他の日付指標がオーバーライドされます。常に日次データのみを返します。
Sync App はFacebook Ads のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| CustomAudiences | Query information about custom audiences defined for your ad accounts. |
| CustomConversions | Query information about custom conversions defined for your ad accounts. |
Query information about custom audiences defined for your ad accounts.
Custom audiences in Facebook Ads represent an advertiser-defined audience to deliver ads to.
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.
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.
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.
| 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. |
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. |
Query information about custom conversions defined for your ad accounts.
Custom conversions in Facebook represent conversion events to optimize ad delivery.
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.
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.
When deleting CustomConversions, the Id of the object should be specified:
DELETE FROM CustomConversions WHERE ID='123abc'
| 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 |
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 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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 | 特定の広告アカウント、広告セット、または広告の、広告クリエイティブ情報をクエリします。広告クリエイティブ情報へのアクセスには、ads_read アクセス許可が必要です。 |
| 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 | ユーザーが現在のアプリケーションに付与した権限をクエリします。 |
Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.
| 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. |
ユーザーが利用できる広告アカウントをクエリします。広告アカウント情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のAdAccounts は、広告を作成するために利用できるFacebook のアカウントです。そのようなアカウントのID は、"act_" 形式で返されます。また、別のテーブル用のリクエストにターゲットとして指定される場合は、"act_" が接頭辞として付けているID のみを指定する必要があります。
広告アカウントをクエリする場合は、結果をフィルタするには、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 が指定されていない場合は、ユーザーアカウントに利用可能なアカウントが一覧表示されます。
| 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 | 協定世界時と現地時間の差異。 |
特定の広告アカウント、広告セット、または広告の、広告クリエイティブ情報をクエリします。広告クリエイティブ情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のAdCreatives は、Facebook の特定のAds のクリエイティブのコレクションです。
広告クリエイティブをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットとしては、広告アカウント、広告セット、または広告を指定できます。次に例を示します。
SELECT * FROM AdCreatives WHERE Target = 'adid'
| Name | Type | Description |
| ID [KEY] | String | 広告クリエイティブのID。 |
| Target | String | 広告セットの取得元になる広告アカウントIDまたはキャンペーンID。 |
| Name | String | 広告クリエイティブの名前。 |
| ApplinkTreatment | String | 動的プロダクト広告においてアプリがインストールされていない場合のdeep link フォールバック。
使用できる値は次のとおりです。deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only |
| Body | String | 広告のボディ。 |
| CallToActionType | String | レガシー広告のアクション要求ボタンのテキストとヘッダー。
使用できる値は次のとおりです。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 | 広告で使われるInstagram 投稿のID。 |
| EffectiveInstagramStoryId | String | Instagram 広告として表示するInstagram 投稿のID。 |
| ImageHash | String | クリエイティブで利用できる画像の画像ハッシュ。 |
| ImageUrl | String | クリエイティブの画像のURL。このURL で指定された画像は広告アカウントの画像ライブラリに保存されます。 |
| InstagramActorId | String | Instagram アクターID。 |
| InstagramPermalinkUrl | String | Instagram のパーマリンク。 |
| InstagramUserId | String | 広告作成のためのInstagram ユーザーのID。 |
| LinkOgId | String | ランディングページがOG タグを持つ場合、このクリエイティブのリンクのOpen Graph (OG) ID。 |
| LinkUrl | String | ページのタブURL によるページへの特定のランディングページの指定に使用(e.g. ページタブアプリ)。 |
| ObjectId | String | 広告もしくは広告タイプに該当するPromoted_object もしくはobject のID。 |
| ObjectStoryId | String | 広告で使われるページ投稿のID。 |
| ObjectType | String | 広告されているもののタイプ。
使用できる値は次のとおりです。APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID |
| ObjectUrl | String | リンク広告でページでつながっていない行先のURL。 |
| PageId | String | クリエイティブのアクターID(ページID)。 |
| ProductSetId | String | クリエイティブで設定されている製品のID。 |
| RunStatus | String | クリエイティブの実行ステータス。
使用できる値は次のとおりです。ACTIVE, DELETED |
| SourceInstagramMediaId | String | 広告作成のためのInstagram 投稿のID。 |
| TemplateUrl | String | 動的プロダクト広告のトラッキングURL。 |
| ThumbnailUrl | String | このクリエイティブのサムネイルへのURL。 |
| Title | String | リンク広告のタイトル(ページには接続されない)。 |
| UrlTags | String | ページ投稿広告、投稿のメッセージ、もしくはCanvas アプリのインストールクリエイティブからクリックされたURL に追記されるか、リプレースされるクエリ文字列パラメータのセット。 |
| UsePageActorOverride | Boolean | この値がtrue の場合、モバイルアプリ広告のページアクターを表示します。 |
| AdLabels | String | クリエイティブに関連する広告ラベル。 |
| ObjectStorySpecLinkData | String | 新しい非公開のページ投稿を作成するためのリンクデータ。他のObjectStorySpec カラムがnull の場合にのみ値を持ちます。 |
| ObjectStorySpecPhotoData | String | 新しい非公開のページ投稿を作成するための写真データ。他のObjectStorySpec カラムがnull の場合にのみ値を持ちます。 |
| ObjectStorySpecVideoData | String | 新しい非公開のページ投稿を作成するための動画データ。他のObjectStorySpec カラムがnull の場合にのみ値を持ちます。 |
| ObjectStorySpecTextData | String | 新しい非公開のページ投稿を作成するためのテキストデータ。他のObjectStorySpec カラムがnull の場合にのみ値を持ちます。 |
| ObjectStorySpecTemplateData | String | 新しい非公開のページ投稿を作成するためのテンプレートデータ。他のObjectStorySpec カラムがnull の場合にのみ値を持ちます。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。 詳細については、WHERE 句のセクションを参照してください。
| Name | Type | Description |
| ThumbnailHeight | String | ThumbnailUrl で指定したサムネイルのレンダリング高さ(ピクセル単位)。デフォルトは64です。 |
| ThumbnailWidth | String | ThumbnailUrl で指定したサムネイルのレンダリング幅。デフォルトは64です。 |
Images associated with an ad account
Facebook の広告画像は、広告クリエイティブで使用できる個別の画像を表します。
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'
| 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. |
広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。
SELECT * FROM AdInsights WHERE Target = 'act_123456'
Adinsights に対するSELECT * クエリでデフォルトで常にフェッチされるカラム:
Adinsights でこの挙動を示す可能性のある指標カラムは、以下のとおりです。
次に例を示します。
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 * を使うと、ブレークダウンカラムは使われません。利用可能なブレークダウンカラムは次のとおりです。
他の多くのカラムは、標準SQL WHERE clause modifiers と使うことができます。次に例を示します。
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000
Facebook Ads では、同時に選択できるブレークダウンに制限を課しているため、デフォルトでは、Sync App に指定されるクエリのブレークダウンにも同様の制限を課しています。必要に応じて、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 Sync App 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.
| 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% となります。 |
| 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 | The number of pixels added to the cart is attributed to the Ad. |
| PixelPurchase | Int | The number of pixel purchases attributed to the Ad. |
| 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 | 広告が表示された地域。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。 |
| AdEffectiveStatus | String | 広告アカウントより低いレベルでインサイトを取得する際にサポートされているステータスの入力専用リスト。有効な値の例については、AdStatus にリストされている値を参照してください。 |
| UseAsync | Boolean | インサイトの取得に非同期呼び出しを使用する必要があるかどうかを示すboolean。 |
| DefaultSummary | Boolean | デフォルトサマリーを取得するかどうかを示すboolean。 |
広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。
AdInsightsActions は、AdInsights からのActions カラムのブレークダウンを表します。AdInsights のクエリについての一般的な情報は、AdInsights を参照してください。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'Adinsightsactions に対するSELECT * クエリでデフォルトで常にフェッチされるカラム:
Adinsightsaction でこの挙動を示す可能性のある指標カラムは、以下のとおりです。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND level = 'ad' AND ActionAttributionWindows = '1d_view,7d_view,28d_click'
複数のコレクションを指定するには、IN 句でActionCollection を使用します。
次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions', 'UniqueActions')
AdInsightsActions で利用可能なその他のブレークダウンは以下のとおりです。
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 Sync App 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.
| 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, 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です。 |
| AdAccountId | String | レポート行と関連のある広告アカウントのID。 |
| AdAccountName | String | レポート行と関連のある広告アカウントの名前。 |
| CampaignId | String | レポート行と関連のあるキャンペーンのID。 |
| CampaignName | String | レポート行と関連のあるキャンペーンの名前。 |
| AdSetId | String | レポート行と関連のある広告セットのID。 |
| AdSetName | String | レポート行と関連のある広告セットの名前。 |
| AdId | String | レポート行と関連のある広告のID。 |
| AdName | String | レポート行と関連のある広告の名前。 |
| ActionType | String | 広告が表示された後に広告、ページ、アプリ、イベント内で起こったアクションの種類(広告がクリックされなかった場合も含む)。 |
| ActionValue | Integer | アトリビューションウィンドウのMetric 値。 |
| 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 value of attribution window which is powered by data driven model. |
| ActionCanvasComponentName | String | Canvas 広告内のコンポーネント名。 |
| ActionCarouselCardId | String | あなたの広告を見た時の人々のカルーセルカードのID。 |
| ActionCarouselCardName | String | あなたの広告を見た際の特定のカルーセルカード。カードはヘッドラインから特定されます。 |
| ActionConvertedProductId | String | コンバートされた製品ID - 共同広告用 |
| ActionDestination | String | あなたの広告をクリックした後の人々の行先。 |
| ActionDevice | String | トラッキングしているコンバージョンイベントが起こったデバイス。 |
| ActionReaction | String | あなたの広告もしくはブーストされた投稿へのリアクションの数。 |
| ActionTargetId | String | あなたの広告をクリックした後の行先のID。 |
| ActionVideoSound | String | 動画広告を見た際の音の(on/off) ステータス。 |
| ActionVideoType | String | 動画指標のブレークダウン。 |
| 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 | 広告が表示された地域。これはブレークダウンカラムです。このカラムを選択すると指標によって結果がさらにブレークダウンされます。 |
| AdEffectiveStatus | String | 広告アカウントより低いレベルでインサイトを取得する際にサポートされているステータスの入力専用リスト。有効な値の例については、AdStatus にリストされている値を参照してください。 |
| UseAsync | Boolean | インサイトの取得に非同期呼び出しを使用する必要があるかどうかを示すboolean。 |
Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.
| 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. |
広告ラベルに関する情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。
| Name | Type | Description |
| ID [KEY] | String | 広告ラベルのID。 |
| Target | String | ラベルを取得する広告アカウントID。 |
| Name | String | 広告ラベルの名前。 |
| CreatedTime | Datetime | 広告ラベルの作成時刻。 |
| UpdatedTime | Datetime | 広告ラベルが最後に更新された時刻。 |
特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のAds は、作成された個々の広告です。
広告アカウントをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。次に例を示します。
SELECT * FROM Ads WHERE Target = 'act_123456'
さらに、> または >= 演算子とともにUpdatedTime を使うことで、特定の日付より新しいレコードのみを取得できます。次に例を示します。
SELECT * FROM Ads WHERE Target = 'act_123456' AND UpdatedTime > '01/01/2016'
| 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。 |
特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告セット情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のAdSets は、Facebook 内のAds のコレクションです。
広告セットをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットとしては、広告アカウントまたはキャンペーンを指定できます。次に例を示します。
SELECT * FROM AdSets WHERE Target = 'act_123456'
| 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 | 広告セットの情報収集期間の進捗状況。 |
ターゲットに関連付けられたアルバムをクエリします。通常、アルバム情報へのアクセスには、user_photos アクセス許可が必要です。
| 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 | アルバムが最後に更新された時刻。 |
指定されたアプリにおいてビジネスの広告を運営する権限を付与された広告アカウント。このビューの利用には、あなたのユーザーID で少なくとも1つのビジネスが設定されている必要があります。
Facebook のAuthorizedAdAccounts は、Facebook ビジネス向けに指定されたアプリケーションで宣伝できる広告アカウントを表します。このビューを正しく動作させるには、Facebook にビジネスを設定する必要があります。
AuthorizedAdAccounts のクエリには、Target を指定する必要があり、オプションでビジネスを指定できます。次に例を示します。
SELECT * FROM AdAccounts WHERE Target = 'ApplicationId' AND Business = 'BusinessId'
ビジネスが指定されていない場合、すべての使用可能なビジネスからの結果が返されます。
| Name | Type | Description |
| ID [KEY] | String | 広告アカウントのID。 |
| Target | String | 認可された広告アカウントから要求するアプリID。 |
| AccountId | String | Facebookで直接見ている広告アカウントのID。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。 詳細については、WHERE 句のセクションを参照してください。
| Name | Type | Description |
| Business | String | 認可された広告アカウントを取得するビジネスのID。 |
Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
| 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. |
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.
| 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. |
Facebook ユーザーのビジネスをクエリします。ビジネス情報へのアクセスには、business_management アクセス許可が必要です。
| Name | Type | Description |
| ID [KEY] | String | ビジネスのID。 |
| Name | String | ビジネスの名前。 |
| PrimaryPage | String | ビジネスのprimary ページ。 |
| TimezoneId | String | ビジネスのタイムゾーンID。 |
| Link | String | ビジネスのリンク。 |
| CreatedTime | Datetime | ビジネスが追加された時刻。 |
| UpdatedTime | Datetime | ビジネスが更新された時刻。 |
特定の広告アカウントのキャンペーン情報をクエリします。キャンペーン情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のCampaigns は、個々のAds またはAdSets が含まれている広告キャンペーンです。
キャンペーンをクエリする場合は、結果をフィルタするには、ID またはTarget のいずれかを指定する必要があります。ターゲットは、広告アカウントである必要があります。次に例を示します。
SELECT * FROM Campaigns WHERE Target = 'act_123456'
| 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 | キャンペーンが最後に更新された時刻。 |
Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.
| 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. |
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.
| 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. |
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.
| 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. |
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.
| 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. |
Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.
| 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. |
Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.
| 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. |
リードに関する情報をクエリします。リード情報へのアクセスには、ads_read アクセス許可が必要です。
Facebook のLeadValue はLead Ad からの個々のvalue を表します。Lead を説明するvalue のタイプはさまざまで、車のモデルなどのカスタム情報から、名前やメールなどの一般的な情報まで幅広くあります。
リードバリューをクエリする場合は、結果をフィルタするには、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 のコレクションです。
| 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 | リードの作成時刻。 |
提供されたID に基づいてページをクエリします。
Facebook のPages は、1人のユーザーによって作成され、1人以上のユーザーによって維持されるページです。ユーザーと同様に、ページはID または画面名で参照できます。
ページをクエリする場合、指定がない場合にはあなたが管理しているページがデフォルトで表示されます。そうでない場合は、ページのID を指定できます。次に例を示します。
SELECT * FROM Pages WHERE Id = 'facebook'
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。 詳細については、WHERE 句のセクションを参照してください。
| Name | Type | Description |
| offset | String | 最初に返す結果。結果の手動ページングで使用されます。 |
ユーザーが現在のアプリケーションに付与した権限をクエリします。
| Name | Type | Description |
| PermissionName [KEY] | String | 権限の名前。 |
| Status | String | 要求された権限のステータス。 |
| プロパティ | 説明 |
| AccountId | 広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。 |
| AuthenticateAsPage | Facebook への要求時に認証するページの名前またはID。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | The scope to use when authenticating to Facebook. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AggregateFormat | 集計またはコレクションの列を返す場合の形式。 |
| AsyncTimeout | When sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown. |
| AutoDetectPageTokens | Controls whether the driver attempts to automatically detect the page token to use for a query targeting a page. |
| IgnoreValidationException | Ignore internal validation exception when breakdown combination is not valid. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Facebook Ads から返されるページあたりの結果の最大数。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | 何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。 |
| TimeIncrement | The time increment used for ad and other ad object insights reporting. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UploadLinkedMedia | 新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AccountId | 広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。 |
| AuthenticateAsPage | Facebook への要求時に認証するページの名前またはID。 |
広告アカウントのID。何も指定しない場合は、Facebook Ads から返された最初の広告アカウントID が使用されます。
Target 接続プロパティは、この接続プロパティよりも優先され、任意の広告アカウント、広告キャンペーン、広告セット、または広告のID を指定するために使用できます。詳しくは、Facebook Ads データの取得 を参照してください。
Facebook への要求時に認証するページの名前またはID。
データを取得するページのID。ページは認証されたユーザーにより管理されている必要があり、Pages ビューをクエリすることでそれらのすべてのページのID を取得することができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| Scope | The scope to use when authenticating to Facebook. |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
The scope to use when authenticating to Facebook.
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.
You may find while using the Sync App 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/.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がFacebook Ads への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がFacebook Ads への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がFacebook Ads にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\FacebookAds Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AggregateFormat | 集計またはコレクションの列を返す場合の形式。 |
| AsyncTimeout | When sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown. |
| AutoDetectPageTokens | Controls whether the driver attempts to automatically detect the page token to use for a query targeting a page. |
| IgnoreValidationException | Ignore internal validation exception when breakdown combination is not valid. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Facebook Ads から返されるページあたりの結果の最大数。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | 何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。 |
| TimeIncrement | The time increment used for ad and other ad object insights reporting. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UploadLinkedMedia | 新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計またはコレクションの列を返す場合の形式。
集計またはコレクションの列を返す場合の形式。
When sending insights requests to Facebook Ads Async API, the value in seconds until a timeout error is thrown.
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.
Controls whether the driver attempts to automatically detect the page token to use for a query targeting a page.
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.
Ignore internal validation exception when breakdown combination is not valid.
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 Sync App. 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.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Facebook Ads から返されるページあたりの結果の最大数。
Pagesize プロパティは、Facebook Ads から返されるページあたりの結果の最大数に影響を与えます。時折、要求するデータを少なくすることを要求するエラーが出ることがあります。 ページサイズを減らすことでそのようなエラーの発生頻度を下げることが可能です。 最大ページサイズはページあたり100であることが多いです。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
The most granular ad object level at which the driver will try to retrieve results on retry.
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:
何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。
何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。
The time increment used for ad and other ad object insights reporting.
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:
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。
UploadLinkedMedia は、投稿を挿入する前にメディアをアップロードするかどうかを決定します。True に設定すると、Link カラムで新しい投稿を挿入しようとすると、ドライバーは最初にURL が写真もしくは動画を参照しているかどうかを判断します。 参照している場合は、最初に写真または動画がアップロードされ、次にそのメディアを含む新しい投稿が作成されます。False の場合、新しい投稿はリンク投稿として作成されます。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM AdAccounts WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。