Connecting to Facebook Ads

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for Facebook Ads can be installed and used in Python 3.10 or newer.

Facebook Ads Version Support

By default, the connector models the current version of the Facebook Graph API, as bidirectional tables.

See Also

• Using the Connector: Establish connections and query Facebook Ads through Python code.
• From SQLAlchemy: Use SQLAlchemy to establish a connection with dialect URL, and interact with Facebook Ads data using mapped classes and Sessions.

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for Facebook Ads is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_facebookads_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_facebookads_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_facebookads_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_facebookads_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_facebookads" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

• Windows:
  

  ./install-license.exe <key>

• Linux / Mac:
  

  ./install-license.sh <key>

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_facebookads folder is trivial to find:

import os
import cdata.facebookads
path = os.path.abspath(cdata.facebookads.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-facebookads-connector

The objects available within our connector are accessible from the "cdata.facebookads" module. To use the module's objects directly:

1. Import the module as follows:
   

   import cdata.facebookads as mod

2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
   

   mod.connect("InitiateOAuth=GETANDREFRESH;")

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 connector returns some columns as a string aggregate. For example, the available likes data for an entity is returned in aggregate. By default, the connector returns aggregate columns in JSON. You can also return aggregates in XML.
• 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

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating an Entra ID (Azure AD) Application for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications. After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: (custom applications only) Set this to the client Id in your application settings.
• OAuthClientSecret: (custom applications only) Set this to the client secret in your application settings.
• CallbackURL: Set this to the Redirect URL 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.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. Extracts the access token from the callback URL.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.

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 connector to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• 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. [

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

Creating a custom OAuth app is optional in the headless OAuth flow; if you want to skip creating an app, you can connect with the driver's embedded OAuth credentials. However, you might want to create a custom OAuth app to change the information displayed when users log into Facebook to grant permissions to the driver. For information on how to create a custom OAuth application, see Creating a Custom OAuth App.

1. Choose one of these two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code", below.
   • Option 2: Install the connector on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings", below.
2. Configure the connector to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. If you are using the Embedded OAuth Application:
   1. Call the GetOAuthAuthorizationURL stored procedure.
   2. Click Facebook Ads OAuth endpoint to open the endpoint in your browser.
2. If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
   • InitiateOAuth: Set to OFF.
   • OAuthClientId: Set to the client Id assigned when you registered your application.
   • OAuthClientSecret: Set to the client secret assigned when you registered your application.
3. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURI input parameter set to the exact Redirect URI you specified in your application settings.
4. Open the URL returned by the stored procedure in a browser.
5. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
6. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

• OAuthClientId: Set to the Client ID in your OAuth Integration settings.
• OAuthClientSecret: Set to the Client Secret in your OAuth Integration settings.
• OAuthVerifier: Set to the verifier code.
• OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified location.
• InitiateOAuth: Set to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

• OAuthSettingsLocation: Set to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the provider to enable the automatic refreshing of the access token.
• InitiateOAuth: Set to REFRESH.

Option 2: Transfer OAuth Settings

To install the connector on another machine, authenticate, and then transfer the resulting OAuth values:

1. On a second machine, install the connector and connect with the following properties set:
   • OAuthSettingsLocation: Set to a writable location.
   • InitiateOAuth: Set to GETANDREFRESH.
   • OAuthClientId: Set to the client ID in your app settings.
   • OAuthClientSecret: Set to the client secret in your app settings.
   • CallbackURL: Set to the callback URL in your app settings.
2. Test the connection to authenticate. The resulting authentication values are written and encrypted to the path specified by OAuthSettingsLocation. After you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
   • InitiateOAuth: Set to REFRESH.
   • OAuthSettingsLocation: Set to the location of your OAuth settings file. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Requesting Additional Permissions

You may find while using the connector 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 for a desktop application.

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/

Note that in some cases, permissions restrictions might not be due to missing but requestable Facebook Ads OAuth permissions, but instead might be due to missing OAuth app features, like Page Public Content Access or Page Public Metadata Access. These features are tied to the OAuth app as a whole, and cannot be approved or denied for individual OAuth access tokens requested by users. Consider Creating a Custom OAuth App if you need access to app features not available with the embedded OAuth app.

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. Alternatively, if you would like to disable this automatic detection and thus require usage of AuthenticateAsPage when querying a page, set AutoDetectPageTokens to "False".

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 and leave AutoDetectPageTokens set to "True". 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.

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

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the Facebook Ads python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

• For Linux:
  

  [facebookads.cpython-311-x86_64-linux-gnu.so]

• For Mac:
  

  [facebookads.cpython-311-darwin.so]

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

• LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
• JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

• CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CDATA_JVM_OPTIONS: Place JVM options here.
• CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]
  • SCHEME: The options are STDOUT, FILE.
    • STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
    • FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
  • TAG
    • For STDOUT, set this to 1. For FILE, set this to the filename.
  • LEVEL
    • Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

• STDOUT://1|DEBUG
• FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

1. Call setCustomLoggerFactory() with your factory function before opening connections.
2. Set Logfile to CUSTOM:// followed by a context string to identify the connection.
3. Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.facebookads as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

Create a Custom OAuth App

To obtain the OAuth client credentials, follow the steps below:

1. Log into Facebook and navigate to https://developers.facebook.com/apps.
2. Create a new app and select Settings > Basic. The OAuthClientId is the App Id displayed. The OAuthClientSecret is the App Secret.
3. Add a website platform on the Settings tab. Enter a Site URL. This value is not used in authentication.

Follow the steps below to configure the OAuth redirect URI.

1. Go to your app settings and add the Facebook Login product from the Products section.
2. In the product settings, define the OAuth redirect URI.

   Set the redirect URI:

   • For desktop applications, set the redirect URI to https://localhost:33333/, or a similar https url.
   • For web applications, set the redirect URI you want to be used as a callback URL, where the user returns with the token that verifies that they have granted your app access.

Fine Tuning Data Access

You can use the following properties to gain greater control over Facebook Ads API features and the strategies the connector 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.

General Changes

Date	Version	Source	Category	Type	Description
2026-05-27	26.0.9643	General	Connection	Removed	Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-22	26.0.9638	Python		Removed	Remove support for Intel x64 architecture on macOS
2026-05-19	26.0.9635	Facebook Ads	Data Model	Added	In the LeadValues view, filters on the CreateTime column are now processed server-side, improving query performance.
2026-05-07	26.0.9623	General	Data Model	Added	Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-07	26.0.9623	Python		Changed	Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-15	26.0.9601	General	Query Exec	Changed	String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-01	26.0.9587	Facebook Ads		Removed	Removed the BatchSize connection property.
2026-03-17	25.0.9572	Facebook Ads	Data Model	Added	Added the following breakdown columns to the AdInsightsActions view: ComscoreMarket, FlexibleFormatAssetType, ReelsTrendingTopic, RuleSetId, and RuleSetName.
2026-03-16	25.0.9571	Facebook Ads	Connection	Changed	The GraphAPIVersion and MarketingAPIVersion properties now default to 25.0 in order to utilize the most up-to-date API version.
2026-03-04	25.0.9559	Facebook Ads	Data Model	Changed	In the AdInsightsMMM view, the DateStop column has been renamed to DateEnd. Additionally, the data type for both DateEnd and DateStart is now "date".
2026-01-15	25.0.9511	Facebook Ads		Added	Added the AdInsightsMMM view.
2026-01-13	25.0.9509	General		Added	Added support for the REGEXP_REPLACE() string function.
2026-01-06	25.0.9502	Facebook Ads		Added	Added the following fields to the AdInsights view: AdvancedReach1DLookback, AdvancedReach7DLookback, AdvancedReach28DLookback, AnchorEventAttributionSetting, AnchorEventsPerformanceIndicator, AttributionSetting, AuctionBid, AuctionCompetitiveness, AuctionMaxCompetitorBid, CanvasAvgViewPercent, CanvasAvgViewTime, CostPerDDACountByConvs, CostPerObjectiveResult, CostPerResult, CreatedTime, DDACountByConvs, DDAResults, FullViewImpressions, FullViewReach, InstagramProfileVisits, InstagramUpcomingEventRemindersSet, LandingPageViewPerLinkClick, MarketingMessagesDelivered, MarketingMessagesDeliveryRate, MarketingMessagesReadRateBenchmark, MultiEventConversionAttributionSetting, OptimizationGoal, PlacePageName, ProductGroupRetailerId, ProductRetailerId, ProductViews, PurchasePerLandingPageView, QualifyingQuestionQualifyAnswerRate, ResultRate, Results, ResultValuesPerformanceIndicator, ShopsAssistedPurchases, SocialSpend, TotalCardView, UpdatedTime, and WishBid. Added the following breakdown columns to the AdInsights view: ComscoreMarket, FlexibleFormatAssetType, ReelsTrendingTopic, RuleSetId, and RuleSetName.
2025-12-21	25.0.9486	Python		Added	Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-05	25.0.9470	General		Added	Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-10-30	25.0.9434	Python		Changed	Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-06	25.0.9410	General		Added	Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-17	25.0.9391	Facebook Ads		Added	Added the TotalPostbacks and TotalPostbacksDetailed fields to the AdInsights and AdInsightsActions views. Added the following breakdown columns to the AdInsights and AdInsightsActions views: AdFormatAsset, BodyAssetId, BodyAssetText, CallToActionAssetId, CallToActionAssetName, DescriptionAssetId, DescriptionAssetText, ImageAssetId, ImageAssetHash, ImageAssetUrl, TitleAssetId, TitleAssetText, LinkUrlAssetId, LinkUrlAssetWebsiteUrl, LinkUrlAssetDisplayUrl, VideoAssetId, VideoAssetVideoId, VideoAssetUrl, VideoAssetThumbnailUrl, VideoAssetVideoName, AppId, IsConversionIdModeled, SkanCampaignId, SkanConversionId, and UserSegmentKey. Added the following action breakdown columns to the AdInsightsActions view: ConversionDestination, SignalSourceBucket, and StandardEventContentType.
2025-09-12	25.0.9386	General		Added	Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-10	25.0.9384	General		Changed	All columns in statically defined Views are now reported as read-only.
2025-09-03	25.0.9377	General		Changed	Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-01	25.0.9375	General		Added	Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-21	25.0.9364	General		Changed	Report behavior change: Fixed inconsistent string value comparisons in non-table queries. For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-13	25.0.9356	General		Changed	Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-08-06	25.0.9349	Facebook Ads		Changed	Changed the default Graph API and Marketing API versions from 21.0 to 23.0.
2025-07-07	25.0.9319	Python		Removed	Removed the 32-bit version of Windows Python.
2025-07-02	25.0.9314	Python		Removed	Removed support for Python 3.9.
2025-06-26	25.0.9308	Facebook Ads		Removed	In the AdCreatives view: removed the columns InstagramActorId and EffectiveInstagramStoryId. As replacements, use the columns InstagramUserId and EffectiveInstagramMediaId, both of which are already in the view.
2025-06-26	25.0.9308	Facebook Ads		Replaced	In the CreateAdPreview stored procedure: replaced the input parameter ApplyStandardEnhancement with CreativeFeature.
2025-06-25	25.0.9307	General		Removed	Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-25	25.0.9307	Python		Added	Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-25	25.0.9307	Python		Removed	Removed support for Python 3.8 as it is no longer supported.
2025-06-20	25.0.9302	General		Added	Created the following functions: TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result). TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset. BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar). BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-18	25.0.9300	General		Changed	The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-27	25.0.9278	General		Removed	Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-12	25.0.9263	Python		Changed	Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-02-15	24.0.9177	General		Added	Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-11-27	24.0.9097	General		Added	Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-09-03	24.0.9012	Facebook Ads		Added	Added the PixelAddToCart and PixelPurchase columns to the AdInsights view. These columns expose the offsite_conversion.fb_pixel_add_to_cart and offsite_conversion.fb_pixel_purchase action types.
2024-08-12	24.0.8990	Facebook Ads		Added	Added the AutoDetectPageTokens connection property. By default, the driver continues to automatically gather page access tokens for mapping when necessary. This new property allows users to disable the automatic retrieval of page access tokens when executing queries that target specific Facebook pages.
2024-07-17	24.0.8964	Facebook Ads		Added	Added the AsyncTimeout connection property, which specifies how long the driver should wait for results when submitting an asynchronous request for insights. If insights are not returned by the time specified in AsyncTimeout, an error message is returned.
2024-06-22	24.0.8939	Facebook Ads		Added	Added the following columns to the Ads view: AdActiveTime, AdScheduledEndTime, AdScheduledStartTime, BidAmount, LastUpdatedByAppId, PreviewShareableLink, and SourceAdId.
2024-06-05	24.0.8922	Python		Added	Added support for Python 3.12.
2024-05-23	24.0.8909	Facebook Ads		Added	The CustomConversions table now supports INSERT and UPDATE queries.
2024-05-09	24.0.8895	General		Changed	The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-04-25	23.0.8881	Facebook Ads		Changed	Changed the default Graph API and Market API versions to 19.0.
2024-03-15	23.0.8840	General		Added	Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2024-02-28	23.0.8824	Facebook Ads		Removed	Removed "region" breakdown from Demographic_DMA_Region_Report. Demographic_Region_Report covers the "region" breakdown.
2024-02-21	23.0.8817	Facebook Ads		Added	Added the CustomConversions view.
2024-02-14	23.0.8810	Facebook Ads		Added	Added the IgnoreValidationException connection property.
2023-12-28	23.0.8762	Facebook Ads		Added	Added the BoostedObjectId column to the Campaigns view.
2023-11-29	23.0.8733	General		Changed	The ROUND function doesn't accept the negative precision values anymore.
2023-11-29	23.0.8733	General		Changed	The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date. The return type of the ABS function will be consistent with the parameter value type.
2023-11-28	23.0.8732	General		Added	Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-08-29	23.0.8641	Python		Added	Added support for SQLAlchemy 2.0.
2023-07-26	23.0.8607	Facebook Ads		Changed	Changed the default Graph API and Market API versions to 17.0.
2023-06-20	23.0.8571	General		Added	Added the new sys_lastresultinfo system table.
2023-06-12	23.0.8563	Facebook Ads		Added	Added the following predefined views to facilitate easier access to specific ad insights reporting: Action_Canvas_Component_Report, Action_Carousel_Card_Report, Action_Conversion_Device_Report, Action_Product_Id_Report, Action_Reactions_Report, Action_Video_Sound_Report, Action_Video_View_Type_Report, Basic_Ad_Set_Report, Basic_All_Levels_Report, Basic_Campaign_Report, Delivery_Device_Report, Delivery_Platform_Report, Demographic_Age_And_Gender_Report, Demographic_Age_Report, Demographic_Country_Report, Demographic_DMA_Region_Report, Demographic_Gender_Report, Demographic_Region_Report.
2023-06-07	23.0.8558	Facebook Ads		Changed	Changed the default Graph API and Market API versions to 16.0.
2023-05-19	23.0.8539	Python		Added	Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-16	23.0.8536	Python		Removed	Removed support for Python 3.7 on Windows and Linux
2023-04-29	23.0.8519	Facebook Ads		Removed	Removed the Version connection property. Graph API and Marketing API versions will now be managed internally by the driver, and updated as necessary in new driver releases per API deprecations.
2023-04-25	23.0.8515	General		Removed	Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2022-12-14	22.0.8383	General		Changed	Added the Default column to the sys_procedureparameters table.
2022-12-09	22.0.8378	Facebook Ads		Added	Added the AdImages view for querying ad images associated with an ad account.
2022-12-09	22.0.8378	Facebook Ads		Changed	Changed the API version default of the Version property from 14.0 to 15.0.
2022-11-15	22.0.8354	Python		Changed	Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-11-14	22.0.8353	Facebook Ads		Added	Added the CreateAdInsightsReport stored procedure for the generation of custom ad insights reports.
2022-10-25	22.0.8333	Facebook Ads		Added	Added retry method, governed by new RetryLevel connection property, for avoiding data limit API errors for ad insights requests. For Target-less queries executed at the ad account level, the driver will now attempt to retry initial data requests that encounter errors about requesting insights over too many rows by attempting to retry the request at a lower level of ad object. The deepest level of ad object to which the driver might retry is determined by the Level query parameter and RetryLevel connection property, in order of precedence.
2022-09-30	22.0.8308	General		Changed	Added the IsPath column to the sys_procedureparameters table.
2022-05-18	22.0.8173	Python		Added	Added support for Python 3.10 on Windows, Linux, and Mac Added support for Python 3.9 on Mac Added support for Mac M1
2022-05-18	22.0.8173	Python		Removed	Removed support for Python 3.6 on Windows and Linux
2022-01-12	21.0.8047	Facebook Ads		Added	Added the following fields for AdCreatives: EffectiveInstagramMediaId, EffectiveInstagramStoryId, SourceInstagramMediaId.
2021-11-02	21.0.7976	Facebook Ads		Changed	Updated the maximum pagesize to be unrestricted for all tables. Previously Facebook would throw exceptions if the pagesize was exceeded, but this seems to have been removed.
2021-10-26	21.0.7969	Facebook Ads		Changed	The default API version is updated to 12.0.
2021-10-14	21.0.7957	Facebook Ads		Added	Added the TargetingDevicePlatforms, TargetingPublisherPlatforms, and TargetingInstagramPositions to the drivers.
2021-09-27	21.0.7940	Facebook Ads		Added	Added extra columns for Dimension, Hierarchy and OLAPType to sys_tablecolumns for OLAP properties.
2021-09-02	21.0.7915	General		Added	Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-07	21.0.7889	General		Changed	Added the KeySeq column to the sys_foreignkeys table.
2021-08-06	21.0.7888	General		Changed	Added the new sys_primarykeys system table.
2021-07-23	21.0.7874	General		Changed	Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match. As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-06-14	21.0.7835	Facebook Ads		Changed	The default API version is updated to 11.0. Facebook has removed access from apps to return comment ids when the user does not also have permissions to moderate the comments. This may mean in some cases comments will stop returning with our driver when they were working previously. The user_likes and user_posts permissions (no longer used by default with the embedded driver) now have much more difficult requirements to access them from Facebook. Nearly all unique page type columns for the Pages table were deprecated by Facebook. For example, Parking columns, GeneralInfo, Attire, Restaurant Services columns, Awards, etc. These will all start returning null as Facebook transitions to the New Page Experience. These columns will be removed in the 2022 release of the driver.
2021-04-25	21.0.7785	General		Added	Added support for handling client side formulas during insert / update. For example: UPDATE Table SET Col1 = CONCAT(Col1, " - ", Col2) WHERE Col2 LIKE 'A%'
2021-04-23	21.0.7783	General		Changed	Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-16	21.0.7776	General		Added	Non-conditional updates between two columns is now available to all drivers. For example: UPDATE Table SET Col1=Col2
2021-04-16	21.0.7776	General		Changed	Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-16	21.0.7776	General		Changed	Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-16	21.0.7776	General		Changed	Updated index naming convention to avoid duplicates.
2021-04-13	21.0.7773	Facebook Ads		Changed	Updated the default Version to 10.0. On the AdsInsights and AdInsightsActions tables, the date_preset input available input value of "lifetime" is changed to "maximum" to comply with Facebook API changes. The more relevant impact is that as of API version 10.0, apps may only retrieve up to 37 months prior data. In the past, older insight data was available.
2021-03-19	21.0.7748	Facebook Ads		Deprecated	The Permissions connection property is deprecated and replaced with Scope to match other drivers.

This section provides a walk-through for writing Facebook Ads data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to Facebook Ads, see Package Installation and Establishing a Connection.

For information on how to connect with the facebookads.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data.

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

Connecting with the cdata.facebookads Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")

Once the connection is created, you can use it to execute subsequent SQL queries.

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT AccountId, Name FROM AdAccounts")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT AccountId, Name FROM AdAccounts WHERE Name = ?"
params = ["Act Name"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:

cmd = "EXECUTE GetOAuthAccessToken AuthMode = ?"
params = ["APP"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:

cur = conn.cursor()
params = ["APP"]
cur.callproc("GetOAuthAccessToken", params)

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

• From SQLAlchemy
• From Pandas
• From Matplotlib
• From Petl

Complete List of Facebook Ads Integration Quickstarts

For information on connecting from other applications, see Facebook Ads integration guides.

The CData Python Connector for Facebook Ads includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model Facebook Ads tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.

from sqlalchemy import create_engine
engine = create_engine("facebookads:///?InitiateOAuth=GETANDREFRESH;")

For SQLAlchemy 2.0, the dialect name is facebookads_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("facebookads_2:///?InitiateOAuth=GETANDREFRESH;")

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class AdAccounts(Base):
	__tablename__ = "AdAccounts"
	Id = Column(String, primary_key=True)
	AccountId = Column(String)
	Name = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:

from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
AdAccounts = abase.classes.AdAccounts

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
AdAccounts_table = Table("AdAccounts", meta)
insp.reflect_table(AdAccounts_table, ["Id","Name"])

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("facebookads:///?InitiateOAuth=GETANDREFRESH;")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AdAccounts).filter_by(Name="Act Name"):
	print("Id: ", instance.Id)
	print("AccountId: ", instance.AccountId)
	print("Name: ", instance.Name)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:

AdAccounts_table = AdAccounts.metadata.tables["AdAccounts"]
for instance in session.execute(AdAccounts_table.select().where(AdAccounts_table.c.Name == "Act Name")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

Implicit Joining

If mapped classes of related Facebook Ads objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:

• Explicit condition (necessary if there are no foreign keys in your mapped classes):
  

  rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
  for Ac, Ct in rs:

• Left-to-right relationship:
  

  rs = session.query(Account, Contact).join(Account.Contact_Link)
  for Ac, Ct in rs:

• Left-to-right relationship with explicit target:
  

  rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
  for Ac, Ct in rs:

• String form of a left-to-right relationship:
  

  rs = session.query(Account, Contact).join("Contact_Link")
  for Ac, Ct in rs:

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:

rs = session.query(AdAccounts).order_by(AdAccounts.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("AccountId: ", instance.AccountId)
	print("Name: ", instance.Name)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(AdAccounts_table.select().order_by(AdAccounts_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:

rs = session.query(func.count(AdAccounts.Id).label("CustomCount"), AdAccounts.AccountId).group_by(AdAccounts.AccountId)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("AccountId: ", instance.AccountId)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(AdAccounts_table.select().with_only_columns([func.count(AdAccounts_table.c.Id).label("CustomCount"), AdAccounts_table.c.AccountId]).group_by(AdAccounts_table.c.AccountId))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:

rs = session.query(AdAccounts).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("AccountId: ", instance.AccountId)
	print("Name: ", instance.Name)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(AdAccounts_table.select().limit(25).offset(100))
for instance in rs:

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.

rs = session.query(func.count(AdAccounts.Id).label("CustomCount"), AdAccounts.AccountId).group_by(AdAccounts.AccountId)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("AccountId: ", instance.AccountId)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(AdAccounts_table.select().with_only_columns([func.count(AdAccounts_table.c.Id).label("CustomCount"), AdAccounts_table.c.AccountId])group_by(AdAccounts_table.c.AccountId))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(AdAccounts.AnnualRevenue).label("CustomSum"), AdAccounts.AccountId).group_by(AdAccounts.AccountId)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("AccountId: ", instance.AccountId)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(AdAccounts_table.select().with_only_columns([func.sum(AdAccounts_table.c.AnnualRevenue).label("CustomSum"), AdAccounts_table.c.AccountId]).group_by(AdAccounts_table.c.AccountId))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:

rs = session.query(func.avg(AdAccounts.AnnualRevenue).label("CustomAvg"), AdAccounts.AccountId).group_by(AdAccounts.AccountId)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("AccountId: ", instance.AccountId)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(AdAccounts_table.select().with_only_columns([func.avg(AdAccounts_table.c.AnnualRevenue).label("CustomAvg"), AdAccounts_table.c.AccountId]).group_by(AdAccounts_table.c.AccountId))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.

rs = session.query(func.max(AdAccounts.AnnualRevenue).label("CustomMax"), func.min(AdAccounts.AnnualRevenue).label("CustomMin"), AdAccounts.AccountId).group_by(AdAccounts.AccountId)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("AccountId: ", instance.AccountId)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(AdAccounts_table.select().with_only_columns([func.max(AdAccounts_table.c.AnnualRevenue).label("CustomMax"), func.min(AdAccounts_table.c.AnnualRevenue).label("CustomMin"), AdAccounts_table.c.AccountId]).group_by(AdAccounts_table.c.AccountId))
for instance in rs:

When combined with the connector, Pandas can be used to generate data frames that contain your Facebook Ads data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:

import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("facebookads:///?InitiateOAuth=GETANDREFRESH;")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.

df = pd.read_sql("""
	SELECT
	   AccountId,
	   Name,
     $exNumericCol;
	FROM AdAccounts;""", engine)
print(df)

Matplotlib contains a number of tools that can graphically model Facebook Ads data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:

from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing Facebook Ads data. For example, the following plot generates and displays a bar graph relating AccountId and AnnualRevenue values:

df.plot(kind="bar", x="AccountId", y=["AnnualRevenue"])
plt.show()

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.

pip install petl

Connecting

After you import the modules, including the CData Python Connector for Facebook Ads, you can use the connector's connect function to create a connection using a valid Facebook Ads connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.

import petl as etl
import cdata.facebookads as mod
cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;")

Extract, Transform, and Load the Facebook Ads Data

Create a SQL query string and store the query results in a DataFrame.

sql = "SELECT	AccountId, Name FROM AdAccounts "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.

etl.tocsv(table1,'output.csv')

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

• Tables and Views
• Columns
• Procedures

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'AdAccounts'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:

import cdata.facebookads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

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

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

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

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

Query Processing

The connector 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).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

The CData Python Connector for Facebook Ads supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Defining Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector 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 connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes 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"

Defining Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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.

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Contents

The sections in this chapter detail the connector's caching functionality and link to the corresponding connection properties, as well as SQL statements.

Configuring the Cache Connection

Configuring the Cache Connection describes the properties that you can set when configuring the cache database.

Caching Metadata

Caching Metadata describes the CacheMetadata property. This property determines whether or not to cache the table metadata to a file store.

Automatically Caching Data

Automatically Caching Data describes how the connector automatically refreshes the cache when the AutoCache property is set.

Explicitly Caching Data

Explicitly Caching Data describes how you can decide what data is stored in the cache and when it is updated.

Data Type Mapping

Data Type Mapping shows the mappings between the data types configured in the schema and the data types in the database.

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

If replication is enabled, the data is generated once and then copied to local and cloud data stores. With incremental updates, the connector achieves a performance advantage over dropping the cached tables and retrieving the entire table again on every refresh. With iterative updates, the connector only performs the query from the last time that the date was refreshed. If replication is not enabled, updates to the cache require downloading the entire data set.

Configuring Automatic Caching

To automatically update the cache and return results from the local cache, set the following connection string properties:

• AutoCache: This property automatically updates the cache when the value is set to true.
• CacheTolerance: This property ensures that the data retrieved from the database is the most current version. The default value is 600 seconds (10 minutes). The connector checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Caching the AdAccounts Table

The following example caches the AdAccounts table in the file specified by the CacheLocation property of the connection string.

SELECT AccountId, Name FROM AdAccounts WHERE Name = 'Act Name'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM AdAccounts WHERE Name = 'Act Name'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM AdAccounts WHERE Name = 'Act Name'
  

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM AdAccounts#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM AdAccounts WHERE Name='Act Name' ORDER BY Name ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

• AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
• Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.

Schema	.NET	JDBC	SQL Server	Derby	MySQL	Oracle	SQLite	Access
int, integer, int32	Int32	int	int	INTEGER	INT	NUMBER	integer	LONG
smallint, short, int16	Int16	short	smallint	SMALLINT	SMALLINT	NUMBER	integer	SHORT
double, float, real	Double	double	float	DOUBLE	DOUBLE	NUMBER	double	DOUBLE
date	DateTime	java.sql.Date	date	DATE	DATE	DATE	date	DATETIME
datetime, timestamp	DateTime	java.sql.Date	datetime	TIMESTAMP	DATETIME	TIMESTAMP	datetime	DATETIME
time, timespan	TimeSpan	java.sql.Time	time	TIME	TIME	TIMESTAMP	datetime	DATETIME
string, varchar	String	java.lang.String	If length > 4000: nvarchar(max), Otherwise: nvarchar(length)	If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)	If length > 4000: CLOB, Otherwise: VARCHAR2(length)	nvarchar(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint	Int64	long	bigint	BIGINT	BIGINT	NUMBER	bigint	LONG
boolean, bool	Boolean	boolean	tinyint	SMALLINT	BIT	NUMBER	tinyint	BIT
decimal, numeric	Decimal	java.math.BigDecimal	decimal	DECIMAL	DECIMAL	DECIMAL	decimal	CURRENCY
uuid	Guid	java.util.UUID	nvarchar(length)	VARCHAR(length)	VARCHAR(length)	VARCHAR2(length)	nvarchar(length)	VARCHAR(length)
binary, varbinary, longvarbinary	byte[]	byte[]	binary(1000) or varbinary(max) after SQL Server 2000, image otherwise	BLOB	LONGBLOB	BLOB	BLOB	LONGBINARY

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to Facebook Ads and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The Facebook Ads Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The Facebook Ads Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

• Logfile: A filepath that designates the name and location of the log file.
• Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
• MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
• MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:

1	Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2	Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3	Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4	Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5	Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

• Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
• Verbosity 4: SSL certificates
• Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for Facebook Ads. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.

0	NONE	Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537	TCP_UNKNOWN_HOST	Unable to resolve a hostname (DNS failure).
65538	TCP_CONNECTION_REFUSED	Could not connect to the remote port.
65539	TCP_AUTH_FAILED	Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540	TCP_TIMEOUT	Did not receive a response after sending a request to the server.
65541	TCP_PROTOCOL	For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073	TLS_SERVER_UNTRUSTED	Could not verify SSL server certificate.
131074	TLS_CLIENT_UNTRUSTED	Server did not accept the client certificate we sent.
196609	OAUTH_DECRYPT_FAILED	OAuthEncryptKey did not decrypt the OAuthSettings file.
196610	OAUTH_MISSING_CLIENT_INFO	OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611	OAUTH_MISSING_PROP	General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612	OAUTH_NO_ACCESS_TOKEN	Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613	OAUTH_TOKEN_EXPIRED	The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614	OAUTH_INVALID_PROP	OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145	HTTP_REQUEST_TIMEOUT	Did not receive a response from the HTTP server.
262146	HTTP_CLIENT_ERROR	Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147	HTTP_AUTH_FAILED	HTTP 401 error.
262148	HTTP_LIMIT_EXCEEDED	HTTP 429 error.
262149	HTTP_SERVER_ERROR	HTTP 5xx error.
262150	HTTP_NOT_FOUND_ERROR	HTTP 404 error.
327681	CORE_TIMEOUT	General timeout. Not related to a specific network request.
327682	CORE_OP_NOT_ALLOWED	Operation blocked by provider permissions.
327683	CORE_CONNECTION_CONFIG	Connection configuration is not valid.
327684	CORE_SERIALIZE	Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685	CORE_DESERIALIZE	Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217	SQL_SYNTAX_ERROR	Unable to parse a SQL query.
393218	SQL_MISSING_COLUMNS	Query did not include required columns.
393219	SQL_MISSING_PARAMS	Stored procedure call did not include required parameters.
393220	SQL_QUERY_NOT_SUPPORTED	A part of the query is not allowed in the current context.
458753	SSH_SERVER_UNTRUSTED	Could not verify SSH server.
524289	STORAGE_LIST_EXCEPTION	Issue listing storage resources.
524290	STORAGE_RESOURCE_NOT_FOUND	Issue finding storage resources.
524291	STORAGE_ROOT_RESOURCE_NOT_FOUND	The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292	STORAGE_RESOURCE_NOT_A_DIRECTORY	Storage resource is not a directory.
524293	STORAGE_RESOURCE_NOT_A_FILE	Storage resource is not a file.
524294	STORAGE_PERMISSIONS_DENIED	Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:

07007	REQUIRED_CLAUSE	Class Code 07: Dynamic SQL Error.
08001	OPEN_CONNECTION	Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004	REJECT_CONNECTION	The application server rejected establishment of the connection.
42501	PRIVILEGE_IDENTIFIED_OBJECT	Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506	AUTH_FAILED	Owner authorization failure occurred.
42601	SQL_SYNTAX	A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the Facebook Ads API.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

• Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
• To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
• Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
• Strings must be quoted using single quotes (e.g., 'John Doe').

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

• SQL Server:
  

  SELECT DATENAME(yy,GETDATE())

• connector:
  

  SELECT DATENAME('yy',GETDATE())

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

• character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48
                    

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

• input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='
                    

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

• input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)
                    

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

• integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'
                    

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1
                    

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

• character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11			
				

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

• string_value1: The first string to be concatenated.
• string_value2: The second string to be concatenated.
• string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'
                    

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0
                    

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

• character_expression: The character expression.
• character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0
                    

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

• uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684
				

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

• value: The string to format.
• format: The string specifying the output syntax of the date or numeric format.
• parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'
                    

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

• algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
• value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
                    

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1
                    

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0
                    

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0
                    

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0
                    

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to extract.
• jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2
                    

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'
                    

LEN(string_expression)

Returns the number of characters of the specified string expression.

• string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5
                    

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

• substring: The substring to find inside larger string.
• string: The larger string that is searched for the substring.
• start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0
				

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

• character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'
                    

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

• character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'
                    

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

• string_expression: The string expression to be searched.
• mask_character: The character to mask with.
• start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
• end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'  
                    

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

• integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

• character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4
				

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

• pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
• expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4
                    

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0
                    

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

• character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
• quote_character: An optional single character to be used as the delimiter. These include:
  • a single quotation mark (')
  • a left or right bracket ([])
  • a double quotation mark (")
  • a left or right parenthesis ( () )
  • a greater or less than sign (><)
  • a left or right brace ({})
  • a backtick (`)

  If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.

                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'
                    

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

• expr: The string expression to be searched.
• pattern: The regular expression pattern to match.
• replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
• position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
• occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
• match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'
                    

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

• string_expression: The string expression to be searched. This can be a character or binary data type.
• string_pattern: The substring to be found. Cannot be an empty string.
• string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'
                    

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

• string_expression: The string to replicate.
• integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'
                    

REVERSE ( string_expression )

Returns the reverse order of the string expression.

• string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'
                    

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'
                    

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

• character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'
                    

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

• character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'
                    

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

• repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '
                    

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

• string: The string to split.
• delimiter: The character to split the string with.
• offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'
                    

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

• character_expression: The character expression.
• character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0
                    

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

• float_expression: The float expression.
• length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
• decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'
                    

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

• character_expression: The string expression.
• start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
• length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
• replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'
                    

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

• string_value: The character string.
• start: The positive integer that specifies the start index of characters to return.
• length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'
                    

You can also drop the FROM and FOR clauses:

                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'
                    

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

• input_string: The plain text string.
• charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)
                    

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

• input_binary: The binary value to decode.
• charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'
                    

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

• string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''
                    

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

• trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
• trimchar: Optional. If included should be a one-character string value.
• string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'
                    

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

• ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

• character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'
                    

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

• xml: The XML document to extract.
• xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
• separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'
                    

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15
                    

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

• float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966
                    

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

• float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299
                    

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

• float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373
                    

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

• float_expression1: The float expression that is the y-coordinate.
• float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448
                    

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2
                    

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

• float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814
                    

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

• float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331
                    

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

• numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531
                    

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

• float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065
                    

EXPR ( expression )

Evaluates the expression.

• expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true
                    

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1
                    

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10			
				

HEX(value)

Returns a the equivalent hex for the input value.

• value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874
				

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5
                    

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2
                    

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4
                    

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4
                    

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9
                    

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1			
				

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

• float_expression: The float expression.
• base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119
                    

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

• float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4
                    

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

• dividend: The number to take the modulus of.
• divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1
				

NEGATE(real_number)

Returns the opposite to the real number input.

• real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4
				

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979 
                

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

• float_expression: The float expression.
• y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25
                    

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

• float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979
                    

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

• seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093
                    

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

• numeric_expression: The expression of a numeric data type.
• length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
• function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0
                    

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

• numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1
                    

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

• float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897
                    

SQRT ( float_expression )

Returns the square root of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10
                    

SQUARE ( float_expression )

Returns the square of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100
                    

TAN ( float_expression )

Returns the tangent of the input expression.

• float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549
                    

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

• decimal_number: The decimal value to truncate.
• precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34
				

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2
				

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01
                

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05
                

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

• datepart: The part of the date to add the specified number to. The valid values and abbreviations are
  • year (yy, yyyy)
  • quarter (qq, q)
  • month (mm, m)
  • week (wk, ww)
  • weekday (dw)
  • dayofyear (dy, y)
  • day (dd, d)
  • hour (hh)
  • minute (mi, n)
  • second (ss, s)
  • millisecond (ms)
• number: The number to be added.
• date: The expression of the datetime data type.
• dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00
                

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

• datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
  • Year (year, yyyy, yy)
  • Quarter (quarter, qq, q)
  • Month (month, mm, m)
  • Week (week, wk, ww)
  • Weekday (weekday, dw)
  • Dayofyear (dayofyear, dy, y)
  • Day (day, dd, d)
  • Hour (hour, hh)
  • Minute (minute, mi, n)
  • Second (second, ss, s)
  • Millisecond (millisecond, ms)
• startdate: The datetime expression of the start date.
• enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12
                

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

• date: A date or timestamp string.
• format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03
				  

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01
                  

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
• date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'
                   

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
• date: The datetime string.
• datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5
                  

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

• date: The datetime string that specifies the date.
• datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'                    
                  

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

• datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
• date: The datetime string that specifies the date.
• weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday
                  

DAY(date)

Returns the integer that specifies the day component of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1
                  

DAYNAME(date)

Returns the name of the day of the week of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday
                  

DAYOFMONTH(date)

Returns the day of the month of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15
				  

DAYOFWEEK(date)

Returns the day of the week of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7
				  

DAYOFYEAR(date)

Returns the day of the year of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106
				  

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

• date: The datetime expression specifying the date for which to return the last day of the month.
• integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30
                

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

• date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
• date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021
                

FDWEEK(date)

Returns the first day of the week of the given date part.

• date: The datetime string that specifies the date.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018
				  

FDMONTH(date)

Returns the first day of the month of the given date part.

• date: The datetime string that specifies the date.
• month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018
				  

FDQUARTER(date)

Returns the first day of the quarter of the given date part.

• date: The datetime string that specifies the date.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018
				  

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

• uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM
				 

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

• datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015
				

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

• time: The time stamp value from epoch time. Milliseconds are accepted.
• issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37
                    

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05
                

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'
                

HOUR(date)

Returns the hour component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11
				

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

• date: The datetime string.
• date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0
                    

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00
				

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00
				

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00
				

LDWEEK(date)

Returns the last day of the provided week.

• date: The datetime string.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020
				

LDMONTH(date)

Returns the last day of the provided month.

• date: The datetime string.
• months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020
				

LDQUARTER(date)

Returns the last day of the provided quarter.

• date: The datetime string.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020
				

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

• year: The year
• days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01
        

MINUTE(date)

Returns the minute component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15
				

MONTH(date)

Returns the month component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2
				

QUARTER(date)

Returns the quarter associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1
				

SECOND(date)

Returns the second component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23
				

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00
                    

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

• string: The string value to be converted to datetime format.
• format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020
				

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05
                

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05
                

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456
                    

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

• date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000
				

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8
				

YEAR(date)

Returns the integer that specifies the year of the specified date.

• date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018
                    

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()

Also available:

• L_LAST/L_THIS/L_NEXT MONTH
• L_LAST/L_THIS/L_NEXT QUARTER
• L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)

Also available:

• L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)

Also available:

• L_LAST/L_NEXT_N_MONTHS(n)
• L_LAST/L_NEXT_N_QUARTERS(n)
• L_LAST/L_NEXT_N_YEARS(n)

A SELECT statement can consist of the following basic clauses.

• SELECT
• INTO
• FROM
• JOIN
• WHERE
• GROUP BY
• HAVING
• UNION
• ORDER BY
• LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
}

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ] 

Examples

1. Return all columns:
   

   SELECT * FROM AdAccounts

2. Rename a column:
   

   SELECT [Name] AS MY_Name FROM AdAccounts

3. Cast a column's data as a different data type:
   

   SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM AdAccounts

4. Search data:
   

   SELECT * FROM AdAccounts WHERE Name = 'Act Name'

5. Return the number of items matching the query criteria:
   

   SELECT COUNT(*) AS MyCount FROM AdAccounts 

6. Return the number of unique items matching the query criteria:
   

   SELECT COUNT(DISTINCT Name) FROM AdAccounts 

7. Return the unique items matching the query criteria:
   

   SELECT DISTINCT Name FROM AdAccounts 

8. Sort a result set in ascending order:
   

   SELECT AccountId, Name FROM AdAccounts  ORDER BY Name ASC

9. Restrict a result set to the specified number of rows:
   

   SELECT AccountId, Name FROM AdAccounts LIMIT 10 

10. Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
    

    SELECT * FROM AdAccounts WHERE Name = @param

See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from Facebook Ads.

    SELECT * FROM AdAccounts WHERE Target = 'businessid'
    

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM AdAccounts WHERE Name = 'Act Name'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT AccountId) AS DistinctValues FROM AdAccounts WHERE Name = 'Act Name'

AVG

Returns the average of the column values.

SELECT Name, AVG(AnnualRevenue) FROM AdAccounts WHERE Name = 'Act Name'  GROUP BY Name

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), Name FROM AdAccounts WHERE Name = 'Act Name' GROUP BY Name

MAX

Returns the maximum column value.

SELECT Name, MAX(AnnualRevenue) FROM AdAccounts WHERE Name = 'Act Name' GROUP BY Name

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM AdAccounts WHERE Name = 'Act Name'

The CData Python Connector for Facebook Ads supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT a.Name, d.AccountStatus FROM AdAccounts a INNER JOIN Ads d ON a.Id = d.Target

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

 SELECT a.Name, d.AccountStatus FROM AdAccounts a LEFT JOIN Ads d ON a.Id = d.Target

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From AdAccounts

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT AccountId, Name, RANK() OVER (ORDER BY Name) AS Rank FROM AdAccounts

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT AccountId, Name, RANK() OVER (PARTITION BY AccountId ORDER BY Name) AS Rank FROM AdAccounts

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT AccountId, Name, DENSE_RANK() OVER (PARTITION BY AccountId ORDER BY Name) AS Rank FROM AdAccounts

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT AccountId, Name, DENSE_RANK() OVER (PARTITION BY AccountId ORDER BY Name) AS Rank FROM AdAccounts

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees

If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)

The following are paramaters that NTILE() supports:

• buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
• PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
• ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;

This statement uses the NTILE() function to divide ten rows into three groups:

SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )
  

This syntax uses the following parameters.

• PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
• ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.

SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

• input_text: A column whose value you want to parse.
• delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three

To unpack this value across multiple records:

SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

• json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
  • The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
• jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

• xml_content: A column containing an XML structure.
• xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
  • When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
  • When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
• child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
  • You can supply the following values:
    • 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
    • 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
    • 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
  • When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

• csv_content: A column containing a CSV table.
• delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement> 

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM AdAccounts

Use the following cache statement to cache all rows of a table into the cache table CachedAdAccounts:

CACHE CachedAdAccounts SELECT * FROM AdAccounts

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedAdAccounts SELECT * FROM AdAccounts WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only AccountId and Name even though the cache table CachedAdAccounts has all the columns in AdAccounts.

CACHE CachedAdAccounts SCHEMA ONLY SELECT * FROM AdAccounts
CACHE CachedAdAccounts SELECT AccountId, Name FROM AdAccounts

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3; 

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.

PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.

UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

The CData Python Connector for Facebook Ads models Facebook Ads APIs as relational Tables, Views, and Stored Procedures. The connector uses the Facebook Ads API to process supported filters. The connector processes other filters client-side within the connector.

Views

Views describes the available views. Two types of views are made available:

• Base Views are statically defined to model Ad Accounts, Campaigns, Businesses, Lead Values, and more. They are used to create your custom reports instead of being used standalone. By default. these views return data from all time aggregated into a single row.
• Predefined Report Views are a set of standard reports that mimic exactly what you see in the Facebook UI. All Predefined Report Views have "report" appended to their name. By default, these views return data from all time with a daily breakdown.

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.

Querying Facebook Ads Data

The connector supports filtering Facebook Ads views in several unique ways, such as by ad level, breakdown, time range, action collection, or action attribution. Also, many views require a target to be specified in queries. See Querying Facebook Ads Data for more information.

Insight Reports

The connector offers a selection of pre-built report views representing common reporting scenarios. Queries to these views are simpler than queries to AdInsights and AdInsightsActions. This is because querying each report view is equivalent to a more complex query containing the breakdowns and action collections associated with that reporting scenario, removing the need to specify them manually.

See Using Pre-Built Reports for a list of these pre-built reports, as well as instructions for defining additional report views.

The ad data for Facebook Ads is represented and accessed through several tables and views exposed by the connector. There are a couple of general rules, presented below, for querying these tables and views.

See the pages for individual tables or views for additional details related to querying them.

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 by default the connector also enforces similar restrictions on breakdowns in queries supplied to it. If desired, this internal enforcement can be disabled through the IgnoreValidationException property. Setting this property to "True" bypasses internal enforcement of breakdown restrictions, and passes any supplied breakdown combination as-is to Facebook.

Please see Data Model for more info on breakdown combos.

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 relevant 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 connector, 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 connector.

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.

The connector models the data in Facebook Ads as a list of tables in a relational database that can be queried using standard SQL statements.

CData Python Connector for Facebook Ads Tables

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

Query information about custom audiences defined for your ad accounts.

Table Specific Information

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

SELECT

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

SELECT Id, Name, ExternalEventSource FROM CustomAudiences

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

Insert

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

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

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

Update

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

UPDATE CustomAudiences SET Name='TestCustomAudience123' WHERE ID='123abc'

Note: The Facebook Marketing API only supports updates on the following fields: Name, Description, Rule, RuleAggregation, RetentionDays, CustomerFileSource, OptOutLink, EnableFetchOrCreate, UseInCampaigns, ContentType, ClaimObjective, EventSourceGroup, ProductSetId

Delete

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

DELETE FROM CustomAudiences WHERE Id='123456'

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

Columns

Name	Type	ReadOnly	Description
ID [KEY]	String	True	The ID of the custom audience.
Target	String	False	The Id of the Account, Campaign, Ad Group, or Ad to retrieve custom audiences for.
Account_ID	String	True	The ID of the custom audience's ad account.
Name	String	False	The name of the custom audience.
Description	String	False	The description of the custom audience.
Subtype	String	False	The subtype of the custom audience. Valid values are: CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, SUBSCRIBER_SEGMENT, EXCLUSION
TimeCreated	Datetime	True	Creation time of the custom audience.
TimeUpdated	Datetime	True	Last updated time of the custom audience.
TimeContentUpdated	Datetime	True	Last update of people in this custom audience. Only supported for Customer List Custom Audiences.
Rule	String	False	Audience rules to be applied on the referrer URL.
RuleAggregation	String	False	Aggregation on top of the audience rule.
ApproximateCountLowerBound	Integer	True	Lower bound of the approximate number of people in this audience.
ApproximateCountUpperBound	Integer	True	Upper bound of the approximate number of people in this audience.
PixelID	String	False	ID of pixel which is collecting events for Website Custom audience.
RetentionDays	Integer	False	Number of days to retain user in this audience. Can be any value between 1 and 180 days. Defaults to forever if left unspecified. Only available for Customer File Custom Audience.
CustomerFileSource	String	False	Source of customer information in the uploaded file.
DataSource	String	True	JSON dictionary to indicate the method by which the custom audience was created.
DeliveryStatus	String	True	JSON dictionary which indicates whether an audience can be used in ads.
ExternalEventSource	String	True	JSON dictionary containing the pixel id whose traffic generated the custom audience. Only returned if explicitly requested.
OperationStatus	String	True	JSON dictionary containing status code and description of last operation.
PermissionForActions	String	True	JSON dictionary of permissions (string) to boolean value if the custom audience has that permission.
IsValueBased	Boolean	False	Whether the audience is used to seed value based lookalike.
OptOutLink	String	False	Opt-out URL for audience members who choose not to be targeted.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
EnableFetchOrCreate	Boolean	When set to true during INSERT, this parameter causes any identical custom audience to be fetched. Prevents INSERT of duplicate audience.
UseInCampaigns	Boolean	Controls whether this custom audience will be used in campaigns. Defaults to true.
Prefill	Boolean	If true, website traffic recorded prior to audience creation will be used to initialize this audience. If false, only website traffic garnered after the creation of this audience will be used.
DatasetId	Integer	ID of offline conversion dataset associated with this audience.
ContentType	String	Specifies content type for TRAVEL claim objective. Mandatory if creating audience with TRAVEL claim objective. Valid values are: AUTOMOTIVE_MODEL, DESTINATION, FLIGHT, GENERIC, HOME_LISTING, HOTEL, JOB, LOCAL_SERVICE_BUSINESS, MEDIA_TITLE, OFFLINE_PRODUCT, PRODUCT, VEHICLE, VEHICLE_OFFER
ClaimObjective	String	Specifies objective of audiences with CLAIM subtype. Valid values are: AUTOMOTIVE_MODEL, COLLABORATIVE_ADS, HOME_LISTING, MEDIA_TITLE, PRODUCT, TRAVEL, VEHICLE, VEHICLE_OFFER.
EventSourceGroup	Integer	Specifies event source group if using TRAVEL claim objective.
ProductSetId	Integer	Id of the Product Set to target with this audience.
OriginAudienceId	Integer	Id of origin Custom Audience. Origin audience must have a minimum size of 100.

Query information about custom conversions defined for your ad accounts.

Table Specific Information

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

Insert

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

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

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

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

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

Update

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

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

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

Delete

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

DELETE FROM CustomConversions WHERE ID='123abc'

Columns

Name	Type	ReadOnly	Description
Target	String	False	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
ID [KEY]	String	True	The ID of the custom conversion
Account_ID	String	True	The ID of the custom conversion's ad account
BusinessID	String	True	ID of business that owns the custom conversion
BusinessName	String	True	Name of business that owns the custom conversion
CreationTime	Datetime	True	Time at which the conversion was created
CustomEventType	String	False	The type of the conversion event The allowed values are ADD_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, COMPLETE_REGISTRATION, CONTENT_VIEW, INITIATED_CHECKOUT, LEAD, PURCHASE, SEARCH, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, LISTING_INTERACTION, FACEBOOK_SELECTED, OTHER.
DataSourcesId	String	True	ID for event sources of the custom conversion
DataSourcesName	String	True	Name for event sources of the custom conversion
DataSourcesSourceType	String	True	Source type for event sources of the custom conversion
DefaultConversionValue	Decimal	False	When conversion is URL based, the default conversion value associated to each conversion
Description	String	False	Description of the custom conversion
EventSourceType	String	True	Event source type of the custom conversion, e.g. pixel, app, etc.
FirstFiredTime	Datetime	True	Time at which the pixel was first fired
IsArchived	Boolean	True	Whether this conversion is archived. Archived conversions are no longer tracked in the system.
IsUnavailable	Boolean	True	Whether this conversion is unavailable
LastFiredTime	Datetime	True	Time at which the pixel was last fired
Name	String	False	Name of the custom conversion
OfflineConversionDataSet	String	True	The offline event set that contains events
PixelID	String	True	ID of the pixel that will send events
RetentionDays	Integer	True	Retention period for advanced rule
Rule	String	False	Rule of the custom conversion

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
EventSourceId	String	Event source Id.
AdvancedRule	String	Advanced ruleset for the custom conversion being created allowing multiple sources.
ActionSourceType	String	Action source type the custom conversion is created from. The allowed values are app, chat, email, other, phone_call, physical_store, system_generated, website, business_messaging.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for Facebook Ads Views

Name	Description
Action_Canvas_Component_Report	Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.
Action_Carousel_Card_Report	Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.
Action_Conversion_Device_Report	Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.
Action_Product_Id_Report	Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.
Action_Reactions_Report	Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.
Action_Video_Sound_Report	Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.
Action_Video_View_Type_Report	Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.
AdAccounts	Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.
AdCreatives	Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.
AdImages	Images associated with an ad account
AdInsights	Queries an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsActions	Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsAssets	Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.
AdInsightsMMM	Queries ad insights data for the marketing mix modeling breakdown. Accessing this information requires the ads_read permission.
AdLabels	Query information about ad labels. Accessing Ad Information requires the ads_read permission.
Ads	Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission.
AdSets	Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission.
Albums	Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.
AuthorizedAdAccounts	Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id.
Basic_Ad_Report	Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Ad_Set_Report	Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_All_Levels_Report	Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Campaign_Report	Ad Report focused on ads and providing information on parent campaigns and ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Businesses	Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.
Campaigns	Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.
Delivery_Device_Report	Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_And_Device_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Purchase_Roas_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_And_Gender_Report	Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_Report	Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Country_Report	Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_DMA_Region_Report	Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.
Demographic_Gender_Report	Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.
Demographic_Region_Report	Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.
LeadValues	Query information about a lead. Accessing Lead Information requires the ads_read and either pages_manage_ads or leads_retrieval permissions.
Pages	Query the Pages based on the supplied Id.
Permissions	Query the Permissions the User has granted the current application.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.
ImageHash	String	Image hash for an image you can use in creatives.
ImageUrl	String	A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library.
InstagramPermalinkUrl	String	Instagram permalink.
InstagramUserId	String	The ID of an Instagram user for creating ads.
LinkOgId	String	The Open Graph (OG) ID for the link in this creative if the landing page has OG tags.
LinkUrl	String	Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
ObjectId	String	The ID of the promoted_object or object that is relevant to the ad and ad type.
ObjectStoryId	String	The ID of a page post to use in an ad.
ObjectType	String	The type of object that is being advertised. The allowed values are APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID.
ObjectUrl	String	Destination URL for a link ads not connected to a page.
PageId	String	The actor ID (Page ID) of this creative.
ProductSetId	String	The ID of the product set for this creative.
RunStatus	String	The run status of this creative. The allowed values are ACTIVE, DELETED.
SourceInstagramMediaId	String	The ID of an Instagram post for creating ads.
TemplateUrl	String	The Tracking URL for dynamic product ads.
ThumbnailUrl	String	The URL to a thumbnail for this creative.
Title	String	Title for a link ad (not connected to a Page).
UrlTags	String	A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only.
UsePageActorOverride	Boolean	If this is true, we will show the page actor for mobile app ads.
AdLabels	String	Ad Labels that are associated with this creative.
ObjectStorySpecLinkData	String	The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecPhotoData	String	The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecVideoData	String	The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTextData	String	The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTemplateData	String	The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

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

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.

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

Table Specific Information

Facebook AdInsights 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, always include a Target. The Target specifies the element from which to retrieve the insights. Legal Targets are AdAccount, Campaign, AdSet, or an Ad. For example:

SELECT * FROM AdInsights WHERE Target = 'act_123456'

Columns that are always fetched by default during a SELECT * query against Adinsights:

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

Metrics Columns

When running a SELECT * query on an Adinsights report, not all of the metrics columns are retrieved from Facebook. This means that certain columns may return “0” or null values if column metadata is retrieved in a prior request. To fetch this data, these columns must be included in the SELECT portion of the query, rather than using SELECT *.

Metrics columns that may display this behavior in Adinsights include:

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

Date Presets

To specify a data range, use either DateStart and DateEnd, or DatePreset. Available values for DatePreset:

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

For example:

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'

To specify how many days should be included in each report row, use TimeIncrement. For example:

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'

To specify the level at which insights should be retrieved, use the Level column. Legal values are ad, adset, campaign, or account. For example:

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

Note: 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 at https://developers.facebook.com/docs/marketing-api/insights/.

Breakdown Columns

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

Facebook Ads enforces restrictions on what breakdowns can be selected together, so by default the connector also enforces similar restrictions on breakdowns in queries supplied to it. If desired, you can bypass internal enforcement of breakdown restrictions by setting IgnoreValidationException to True. This passes any supplied breakdown combination to Facebook as-is.

Note: 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 at https://developers.facebook.com/docs/marketing-api/insights/.

Managing Query Size

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

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

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

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

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range is automatically calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
AccountCurrency	String	The currency that is being used by the ad account.
ActionAttributionWindows	String	A comma separated list that determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId	String	The Id of the Ad Account that is associated with the report row.
AdAccountName	String	The name of the Ad Account that is associated with the report row.
CampaignId	String	The Id of the Campaign that is associated with the report row.
CampaignName	String	The name of the Campaign that is associated with the report row.
AdSetId	String	The Id of the Ad Set that is associated with the report row.
AdSetName	String	The name of the Ad Set that is associated with the report row.
AdId	String	The Id of the Ad that is associated with the report row.
AdName	String	The name of the Ad that is associated with the report row.
AdvancedReach1DLookback	String	advanced_reach_1d_lookback.
AdvancedReach7DLookback	String	advanced_reach_7d_lookback.
AdvancedReach28DLookback	String	advanced_reach_28d_lookback.
AnchorEventAttributionSetting	String	anchor_event_attribution_setting.
AnchorEventsPerformanceIndicator	String	anchor_events_performance_indicator.
AttributionSetting	String	Default attribution window to be used when attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for campaign or account is calculated based on existing ad sets.
AuctionBid	String	auction_bid.
AuctionCompetitiveness	String	auction_competitiveness.
AuctionMaxCompetitorBid	String	auction_max_competitor_bid.
BuyingType	String	The method by which target ads are paid for in your campaigns.
CanvasAvgViewPercent	Double	Average percentage of the Instant Experience that Accounts Center accounts saw.
CanvasAvgViewTime	Double	Average total time, in seconds, that Accounts Center accounts spent viewing an Instant Experience.
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.
CostPerDDACountByConvs	Decimal	cost_per_dda_countby_convs.
CostPerEstimatedAdRecallers	Decimal	The average cost per additional person that we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick	Decimal	The average cost per click on links in the ad.
CostPerInlinePostEngagement	Decimal	The average cost per engagement on the post.
CostPerUniqueClick	Decimal	The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick	Decimal	The average you paid for each unique inline link click.
CostPerObjectiveResult	String	The average cost per objective result from your ads.
CostPerResult	String	The average cost per result from your ads.
CPC	Decimal	The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM	Decimal	The average cost that you've paid to have 1,000 impressions on your ad.
CPP	Decimal	The average cost that you've paid to have your ad served to 1,000 unique people.
CTR	Double	The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
CreatedTime	String	created_time.
DDACountByConvs	String	dda_countby_convs.
DDAResults	String	dda_results.
EstimatedAdRecallRate	Double	The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers	Double	The additional number of people that we estimate will remember seeing your ads if asked within 2 days.
Frequency	Double	The average number of times that your ad was served to each person.
FullViewImpressions	Long	The number of Full Views on your Page's posts as a result of your ad.
FullViewReach	Long	The number of Accounts Center accounts that performed a Full View on your Page's post as a result of your ad.
Impressions	Long	The number of times that your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks	Long	Total number of clicks on links in the ad.
InlineLinkClicksCounter	Double	The click-through rate for inline clicks to link.
InlinePostEngagement	Long	The total number of engagements on the post.
InstagramProfileVisits	Long	The number of times your Instagram profile was visited.
InstagramUpcomingEventRemindersSet	Long	instagram_upcoming_event_reminders_set.
InstantExperienceClicksToOpen	Long	instant_experience_clicks_to_open
InstantExperienceClicksToStart	Long	instant_experience_clicks_to_start
InstantExperienceOutboundClicks	Long	instant_experience_outbound_clicks
LandingPageViewPerLinkClick	Double	landing_page_view_per_link_click.
MarketingMessagesDelivered	Double	The number of messages your business sent to customers that were delivered.
MarketingMessagesDeliveryRate	Double	The number of messages delivered divided by the number of messages sent.
MarketingMessagesReadRateBenchmark	String	Metric is the 75th percentile of read rates across similar businesses, representing the percentage of messages read out of total messages delivered.
MultiEventConversionAttributionSetting	String	multi_event_conversion_attribution_setting.
Objective	String	The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
ObjectiveResultRate	String	The number of objective results you received divided by the number of impressions.
ObjectiveResults	String	The number of responses you wanted to achieve from your ad campaign, based on your selected objective.
OptimizationGoal	String	The optimization goal you selected for your ad or ad set.
PlacePageName	String	The name of the place page involved in impression or click. Has to be used together with Business Locations breakdown.
ProductGroupRetailerId	String	product_group_retailer_id.
ProductRetailerId	String	product_retailer_id.
ProductViews	String	product_views.
PurchasePerLandingPageView	String	purchase_per_landing_page_view.
QualifyingQuestionQualifyAnswerRate	Double	qualifying_question_qualify_answer_rate.
QualityRanking	String	The quality ranking.
Reach	Long	The number of people your ad was served to.
ResultRate	String	The percentage of results you received out of all the views of your ads.
Results	String	The number of times your ad achieved an outcome, based on the objective and settings you selected.
ResultValuesPerformanceIndicator	String	result_values_performance_indicator.
ShopsAssistedPurchases	String	shops_assisted_purchases.
SocialSpend	Double	The total amount you've spent so far for your ads showed with social information.
Spend	Decimal	The total amount you've spent so far.
TotalCardView	String	total_card_view.
UpdatedTime	String	updated_time.
UniqueClicks	Long	The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it counts as 3 unique clicks.
UniqueCTR	Double	The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks	Long	The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter	Double	The click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter	Double	The unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
TotalPostbacks	String	Total postbacks. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
TotalPostbacksDetailed	String	Total postbacks detailed. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
WishBid	Double	wish_bid.
Checkins	Int	The number of checkins attributed to the Ad.
EventResponses	Int	The number of event responses attributed to the Ad.
LinkClicks	Int	The number of link clicks attributed to the Ad.
OfferSaves	Int	The number of receive offers attributed to the Ad.
OutboundClicks	Int	The number of outbound clicks attributed to the Ad.
PageEngagements	Int	The number of page enagements attributed to the Ad.
PageLikes	Int	The number of page likes attributed to the Ad.
PageMentions	Int	The number of page mentions attributed to the Ad.
PagePhotoViews	Int	The number of photo views attributed to the Ad.
PostComments	Int	The number of post comments attributed to the Ad.
PostEngagements	Int	The number of post engagements attributed to the Ad.
PostShares	Int	The number of post shares attributed to the Ad.
PostReactions	Int	The number of post reactions attributed to the Ad.
PageTabViews	Int	The number of tab views attributed to the Ad.
Video3SecondViews	Int	The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played.
PixelAddToCart	Int	Pixel adds to cart.
PixelPurchase	Int	Pixel purchases.
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ComscoreMarket	String	The Comscore-defined market segment associated with the ad impression, used for audience measurement and cross-media planning. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Country	String	The country for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
DMA	String	The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
FlexibleFormatAssetType	String	The asset type (such as image or video) used in a Flexible Ad Format placement, where Facebook dynamically selects the best-performing format from the provided creative assets. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
FrequencyValue	String	The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
HStatsByAdvertiserTZ	String	Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
HStatsByAudienceTZ	String	Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImpressionDevice	String	The devices used to view the Ad. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
PlacePageId	String	The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns.
PlatformPosition	String	The position on the platform.
ProductId	String	The product Id advertised in the Ad. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
PublisherPlatform	String	The platforms the ads were published on.
ReelsTrendingTopic	String	The trending topic category associated with the Reels placement where the ad was displayed. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
RuleSetId	String	The unique identifier of the rule set associated with the ad delivery, used to segment insights by specific automation or eligibility rules applied to campaigns. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
RuleSetName	String	The name of the rule set associated with the ad delivery, used to segment insights by specific automation or eligibility rules applied to campaigns. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Region	String	The region someone viewed the Ad from. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdFormatAsset	String	Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetId	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetText	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetId	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetName	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetId	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetText	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetId	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetHash	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetUrl	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetId	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetText	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetId	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetWebsiteUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetDisplayUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetThumbnailUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoName	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AppId	String	The ID of the application associated with the ad account or campaign requested. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
IsConversionIdModeled	String	Whether the conversion_bits are modeled. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanCampaignId	String	The raw campaign ID received as a part of Skan postback from iOS 15+. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanConversionId	String	The assigned Conversion ID of the event and or event bundle configured in the application's SKAdNetwork configuration schema. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
UserSegmentKey	String	User segment of Advantage+ Shopping Campaigns. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdEffectiveStatus	String	An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.
DefaultSummary	Boolean	A boolean indicating if we should get the default summary.