CData Sync App は、Facebook Ads データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Facebook Ads コネクタはCData Sync アプリケーションから使用可能で、Facebook Ads からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Facebook Ads への接続を作成します。Facebook Ads アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからFacebook Ads コネクタをダウンロードおよびインストールします。
必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。
Facebook Ads はユーザー認証にOAuth 標準を使用しています。
Web アプリケーション経由で接続する場合は、Facebook Ads にカスタムOAuth アプリケーションを作成および登録する必要があります。カスタムアプリケーションについて詳しくは、カスタムOAuth アプリの作成 を参照してください。それからSync App を使用してOAuth トークンの値を取得および管理します。 OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。
Sync App の使用中に、指定のアクションを行う権限がアプリにありませんというエラーメッセージがFacebook から返されることがあります。 このエラーを解消するには、必要な権限を持つ新しいOAuth アクセストークンを発行する必要があります。認証ステップでScope プロパティを設定します。
Web アプリケーションは、リクエストしたいアクセス許可のインプットを持つGetOAuthAuthorizationURL およびGetOAuthAccessToken ストアドプロシージャを呼び出す必要があります。
これらはカンマで区切られたアクセス許可のリストで、一回の認可要求で複数を要求することができます。 利用可能なFacebook アクセス許可のリストはこちらで確認できます。
http://developers.facebook.com/docs/authentication/permissions/
次のセクションでは、2つのオプションについて比較します。
ページとして投稿する
Facebook Ads に認証した後、あなたのユーザーアカウントで管理するページとして投稿をすることができます。AuthenticateAsPage プロパティを使用するページのID に設定します。Pages ビューをクエリして、あなたのアカウントでアクセスすることが可能なすべてのページのID を見ることができます。
自動ページ
Facebook Ads では、ページが所有するほとんどのリソースに対してページトークンを必要とする多くの変更を最近加えました。これは、複数のページを管理していてすべてのページで同じクエリを実行したい場合（例えばInsights を取得する場合など）に面倒です。CData のツールでこれをシームレスに処理するために、使用するページトークンを自動的に検出する方法を追加しました。これを機能させるには、AuthenticateAsPage を指定しないでください。正しいページトークンは、リクエストでターゲットの一部としてページID が指定されている場合にのみ解決できます。つまり、リクエストによっては手動でAuthenticateAsPage を指定する必要があります。
The ad data for Facebook Ads is represented and accessed through several views exposed by the Sync App. See データモデル for more details on these views. The way that Facebook Ads works means that there are a couple of general rules, presented below, for querying these views. For any view, its page in the データモデル section will also go over any special details related to querying it.
SELECT * FROM Ads WHERE Target = 'act_123456'A Target can also be specified dynamically in a query:
SELECT * FROM Ads WHERE Target IN (SELECT ID FROM AdAccounts)If no Target is specified in a query, and the Target connection property is not set, the AccountID connection property will be used to determine the default target for ads queries. If none of these are set, the first account id returned from Facebook Ads will be used.
Analytics, peformance, and reporting data for ads is accessed through the AdInsights and AdInsightsActions views. Queries to these views will require a Target as covered in the previous section, but also support more detailed query syntax for their reporting functionality.
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'When specifying a time range for ads data, use TimeIncrement to control the time span of ad data summarized in each result row. For example, if TimeIncrement is set to "monthly", each result row will correspond to a monthly roll-up of ad data.
The Target specified for a query will control what ad account ad data is retrieved for. Use Level to control what level of ad object results are reported at. Level can be set to ad, adset, campaign, or account.
The AdInsightsActions view also offers an ActionCollection column, which allows you to specify what sort of actions attributed to your ads you would like to look at.
The AdInsightsActions view also offers an ActionAttributionWindows column, which allows you to control how Facebook Ads attributes actions to your ad object when it generates its report. ActionAttributionWindows are specified from a list of combinations that define action and time period combinations. For example, the default value for ActionAttributionWindows is "7d_click,1d_view", meaning that relevent actions taken within 7 days of clicking on your ad object or 1 day of viewing it are attributed to and reported on for the ad object.
There are a number of ways that you can query Facebook Ads to get ad insights data, and the AdInsights and AdInsightsActions views facilitate all of these querying methods. For a simplified datamodel and querying experience, we also offer alternatives: you can use pre-built, simplified reports that correspond to queries that you would write for AdInsights or AdInsightsActions, or you can define your own ad insights report with the CreateAdInsightsReport stored procedure.
The driver contains the following pre-built reports:
Queries to these views are simpler than queries to AdInsights and AdInsightsActions in that these views already define the breakdowns and action collections to query. Queries to these views still require the specification of a Target ad object, however, and can also still use the Level and ActionAttributionWindows filters.
SELECT * FROM AdInsights_ByActionReaction_90DayIncr WHERE Target='act_12345' AND Level='adset'
The naming scheme for the views defines the breakdowns queried by the view, and the default time increment used by the view. The views will attempt to query ads data as far back in time as possible. The time span and time increment for the default views can be changed by query inputs.
If you routinely need to request fields that are not available on the pre-built reports that ship with the Sync App, or you want to create a simpler ad report for your users, you may want to define your own custom ads report so that you can more easily query for the data you need. The CreateAdInsightsReport stored procedure can be used for this purpose.
The stored procedure outputs schema files, depdending on the output options supplied. Set the Location connection property to the output path of the generated reports to expose them as queryable tables in the Sync App.
The example stored procedure call below creates a custom ad insights report with the specified fields, breakdowns, action breakdowns, and action collections:
EXEC CreateAdInsightsReport @ReportName = 'AdInsights_CreatedReport', @Fields = 'AccountCurrency,AdAccountId', @Breakdowns = 'Country', @ActionBreakdowns='ActionType,ActionDestination',@ActionCollection='Actions,UniqueActions', @OutputDirectory='LOCATION'"In this example, the @OutputDirectory parameter is set to the location specified for the Location connection property.
You can use the following properties to gain greater control over Facebook Ads API features and the strategies the Sync App uses to surface them:
このセクションでは、Facebook Ads Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Facebook Ads にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Facebook Ads API をリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。 このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| Name | Description |
| AdAccounts | ユーザーが利用できる広告アカウントをクエリします。広告アカウント情報へのアクセスには、ads_read アクセス許可が必要です。 |
| AdCreatives | 特定の広告アカウント、広告セット、または広告の、広告クリエイティブ情報をクエリします。広告クリエイティブ情報へのアクセスには、ads_read アクセス許可が必要です。 |
| AdImages | Images associated with an ad account |
| AdInsights | 広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。 |
| AdInsightsActions | 広告レポートをクエリします。広告レポート情報へのアクセスには、ads_read アクセス許可が必要です。 |
| AdInsightsTemplateInternal | Query an Ad Report. Accessing Ad Report information requires the ads_read permission. |
| AdLabels | 広告ラベルに関する情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。 |
| Ads | 特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告情報へのアクセスには、ads_read アクセス許可が必要です。 |
| AdSets | 特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告セット情報へのアクセスには、ads_read アクセス許可が必要です。 |
| Albums | ターゲットに関連付けられたアルバムをクエリします。通常、アルバム情報へのアクセスには、user_photos アクセス許可が必要です。 |
| AuthorizedAdAccounts | 指定されたアプリにおいてビジネスの広告を運営する権限を付与された広告アカウント。このビューの利用には、あなたのユーザーID で少なくとも1つのビジネスが設定されている必要があります。 |
| Businesses | Facebook ユーザーのビジネスをクエリします。ビジネス情報へのアクセスには、business_management アクセス許可が必要です。 |
| Campaigns | 特定の広告アカウントのキャンペーン情報をクエリします。キャンペーン情報へのアクセスには、ads_read アクセス許可が必要です。 |
| LeadValues | リードに関する情報をクエリします。リード情報へのアクセスには、ads_read アクセス許可が必要です。 |
| Pages | 提供されたID に基づいてページをクエリします。 |
| Permissions | ユーザーが現在のアプリケーションに付与した権限をクエリします。 |
ユーザーが利用できる広告アカウントをクエリします。広告アカウント情報へのアクセスには、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 の場合にのみ値を持ちます。 |
Images associated with an ad account
Ad Images in Facebook represent individual images that can be used with ad creatives.
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 アクセス許可が必要です。
Facebook のAdInsights ではレポートから取得できる情報と同等のものが要求できます。
AdInsights を要求する場合は、Target を指定する必要があります。どのエレメントからインサイトを抽出するかを指定します。AdAccount、Campaign、AdSet、またはAd などが考えられます。次に例を示します。
SELECT * FROM AdInsights WHERE Target = 'act_123456'
日付範囲はDateStart とDateEnd で指定でき、DatePreset も指定されていなければなりません。次に例を示します。
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d'
DatePreset で使用できる値は次のとおりです。
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 はインサイトがどのレベルで抽出されるかを指定します。AdAccount、Campaign、AdSet、またはAd などに設定できます。次に例を示します。
SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND Level='campaign'
ブレークダウンカラムが多く存在します。一般的には、一度に1つのブレークダウンカラムしか選択できません。SELECT * を使うと、ブレークダウンカラムは使われません。利用可能なブレークダウンカラムは次のとおりです。
他の多くのカラムは、標準SQL WHERE clause modifiers と使うことができます。次に例を示します。
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000
DataPreset およびブレークダウンはFacebook によって頻繁に変更されることがあります。Facebook 側の変更により、上のリストは古くなっている可能性があります。最新のブレークダウンおよび、data presets を参照するには、Facebook のドキュメントのパラメータとブレークダウンを参照してください：https://developers.facebook.com/docs/marketing-api/insights/
Note: The following error message may be encountered when querying from this table: "Please reduce the amount of data you're asking for, then retry your request".
This error typically occurs when the driver requests an amount of data that Facebook cannot handle the calculations for on its end. It appears to be triggered based on individually dense fields, and not the page size.
If the Sync App encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.
If this error is still encountered, either reduce the date range of the query or remove 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. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.
| 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秒未満の場合は動画全体が再生された場合に、再生回数がカウントされます。 |
| 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 を参照してください。
AdInsightsActions を要求する場合は、Target を指定する必要があります。どのエレメントからインサイトを抽出するかを指定します。AdAccount、Campaign、AdSet、またはAd などが考えられます。次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'
AdInsightsActions から取得する特定のコレクションはActionCollection で指定できます。何も指定されなかった場合は、Atcions が使われます。それぞれのインプットは、アクションのコレクションが返されるAdInsights からの使用可能なカラムを表します。さらに、IN 句によって複数のコレクションを指定することができます。次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions','UniqueActions')
AdInsights からの有効なセレクションクライテリアのようにブレークダウンが使用可能です。ブレークダウンの詳細については、AdInsights を参照してください。AdInsightsActions の追加でのブレークダウンは以下を含みます：ActionType、ActionCanvasComponentName、ActionCarouselCardId、ActionCarouselCardName、ActionDestination、ActionDevice、ActionLinkClickDestination、ActionReaction、ActionTargetId、ActionVideoSound、およびActionVideoType。
ActionAttributionWindows は、アトリビューションウィンドウのカンマ区切りのリストを入力するために使用できます。次に例を示します。
SELECT * FROM AdInsightsActions WHERE Target='act_123456' AND level='ad' AND ActionAttributionWindows='1d_view,7d_view,28d_click'
Note: The following error message may be encountered when querying from this table: "Please reduce the amount of data you're asking for, then retry your request".
This error typically occurs when the driver requests an amount of data that Facebook cannot handle the calculations for on its end. It appears to be triggered based on individually dense fields, and not the page size.
If the Sync App encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.
If this error is still encountered, either reduce the date range of the query or remove 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. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.
| 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,28d_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 | String | アトリビューションウィンドウの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。 |
Query an Ad Report. 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. |
| 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 which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default 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 associated with the report row. |
| AdAccountName | String | The name 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. |
| AdName | String | The name of the Ad 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 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 you've paid to have 1,000 impressions on your ad. |
| CPP | Decimal | The average cost 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 we estimate will remember seeing your ads if asked within 2 days. |
| Frequency | Double | The average number of times your ad was served to each person. |
| Impressions | Long | The number of times 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 | Click-through rate for inline clicks to link. |
| InlinePostEngagement | Long | 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 will count 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 | Click-through rate for unique inline clicks to link. |
| UniqueLinkClicksCounter | Double | 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%. |
| 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 | String | Metric value of default attribution window. |
| Action1dClick | String | Metric value of attribution window 1 day after clicking the ad. |
| Action1dView | String | Metric value of attribution window 1 day after viewing the ad. |
| Action7dClick | String | Metric value of attribution window 7 days after clicking the ad. |
| Action7dView | String | Metric value of attribution window 7 days after viewing the ad. |
| Action28dClick | String | Metric value of attribution window 28 days after clicking the ad. |
| Action28dView | String | Metric value of attribution window 28 days after viewing the ad. |
| ActionDDA | String | Metric value of attribution window which is powered by data driven model. |
| ActionCollection | String | The action collection to retrieve. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas
デフォルト値はActionsです。 |
| ActionCanvasComponentName | String | Name of a component within a Canvas ad. |
| 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. |
| ActionConvertedProductId | String | Converted product ids - for Collaborative Ads. |
| ActionDestination | String | The destination where people go after clicking on your ad. |
| ActionDevice | String | The device on which the conversion event you are tracking occurred. |
| ActionReaction | String | The number of reactions on your ads or boosted posts. |
| ActionTargetId | String | The id of destination where people go after clicking on your ad. |
| ActionVideoSound | String | The sound status (on/off) when user watches your video ad. |
| ActionVideoType | String | Video metrics breakdown. |
| 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. |
| 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. |
| 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. |
| DMA | String | The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns. |
| FrequencyValue | String | The number of times an ad in your Reach and Frequency campaign was served to each person. 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. |
| HStatsByAdvertiserTZ | String | Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
| HStatsByAudienceTZ | String | Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
| ImpressionDevice | String | The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
| PlacePageId | String | The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns. |
| PlatformPosition | String | The position on the platform. |
| 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. |
| PublisherPlatform | String | The platforms the ads were published on. |
| 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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。 詳細については、WHERE 句のセクションを参照してください。
| Name | Type | Description |
| 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 に設定されていない場合、デフォルト値は目的、または広告に基づき設定されます。 |
特定の広告セット、キャンペーン、広告アカウントの広告情報をクエリします。広告セット情報へのアクセスには、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 | 広告の対象となるページの種類。有効値は、デスクトップ、フィード、デスクトップ・フィード、モバイル、右列、右列・モバイル、ホーム、モバイルフィード・外部、デスクトップ・モバイル・外部、フィード・外部、右列・モバイル・外部です。 |
ターゲットに関連付けられたアルバムをクエリします。通常、アルバム情報へのアクセスには、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。 |
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 | キャンペーンが最後に更新された時刻。 |
リードに関する情報をクエリします。リード情報へのアクセスには、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 | The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads. |
| Version | 使用するFacebook Graph API のバージョン。 |
| AuthenticateAsPage | Facebook への要求時に認証するページの名前またはID。 |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| Scope | The scope to use when authenticating to Facebook. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AggregateFormat | 集計またはコレクションの列を返す場合の形式。 |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Facebook Ads から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | 何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UploadLinkedMedia | 新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AccountId | The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads. |
| Version | 使用するFacebook Graph API のバージョン。 |
| AuthenticateAsPage | Facebook への要求時に認証するページの名前またはID。 |
The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads.
Note that the Target connection property has precedence over this connection property, and can be used to specify the id for any ad account, ad campaign, ad set, or ad. Please see The ad data for Facebook Ads is represented and accessed through several views exposed by the Sync App. See データモデル for more details on these views. The way that Facebook Ads works means that there are a couple of general rules, presented below, for querying these views. For any view, its page in the データモデル section will also go over any special details related to querying it.
SELECT * FROM Ads WHERE Target = 'act_123456'A Target can also be specified dynamically in a query:
SELECT * FROM Ads WHERE Target IN (SELECT ID FROM AdAccounts)If no Target is specified in a query, and the Target connection property is not set, the AccountID connection property will be used to determine the default target for ads queries. If none of these are set, the first account id returned from Facebook Ads will be used.
Analytics, peformance, and reporting data for ads is accessed through the AdInsights and AdInsightsActions views. Queries to these views will require a Target as covered in the previous section, but also support more detailed query syntax for their reporting functionality.
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'When specifying a time range for ads data, use TimeIncrement to control the time span of ad data summarized in each result row. For example, if TimeIncrement is set to "monthly", each result row will correspond to a monthly roll-up of ad data.
The Target specified for a query will control what ad account ad data is retrieved for. Use Level to control what level of ad object results are reported at. Level can be set to ad, adset, campaign, or account.
The AdInsightsActions view also offers an ActionCollection column, which allows you to specify what sort of actions attributed to your ads you would like to look at.
The AdInsightsActions view also offers an ActionAttributionWindows column, which allows you to control how Facebook Ads attributes actions to your ad object when it generates its report. ActionAttributionWindows are specified from a list of combinations that define action and time period combinations. For example, the default value for ActionAttributionWindows is "7d_click,1d_view", meaning that relevent actions taken within 7 days of clicking on your ad object or 1 day of viewing it are attributed to and reported on for the ad object. for more information.
使用するFacebook Graph API のバージョン。
使用するFacebook Graph API のバージョン。一般的に、このプロパティは設定する必要はありません。
Facebook への要求時に認証するページの名前またはID。
データを取得するページのID。ページは認証されたユーザーにより管理されている必要があり、Pages ビューをクエリすることでそれらのすべてのページのID を取得することができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| Scope | The scope to use when authenticating to Facebook. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
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.
Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the scope you would like to request.
Note that these are comma-separated lists of scopes, so you can request more than one per authorization request. 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 | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はFacebook Ads への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\FacebookAds Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AggregateFormat | 集計またはコレクションの列を返す場合の形式。 |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Facebook Ads から返されるページあたりの結果の最大数。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | 何も指定されなかった場合のデフォルトのターゲット。ターゲットを指定できるComments などの一部のテーブルで使用されます。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UploadLinkedMedia | 新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
集計またはコレクションの列を返す場合の形式。
集計またはコレクションの列を返す場合の形式。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Facebook Ads から返されるページあたりの結果の最大数。
Pagesize プロパティは、Facebook Ads から返されるページあたりの結果の最大数に影響を与えます。時折、要求するデータを少なくすることを要求するエラーが出ることがあります。 ページサイズを減らすことでそのようなエラーの発生頻度を下げることが可能です。 最大ページサイズはページあたり100であることが多いです。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"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 などの一部のテーブルで使用されます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
新しい投稿を挿入する前に、リンクされた写真または動画をアップロードします。
UploadLinkedMedia は、投稿を挿入する前にメディアをアップロードするかどうかを決定します。True に設定すると、Link カラムで新しい投稿を挿入しようとすると、ドライバーは最初にURL が写真もしくは動画を参照しているかどうかを判断します。 参照している場合は、最初に写真または動画がアップロードされ、次にそのメディアを含む新しい投稿が作成されます。False の場合、新しい投稿はリンク投稿として作成されます。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM AdAccounts WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"