Matillion ETL Data Model for Facebook Ads
|
string
""
Note that the Target connection property has precedence over this connection property, and can be used to specify the id for any ad account, ad campaign, ad set, or ad. Please see The ad data for Facebook Ads is represented and accessed through several views exposed by the driver. See Data Model for more details on these views. The way that Facebook Ads works means that there are a couple of general rules, presented below, for querying these views. For any view, its page in the Data Model section will also go over any special details related to querying it.
SELECT * FROM Ads WHERE Target = 'act_123456'A Target can also be specified dynamically in a query:
SELECT * FROM Ads WHERE Target IN (SELECT ID FROM AdAccounts)If no Target is specified in a query, and the Target connection property is not set, the RSBFacebook_p_AccountId connection property will be used to determine the default target for ads queries. If none of these are set, the first account id returned from Facebook Ads will be used.
Analytics, peformance, and reporting data for ads is accessed through the AdInsights and AdInsightsActions views. Queries to these views will require a Target as covered in the previous section, but also support more detailed query syntax for their reporting functionality.
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d' AND TimeIncrement='monthly'When specifying a time range for ads data, use TimeIncrement to control the time span of ad data summarized in each result row. For example, if TimeIncrement is set to "monthly", each result row will correspond to a monthly roll-up of ad data.
The Target specified for a query will control what ad account ad data is retrieved for. Use Level to control what level of ad object results are reported at. Level can be set to ad, adset, campaign, or account.
The AdInsightsActions view also offers an ActionCollection column, which allows you to specify what sort of actions attributed to your ads you would like to look at.
The AdInsightsActions view also offers an ActionAttributionWindows column, which allows you to control how Facebook Ads attributes actions to your ad object when it generates its report. ActionAttributionWindows are specified from a list of combinations that define action and time period combinations. For example, the default value for ActionAttributionWindows is "7d_click,1d_view", meaning that relevent actions taken within 7 days of clicking on your ad object or 1 day of viewing it are attributed to and reported on for the ad object. for more information.
string
"15.0"
The Facebook Graph API version to use. Generally this property does not need to be set.
string
""
The Id of a page to retrieve data from. The page must be managed by the authenticated user; you can obtain the Ids for all such pages by querying the Pages view.
string
"OFF"
The following options are available:
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
string
""
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
string
"%APPDATA%\\CData\\FacebookAds Data Provider\\OAuthSettings.txt"
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.
Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
If left unspecified, the default location is "%APPDATA%\\CData\\FacebookAds Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
string
""
The scope that are used when authenticating to Facebook give your App access to request additional information that may be required for certain tables. Individual scope may be entered in a comma separated list. Leaving it blank will use the defaults. The Scope is only used if you have specified your own OAuthClientId and OAuthClientSecret.
You may find while using the driver that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required scope. Set the Scope property in the authentication step for a desktop application.
Web applications need to call the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures, which have inputs for the scope you would like to request.
Note that these are comma-separated lists of scopes, so you can request more than one per authorization request. You can find a list of available Facebook scopes here: http://developers.facebook.com/docs/authentication/permissions/.
string
""
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
See Establishing a Connection to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
string
"NONE"
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the driver opens a connection to Facebook Ads and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
bool
false
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
string
""
Once this property is set, the driver will populate 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 will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
Java logging is also supported. To enable Java logging, set Logfile to:
Logfile=JAVALOG://myloggername
As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.
The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.
When Java logging is enabled, the Verbosity will now correspond to specific logging levels.
string
"1"
The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
string
"100MB"
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.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
int
-1
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.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
string
"%APPDATA%\\CData\\FacebookAds Data Provider\\Schema"
The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\FacebookAds Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
bool
false
When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.
When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
string
""
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined by the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.
Note: you must add the CacheDriver JAR file to the classpath.
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:
jdbc:facebookads:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:facebookads:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;
The following is a JDBC URL for the SQLite JDBC driver:
jdbc:facebookads:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;
The following is a JDBC URL for the included CData JDBC Driver for MySQL:
jdbc:facebookads:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;
The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:
jdbc:facebookads:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;
The following is a JDBC URL for the Oracle Thin Client:
jdbc:facebookads:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
The following JDBC URL uses the official PostgreSQL JDBC driver:
jdbc:facebookads:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;
string
""
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.
The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.
The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.
Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory
To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:
jdbc:sqlite:dataSource
The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:
The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:
string
"%APPDATA%\\CData\\FacebookAds Data Provider"
The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
If left unspecified, the default location is "%APPDATA%\\CData\\FacebookAds Data Provider" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
bool
false
As you execute queries with this property set, table metadata in the Facebook Ads catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
string
"JSON"
The format aggregate or collection columns should return in.
int
0
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
int
0
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
bool
false
When set to true, a connection will be made to Facebook Ads when the connection is opened. This property enables the Test Connection feature available in various database tools.
This feature acts as a NOOP command as it is used to verify a connection can be made to Facebook Ads and nothing from this initial connection is maintained.
Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
CachePartial=True | Caches only a subset of columns, which you can specify in your query. |
QueryPassthrough=True | Passes the specified query to the cache database instead of using the SQL parser of the driver. |
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
string
""
The Pagesize property affects the maximum number of results to return per page from Facebook Ads. Sometimes you may get an error asking you to request less data. The frequency of such errors can be reduced by reducing the pagesize. The maximum pagesize tends to be about 100 per page.
int
60
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
int
100
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
int
1
The minimum number of connections in the pool. The default is 1.
int
60
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
string
"ACCOUNT"
This property only applies if no Target is specified for the submitted query. The RetryLevel property limits the levels of ad objects that the driver will attempt to get data for on retry requests for certain errors. The Insights API for ad insights will return specific errors if the response for an ad insights query from the driver would return too many rows, or have to be computed over too many data points. For these errors, the driver will attempt to retry the query targeting the next most granular level of ad object, up to the level of ad object specified by RetryLevel. The driver's ad object precedence is listed below, from least granular to most granular:
string
""
The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
string
""
A default target if none is specified. Used for some tables, such as Comments, where a target may be specified.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
bool
false
The UploadLinkedMedia determines whether to upload media before inserting a Post. If set to True, when you attempt to insert a new Post with the Link column, the driver will first attempt to resolve the URL and determine if the URL is referencing a photo or a video. If so, the photo or video will be uploaded first, then a new Post containing the media will be created.If False, then the new Post will be created as a Link Post.
bool
false
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The driver 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 driver.
This User Defined View configuration file is formatted as follows:
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"
Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.
AdAccounts in Facebook are the accounts you have available in Facebook for creating Ads on. The Ids for them are always returned in the format "act_" and when they are used as a Target in requests for other tables, the Id with the prefix "act_" must always be used.
When querying AdAccounts, the Id or Target can be used to filter results. For instance:
SELECT * FROM AdAccounts WHERE Id = 'act_123456'
If you use Facebook Business Manager and manage AdAccounts for clients, all of the ad account ids your business has access to can be listed like so:
SELECT Id FROM AdAccounts WHERE Target IN (SELECT Id FROM Businesses)
Otherwise if Id is not specified, the accounts available for your user account will be listed.
Name | Type | Description |
ID [KEY] | String | The Id of Ad Account. |
Target | String | The target to get ad accounts from such as a business id. |
AccountId | String | The Id of the Ad Account when viewed directly in Facebook. |
AccountStatus | Integer | Status of the account. 1 = Active, 2 = Disabled, 3 = Unsettled, 7 = Pending Review, 9 = in Grace Period, 101 = temporarily unavailable, 100 = pending closure. |
Age | Double | Amount of time the ad account has been open, in days. |
AmountSpent | Integer | Current total amount spent by the account. This can be reset. |
Balance | Integer | Bill amount due. |
BusinessCity | String | City for business address. |
BusinessCountryCode | String | Country code for the business address. |
BusinessName | String | The business name for the account. |
BusinessState | String | State abbreviation for business address. |
BusinessStreet | String | First line of the business street address for the account. |
BusinessStreet2 | String | Second line of the business street address for the account. |
BusinessZip | String | Zip code for business address. |
Capabilities | String | Capabilities allowed for this ad account. |
CreatedTime | Datetime | The time the account was created. |
Currency | String | The currency used for the account, based on the corresponding value in the account settings. |
MinCampaignGroupSpendCap | String | The minimum campaign group spend limit. |
Name | String | Name of the account; note that many accounts are unnamed, so this field may be empty. |
OffsitePixelsTosAccepted | String | Indicates whether the offsite pixel Terms Of Service contract was signed. |
OwnerId | String | Facebook ID of the owner fo the Ad Account. |
SpendCap | Integer | The maximum that can be spent by this account after which campaigns will be paused. A value of 0 signifies no spending-cap. |
TimezoneId | String | ID for the timezone. |
TimezoneName | String | Name for the time zone. |
TimezoneOffsetHoursUTC | Double | Time Zone difference from UTC. |
Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.
AdCreatives in Facebook represent a collection of the creatives for specific Ads in Facebook.
When querying ad creatives, either the Id or Target must be used to filter results. The Target may be an ad account, ad set, or ad. For instance:
SELECT * FROM AdCreatives WHERE Target = 'adid'
Name | Type | Description |
ID [KEY] | String | The Id of Ad Creative. |
Target | String | The Ad Account Id or Campaign Id to get Ad Sets of. |
Name | String | The name of the Ad Creative. |
ApplinkTreatment | String | Deep link fallback behavior for dynamic product ads if the app is not installed.
The allowed values are deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only. |
Body | String | The body of the ad. |
CallToActionType | String | The call to action button text and header text of legacy ads.
The allowed values are OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, BOOK_TRAVEL, LISTEN_MUSIC, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, CALL_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, GET_DIRECTIONS, MESSAGE_PAGE, SUBSCRIBE, SELL_NOW, DONATE_NOW, GET_QUOTE, CONTACT_US, RECORD_NOW, VOTE_NOW, REGISTER_NOW, OPEN_MOVIES. |
EffectiveInstagramMediaId | String | The ID of an Instagram post to use in an ad. |
EffectiveInstagramStoryId | String | The ID of an Instagram post to display as an Instagram ad. |
ImageHash | String | Image hash for an image you can use in creatives. |
ImageUrl | String | A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library. |
InstagramActorId | String | Instagram actor ID. |
InstagramPermalinkUrl | String | Instagram permalink. |
InstagramUserId | String | The ID of an Instagram user for creating ads. |
LinkOgId | String | The Open Graph (OG) ID for the link in this creative if the landing page has OG tags. |
LinkUrl | String | Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL. |
ObjectId | String | The ID of the promoted_object or object that is relevant to the ad and ad type. |
ObjectStoryId | String | The ID of a page post to use in an ad. |
ObjectType | String | The type of object that is being advertised.
The allowed values are APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID. |
ObjectUrl | String | Destination URL for a link ads not connected to a page. |
PageId | String | The actor ID (Page ID) of this creative. |
ProductSetId | String | The ID of the product set for this creative. |
RunStatus | String | The run status of this creative.
The allowed values are ACTIVE, DELETED. |
SourceInstagramMediaId | String | The ID of an Instagram post for creating ads. |
TemplateUrl | String | The Tracking URL for dynamic product ads. |
ThumbnailUrl | String | The URL to a thumbnail for this creative. |
Title | String | Title for a link ad (not connected to a Page). |
UrlTags | String | A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only. |
UsePageActorOverride | Boolean | If this is true, we will show the page actor for mobile app ads. |
AdLabels | String | Ad Labels that are associated with this creative. |
ObjectStorySpecLinkData | String | The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
ObjectStorySpecPhotoData | String | The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
ObjectStorySpecVideoData | String | The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
ObjectStorySpecTextData | String | The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
ObjectStorySpecTemplateData | String | The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null. |
Images associated with an ad account
Ad Images in Facebook represent individual images that can be used with ad creatives.
When querying ad images, a Target can be specified so that ad images are queried for the correct ad account. If no Target is specified, the driver will query from the first ad account it finds for your user account:
SELECT * FROM AdImages WHERE Target = 'act_123456'
Name | Type | Description |
ID | String | The Id of image. |
Target | String | The target ad account to pull images from. |
AccountId | String | The id of the ad account of the image. |
CreatedTime | Datetime | The datetime the image was created. |
Creatives | String | The name of the Ad the lead originates from. |
hash | String | The unique hash of the image. |
height | Integer | The height of the image. |
width | Integer | The width of the image. |
AssociatedWithCreatives | Boolean | Whether the image is associated with any ad creatives. |
name | String | The filename of the image. |
OriginalHeight | Integer | The height of the original uploaded image |
OriginalWidth | Integer | The width of the original uploaded image |
Status | String | The status of the image. |
PermalinkUrl | String | The permanent URL of the image to use in ad creatives. |
Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsights in Facebook can be requested with a great amount of detail to simulate the same sort of information that can be retrieved in a report.
When requesting AdInsights, a Target must be specified. This indicates what element to retrieve the insights from. It can be an AdAccount, Campaign, AdSet, or an Ad. For instance:
SELECT * FROM AdInsights WHERE Target = 'act_123456'
A date range can be specified using DateStart and DateEnd, or DatePreset must also be specified. For instance:
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d'
The available values for DatePreset are:
The TimeIncrement can used to specify how many days should be included in each report row. For instance:
SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d' AND TimeIncrement='7'
SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d' AND TimeIncrement='monthly'
The Level column can be used to specify what level insights are retrieved at. This can be set to ad,adset,campaign, or account. For instance:
SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND Level='campaign'
There are a number of breakdown columns. In general, only one breakdown column can be selected at a time. If you use SELECT *, no breakdown columns will be used. The available breakdown columns are:
Most other columns not already mentioned can be used with standard SQL WHERE clause modifiers. For instance:
SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000
Both the DatePreset and the breakdowns are subject to frequent changes by Facebook. The lists above may be outdated due to Facebook changes. To see the most currently available breakdowns and date presets, see the documentation on Facebook for parameters and breakdowns: https://developers.facebook.com/docs/marketing-api/insights/
Note: The following error message may be encountered when querying from this table: "Please reduce the amount of data you're asking for, then retry your request".
This error typically occurs when the driver requests an amount of data that Facebook cannot handle the calculations for on its end. It appears to be triggered based on individually dense fields, and not the page size.
If the driver encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.
If this error is still encountered, either reduce the date range of the query or remove expensive columns.
A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.
Name | Type | Description |
Target | String | The Id of the Account, Campaign, Ad Group, or Ad to get insights for. |
DatePreset | String | An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.
The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month. |
DateStart | Date | The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field. |
DateEnd | Date | The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field. |
TimeIncrement | String | The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.
The default value is 1. |
Level | String | The level to represent the results at.
The allowed values are ad, adset, campaign, account. |
AccountCurrency | String | The currency that is being used by the ad account. |
ActionAttributionWindows | String | A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. |
AdAccountId | String | The Id of the Ad Account associated with the report row. |
AdAccountName | String | The name of the Ad Account associated with the report row. |
CampaignId | String | The Id of the Campaign associated with the report row. |
CampaignName | String | The name of the Campaign associated with the report row. |
AdSetId | String | The Id of the Ad Set associated with the report row. |
AdSetName | String | The name of the Ad Set associated with the report row. |
AdId | String | The Id of the Ad associated with the report row. |
AdName | String | The name of the Ad associated with the report row. |
BuyingType | String | The method by which target ads are paid for in your campaigns. |
Clicks | Long | The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field. |
ConversionRateRanking | String | The conversion rate ranking. |
CostPerEstimatedAdRecallers | Decimal | The average cost per additional person we estimate will recall seeing your ad if asked within 2 days. |
CostPerInlineLinkClick | Decimal | The average cost per click on links in the ad. |
CostPerInlinePostEngagement | Decimal | The average cost per engagement on the post. |
CostPerUniqueClick | Decimal | The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received. |
CostPerUniqueInlineLinkClick | Decimal | The average you paid for each unique inline link click. |
CPC | Decimal | The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received. |
CPM | Decimal | The average cost you've paid to have 1,000 impressions on your ad. |
CPP | Decimal | The average cost you've paid to have your ad served to 1,000 unique people. |
CTR | Double | The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field. |
EstimatedAdRecallRate | Double | The estimated number of people who recall your ad divided by the number of people your ad reached. |
EstimatedAdRecallers | Double | The additional number of people we estimate will remember seeing your ads if asked within 2 days. |
Frequency | Double | The average number of times your ad was served to each person. |
Impressions | Long | The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column. |
InlineLinkClicks | Long | Total number of clicks on links in the ad. |
InlineLinkClicksCounter | Double | Click-through rate for inline clicks to link. |
InlinePostEngagement | Long | Total number of engagements on the post. |
InstantExperienceClicksToOpen | Long | instant_experience_clicks_to_open |
InstantExperienceClicksToStart | Long | instant_experience_clicks_to_start |
InstantExperienceOutboundClicks | Long | instant_experience_outbound_clicks |
Objective | String | The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising. |
QualityRanking | String | The quality ranking. |
Reach | Long | The number of people your ad was served to. |
Spend | Decimal | The total amount you've spent so far. |
UniqueClicks | Long | The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it will count as 3 unique clicks. |
UniqueCTR | Double | The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%. |
UniqueInlineLinkClicks | Long | The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field. |
UniqueInlineLinkClickCounter | Double | Click-through rate for unique inline clicks to link. |
UniqueLinkClicksCounter | Double | Unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%. |
Checkins | Int | The number of checkins attributed to the Ad. |
EventResponses | Int | The number of event responses attributed to the Ad. |
LinkClicks | Int | The number of link clicks attributed to the Ad. |
OfferSaves | Int | The number of receive offers attributed to the Ad. |
OutboundClicks | Int | The number of outbound clicks attributed to the Ad. |
PageEngagements | Int | The number of page enagements attributed to the Ad. |
PageLikes | Int | The number of page likes attributed to the Ad. |
PageMentions | Int | The number of page mentions attributed to the Ad. |
PagePhotoViews | Int | The number of photo views attributed to the Ad. |
PostComments | Int | The number of post comments attributed to the Ad. |
PostEngagements | Int | The number of post engagements attributed to the Ad. |
PostShares | Int | The number of post shares attributed to the Ad. |
PostReactions | Int | The number of post reactions attributed to the Ad. |
PageTabViews | Int | The number of tab views attributed to the Ad. |
Video3SecondViews | Int | The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played. |
Age | String | The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Country | String | The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
DevicePlatform | String | The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns. |
DMA | String | The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns. |
FrequencyValue | String | The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Gender | String | The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAdvertiserTZ | String | Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAudienceTZ | String | Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
ImpressionDevice | String | The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PlacePageId | String | The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns. |
PlatformPosition | String | The position on the platform. |
ProductId | String | The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PublisherPlatform | String | The platforms the ads were published on. |
Region | String | The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
AdEffectiveStatus | String | An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values. |
UseAsync | Boolean | A boolean indicating if an asynchronous call should be used for retrieving the insights. |
DefaultSummary | Boolean | A boolean indicating if we should get the default summary. |
Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsActions represents a breakdown of the Actions column from the AdInsights. See AdInsights for general information on querying AdInsights.
When requesting AdInsightsActions, a Target must be specified. This indicates what element to retrieve the insights from. It can be an AdAccount, Campaign, AdSet, or an Ad. For instance:
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'
The specific collection to retrieve from AdInsightsActions may be specified via ActionCollection. If none is specified, Actions is used. Each input represents an available column from AdInsights where a collection of actions would return. Furthermore, multiple collections may be specified via the IN clause. For instance:
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'
SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions','UniqueActions')
Just as in the available selection criterias from AdInsights, breakdowns are available. Please see AdInsights for details on breakdowns. Additional breakdowns for AdInsightsActions include ActionType, ActionCanvasComponentName, ActionCarouselCardId, ActionCarouselCardName, ActionDestination, ActionDevice, ActionLinkClickDestination, ActionReaction, ActionTargetId, ActionVideoSound, and ActionVideoType.
ActionAttributionWindows is available to input a comma separated list of attribution windows. For instance:
SELECT * FROM AdInsightsActions WHERE Target='act_123456' AND level='ad' AND ActionAttributionWindows='1d_view,7d_view,28d_click'
Note: The following error message may be encountered when querying from this table: "Please reduce the amount of data you're asking for, then retry your request".
This error typically occurs when the driver requests an amount of data that Facebook cannot handle the calculations for on its end. It appears to be triggered based on individually dense fields, and not the page size.
If the driver encounters this error when first executing certain types of queries, the driver will attempt to retry the query at a lower level of ad object, if possible. To retry, the driver will execute the query at the next lowest level of ad object, down to the level defined in RetryLevel. Note that if the Level parameter is specified in a query, the driver will not attempt to retry beyond the ad object level specified by Level. Please see RetryLevel for more details. Additionally, spreading queries across more granular ad objects can decrease query performance by increasing the number of requests executed for the query.
If this error is still encountered, either reduce the date range of the query or remove expensive columns.
A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. Then retry again with half of the remaining columns if you get the same error, or half of the removed columns if you got no error.
Name | Type | Description |
Target | String | The Id of the Account, Campaign, Ad Group, or Ad to get insights for. |
DatePreset | String | An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.
The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month. |
DateStart | Date | The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field. |
DateEnd | Date | The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field. |
TimeIncrement | String | The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments.
The default value is 1. |
Level | String | The level to represent the results at.
The allowed values are ad, adset, campaign, account. |
ActionAttributionWindows | String | A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. |
ActionCollection | String | The action collection to retrieve. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas
The default value is Actions. |
AdAccountId | String | The Id of the Ad Account associated with the report row. |
AdAccountName | String | The name of the Ad Account associated with the report row. |
CampaignId | String | The Id of the Campaign associated with the report row. |
CampaignName | String | The name of the Campaign associated with the report row. |
AdSetId | String | The Id of the Ad Set associated with the report row. |
AdSetName | String | The name of the Ad Set associated with the report row. |
AdId | String | The Id of the Ad associated with the report row. |
AdName | String | The name of the Ad associated with the report row. |
ActionType | String | The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. |
ActionValue | String | Metric value of default attribution window. |
Action1dClick | String | Metric value of attribution window 1 day after clicking the ad. |
Action1dView | String | Metric value of attribution window 1 day after viewing the ad. |
Action7dClick | String | Metric value of attribution window 7 days after clicking the ad. |
Action7dView | String | Metric value of attribution window 7 days after viewing the ad. |
Action28dClick | String | Metric value of attribution window 28 days after clicking the ad. |
Action28dView | String | Metric value of attribution window 28 days after viewing the ad. |
ActionDDA | String | Metric value of attribution window which is powered by data driven model. |
ActionCanvasComponentName | String | Name of a component within a Canvas ad. |
ActionCarouselCardId | String | The ID of the specific carousel card that people engaged with when they saw your ad. |
ActionCarouselCardName | String | The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines. |
ActionConvertedProductId | String | Converted product ids - for Collaborative Ads. |
ActionDestination | String | The destination where people go after clicking on your ad. |
ActionDevice | String | The device on which the conversion event you are tracking occurred. |
ActionReaction | String | The number of reactions on your ads or boosted posts. |
ActionTargetId | String | The id of destination where people go after clicking on your ad. |
ActionVideoSound | String | The sound status (on/off) when user watches your video ad. |
ActionVideoType | String | Video metrics breakdown. |
Age | String | The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Country | String | The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
DevicePlatform | String | The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns. |
DMA | String | The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns. |
FrequencyValue | String | The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Gender | String | The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAdvertiserTZ | String | Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAudienceTZ | String | Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
ImpressionDevice | String | The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PlacePageId | String | The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns. |
PlatformPosition | String | The position on the platform. |
ProductId | String | The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PublisherPlatform | String | The platforms the ads were published on. |
Region | String | The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
AdEffectiveStatus | String | An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values. |
UseAsync | Boolean | A boolean indicating if an asynchronous call should be used for retrieving the insights. |
Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
Name | Type | Description |
Target | String | The Id of the Account, Campaign, Ad Group, or Ad to get insights for. |
DatePreset | String | An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value.
The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month. |
DateStart | Date | The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field. |
DateEnd | Date | The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field. |
TimeIncrement | String | The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. |
Level | String | The level to represent the results at.
The allowed values are ad, adset, campaign, account. |
AccountCurrency | String | The currency that is being used by the ad account. |
ActionAttributionWindows | String | A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. |
AdAccountId | String | The Id of the Ad Account associated with the report row. |
AdAccountName | String | The name of the Ad Account associated with the report row. |
CampaignId | String | The Id of the Campaign associated with the report row. |
CampaignName | String | The name of the Campaign associated with the report row. |
AdSetId | String | The Id of the Ad Set associated with the report row. |
AdSetName | String | The name of the Ad Set associated with the report row. |
AdId | String | The Id of the Ad associated with the report row. |
AdName | String | The name of the Ad associated with the report row. |
BuyingType | String | The method by which target ads are paid for in your campaigns. |
Clicks | Long | The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field. |
ConversionRateRanking | String | The conversion rate ranking. |
CostPerEstimatedAdRecallers | Decimal | The average cost per additional person we estimate will recall seeing your ad if asked within 2 days. |
CostPerInlineLinkClick | Decimal | The average cost per click on links in the ad. |
CostPerInlinePostEngagement | Decimal | The average cost per engagement on the post. |
CostPerUniqueClick | Decimal | The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received. |
CostPerUniqueInlineLinkClick | Decimal | The average you paid for each unique inline link click. |
CPC | Decimal | The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received. |
CPM | Decimal | The average cost you've paid to have 1,000 impressions on your ad. |
CPP | Decimal | The average cost you've paid to have your ad served to 1,000 unique people. |
CTR | Double | The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field. |
EstimatedAdRecallRate | Double | The estimated number of people who recall your ad divided by the number of people your ad reached. |
EstimatedAdRecallers | Double | The additional number of people we estimate will remember seeing your ads if asked within 2 days. |
Frequency | Double | The average number of times your ad was served to each person. |
Impressions | Long | The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column. |
InlineLinkClicks | Long | Total number of clicks on links in the ad. |
InlineLinkClicksCounter | Double | Click-through rate for inline clicks to link. |
InlinePostEngagement | Long | Total number of engagements on the post. |
InstantExperienceClicksToOpen | Long | instant_experience_clicks_to_open |
InstantExperienceClicksToStart | Long | instant_experience_clicks_to_start |
InstantExperienceOutboundClicks | Long | instant_experience_outbound_clicks |
Objective | String | The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising. |
QualityRanking | String | The quality ranking. |
Reach | Long | The number of people your ad was served to. |
Spend | Decimal | The total amount you've spent so far. |
UniqueClicks | Long | The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it will count as 3 unique clicks. |
UniqueCTR | Double | The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%. |
UniqueInlineLinkClicks | Long | The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field. |
UniqueInlineLinkClickCounter | Double | Click-through rate for unique inline clicks to link. |
UniqueLinkClicksCounter | Double | Unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%. |
ActionType | String | The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. |
ActionValue | String | Metric value of default attribution window. |
Action1dClick | String | Metric value of attribution window 1 day after clicking the ad. |
Action1dView | String | Metric value of attribution window 1 day after viewing the ad. |
Action7dClick | String | Metric value of attribution window 7 days after clicking the ad. |
Action7dView | String | Metric value of attribution window 7 days after viewing the ad. |
Action28dClick | String | Metric value of attribution window 28 days after clicking the ad. |
Action28dView | String | Metric value of attribution window 28 days after viewing the ad. |
ActionDDA | String | Metric value of attribution window which is powered by data driven model. |
ActionCollection | String | The action collection to retrieve. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas
The default value is Actions. |
ActionCanvasComponentName | String | Name of a component within a Canvas ad. |
ActionCarouselCardId | String | The ID of the specific carousel card that people engaged with when they saw your ad. |
ActionCarouselCardName | String | The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines. |
ActionConvertedProductId | String | Converted product ids - for Collaborative Ads. |
ActionDestination | String | The destination where people go after clicking on your ad. |
ActionDevice | String | The device on which the conversion event you are tracking occurred. |
ActionReaction | String | The number of reactions on your ads or boosted posts. |
ActionTargetId | String | The id of destination where people go after clicking on your ad. |
ActionVideoSound | String | The sound status (on/off) when user watches your video ad. |
ActionVideoType | String | Video metrics breakdown. |
Age | String | The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Country | String | The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
DevicePlatform | String | The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns. |
DMA | String | The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns. |
FrequencyValue | String | The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Gender | String | The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAdvertiserTZ | String | Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
HStatsByAudienceTZ | String | Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
ImpressionDevice | String | The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PlacePageId | String | The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns. |
PlatformPosition | String | The position on the platform. |
ProductId | String | The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
PublisherPlatform | String | The platforms the ads were published on. |
Region | String | The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
Name | Type | Description |
AdEffectiveStatus | String | An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values. |
UseAsync | Boolean | A boolean indicating if an asynchronous call should be used for retrieving the insights. |
DefaultSummary | Boolean | A boolean indicating if we should get the default summary. |
Query information about ad labels. Accessing Ad Information requires the ads_read permission.
Name | Type | Description |
ID [KEY] | String | The Id of Ad label. |
Target | String | The Ad Account Id to retrieve labels from. |
Name | String | The name of the Ad label. |
CreatedTime | Datetime | The time when the Ad label was created. |
UpdatedTime | Datetime | When the Ad label was last updated. |
Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission.
Ads in Facebook represent individual ads that have been created.
When querying ad accounts, either the Id or Target must be used to filter results. For instance:
SELECT * FROM Ads WHERE Target = 'act_123456'
Additionally, UpdatedTime may be used with the > or >= operators to retrieve only records newer than a certain date. For instance:
SELECT * FROM Ads WHERE Target = 'act_123456' AND UpdatedTime > '01/01/2016'
Name | Type | Description |
ID [KEY] | String | The Id of Ad. |
Target | String | The Ad Account Id, Campaign Id, or Ad Set Id to get Ads in. |
Name | String | The name of the Ad. |
AdStatus | String | The status of the Ad.
The allowed values are ACTIVE, PAUSED, CAMPAIGN_PAUSED, CAMPAIGN_GROUP_PAUSED, CREDIT_CARD_NEEDED, DISABLED, DISAPPROVED, PENDING_REVIEW, PREAPPROVED, PENDING_BILLING_INFO, ARCHIVED, DELETED. |
BidInfo | String | The value of the bid info taken from the Ad Set. |
BidType | String | The bid type value taken from the Ad Set.
The allowed values are CPM, CPC, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA. |
CampaignId | String | The Id of the Campaign the Ad belongs to. |
AdSetId | String | The Id of the Ad Set the Ad belongs to. |
AdCreativeId | String | The Id of the Ad Creative associated with the Ad. |
ConfiguredStatus | String | The configured status of the ad. Prefer using 'status' instead of this.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
CreatedTime | Datetime | The time when the Ad was created. |
UpdatedTime | Datetime | When the Ad was last updated. |
ConversionSpecs | String | The Ad's conversion specs. |
FailedDeliveryChecks | String | Possible checks that could have failed which will prevent the Ad from showing up. |
Recommendations | String | If there are recommendations for this ad, this field includes them. Otherwise, this field will be null. |
TrackingSpecs | String | The Ad's tracking specification. This field will be defaulted based on the objective, if not set to NONE, or based on the ad creative. |
Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission.
AdSets in Facebook represent a collection of Ads in Facebook.
When querying ad sets, either the Id or Target must be used to filter results. The Target may be an ad account, or a campaign. For instance:
SELECT * FROM AdSets WHERE Target = 'act_123456'
Name | Type | Description |
ID [KEY] | String | The Id of Ad Set. |
Target | String | The Ad Account Id or Campaign Id to get Ad Sets of. |
Name | String | The name of the Ad Set. |
BudgetRemaining | Integer | The amount of budget remaining for this Ad Set. |
CampaignId | String | The Ad Campaign this ad set is a part of. |
AdSetStatus | String | The status of the Ad Set.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DELETED. |
BillingEvent | String | The billing event that this adset is using: APP_INSTALLS: Pay when people install your app. CLICKS: Pay when people click anywhere in the ad. IMPRESSIONS: Pay when the ads are shown to people. LINK_CLICKS: Pay when people click on the link of the ad. OFFER_CLAIMS: Pay when people claim the offer. PAGE_LIKES: Pay when people like your page. POST_ENGAGEMENT: Pay when people engage with your post. VIDEO_VIEWS: Pay when people watch videos. |
CreatedTime | Datetime | When the Ad Set was created. |
DailyBudget | Integer | The daily budget of the set defined in your account currency, it is allowed only for ad sets with a duration longer than 24 hours. |
LifetimeBudget | Decimal | The lifetime budget of the set defined in your account currency. |
EndTime | Datetime | When the Ad Set is scheduled to end. |
StartTime | Datetime | When the Ad Set started. |
UpdatedTime | Datetime | The time the Ad Set was last updated. |
Recommendations | String | If there are recommendations for this ad set, this field includes them. Otherwise, this field will be null. |
TargetingGenders | Integer | Indicates gender-based targeting. 0=all, 1=male, 2=female.
The allowed values are 0, 1, 2. |
TargetingAgeMax | Integer | Maximum age. If used, must be 65 or lower. |
TargetingAgeMin | Integer | Minimum age. If used, must be 13 or higher. If omitted, will default to 18. |
TargetingCountries | String | Values for country targeting. |
TargetingLocationTypes | String | Values for the types of locations to target. |
TargetingRegions | String | The state, province, or region. |
TargetingCities | String | Cities to target with a radius and distance. |
TargetingZips | String | The zip codes used for targeting. |
TargetingCustomLocations | String | Any custom locations to target. |
TargetingGeoMarkets | String | They key for the market. The destination market areas (DMA) and keys are in the format DMA:NUMBER, such as DMA:501. |
TargetingInterests | String | Interests to target based on. |
TargetingBehaviors | String | Behaviors to target based on. |
TargetingDevicePlatforms | String | The device platforms to target. |
TargetingPublisherPlatforms | String | The publisher platforms to target. |
TargetingInstagramPositions | String | The instagram positions to target. |
TargetingPageTypes | String | The types of pages to use when targeting. Values may include desktop, feed, desktopfeed, mobile, rightcolumn, rightcolumn-and-mobile, home, mobilefeed-and-external, desktop-and-mobile-and-external, feed-and-external, rightcolumn-and-mobile-and-external. |
Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.
Name | Type | Description |
ID [KEY] | String | The Id of the album. |
Target | String | The Id or username of the target you are retrieving albums from. |
Name | String | The name of the album. |
FromId | String | Id of the user who owns the album. |
FromName | String | Name of the user who owns the album. |
FromPicture | String | The picture of user the album is from. |
FromCategory | String | The category of user the album is from. FromCategory may only be retrieved if the other From* fields are not selected. |
Description | String | A description of the album. |
Location | String | The location of the album. |
Link | String | A link to this album on Facebook. |
CoverPhoto | String | The album cover photo Id. |
Privacy | String | The privacy settings for the album. |
Count | Integer | The number of photos in this album. |
Type | String | The type of the album: profile, mobile, wall, normal or album. |
CommentsCount | Integer | The number of comments for the album. |
CommentsData | String | An aggregate of comment data. |
CreatedTime | Datetime | When the album was uploaded. |
UpdatedTime | Datetime | When the album was last updated. |
Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id.
AuthorizedAdAccounts in Facebook represent the ad accounts that have been authorized for advertising on the specified application for your Facebook business. You must have a business set up in Facebook for this view to work correctly.
When querying AuthorizedAdAccounts, a Target must be specified and a business may optionally be specified. For instance:
SELECT * FROM AdAccounts WHERE Target = 'ApplicationId' AND Business = 'BusinessId'
If no business is specified, results for all of your available businesses will come back.
Name | Type | Description |
ID [KEY] | String | The Id of the Ad Account. |
Target | String | The app id to request authorized ad accounts from. |
AccountId | String | The Id of the Ad Account when viewed directly in Facebook. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
Name | Type | Description |
Business | String | The id of the business to retrieve authorized ad accounts for. |
Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.
Name | Type | Description |
ID [KEY] | String | The Id of the business. |
Name | String | The name of the business. |
PrimaryPage | String | The primary page of the business. |
TimezoneId | String | The timezone id of the business. |
Link | String | The link of the business. |
CreatedTime | Datetime | When the business was added. |
UpdatedTime | Datetime | When the business was updated. |
Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.
Campaigns in Facebook represent advertising campaigns that individual Ads or AdSets may be a part of.
When querying campaigns, either the Id or Target must be used to filter results. The Target must be an ad account. For instance:
SELECT * FROM Campaigns WHERE Target = 'act_123456'
Name | Type | Description |
ID [KEY] | String | The Id of Campaign. |
Target | String | The target or Ad Account Id to get Campaigns. |
Name | String | The name of the Campaign. |
BuyingType | String | This field will help Facebook make future optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type.
The allowed values are AUCTION, FIXED_CPM, RESERVED. |
ConfiguredStatus | String | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
EffectiveStatus | String | The effective status of this campaign. For example, when all Ad Sets beneath the campaign are paused, the effective status is ADSET_PAUSED..
The allowed values are ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED. |
Status | String | If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.
The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED. |
CreatedTime | Datetime | When the campaign was created. |
Objective | String | Objective of this ad campaign. If it is specified the API will validate that any ad groups created under the campaign match that objective.
The allowed values are CANVAS_APP_ENGAGEMENT, CANVAS_APP_INSTALLS, EVENT_RESPONSES, MOBILE_APP_ENGAGEMENT, MOBILE_APP_INSTALLS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, WEBSITE_CLICKS, WEBSITE_CONVERSIONS. |
SpendCap | Int | A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency. |
DailyBudget | Int | The daily budget of the campaign. |
BudgetRemaining | Int | The remaining budget of the campaign. |
LifetimeBudget | Int | The lifetime budget of the campaign. |
BidStrategy | String | The bid strategy of the campaign. May be one of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP. |
StartTime | Datetime | When the Campaign was started. |
StopTime | Datetime | When the Campaign was stopped. |
UpdatedTime | Datetime | When the Campaign was last updated. |
Query information about a lead. Accessing Lead Information requires the ads_read permission.
LeadValues in Facebook represent individual values available from a Lead Ad. The types of values describing a leads are varied and can range from custom information such as a car model, or something general such as name and email.
When querying lead values, either the Id or Target must be used to filter results. The id represents the id of the individual lead while the target must be a Lead Ad. For instance:
SELECT * FROM LeadValues WHERE Target = 'lead_ad_id'
SELECT * FROM LeadValues WHERE Id = 'lead_id'
SELECT * FROM LeadValues WHERE Target IN (SELECT id FROM Ads WHERE Target='campaign_id')
Note that many values may come back for a single lead id. The leads themselves are a collection on the Lead Ad, and the lead values are a collection on each individual lead.
Name | Type | Description |
ID | String | The Id of Lead. |
Target | String | The target or Ads Id to get Lead values from. |
AdId | String | The id of the Ad the lead originates from. |
AdName | String | The name of the Ad the lead originates from. |
AdSetId | String | The id of the Ad Set the lead is associated with. |
AdSetName | String | The name of the Ad Set the lead is associated with. |
CampaignId | String | The id of the Campaign the lead is associated with. |
CampaignName | String | The name of the Campaign the lead is associated with. |
FormId | String | The id of the form the lead originates from. |
FieldName | String | The name of the field of lead data. |
FieldValues | String | The values for the given field of lead data. |
IsOrganic | Boolean | A boolean indicating if the lead is organic. |
CreatedTime | Datetime | The datetime the lead was created. |
Query the Pages based on the supplied Id.
Pages in Facebook are pages that are created by a user and may be maintained by one or multiple users. Pages, like users, may be referred to by Id or by screen name.
When querying pages, if nothing is specified then the pages you administrate will be displayed by default. Otherwise, the Id of the page can be specified. For example:
SELECT * FROM Pages WHERE Id = 'facebook'
Name | Type | Description |
ID [KEY] | String | The Id of the page. |
Username | String | The username for the page, if any. |
Name | String | The name of the page. |
Category | String | The category of the page. |
Categories | String | An aggregate of categories associated with the page if multiple categories are available. |
Link | String | A link to the page. |
Picture | String | A link to the profile picture of the page for the page. |
CoverId | String | Id of the cover image for the page. |
CoverSource | String | The URL to the cover image for the page. |
CoverOffsetY | String | The y-axis offset of the cover image for the page. |
CoverOffsetX | String | The x-axis offset of the cover image for the page. |
About | String | Basic information about the page. |
Description | String | A description of the page, if available. |
GeneralInfo | String | General information provided by the page. |
LocationStreet | String | The street address of the page. |
LocationCity | String | The city for the page. |
LocationState | String | The state for the page. |
LocationCountry | String | The country for the page. |
LocationZip | String | The ZIP code of the page. |
LocationLatitude | String | The latitude of the page. |
LocationLongitude | String | The longitude of the page. |
StoreNumber | Integer | Unique store number for this location page, if applicable. |
Phone | String | The phone number of the page, if available. |
Website | String | A link to the website for the page. |
Likes | Integer | The number of people who like the page. |
Checkins | Integer | The total number of users who have checked in to the place associated with the page. |
TalkingAboutCount | Integer | The number of users talking about the page. |
WereHereCount | Integer | The number of users who were at the location the page is for, if applicable. |
CanPost | Boolean | Boolean indicating if the authenticated user can post of the page for the page. |
IsPublished | Boolean | Boolean indicating if the page for the page has been published. |
IsCommunityPage | Boolean | Boolean indicating if this is a community page. |
PublicTransit | String | The public transit available for the page, if any. |
ParkingStreet | Boolean | Boolean indicating if street parking is available. |
ParkingLot | Boolean | Boolean indicating if a parking lot is available. |
ParkingValet | Boolean | Boolean indicating if valet parking is available. |
PromotionEligible | Boolean | Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page. |
PromotionIneligibleReason | String | Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page. |
Founded | String | When the company is founded. Applicable to companies. |
Mission | String | The company mission. Applicable to companies. |
Products | String | The products of this company. Applicable to companies. |
Hours | String | An aggregate for the hours of operation. Applicable to businesses and places. |
Attire | String | Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified. |
AcceptsCashOnly | Boolean | Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife. |
AcceptsVisa | Boolean | Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife. |
AcceptsAmericanExpress | Boolean | Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife. |
AcceptsMasterCard | Boolean | Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife. |
AcceptsDiscover | Boolean | Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife. |
PriceRange | String | Price range of the business. Applicable to restaurants or nightlife. Valid values are \$ (0-10), \$\$ (10-30), \$\$\$ (30-50), \$\$\$\$ (50+), or Unspecified. |
TakesReservations | Boolean | Whether the restaurant takes reservations. Only applicable to restaurants. |
AllowsWalkins | Boolean | Whether the restaurant allows walk-ins. Only applicable to restaurants. |
AllowsGroups | Boolean | Whether the restaurant accommodates groups. Only applicable to restaurants. |
AllowsKids | Boolean | Whether the restaurant allows kids. Only applicable to restaurants. |
ProvidesTakeout | Boolean | Whether the restaurant provides a takeout service. Only applicable to restaurants. |
ProvidesDelivery | Boolean | Whether the restaurant provides a delivery service. Only applicable to restaurants. |
ProvidesCatering | Boolean | Whether the restaurant provides a catering service. Only applicable to restaurants. |
HasWaiters | Boolean | Whether the restaurant has waiters. Only applicable to restaurants. |
HasOutdoorSeating | Boolean | Whether the restaurant has outdoor seating. Only applicable to restaurants. |
ServesBreakfast | Boolean | Whether the restaurant serves breakfast. Only applicable to restaurants. |
ServesLunch | Boolean | Whether the restaurant serves lunch. Only applicable to restaurants. |
ServesDinner | Boolean | Whether the restaurant serves dinner. Only applicable to restaurants. |
ServesCoffee | Boolean | Whether the restaurant serves coffee. Only applicable to restaurants. |
ServesDrinks | Boolean | Whether the restaurant serves drinks. Only applicable to restaurants. |
CulinaryTeam | String | Culinary team of the business. Applicable to restaurants or nightlife. |
PharmaSafetyInfo | String | Pharmacy safety information. Applicable to pharmaceutical companies. |
Affiliation | String | Affiliation of this person. Applicable to pages representing people. |
Birthday | String | Birthday of this person. Applicable to pages representing people. |
PersonalInfo | String | Personal information. Applicable to pages representing people. |
PersonalInterests | String | Personal interests. Applicable to pages representing people. |
ArtistsWeLike | String | Artists the band likes. Applicable to bands. |
BandInterests | String | Band interests. Applicable to bands. |
BandMembers | String | Members of the band. Applicable to bands. |
Bio | String | Biography of the band. Applicable to bands. |
BookingAgent | String | Booking agent of the band. Applicable to bands. |
GeneralManager | String | General manager of the business. Applicable to restaurants or nightlife. Applicable to bands. |
Hometown | String | Hometown of the band. Applicable to bands. |
PressContact | String | Press contact information of the band. Applicable to bands. |
RecordLabel | String | Record label of the band. Applicable to bands. |
Awards | String | Awards information for the film or TV show. Applicable to films and TV shows. |
DirectedBy | String | The director of the film or TV show. Applicable to films and TV shows. |
Genre | String | The genre of the film or TV show. Applicable to films and TV shows. |
Influences | String | Influences on the band. Applicable to bands. |
PlotOutline | String | The plot outline of the film or TV show. Applicable to films and TV shows. |
ProducedBy | String | The productor of the film. Applicable to films. |
ReleaseData | String | The film's release data. Applicable to films and TV shows. |
ScreenplayBy | String | The screenwriter of the film. Applicable to films and TV shows. |
Starring | String | The cast of the film or TV show. Applicable to films and TV shows. |
Studio | String | The studio for the film production. Applicable to films. |
Network | String | The network the TV show airs on. Applicable to TV shows. |
Schedule | String | The air schedule of the TV show. Applicable to TV shows. |
Season | String | The current season of the TV show. Applicable to TV shows. |
WrittenBy | String | The writer of the TV show. Applicable to TV shows. |
Built | String | The information about when the vehicle was built. Applicable to vehicles. |
Features | String | Features of the vehicle. Applicable to vehicles. |
MPG | String | Miles per gallon for the vehicle. Applicable to vehicles. |
Members | String | Members of this org. Applicable to pages representing team orgs. |
InstagramBusinessAccountId | String | The business instagram account id associated with this page. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.
Name | Type | Description |
offset | String | Which result to begin returning results from. Used for manual paging of results. |
Query the Permissions the User has granted the current application.
Name | Type | Description |
PermissionName [KEY] | String | The name of the permission. |
Status | String | The status of the requested permission. |