CData Cloud offers access to Facebook Ads across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Facebook Ads through CData Cloud.
CData Cloud allows you to standardize and configure connections to Facebook Ads as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Facebook Ads in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Facebook Ads and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Facebook Ads through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Facebook Ads by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Facebook Ads uses the OAuth standard to authenticate users.
You may find while using the Cloud that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you must generate a new OAuth access token with the required permissions. Set the Scope property in the authentication step. You can find a list of available Facebook permissions here:
http://developers.facebook.com/docs/authentication/permissions/
Note that in some cases, permissions restrictions might not be due to missing but requestable Facebook Ads OAuth permissions, but instead might be due to missing OAuth app features, like Page Public Content Access or Page Public Metadata Access. These features are tied to the OAuth app as a whole, and cannot be approved or denied for individual OAuth access tokens requested by users. Consider Creating a Custom OAuth App if you need access to app features not available with the embedded OAuth app.
The following sections compare the two options.
Posting as a Page
After authenticating to Facebook Ads with your user account, you can post, etc. as one of the pages you manage: Set the AuthenticateAsPage property to the Id of the page you want. You can find the Ids for all pages your account has access to by querying the Pages view.
Automatic Page
Facebook Ads has made a number of recent changes that require page tokens for most resources owned by a page. This can be troublesome if you manage multiple pages and want to execute the same queries across all pages (such as retrieving Insights). In order to make this work seamlessly with our tools, we have added a way to automatically detect the page token to use. For this to work, simply do not specify the AuthenticateAsPage. Note that the correct page token can only be resolved if the page id is specified as part of the target in the request. This means for some requests you will still need to manually specify AuthenticateAsPage.
The ad data for Facebook Ads is represented and accessed through several views exposed by the Cloud. See Data Model 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 Data Model 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.
Facebook Ads does enforce restrictions on what breakdowns can be selected together, so by default the Cloud also enforces similar restrictions on breakdowns in queries supplied to it. If desired, this internal enforcement can be disabled through the IgnoreValidationException property. Setting this property to "True" bypasses internal enforcement of breakdown restrictions, and passes any supplied breakdown combination as-is to Facebook.
Please see Data Model for more info on breakdown combos.
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 Cloud, 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 Cloud.
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 Cloud uses to surface them:
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Cloud models Facebook Ads APIs as relational Tables, Views, and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Views describes the available views. Two types of views are made available:
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Additional predefined date fields are available, specifically:
When filtering on these, you can use the = operator with the date set to the first day of the time period. If you specify a different date, an error is returned.
For example, to specify the month of May in the year 2022, use the following condition, specifying the first day of that month:
month = '2022-05-01'
“Date” returns daily data in the query results. For example,
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” returns data aggregated by hour across the date range selected. For example, querying two years of data and selecting “Hour” returns 24 rows of data (one for each hour) with two years of data aggregated for each hour.
“DayofWeek” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “DayOfWeek” returns seven rows of data (one for each day) with two years of data aggregated for each day.
“Week” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “Week” returns 104 rows of data (one for each week) with data aggregated for each week.
“Month” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “Month” returns 24 rows of data (one for each month) with data aggregated for each month.
“MonthofYear” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “MonthofYear” returns 12 rows of data (one for each month) with two years of data aggregated for each month.
“Quarter” returns data aggregated by quarter across the date range selected. For example. querying two years of data and selecting “Quarter” return eight rows of data (one for each quarter). Note that a Quarter is defined as starting on the 1st of the month of January, April, July, and October.
“Year” returns data aggregated by year across the date range selected. For example, querying two years of data and selecting “Year” returns two rows of data (one for each year) with data aggregated by year.
NOTE: Selecting "Date" overrides any other date metric. It always returns daily data only.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| 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 | Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission. |
| AdCreatives | Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission. |
| AdImages | Images associated with an ad account |
| AdInsights | Queries an Ad Report. Accessing Ad Report information requires the ads_read permission. |
| AdInsightsActions | Query an Ad Report. Accessing Ad Report information requires the ads_read permission. |
| AdLabels | Query information about ad labels. Accessing Ad Information requires the ads_read permission. |
| Ads | Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission. |
| AdSets | Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission. |
| Albums | Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission. |
| AuthorizedAdAccounts | Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id. |
| 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 | Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission. |
| Campaigns | Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission. |
| CustomConversions | Query information about custom conversions defined for your ad accounts. |
| 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 | Query information about a lead. Accessing Lead Information requires the ads_read permission. |
| Pages | Query the Pages based on the supplied Id. |
| Permissions | Query the Permissions the User has granted the current application. |
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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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. |
Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.
AdAccounts in Facebook are the accounts you have available in Facebook for creating Ads on. The Ids for them are always returned in the format "act_" and when they are used as a Target in requests for other tables, the Id with the prefix "act_" must always be used.
When querying AdAccounts, the Id or Target can be used to filter results. For instance:
SELECT * FROM AdAccounts WHERE Id = 'act_123456'
If you use Facebook Business Manager and manage AdAccounts for clients, all of the ad account ids your business has access to can be listed like so:
SELECT Id FROM AdAccounts WHERE Target IN (SELECT Id FROM Businesses)
Otherwise if Id is not specified, the accounts available for your user account will be listed.
| Name | Type | Description |
| ID [KEY] | String | The Id of Ad Account. |
| Target | String | The target to get ad accounts from such as a business id. |
| AccountId | String | The Id of the Ad Account when viewed directly in Facebook. |
| AccountStatus | Integer | Status of the account. 1 = Active, 2 = Disabled, 3 = Unsettled, 7 = Pending Review, 9 = in Grace Period, 101 = temporarily unavailable, 100 = pending closure. |
| Age | Double | Amount of time the ad account has been open, in days. |
| AmountSpent | Integer | Current total amount spent by the account. This can be reset. |
| Balance | Integer | Bill amount due. |
| BusinessCity | String | City for business address. |
| BusinessCountryCode | String | Country code for the business address. |
| BusinessName | String | The business name for the account. |
| BusinessState | String | State abbreviation for business address. |
| BusinessStreet | String | First line of the business street address for the account. |
| BusinessStreet2 | String | Second line of the business street address for the account. |
| BusinessZip | String | Zip code for business address. |
| Capabilities | String | Capabilities allowed for this ad account. |
| CreatedTime | Datetime | The time the account was created. |
| Currency | String | The currency used for the account, based on the corresponding value in the account settings. |
| MinCampaignGroupSpendCap | String | The minimum campaign group spend limit. |
| Name | String | Name of the account; note that many accounts are unnamed, so this field may be empty. |
| OffsitePixelsTosAccepted | String | Indicates whether the offsite pixel Terms Of Service contract was signed. |
| OwnerId | String | Facebook ID of the owner fo the Ad Account. |
| SpendCap | Integer | The maximum that can be spent by this account after which campaigns will be paused. A value of 0 signifies no spending-cap. |
| TimezoneId | String | ID for the timezone. |
| TimezoneName | String | Name for the time zone. |
| TimezoneOffsetHoursUTC | Double | Time Zone difference from UTC. |
Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.
AdCreatives in Facebook represent a collection of the creatives for specific Ads in Facebook.
When querying ad creatives, either the Id or Target must be used to filter results. The Target may be an ad account, ad set, or ad. For instance:
SELECT * FROM AdCreatives WHERE Target = 'adid'
| Name | Type | Description |
| ID [KEY] | String | The Id of Ad Creative. |
| Target | String | The Ad Account Id or Campaign Id to get Ad Sets of. |
| Name | String | The name of the Ad Creative. |
| ApplinkTreatment | String | Deep link fallback behavior for dynamic product ads if the app is not installed.
The allowed values are deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only. |
| Body | String | The body of the ad. |
| CallToActionType | String | The call to action button text and header text of legacy ads.
The allowed values are OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, BOOK_TRAVEL, LISTEN_MUSIC, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, CALL_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, GET_DIRECTIONS, MESSAGE_PAGE, SUBSCRIBE, SELL_NOW, DONATE_NOW, GET_QUOTE, CONTACT_US, RECORD_NOW, VOTE_NOW, REGISTER_NOW, OPEN_MOVIES. |
| EffectiveInstagramMediaId | String | The ID of an Instagram post to use in an ad. |
| EffectiveInstagramStoryId | String | The ID of an Instagram post to display as an Instagram ad. |
| ImageHash | String | Image hash for an image you can use in creatives. |
| ImageUrl | String | A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library. |
| InstagramActorId | String | Instagram actor ID. |
| InstagramPermalinkUrl | String | Instagram permalink. |
| InstagramUserId | String | The ID of an Instagram user for creating ads. |
| LinkOgId | String | The Open Graph (OG) ID for the link in this creative if the landing page has OG tags. |
| LinkUrl | String | Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL. |
| ObjectId | String | The ID of the promoted_object or object that is relevant to the ad and ad type. |
| ObjectStoryId | String | The ID of a page post to use in an ad. |
| ObjectType | String | The type of object that is being advertised.
The allowed values are APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID. |
| ObjectUrl | String | Destination URL for a link ads not connected to a page. |
| PageId | String | The actor ID (Page ID) of this creative. |
| ProductSetId | String | The ID of the product set for this creative. |
| RunStatus | String | The run status of this creative.
The allowed values are ACTIVE, DELETED. |
| SourceInstagramMediaId | String | The ID of an Instagram post for creating ads. |
| TemplateUrl | String | The Tracking URL for dynamic product ads. |
| ThumbnailUrl | String | The URL to a thumbnail for this creative. |
| Title | String | Title for a link ad (not connected to a Page). |
| UrlTags | String | A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only. |
| UsePageActorOverride | Boolean | If this is true, we will show the page actor for mobile app ads. |
| AdLabels | String | Ad Labels that are associated with this creative. |
| ObjectStorySpecLinkData | String | The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
| ObjectStorySpecPhotoData | String | The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
| ObjectStorySpecVideoData | String | The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
| ObjectStorySpecTextData | String | The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
| ObjectStorySpecTemplateData | String | The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
| Name | Type | Description |
| ThumbnailHeight | String | Rendered height of thumbnails provided in ThumbnailUrl, in pixels. Default 64. |
| ThumbnailWidth | String | Rendered width of thumbnails provided in ThumbnailUrl, in pixels. Default 64. |
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. |
Queries an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsights in Facebook can be requested with a great amount of detail to simulate the same sort of information that can be retrieved in a report.
When requesting AdInsights, a Target must be specified. This indicates what element to retrieve the insights from. It can be an AdAccount, Campaign, AdSet, or an Ad. For instance:
SELECT * FROM AdInsights WHERE Target = 'act_123456'
A date range can be specified using DateStart and DateEnd, or DatePreset must also be specified. For instance:
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'
The available values for DatePreset are:
The TimeIncrement can used to specify how many days should be included in each report row. For instance:
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'
The Level column can be used to specify what level insights are retrieved at. This can be set to ad,adset,campaign, or account. For instance:
SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND Level = 'campaign'
There are a number of breakdown columns. In general, only one breakdown column can be selected at a time. If you use SELECT *, no breakdown columns will be used. The available breakdown columns are:
Most other columns not already mentioned can be used with standard SQL WHERE clause modifiers. For instance:
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000
Both the DatePreset and the breakdowns are subject to frequent changes by Facebook. The lists above may be outdated due to Facebook changes. To see the most currently available breakdowns and date presets, see the documentation on Facebook for parameters and breakdowns: https://developers.facebook.com/docs/marketing-api/insights/.
Note that Facebook Ads does enforce restrictions on what breakdowns can be selected together, so by default the Cloud also enforces similar restrictions on breakdowns in queries supplied to it. If desired, this internal enforcement can be disabled through the IgnoreValidationException property. Setting this property to "True" bypasses internal enforcement of breakdown restrictions, and passes any supplied breakdown combination as-is to Facebook.
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 Cloud 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 | 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 is automatically calculated based on the specified preset value.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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. |
| 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. |
| Country | String | The country 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. |
| 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 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. |
| HStatsByAdvertiserTZ | String | Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column causes 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 causes 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 causes 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 causes 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 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. |
Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsActions represents a breakdown of the Actions column from the AdInsights. See AdInsights for general information on querying AdInsights.
When requesting AdInsightsActions, a Target must be specified. This indicates what element to retrieve the insights from. It can be an AdAccount, Campaign, AdSet, or an Ad. For instance:
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'
The specific collection to retrieve from AdInsightsActions may be specified via ActionCollection. If none is specified, Actions is used. Each input represents an available column from AdInsights where a collection of actions would return. Furthermore, multiple collections may be specified via the IN clause. For instance:
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions', 'UniqueActions')
Just as in the available selection criterias from AdInsights, breakdowns are available. Please see AdInsights for details on breakdowns. Additional breakdowns for AdInsightsActions include ActionType, ActionCanvasComponentName, ActionCarouselCardId, ActionCarouselCardName, ActionDestination, ActionDevice, ActionLinkClickDestination, ActionReaction, ActionTargetId, ActionVideoSound, and ActionVideoType.
ActionAttributionWindows is available to input a comma separated list of attribution windows. For instance:
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 Cloud 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 | 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are ad, adset, campaign, 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,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. |
| 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
The default value is Actions. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
Query information about ad labels. Accessing Ad Information requires the ads_read permission.
| Name | Type | Description |
| ID [KEY] | String | The Id of Ad label. |
| Target | String | The Ad Account Id to retrieve labels from. |
| Name | String | The name of the Ad label. |
| CreatedTime | Datetime | The time when the Ad label was created. |
| UpdatedTime | Datetime | When the Ad label was last updated. |
Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission.
Ads in Facebook represent individual ads that have been created.
When querying ad accounts, either the Id or Target must be used to filter results. For instance:
SELECT * FROM Ads WHERE Target = 'act_123456'
Additionally, UpdatedTime may be used with the > or >= operators to retrieve only records newer than a certain date. For instance:
SELECT * FROM Ads WHERE Target = 'act_123456' AND UpdatedTime > '01/01/2016'
| Name | Type | Description |
| ID [KEY] | String | The Id of Ad. |
| Target | String | The Ad Account Id, Campaign Id, or Ad Set Id to get Ads in. |
| Name | String | The name of the Ad. |
| AdStatus | String | The status of the Ad.
The allowed values are ACTIVE, PAUSED, CAMPAIGN_PAUSED, CAMPAIGN_GROUP_PAUSED, CREDIT_CARD_NEEDED, DISABLED, DISAPPROVED, PENDING_REVIEW, PREAPPROVED, PENDING_BILLING_INFO, ARCHIVED, DELETED. |
| BidInfo | String | The value of the bid info taken from the Ad Set. |
| BidType | String | The bid type value taken from the Ad Set.
The allowed values are CPM, CPC, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA. |
| CampaignId | String | The Id of the Campaign the Ad belongs to. |
| AdSetId | String | The Id of the Ad Set the Ad belongs to. |
| AdCreativeId | String | The Id of the Ad Creative associated with the Ad. |
| ConfiguredStatus | String | The configured status of the ad. Prefer using 'status' instead of this.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
| CreatedTime | Datetime | The time when the Ad was created. |
| UpdatedTime | Datetime | When the Ad was last updated. |
| ConversionSpecs | String | The Ad's conversion specs. |
| FailedDeliveryChecks | String | Possible checks that could have failed which will prevent the Ad from showing up. |
| Recommendations | String | If there are recommendations for this ad, this field includes them. Otherwise, this field will be null. |
| TrackingSpecs | String | The Ad's tracking specification. This field will be defaulted based on the objective, if not set to NONE, or based on the ad creative. |
Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission.
AdSets in Facebook represent a collection of Ads in Facebook.
When querying ad sets, either the Id or Target must be used to filter results. The Target may be an ad account, or a campaign. For instance:
SELECT * FROM AdSets WHERE Target = 'act_123456'
| Name | Type | Description |
| ID [KEY] | String | The Id of Ad Set. |
| Target | String | The Ad Account Id or Campaign Id to get Ad Sets of. |
| Name | String | The name of the Ad Set. |
| BudgetRemaining | Integer | The amount of budget remaining for this Ad Set. |
| CampaignId | String | The Ad Campaign this ad set is a part of. |
| AdSetStatus | String | The status of the Ad Set.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DELETED. |
| BillingEvent | String | The billing event that this adset is using: APP_INSTALLS: Pay when people install your app. CLICKS: Pay when people click anywhere in the ad. IMPRESSIONS: Pay when the ads are shown to people. LINK_CLICKS: Pay when people click on the link of the ad. OFFER_CLAIMS: Pay when people claim the offer. PAGE_LIKES: Pay when people like your page. POST_ENGAGEMENT: Pay when people engage with your post. VIDEO_VIEWS: Pay when people watch videos. |
| CreatedTime | Datetime | When the Ad Set was created. |
| DailyBudget | Integer | The daily budget of the set defined in your account currency, it is allowed only for ad sets with a duration longer than 24 hours. |
| LifetimeBudget | Decimal | The lifetime budget of the set defined in your account currency. |
| EndTime | Datetime | When the Ad Set is scheduled to end. |
| StartTime | Datetime | When the Ad Set started. |
| UpdatedTime | Datetime | The time the Ad Set was last updated. |
| Recommendations | String | If there are recommendations for this ad set, this field includes them. Otherwise, this field will be null. |
| TargetingGenders | Integer | Indicates gender-based targeting. 0=all, 1=male, 2=female.
The allowed values are 0, 1, 2. |
| TargetingAgeMax | Integer | Maximum age. If used, must be 65 or lower. |
| TargetingAgeMin | Integer | Minimum age. If used, must be 13 or higher. If omitted, will default to 18. |
| TargetingCountries | String | Values for country targeting. |
| TargetingLocationTypes | String | Values for the types of locations to target. |
| TargetingRegions | String | The state, province, or region. |
| TargetingCities | String | Cities to target with a radius and distance. |
| TargetingZips | String | The zip codes used for targeting. |
| TargetingCustomLocations | String | Any custom locations to target. |
| TargetingGeoMarkets | String | They key for the market. The destination market areas (DMA) and keys are in the format DMA:NUMBER, such as DMA:501. |
| TargetingInterests | String | Interests to target based on. |
| TargetingBehaviors | String | Behaviors to target based on. |
| TargetingDevicePlatforms | String | The device platforms to target. |
| TargetingPublisherPlatforms | String | The publisher platforms to target. |
| TargetingInstagramPositions | String | The instagram positions to target. |
| TargetingPageTypes | String | The types of pages to use when targeting. Values may include desktop, feed, desktopfeed, mobile, rightcolumn, rightcolumn-and-mobile, home, mobilefeed-and-external, desktop-and-mobile-and-external, feed-and-external, rightcolumn-and-mobile-and-external. |
| LearningStageInfoStatus | String | Learning Phase progress for the ad set. |
Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.
| Name | Type | Description |
| ID [KEY] | String | The Id of the album. |
| Target | String | The Id or username of the target you are retrieving albums from. |
| Name | String | The name of the album. |
| FromId | String | Id of the user who owns the album. |
| FromName | String | Name of the user who owns the album. |
| FromPicture | String | The picture of user the album is from. |
| FromCategory | String | The category of user the album is from. FromCategory may only be retrieved if the other From* fields are not selected. |
| Description | String | A description of the album. |
| Location | String | The location of the album. |
| Link | String | A link to this album on Facebook. |
| CoverPhoto | String | The album cover photo Id. |
| Privacy | String | The privacy settings for the album. |
| Count | Integer | The number of photos in this album. |
| Type | String | The type of the album: profile, mobile, wall, normal or album. |
| CommentsCount | Integer | The number of comments for the album. |
| CommentsData | String | An aggregate of comment data. |
| CreatedTime | Datetime | When the album was uploaded. |
| UpdatedTime | Datetime | When the album was last updated. |
Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id.
AuthorizedAdAccounts in Facebook represent the ad accounts that have been authorized for advertising on the specified application for your Facebook business. You must have a business set up in Facebook for this view to work correctly.
When querying AuthorizedAdAccounts, a Target must be specified and a business may optionally be specified. For instance:
SELECT * FROM AdAccounts WHERE Target = 'ApplicationId' AND Business = 'BusinessId'
If no business is specified, results for all of your available businesses will come back.
| Name | Type | Description |
| ID [KEY] | String | The Id of the Ad Account. |
| Target | String | The app id to request authorized ad accounts from. |
| AccountId | String | The Id of the Ad Account when viewed directly in Facebook. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
| Name | Type | Description |
| Business | String | The id of the business to retrieve authorized ad accounts for. |
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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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. |
Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.
| Name | Type | Description |
| ID [KEY] | String | The Id of the business. |
| Name | String | The name of the business. |
| PrimaryPage | String | The primary page of the business. |
| TimezoneId | String | The timezone id of the business. |
| Link | String | The link of the business. |
| CreatedTime | Datetime | When the business was added. |
| UpdatedTime | Datetime | When the business was updated. |
Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.
Campaigns in Facebook represent advertising campaigns that individual Ads or AdSets may be a part of.
When querying campaigns, either the Id or Target must be used to filter results. The Target must be an ad account. For instance:
SELECT * FROM Campaigns WHERE Target = 'act_123456'
| Name | Type | Description |
| ID [KEY] | String | The Id of Campaign. |
| Target | String | The target or Ad Account Id to get Campaigns. |
| Name | String | The name of the Campaign. |
| BuyingType | String | This field will help Facebook make future optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type.
The allowed values are AUCTION, FIXED_CPM, RESERVED. |
| ConfiguredStatus | String | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
| EffectiveStatus | String | The effective status of this campaign. For example, when all Ad Sets beneath the campaign are paused, the effective status is ADSET_PAUSED..
The allowed values are ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED. |
| Status | String | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
| CreatedTime | Datetime | When the campaign was created. |
| Objective | String | Objective of this ad campaign. If it is specified the API will validate that any ad groups created under the campaign match that objective.
The allowed values are 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 | A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency. |
| DailyBudget | Int | The daily budget of the campaign. |
| BudgetRemaining | Int | The remaining budget of the campaign. |
| LifetimeBudget | Int | The lifetime budget of the campaign. |
| BidStrategy | String | The bid strategy of the campaign. May be one of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP. |
| StartTime | Datetime | When the Campaign was started. |
| StopTime | Datetime | When the Campaign was stopped. |
| UpdatedTime | Datetime | When the Campaign was last updated. |
Query information about custom conversions defined for your ad accounts.
| Name | Type | Description |
| ID [KEY] | String | The ID of the custom conversion |
| Account_ID | String | The ID of the custom conversion's ad account |
| BusinessID | String | ID of business that owns the custom conversion |
| BusinessName | String | Name of business that owns the custom conversion |
| CreationTime | Datetime | Time at which the conversion was created |
| CustomEventType | String | The type of the conversion event
The allowed values are 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 | ID for event sources of the custom conversion |
| DataSourcesName | String | Name for event sources of the custom conversion |
| DataSourcesSourceType | String | Source type for event sources of the custom conversion |
| DefaultConversionValue | Decimal | When conversion is URL based, the default conversion value associated to each conversion |
| Description | String | Description of the custom conversion |
| EventSourceType | String | Event source type of the custom conversion, e.g. pixel, app, etc. |
| FirstTimeFired | Datetime | Time at which the pixel was first fired |
| IsArchived | Boolean | Whether this conversion is archived. Archived conversions are no longer tracked in the system. |
| IsUnavailable | Boolean | Whether this conversion is unavailable |
| LastFiredTime | Datetime | Time at which the pixel was last fired |
| Name | String | Name of the custom conversion |
| OfflineConversionDataSet | String | The offline event set that contains events |
| PixelID | String | ID of the pixel that will send events |
| RetentionDays | Integer | Retention period for advanced rule |
| Rule | String | Rule of the custom conversion |
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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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.
The allowed values are 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.
The default value is 1. |
| Level | String | The level to represent the results at.
The allowed values are 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. |
Query information about a lead. Accessing Lead Information requires the ads_read permission.
LeadValues in Facebook represent individual values available from a Lead Ad. The types of values describing a leads are varied and can range from custom information such as a car model, or something general such as name and email.
When querying lead values, either the Id or Target must be used to filter results. The id represents the id of the individual lead while the target must be a Lead Ad. For instance:
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')
Note that many values may come back for a single lead id. The leads themselves are a collection on the Lead Ad, and the lead values are a collection on each individual lead.
| Name | Type | Description |
| ID | String | The Id of Lead. |
| Target | String | The target or Ads Id to get Lead values from. |
| AdId | String | The id of the Ad the lead originates from. |
| AdName | String | The name of the Ad the lead originates from. |
| AdSetId | String | The id of the Ad Set the lead is associated with. |
| AdSetName | String | The name of the Ad Set the lead is associated with. |
| CampaignId | String | The id of the Campaign the lead is associated with. |
| CampaignName | String | The name of the Campaign the lead is associated with. |
| FormId | String | The id of the form the lead originates from. |
| FieldName | String | The name of the field of lead data. |
| FieldValues | String | The values for the given field of lead data. |
| IsOrganic | Boolean | A boolean indicating if the lead is organic. |
| CreatedTime | Datetime | The datetime the lead was created. |
Query the Pages based on the supplied Id.
Pages in Facebook are pages that are created by a user and may be maintained by one or multiple users. Pages, like users, may be referred to by Id or by screen name.
When querying pages, if nothing is specified then the pages you administrate will be displayed by default. Otherwise, the Id of the page can be specified. For example:
SELECT * FROM Pages WHERE Id = 'facebook'
| Name | Type | Description |
| ID [KEY] | String | The Id of the page. |
| Username | String | The username for the page, if any. |
| Name | String | The name of the page. |
| Category | String | The category of the page. |
| Categories | String | An aggregate of categories associated with the page if multiple categories are available. |
| Link | String | A link to the page. |
| Picture | String | A link to the profile picture of the page for the page. |
| CoverId | String | Id of the cover image for the page. |
| CoverSource | String | The URL to the cover image for the page. |
| CoverOffsetY | String | The y-axis offset of the cover image for the page. |
| CoverOffsetX | String | The x-axis offset of the cover image for the page. |
| About | String | Basic information about the page. |
| Description | String | A description of the page, if available. |
| GeneralInfo | String | General information provided by the page. |
| LocationStreet | String | The street address of the page. |
| LocationCity | String | The city for the page. |
| LocationState | String | The state for the page. |
| LocationCountry | String | The country for the page. |
| LocationZip | String | The ZIP code of the page. |
| LocationLatitude | String | The latitude of the page. |
| LocationLongitude | String | The longitude of the page. |
| StoreNumber | Integer | Unique store number for this location page, if applicable. |
| Phone | String | The phone number of the page, if available. |
| Website | String | A link to the website for the page. |
| Likes | Integer | The number of people who like the page. |
| Checkins | Integer | The total number of users who have checked in to the place associated with the page. |
| TalkingAboutCount | Integer | The number of users talking about the page. |
| WereHereCount | Integer | The number of users who were at the location the page is for, if applicable. |
| CanPost | Boolean | Boolean indicating if the authenticated user can post of the page for the page. |
| IsPublished | Boolean | Boolean indicating if the page for the page has been published. |
| IsCommunityPage | Boolean | Boolean indicating if this is a community page. |
| PublicTransit | String | The public transit available for the page, if any. |
| ParkingStreet | Boolean | Boolean indicating if street parking is available. |
| ParkingLot | Boolean | Boolean indicating if a parking lot is available. |
| ParkingValet | Boolean | Boolean indicating if valet parking is available. |
| PromotionEligible | Boolean | Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page. |
| PromotionIneligibleReason | String | Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page. |
| Founded | String | When the company is founded. Applicable to companies. |
| Mission | String | The company mission. Applicable to companies. |
| Products | String | The products of this company. Applicable to companies. |
| Hours | String | An aggregate for the hours of operation. Applicable to businesses and places. |
| Attire | String | Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified. |
| AcceptsCashOnly | Boolean | Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife. |
| AcceptsVisa | Boolean | Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife. |
| AcceptsAmericanExpress | Boolean | Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife. |
| AcceptsMasterCard | Boolean | Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife. |
| AcceptsDiscover | Boolean | Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife. |
| PriceRange | String | Price range of the business. Applicable to restaurants or nightlife. Valid values are \$ (0-10), \$\$ (10-30), \$\$\$ (30-50), \$\$\$\$ (50+), or Unspecified. |
| TakesReservations | Boolean | Whether the restaurant takes reservations. Only applicable to restaurants. |
| AllowsWalkins | Boolean | Whether the restaurant allows walk-ins. Only applicable to restaurants. |
| AllowsGroups | Boolean | Whether the restaurant accommodates groups. Only applicable to restaurants. |
| AllowsKids | Boolean | Whether the restaurant allows kids. Only applicable to restaurants. |
| ProvidesTakeout | Boolean | Whether the restaurant provides a takeout service. Only applicable to restaurants. |
| ProvidesDelivery | Boolean | Whether the restaurant provides a delivery service. Only applicable to restaurants. |
| ProvidesCatering | Boolean | Whether the restaurant provides a catering service. Only applicable to restaurants. |
| HasWaiters | Boolean | Whether the restaurant has waiters. Only applicable to restaurants. |
| HasOutdoorSeating | Boolean | Whether the restaurant has outdoor seating. Only applicable to restaurants. |
| ServesBreakfast | Boolean | Whether the restaurant serves breakfast. Only applicable to restaurants. |
| ServesLunch | Boolean | Whether the restaurant serves lunch. Only applicable to restaurants. |
| ServesDinner | Boolean | Whether the restaurant serves dinner. Only applicable to restaurants. |
| ServesCoffee | Boolean | Whether the restaurant serves coffee. Only applicable to restaurants. |
| ServesDrinks | Boolean | Whether the restaurant serves drinks. Only applicable to restaurants. |
| CulinaryTeam | String | Culinary team of the business. Applicable to restaurants or nightlife. |
| PharmaSafetyInfo | String | Pharmacy safety information. Applicable to pharmaceutical companies. |
| Affiliation | String | Affiliation of this person. Applicable to pages representing people. |
| Birthday | String | Birthday of this person. Applicable to pages representing people. |
| PersonalInfo | String | Personal information. Applicable to pages representing people. |
| PersonalInterests | String | Personal interests. Applicable to pages representing people. |
| ArtistsWeLike | String | Artists the band likes. Applicable to bands. |
| BandInterests | String | Band interests. Applicable to bands. |
| BandMembers | String | Members of the band. Applicable to bands. |
| Bio | String | Biography of the band. Applicable to bands. |
| BookingAgent | String | Booking agent of the band. Applicable to bands. |
| GeneralManager | String | General manager of the business. Applicable to restaurants or nightlife. Applicable to bands. |
| Hometown | String | Hometown of the band. Applicable to bands. |
| PressContact | String | Press contact information of the band. Applicable to bands. |
| RecordLabel | String | Record label of the band. Applicable to bands. |
| Awards | String | Awards information for the film or TV show. Applicable to films and TV shows. |
| DirectedBy | String | The director of the film or TV show. Applicable to films and TV shows. |
| Genre | String | The genre of the film or TV show. Applicable to films and TV shows. |
| Influences | String | Influences on the band. Applicable to bands. |
| PlotOutline | String | The plot outline of the film or TV show. Applicable to films and TV shows. |
| ProducedBy | String | The productor of the film. Applicable to films. |
| ReleaseData | String | The film's release data. Applicable to films and TV shows. |
| ScreenplayBy | String | The screenwriter of the film. Applicable to films and TV shows. |
| Starring | String | The cast of the film or TV show. Applicable to films and TV shows. |
| Studio | String | The studio for the film production. Applicable to films. |
| Network | String | The network the TV show airs on. Applicable to TV shows. |
| Schedule | String | The air schedule of the TV show. Applicable to TV shows. |
| Season | String | The current season of the TV show. Applicable to TV shows. |
| WrittenBy | String | The writer of the TV show. Applicable to TV shows. |
| Built | String | The information about when the vehicle was built. Applicable to vehicles. |
| Features | String | Features of the vehicle. Applicable to vehicles. |
| MPG | String | Miles per gallon for the vehicle. Applicable to vehicles. |
| Members | String | Members of this org. Applicable to pages representing team orgs. |
| InstagramBusinessAccountId | String | The business instagram account id associated with this page. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
| Name | Type | Description |
| offset | String | Which result to begin returning results from. Used for manual paging of results. |
Query the Permissions the User has granted the current application.
| Name | Type | Description |
| PermissionName [KEY] | String | The name of the permission. |
| Status | String | The status of the requested permission. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Facebook Ads.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Facebook Ads, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateAdInsightsReport | Generates a report schema for ad insights. |
| CreateAdPreview | Creates a schema file for an app insight. |
Generates a report schema for ad insights.
| Name | Type | Description |
| ReportName | String | The name of the report. |
| Description | String | An optional description for the report. |
| Fields | String | Comma-delimited list of non-breakdown fields for your report. Available values: AccountCurrency,ActionValue,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,ConversionRateRanking,CostPerEstimatedAdRecallers,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,EstimatedAdRecallRate,EstimatedAdRecallers,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,InstantExperienceClicksToOpen,InstantExperienceClicksToStart,InstantExperienceOutboundClicks,Objective,QualityRanking,Reach,Spend,UniqueClicks,UniqueCTR,UniqueInlineLinkClicks,UniqueInlineLinkClickCounter,UniqueLinkClicksCounter
The default value is AccountCurrency,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,Reach,Spend. |
| Breakdowns | String | Breakdowns for your report. Available values: Age,Country,DevicePlatform,DMA,FrequencyValue,Gender,HStatsByAdvertiserTZ,HStatsByAudienceTZ,ImpressionDevice,PlacePageId,PlatformPosition,ProductId,PublisherPlatform,Region |
| ActionBreakdowns | String | Action breakdowns for your report. Available values: ActionCanvasComponentName,ActionCarouselCardId,ActionCarouselCardName,ActionConvertedProductId,ActionDestination,ActionDevice,ActionReaction,ActionTargetId,ActionType,ActionVideoSound,ActionVideoType |
| ActionCollection | String | Collections of ads actions stats to return for your report. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas
The default value is Actions. |
| ActionAttributionWindows | String | A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default is [1d_view,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
The default value is default. |
| DatePreset | String | An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.
The allowed values are 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. The default value is maximum. |
| TimeIncrement | String | The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.
The default value is 90. |
| OutputDirectory | String | The directory where the schema file will be written. If no directory is specified, the generated report will be written to the FileData output. |
| Name | Type | Description |
| Result | String | Success or Failure. |
| SchemaFile | String | The generated schema file. |
| Columns | String | The number of columns found. |
| FileData | String | The BASE64 downloaded file content. Only returned if SchemaDirectory and FileStream is not set. |
Creates a schema file for an app insight.
| Name | Type | Description |
| AdCreativeId | String | An ID of the ad creative to use for creating the preview from. |
| AdFormat | String | The format of the ad to use.
The allowed values are AUDIENCE_NETWORK_INSTREAM_VIDEO, AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE, AUDIENCE_NETWORK_OUTSTREAM_VIDEO, AUDIENCE_NETWORK_REWARDED_VIDEO, DESKTOP_FEED_STANDARD, FACEBOOK_STORY_MOBILE, INSTAGRAM_STANDARD, INSTAGRAM_STORY, INSTANT_ARTICLE_STANDARD, INSTREAM_VIDEO_DESKTOP, INSTREAM_VIDEO_MOBILE, MARKETPLACE_MOBILE, MESSENGER_MOBILE_INBOX_MEDIA, MOBILE_BANNER, MOBILE_FEED_BASIC, MOBILE_FEED_STANDARD, MOBILE_FULLWIDTH, MOBILE_INTERSTITIAL, MOBILE_MEDIUM_RECTANGLE, MOBILE_NATIVE, RIGHT_COLUMN_STANDARD, SUGGESTED_VIDEO_DESKTOP, SUGGESTED_VIDEO_MOBILE, WATCH_FEED_MOBILE. |
| Name | Type | Description |
| Url | String | A url to the preview. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Facebook Ads:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the AdAccounts table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdAccounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataTypeName | String | The name of the data type. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the AdAccounts table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAccounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:facebookads:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AccountId | The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads. |
| AuthenticateAsPage | The name or Id of a page to authenticate as when making requests to Facebook. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| Scope | The scope to use when authenticating to Facebook. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Property | Description |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Property | Description |
| AggregateFormat | The format aggregate or collection columns should return in. |
| IgnoreValidationException | Ignore internal validation exception when breakdown combination is not valid. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Pagesize | The maximum number of results to return per page from Facebook Ads. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | A default target if none is specified. Used for some tables, such as Comments, where a target may be specified. |
| TimeIncrement | The time increment used for ad and other ad object insights reporting. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UploadLinkedMedia | Upload linked photos or videos before inserting a new Post. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AccountId | The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads. |
| AuthenticateAsPage | The name or Id of a page to authenticate as when making requests to Facebook. |
The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads.
string
""
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 Retrieving Facebook Ads Data for more information.
The name or Id of a page to authenticate as when making requests to Facebook.
string
""
The Id of a page to retrieve data from. The page must be managed by the authenticated user; you can obtain the Ids for all such pages by querying the Pages view.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| Scope | The scope to use when authenticating to Facebook. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The scope to use when authenticating to Facebook.
string
""
The scope that are used when authenticating to Facebook give your App access to request additional information that may be required for certain tables. Individual scope may be entered in a comma separated list. Leaving it blank will use the defaults. The Scope is only used if you have specified your own OAuthClientId and OAuthClientSecret.
You may find while using the Cloud that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AggregateFormat | The format aggregate or collection columns should return in. |
| IgnoreValidationException | Ignore internal validation exception when breakdown combination is not valid. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Pagesize | The maximum number of results to return per page from Facebook Ads. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| RetryLevel | The most granular ad object level at which the driver will try to retrieve results on retry. |
| Target | A default target if none is specified. Used for some tables, such as Comments, where a target may be specified. |
| TimeIncrement | The time increment used for ad and other ad object insights reporting. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UploadLinkedMedia | Upload linked photos or videos before inserting a new Post. |
The format aggregate or collection columns should return in.
string
"JSON"
The format aggregate or collection columns should return in.
Ignore internal validation exception when breakdown combination is not valid.
bool
false
When set to "True", the supplied breakdown combination for an insights query will be passed directly to Facebook, without any internal attempts at validation by the Cloud. If the supplied combination is invalid, the error message from Facebook Ads will be returned directly to the user. Refer to Facebook documentation on breadown combinations for information on valid combinations.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
The maximum number of results to return per page from Facebook Ads.
string
""
The Pagesize property affects the maximum number of results to return per page from Facebook Ads. Sometimes you may get an error asking you to request less data. The frequency of such errors can be reduced by reducing the pagesize. The maximum pagesize tends to be about 100 per page.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The most granular ad object level at which the driver will try to retrieve results on retry.
string
"ACCOUNT"
This property only applies if no Target is specified for the submitted query. The RetryLevel property limits the levels of ad objects that the driver will attempt to get data for on retry requests for certain errors. The Insights API for ad insights will return specific errors if the response for an ad insights query from the driver would return too many rows, or have to be computed over too many data points. For these errors, the driver will attempt to retry the query targeting the next most granular level of ad object, up to the level of ad object specified by RetryLevel. The driver's ad object precedence is listed below, from least granular to most granular:
A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
string
""
A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
The time increment used for ad and other ad object insights reporting.
string
"monthly"
This property controls the time increment for insights reporting, which is the increment of time covered by each row in the insights result set. Valid specifications for the property are as follows:
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
Upload linked photos or videos before inserting a new Post.
bool
false
The UploadLinkedMedia determines whether to upload media before inserting a Post. If set to True, when you attempt to insert a new Post with the Link column, the driver will first attempt to resolve the URL and determine if the URL is referencing a photo or a video. If so, the photo or video will be uploaded first, then a new Post containing the media will be created. If False, then the new Post will be created as a Link Post.