Create a connection to Facebook Ads by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Facebook Ads icon is not available, click the Add More icon to download and install the Facebook Ads connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Facebook Ads

The following are optional connection properties:

• Target: Some Facebook tables can be filtered by a target. For example, to retrieve comments on a video, specify the Id of the video as the target. This property enables you to restrict the results of all queries in the connection to records that match the specified target. You can also specify this restriction per query with the Target column.
• AggregateFormat: The Sync App returns some columns as a string aggregate. For example, the available likes data for an entity is returned in aggregate. By default, the Sync App returns aggregate columns in JSON. You can also return aggregates in XML.
• Version: Set this property to the Facebook Ads API version if you need to work with a different version than the default.
• RetryLevel: Use this property to control automatic query retry for specific ad insights queries and errors.

Authenticating to Facebook Ads

Facebook Ads uses the OAuth standard to authenticate users.

OAuth

In all OAuth flows, you must set AuthScheme to OAuth. The sections below assume that you have done so.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Facebook Ads. See Creating a Custom OAuth App for more information about custom applications. You can then use the Sync App to get and manage the OAuth token values. Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• AuthScheme: Set this to AzureAD.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings
• Scope (optional): Set this if you need to customizie the permissions that the driver requests.
• AuthenticateAsPage (optional): Set this to a page name or Id to make requests as a page. The page must be managed by the authenticated user.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. If necessary, set the "Permissions" parameter to request custom permissions.
2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the "Permissions" parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you must generate a new OAuth access token with the required permissions. Set the Scope property in the authentication step.

Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the permissions you would like to request.

Note that these are comma-separated lists of permissions, so you can request more than one per authorization request. You can find a list of available Facebook permissions here:

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

AuthenticateAsPage Property

Use the AuthenticateAsPage connection property if you want to post as a single page. To query collections of pages, leave AuthenticateAsPage blank, in which case CData tools automatically detect which page tokens to use.

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 Sync App. 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.

Specifying a Target

For many views related to ads, a target must be specified when querying them in order to identify the specific ad or account object for which data should be retrieved. For example, when querying the Ads view, the Target column must be specificed as a criteria pointing to a specific ad account:

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.

Insights Views

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.

Time Ranges

When trying to pull ad reporting and analytics, use DateStart and DateEnd or DatePreset in your query to control the time range of ads data.

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.

Ad levels

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.

Breakdowns

Facebook Ads offers a number of breakdowns for querying your ad insights data. These breakdowns are exposed and can be used through the AdInsights and AdInsightsActions views, such that each row returned for a query will correspond to the reporting data for one combination of the breakdowns specified in the query. The aggregated data returned for a breakdown combo will still be limited by the ad object target and ad object level specified in the query. Facebook Ads does enforce restrictions on what breakdowns can be selected together, so the Sync App also enforces similar restrictions on breakdowns in queries supplied to it. Please see Data Model for more info on brekdown combos.

Action Collections

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.

Action Attributions

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.

Using the Pre-Built Reports

The driver contains the following pre-built reports:

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

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.

Defining Custom Reports with CreateAdInsightsReport

If you routinely need to request fields that are not available on the pre-built reports that ship with the Sync App, or you want to create a simpler ad report for your users, you may want to define your own custom ads report so that you can more easily query for the data you need. The CreateAdInsightsReport stored procedure can be used for this purpose.

The stored procedure outputs schema files, depdending on the output options supplied. Set the Location connection property to the output path of the generated reports to expose them as queryable tables in the Sync App.

The example stored procedure call below creates a custom ad insights report with the specified fields, breakdowns, action breakdowns, and action collections:

EXEC CreateAdInsightsReport @ReportName = 'AdInsights_CreatedReport', @Fields = 'AccountCurrency,AdAccountId', @Breakdowns = 'Country', @ActionBreakdowns='ActionType,ActionDestination',@ActionCollection='Actions,UniqueActions', @OutputDirectory='LOCATION'"

In this example, the @OutputDirectory parameter is set to the location specified for the Location connection property.

Fine Tuning Data Access

You can use the following properties to gain greater control over Facebook Ads API features and the strategies the Sync App uses to surface them:

• AccountID: Set this to specify an ad account ID that will be used for the Target input for queries if none is specified. Both Target connection property and Target query input have precedence over this property.
• RetryLevel: Use this property to control query retry for certain types of ad insights queries and errors. Please see the pages for AdInsights and AdInsightsActions views in Data Model for more information.

This section details a selection of advanced features of the Facebook Ads Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Facebook Ads and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

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.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App 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

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Facebook Ads Connector for CData Sync Views

Name	Description
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	Query 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.
AdInsightsTemplateInternal	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.
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.
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.

Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.

Table Specific Information

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.

Select

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.

Columns

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.

Table Specific Information

AdCreatives in Facebook represent a collection of the creatives for specific Ads in Facebook.

Select

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'

Columns

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

Images associated with an ad account

Table Specific Information

Ad Images in Facebook represent individual images that can be used with ad creatives.

Select

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

SELECT * FROM AdImages WHERE Target = 'act_123456'

Columns

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

Query an Ad Report. Accessing Ad Report information requires the ads_read permission.

Table Specific Information

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.

Select

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:

• 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 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:

• Age: Can also be selected with Gender
• Country
• FrequencyValue
• Gender: Can also be selected with Age
• HStatsByAdvertiserTZ (Hourly Stats by Advertizer Timezone)
• HStatsByAudienceTZ (Hourly Stats by Audience Timezone)
• ImpressionDevice: Can also be selected with PublisherPlatform or both PublisherPlatform and PlatformPosition.
• PlatformPosition: Must be selected with PublisherPlatform. Can also be selected with ImpressionDevice.
• PublisherPlatform: Can be selected with PlatformPosition, ImpressionDevice, or both PlatformPosition and ImpressionDevice.
• ProductId
• Region

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: The following error message may be encountered when querying from this table: "Please reduce the amount of data you're asking for, then retry your request".

This error typically occurs when the driver requests an amount of data that Facebook cannot handle the calculations for on its end. It appears to be triggered based on individually dense fields, and not the page size.

If the Sync App encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.

If this error is still encountered, either reduce the date range of the query or remove expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. 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.
AccountCurrency	String	The currency that is being used by the ad account.
ActionAttributionWindows	String	A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId	String	The Id of the Ad Account associated with the report row.
AdAccountName	String	The name of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
AdId	String	The Id of the Ad associated with the report row.
AdName	String	The name of the Ad associated with the report row.
BuyingType	String	The method by which target ads are paid for in your campaigns.
Clicks	Long	The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field.
ConversionRateRanking	String	The conversion rate ranking.
CostPerEstimatedAdRecallers	Decimal	The average cost per additional person we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick	Decimal	The average cost per click on links in the ad.
CostPerInlinePostEngagement	Decimal	The average cost per engagement on the post.
CostPerUniqueClick	Decimal	The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick	Decimal	The average you paid for each unique inline link click.
CPC	Decimal	The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM	Decimal	The average cost you've paid to have 1,000 impressions on your ad.
CPP	Decimal	The average cost you've paid to have your ad served to 1,000 unique people.
CTR	Double	The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
EstimatedAdRecallRate	Double	The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers	Double	The additional number of people we estimate will remember seeing your ads if asked within 2 days.
Frequency	Double	The average number of times your ad was served to each person.
Impressions	Long	The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks	Long	Total number of clicks on links in the ad.
InlineLinkClicksCounter	Double	Click-through rate for inline clicks to link.
InlinePostEngagement	Long	Total number of engagements on the post.
InstantExperienceClicksToOpen	Long	instant_experience_clicks_to_open
InstantExperienceClicksToStart	Long	instant_experience_clicks_to_start
InstantExperienceOutboundClicks	Long	instant_experience_outbound_clicks
Objective	String	The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
QualityRanking	String	The quality ranking.
Reach	Long	The number of people your ad was served to.
Spend	Decimal	The total amount you've spent so far.
UniqueClicks	Long	The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it will count as 3 unique clicks.
UniqueCTR	Double	The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks	Long	The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter	Double	Click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter	Double	Unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
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 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.
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.

Table Specific Information

AdInsightsActions represents a breakdown of the Actions column from the AdInsights. See AdInsights for general information on querying AdInsights.

Select

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 Sync App encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.

If this error is still encountered, either reduce the date range of the query or remove expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. 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,28d_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	String	Metric value of default attribution window.
Action1dClick	String	Metric value of attribution window 1 day after clicking the ad.
Action1dView	String	Metric value of attribution window 1 day after viewing the ad.
Action7dClick	String	Metric value of attribution window 7 days after clicking the ad.
Action7dView	String	Metric value of attribution window 7 days after viewing the ad.
Action28dClick	String	Metric value of attribution window 28 days after clicking the ad.
Action28dView	String	Metric value of attribution window 28 days after viewing the ad.
ActionDDA	String	Metric value of attribution window which is powered by data driven model.
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 an Ad Report. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. 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.
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 which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId	String	The Id of the Ad Account associated with the report row.
AdAccountName	String	The name of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
AdId	String	The Id of the Ad associated with the report row.
AdName	String	The name of the Ad associated with the report row.
BuyingType	String	The method by which target ads are paid for in your campaigns.
Clicks	Long	The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field.
ConversionRateRanking	String	The conversion rate ranking.
CostPerEstimatedAdRecallers	Decimal	The average cost per additional person we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick	Decimal	The average cost per click on links in the ad.
CostPerInlinePostEngagement	Decimal	The average cost per engagement on the post.
CostPerUniqueClick	Decimal	The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick	Decimal	The average you paid for each unique inline link click.
CPC	Decimal	The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM	Decimal	The average cost you've paid to have 1,000 impressions on your ad.
CPP	Decimal	The average cost you've paid to have your ad served to 1,000 unique people.
CTR	Double	The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
EstimatedAdRecallRate	Double	The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers	Double	The additional number of people we estimate will remember seeing your ads if asked within 2 days.
Frequency	Double	The average number of times your ad was served to each person.
Impressions	Long	The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks	Long	Total number of clicks on links in the ad.
InlineLinkClicksCounter	Double	Click-through rate for inline clicks to link.
InlinePostEngagement	Long	Total number of engagements on the post.
InstantExperienceClicksToOpen	Long	instant_experience_clicks_to_open
InstantExperienceClicksToStart	Long	instant_experience_clicks_to_start
InstantExperienceOutboundClicks	Long	instant_experience_outbound_clicks
Objective	String	The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
QualityRanking	String	The quality ranking.
Reach	Long	The number of people your ad was served to.
Spend	Decimal	The total amount you've spent so far.
UniqueClicks	Long	The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it will count as 3 unique clicks.
UniqueCTR	Double	The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks	Long	The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter	Double	Click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter	Double	Unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	String	Metric value of default attribution window.
Action1dClick	String	Metric value of attribution window 1 day after clicking the ad.
Action1dView	String	Metric value of attribution window 1 day after viewing the ad.
Action7dClick	String	Metric value of attribution window 7 days after clicking the ad.
Action7dView	String	Metric value of attribution window 7 days after viewing the ad.
Action28dClick	String	Metric value of attribution window 28 days after clicking the ad.
Action28dView	String	Metric value of attribution window 28 days after viewing the ad.
ActionDDA	String	Metric value of attribution window which is powered by data driven model.
ActionCollection	String	The action collection to retrieve. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas The default value is Actions.
ActionCanvasComponentName	String	Name of a component within a Canvas ad.
ActionCarouselCardId	String	The ID of the specific carousel card that people engaged with when they saw your ad.
ActionCarouselCardName	String	The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.
ActionConvertedProductId	String	Converted product ids - for Collaborative Ads.
ActionDestination	String	The destination where people go after clicking on your ad.
ActionDevice	String	The device on which the conversion event you are tracking occurred.
ActionReaction	String	The number of reactions on your ads or boosted posts.
ActionTargetId	String	The id of destination where people go after clicking on your ad.
ActionVideoSound	String	The sound status (on/off) when user watches your video ad.
ActionVideoType	String	Video metrics breakdown.
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Country	String	The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
DMA	String	The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
FrequencyValue	String	The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
HStatsByAdvertiserTZ	String	Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
HStatsByAudienceTZ	String	Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
ImpressionDevice	String	The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
PlacePageId	String	The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns.
PlatformPosition	String	The position on the platform.
ProductId	String	The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
PublisherPlatform	String	The platforms the ads were published on.
Region	String	The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.

Pseudo-Columns

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
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 information about ad labels. Accessing Ad Information requires the ads_read permission.

Columns

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.

Table Specific Information

Ads in Facebook represent individual ads that have been created.

Select

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' 

Columns

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.

Table Specific Information

AdSets in Facebook represent a collection of Ads in Facebook.

Select

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'

Columns

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.

Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.

Columns

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.

Table Specific Information

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.

Select

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.

Columns

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

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.

Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.

Columns

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.

Table Specific Information

Campaigns in Facebook represent advertising campaigns that individual Ads or AdSets may be a part of.

Select

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'

Columns

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 a lead. Accessing Lead Information requires the ads_read permission.

Table Specific Information

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.

Select

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.

Columns

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.

Table Specific Information

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.

Select

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'

Columns

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

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.

Columns

Name	Type	Description
PermissionName [KEY]	String	The name of the permission.
Status	String	The status of the requested permission.

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.

Authentication

---

Property	Description
AccountId	The ID of your ad account. If none is specified, we use the first ad account id returned from Facebook Ads.
Version	The Facebook Graph API version to use.
AuthenticateAsPage	The name or Id of a page to authenticate as when making requests to Facebook.

OAuth

---

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.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
AggregateFormat	The format aggregate or collection columns should return in.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
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.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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.
Version	The Facebook Graph API version to use.
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.

Remarks

Note that the Target connection property has precedence over this connection property, and can be used to specify the id for any ad account, ad campaign, ad set, or ad. Please see The ad data for Facebook Ads is represented and accessed through several views exposed by the Sync App. See 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.

Specifying a Target

For many views related to ads, a target must be specified when querying them in order to identify the specific ad or account object for which data should be retrieved. For example, when querying the Ads view, the Target column must be specificed as a criteria pointing to a specific ad account:

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.

Insights Views

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.

Time Ranges

When trying to pull ad reporting and analytics, use DateStart and DateEnd or DatePreset in your query to control the time range of ads data.

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.

Ad levels

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.

Breakdowns

Facebook Ads offers a number of breakdowns for querying your ad insights data. These breakdowns are exposed and can be used through the AdInsights and AdInsightsActions views, such that each row returned for a query will correspond to the reporting data for one combination of the breakdowns specified in the query. The aggregated data returned for a breakdown combo will still be limited by the ad object target and ad object level specified in the query. Facebook Ads does enforce restrictions on what breakdowns can be selected together, so the Sync App also enforces similar restrictions on breakdowns in queries supplied to it. Please see Data Model for more info on brekdown combos.

Action Collections

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.

Action Attributions

The AdInsightsActions view also offers an ActionAttributionWindows column, which allows you to control how Facebook Ads attributes actions to your ad object when it generates its report. ActionAttributionWindows are specified from a list of combinations that define action and time period combinations. For example, the default value for ActionAttributionWindows is "7d_click,1d_view", meaning that relevent actions taken within 7 days of clicking on your ad object or 1 day of viewing it are attributed to and reported on for the ad object. for more information.

The Facebook Graph API version to use.

Remarks

The Facebook Graph API version to use. Generally this property does not need to be set.

The name or Id of a page to authenticate as when making requests to Facebook.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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

Requesting Additional Permissions

You may find while using the Sync App that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step.

Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the scope you would like to request.

Note that these are comma-separated lists of scopes, so you can request more than one per authorization request. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/.

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.

Remarks

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 Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Facebook Ads and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\FacebookAds Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

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.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
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.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

The format aggregate or collection columns should return in.

Remarks

The format aggregate or collection columns should return in.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from Facebook Ads.

Remarks

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.

Remarks

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.

Remarks

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

1. Account
2. Campaign
3. AdSet
4. Ad

If the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level.

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

Remarks

A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

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 Sync App throws an exception.

Upload linked photos or videos before inserting a new Post.

Remarks

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.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

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

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

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