Bing Ads Data Model

Connection String Options

  1. Account Id
  2. Auto Cache
  3. Batch Size
  4. Cache Connection
  5. Cache Driver
  6. Cache Location
  7. Cache Metadata
  8. Cache Query Result
  9. Callback URL
  10. Connect On Open
  11. Customer Id
  12. Developer Token
  13. Firewall Password
  14. Firewall Port
  15. Firewall Server
  16. Firewall Type
  17. Firewall User
  18. Initiate OAuth
  19. Location
  20. Logfile
  21. Max Log File Size
  22. OAuth Access Token
  23. OAuth Client Id
  24. OAuth Client Secret
  25. OAuth Refresh Token
  26. OAuth Settings Location
  27. OAuth Verifier
  28. Offline
  29. Other
  30. Pool Idle Timeout
  31. Pool Max Size
  32. Pool Wait Time
  33. Proxy Auth Scheme
  34. Proxy Auto Detect
  35. Proxy Exceptions
  36. Proxy Password
  37. Proxy Port
  38. Proxy Server
  39. Proxy SSL Type
  40. Proxy User
  41. Pseudo Columns
  42. Readonly
  43. RTK
  44. SSL Server Cert
  45. Support Enhanced SQL
  46. Tables
  47. Timeout
  48. Use Connection Pooling
  49. Use Sandbox
  50. Verbosity
  51. Views

Account Id

Data Type

string

Default Value

""

Remarks

AccountId of the currently authenticated user.

You can find this value in the Bing Ads Web application, under Settings -> Accounts and Billing -> Your Account -> Account.

 

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Bing Ads data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Bing Ads in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [AdGroups#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Bing Ads metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

Remarks

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.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

 

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies 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.

 

Derby and Java DB

 

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 CacheProvider and CacheConnection. Below 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

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

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
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    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.

  • User ID: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below 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
Below 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).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below 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
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

 

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, 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:bingads:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
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:bingads:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:bingads:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:bingads:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Bing Ads 2018 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:bingads:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:bingads:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:bingads:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Bing Ads catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Bing 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.

When to Use CacheMetadata

 

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.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Callback URL

Data Type

string

Default Value

""

Remarks

 

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.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to Bing 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 Bing 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).

 

Customer Id

Data Type

string

Default Value

""

Remarks

CustomerId of the currently authenticated user.

You can find this value in the Bing Ads Web application, under Settings -> Accounts and Billing -> Your Account -> Account.

 

Developer Token

Data Type

string

Default Value

""

Remarks

DeveloperToken of the currently authenticated user.

 

Firewall Password

Data Type

string

Default Value

""

Remarks

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

 

Firewall Port

Data Type

string

Default Value

""

Remarks

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

 

Firewall Server

Data Type

string

Default Value

""

Remarks

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

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

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

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 Bing 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.

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

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

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

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 username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\BingAds Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

 

OAuth Verifier

Data Type

string

Default Value

""

Remarks

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. The verifier will only be used when InitiateOAuth is set to GETANDREFRESH. Once the OAuth settings file has been generated, the verifier can be removed from the connection properties.

 

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

   
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.

 

Integration and Formatting

 

   
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT 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.

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

Default Value

"100"

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

 

Pool Wait Time

Data Type

string

Default Value

""

Remarks

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.

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

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:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

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

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

 

Proxy Password

Data Type

string

Default Value

""

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

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

 

Proxy Server

Data Type

string

Default Value

""

Remarks

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.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

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

 

   
AUTO Default setting. If the URL is an HTTPS URL, the 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.

 

 

Proxy User

Data Type

string

Default Value

""

Remarks

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

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

user@domain
domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; i.e., "*=*".

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Bing Ads and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Bing Ads API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

Tables

Data Type

string

Default Value

""

Remarks

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. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

Use Sandbox

Data Type

bool

Default Value

false

Remarks

If you are using a production account, this property can be left blank. If you are using a developer test account, set this to 'TRUE'.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

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 described below:

 

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

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

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. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Views

  1. AccountPerformanceReport
  2. Accounts
  3. AdDynamicTextPerformanceReport
  4. AdExtensionByAdReport
  5. AdExtensionByKeywordReport
  6. AdExtensionDetailReport
  7. AdGroupPerformanceReport
  8. AdGroups
  9. AdPerformanceReport
  10. Ads
  11. AgeGenderDemographicReport
  12. AudiencePerformanceReport
  13. Audiences
  14. BidOpportunities
  15. BudgetOpportunities
  16. Budgets
  17. BudgetSummaryReport
  18. CampaignPerformanceReport
  19. Campaigns
  20. ConversionPerformanceReport
  21. DestinationUrlPerformanceReport
  22. DSAAutoTargetPerformanceReport
  23. DSACategoryPerformanceReport
  24. DSASearchQueryPerformanceReport
  25. GeographicPerformanceReport
  26. GoalsAndFunnelsReport
  27. KeywordDemographics
  28. KeywordEstimatedBid
  29. KeywordEstimatedPosition
  30. KeywordHistoricalSearch
  31. KeywordLocations
  32. KeywordPerformance
  33. KeywordPerformanceReport
  34. Keywords
  35. NegativeKeywordConflictReport
  36. ProductDimensionPerformanceReport
  37. ProductPartitionPerformanceReport
  38. ProductPartitionUnitPerformanceReport
  39. ProductSearchQueryPerformanceReport
  40. PublisherUsagePerformanceReport
  41. SearchCampaignChangeHistoryReport
  42. SearchQueryPerformanceReport
  43. ShareOfVoiceReport
  44. Tags
  45. UserLocationPerformanceReport

AccountPerformanceReport

Use this report to observe long-term account performance and trends.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
LowQualityClicks Integer Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double The low-quality clicks as a percentage.
LowQualityImpressions Integer The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double The low-quality impressions as a percentage.
LowQualityConversions Integer The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double The low-quality conversion rate as a percentage.
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
ImpressionLostToBidPercent Double The percentage of time your ads would have been displayed to users, but were not because your bid was too low or your bid and quality score was below minimum thresholds, which prevented you from entering the auction. The value of this column is empty if the data is not available.
ImpressionLostToAdRelevancePercent Double The percentage of impression share lost due to low ad relevance. The value of this column is empty if the data is not available.
ImpressionLostToExpectedCtrPercent Double The percentage of impression share lost due to low expected click-through rate. If this is high, figure out what you can do to increase your CTR. The value of this column is empty if the data is not available.
PhoneImpressions Integer The number of times your tracked number was shown on all devices.
PhoneCalls Integer The number of total calls to the tracked phone number that showed with your ad.
ManualCalls Integer The number of calls dialed manually from any device to the tracked phone number.
ClickCalls Integer The number of phone calls initiated by clicks.
Ptr Double The phone-through rate (Ptr). The formula for calculating the Ptr is (PhoneCalls / PhoneImpressions) x 100.
AverageCpp Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Integer Clicks that are filtered by general methods, such as blacklists and activity-based detection, and that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualitySophisticatedClicks Integer Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Accounts

Query the available Accounts in Bing Ads.

 

Table Specific Information
Select
Searches on this table are processed client-side by the driver; the following query is processed server-side.
SELECT * FROM [ Accounts ]
The client-side execution of the query can be turned off by setting SupportEnhancedSQL to false in which case any query other than SELECT * will return an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The system generated identifier of the account.
Name String The name of the account.
Number String The account number.
AccountLifeCycleStatus String The status of the account.

The allowed values are Draft, Active, Inactive, Pause, Pending, Suspended.

PauseReason Integer A flag value that indicates who paused the account. The following are the possible values: 1-The user paused the account. 2-The billing service paused the account. 4-The user and billing service paused the account.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

AdDynamicTextPerformanceReport

Use this report to identify which dynamic text strings are performing well and which strings you should consider changing.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
Keyword String The keyword text.
AdId Long Ad Id
AdTitle String The ad title.
AdType String The ad type.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Param1 String The first dynamic substitution parameter (Param1) of a keyword or biddable ad group criterion.
Param2 String The second dynamic substitution parameter (Param2) of a keyword or biddable ad group criterion.
Param3 String The third dynamic substitution parameter (Param3) of a keyword or biddable ad group criterion.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
KeywordStatus String The keyword status.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
Path1 String The path 1 attribute of an ad.
Path6 String The path 2 attribute of an ad.
FinalURL String The Final URL of the ad, keyword, or criterion.
FinalMobileURL String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppURL String Reserved for future use.
AdDescription String The text attribute of an ad.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AdExtensionByAdReport

Use this report to compare how well different versions of your ad extensions are performing with each ad.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdTitle String The ad title.
AdExtensionType String The type name that corresponds to the AdExtensionTypeId column.
AdExtensionVersion String The version attribute of an ad extension.
AdExtensionId Long The identifier of the ad extension.
AdId Long Ad Id
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
ClickType String Click type refers to each component of an ad that a customer can click.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
TotalClicks Integer The number of billable and non-billable times that the ad extension was clicked.
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AdExtensionByKeywordReport

Use this report to compare how well different versions of your ad extensions are performing for each keyword.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdExtensionType String The Bing Ads assigned identifier of an ad extension.
AdExtensionId Long The version attribute of an ad extension.
AdExtensionVersion String The version attribute of an ad extension.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
ClickType String Click type refers to each component of an ad that a customer can click.
Keyword String The keyword text.
KeywordId String The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
TotalClicks Integer The number of billable and non-billable times that the ad extension was clicked.
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AdExtensionDetailReport

Use this report to discover the effectiveness of individual ad extension items, for example, each link of a sitelink extension.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdTitle String The ad title.
AdId String The Bing Ads assigned identifier of an ad.
AdExtensionType String The Bing Ads assigned identifier of an ad extension.
AdExtensionTypeId String The system identifier that corresponds to the AdExtensionType column. The supported identifiers are 10, 11, and 12.
AdExtensionId Long The version attribute of an ad extension.
AdExtensionVersion String The version attribute of an ad extension.
AdExtensionPropertyValue String The human readable ad extension property value. For this report only one property is available for each type of ad extension.
AdStatus String The ad status.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AdGroupPerformanceReport

Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
Status String The ad distribution attribute of an ad group.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
AccountStatus String The account status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current custom parameters set for the ad group.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
BusinessListingId Long Reserved for internal use.
BusinessListingName String Reserved for internal use.
BusinessCategoryId Long Reserved for internal use.
BusinessCategoryName String Reserved for internal use.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
QualityScore Integer The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ExpectedCtr Integer How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate. This metric tells you if a keyword is underperforming and causing a loss in impression share, so you can make keyword changes or remove ads altogether.
AdRelevance Integer How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience String An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
HistoricQualityScore Integer The historic quality score of the keyword. The historic quality score for each row is the value that was calculated for quality score on that date.
HistoricExpectedCtr Integer Historic average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period.
HistoricAdRelevance Integer Historic average of ad relevance scores back as far as 18 months from the current date.
HistoricLandingPageExperience Integer Historic average of landing page experience scores back as far as 18 months from the current date.
ImpressionLostToBidPercent Double The percentage of time your ads would have been displayed to users, but were not because your bid was too low or your bid and quality score was below minimum thresholds, which prevented you from entering the auction. The value of this column is empty if the data is not available.
ImpressionLostToAdRelevancePercent Double The percentage of impression share lost due to low ad relevance. The value of this column is empty if the data is not available.
ImpressionLostToExpectedCtrPercent Double The percentage of impression share lost due to low expected click-through rate. If this is high, figure out what you can do to increase your CTR. The value of this column is empty if the data is not available.
PhoneImpressions Integer The number of times your tracked number was shown on all devices.
PhoneCalls Integer The number of total calls to the tracked phone number that showed with your ad. The formula for calculating the phone calls is ManualCalls + ClickCalls.
ManualCalls Integer The number of calls dialed manually from any device to the tracked phone number.
ClickCalls Integer The number of phone calls initiated by clicks.
Ptr Double The phone-through rate (Ptr).
AverageCpp Double The average cost per phone call (CPP).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AdGroups

Query the available AdGroups in Bing Ads.

 

Table Specific Information
Select

 

You must specify the CampaignId column in the WHERE clause to query this table. The driver will use the Bing Ads API to filter the results by CampaignId while the rest of the filter is executed client side within the driver.

For example, the following query is processed server side:

SELECT * FROM [AdGroups] WHERE CampaignId = '234505536'
The client-side execution of the query can be turned off by setting SupportEnhancedSQL to false in which case any search criteria with columns in the WHERE clause other than CampaignId will cause an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The system generated identifier of the ad group.
CampaignId Long The system generated identifier of the campaign.
Name String The name of the ad group.
AdRotationType String Determines how often you'd like the ads in your ad group to show in relation to one another. If you have multiple ads within an ad group, your ads will rotate because no more than one ad from your account can show at a time.
AdDistribution String Determines whether the ads within this ad group will be displayed on the content distribution channel, search distribution channel, or both.
StartDate Date The date that the ads in the ad group can begin serving; otherwise, the service can begin serving the ads in the ad group the day that the ad group becomes active.
EndDate Date The date that the ads in the ad group will expire.
Language String The language of the ads and keywords in the ad group.
ContentMatchBidAmount Double The bid to use when the keywords that the service extracts from the content page and the ad group's keywords match by using an exact match comparison. An exact match results when all of the words in the keyword exactly match the user's query.
SearchBidAmount Double The default bid to use when the user's query and the ad group's keywords match by using either a broad, exact, or phrase match comparison.
BiddingSchemeType String The bid strategy type for how you want to manage your bids.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
NativeBidAdjustment String The percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid.
Network String The search networks where you want your ads to display.
PricingModel String The only supported pricing model in Bing Ads is based on cost per click (CPC).
RemarketingTargetingSetting String The targeting setting that is applicable for all audiences e.g., custom audiences and remarketing lists that are associated with this ad group. Each audience can be associated with multiple ad groups, and each ad group's remarketing targeting setting is applied independently for delivery.
Status String The status of the ad group.
TrackingUrlTemplate String The tracking template to use as a default for all URLs in your ad group.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

AdPerformanceReport

Use this report to help you determine which ads lead to clicks and conversions, and which are not performing. Having underperforming ads in your account can pull down the quality of your campaigns.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdId Long The Bing Ads Ad identifier
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdTitle String The ad title.
AdDescription String The text attribute of an ad.
AdType String The ad type.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
AccountStatus String The account status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template of the ad, keyword, or criterion.
CustomParameters String The current custom parameters set of the ad, keyword, or criterion.
FinalURL String The Final URL of the ad, keyword, or criterion.
FinalMobileURL String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppURL String Reserved for future use.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
TitlePart1 String The title part 1 attribute of an ad.
TitlePart2 String The title part 2 attribute of an ad.
Path1 String The path 1 attribute of an ad.
Path6 String The path 2 attribute of an ad.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
DisplayUrl String The ad display URL.
BusinessListingId String Reserved for internal use.
BusinessListingName String Reserved for internal use.
BusinessCategoryId String Reserved for internal use.
BusinessCategoryName String Reserved for internal use.
DeviceOS String The operating system of the device reported in the DeviceType column. The possible values include Android, Blackberry, iOS, Other, Unknown, and Windows.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion. If the destination URL contains dynamic text substitution parameters (for example, {param1}), the report will contain the URL after substitution occurs.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. The possible values are Broad, Exact, Phrase, and Unknown.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Ads

Query the available Ads in Bing Ads.

 

Table Specific Information
Select

 

You must specify the AdGroupId and Type columns in the WHERE clause to query this table. The driver will use the Bing Ads API to filter the results by AdGroup and Type while the rest of the filter is executed client side within the driver.

For example, the following query is processed server side:

SELECT * FROM [ Ads ] WHERE AdGroupId = '5179946006' AND Type = 'Text'

 

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than AdGroupId and Type will cause an error.

Columns

 

 

 

   
Name Type Description
Id [KEY] Long The unique Bing Ads identifier for the ad.
AdGroupId Long The system generated identifier of the ad group.
Type String The ad type. One of Text,Image,Product,AppInstall,ExpandedText,DynamicSearch
Title String The title of the ad. The title must contain at least one word. The ad's copy and title combined must total at least three words.
Text String The ad copy. The copy must contain at least one word. The ad's copy and title combined must total at least three words.
DisplayUrl String The URL to display in the ad.
DestinationUrl String The URL of the webpage to take the user to when they click the ad.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
TrackingUrlTemplate String The tracking template to use as a default for all landing page URLs.
Status String The status of the ad.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
FinalUrls String The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects.
FinalMobileUrls String The mobile landing page URL.
FinalAppUrls String Reserved for future use.
EditorialStatus String The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved.
DevicePreference Integer Determines the device preference for showing the ad.
AdFormatPreference String The Ad Format Preference is used to indicate whether or not you prefer the ad copy to be shown to users as a search or native ad. Search ads tend to be written as a call to action, whereas native ads should be written in more of an informational style.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

AgeGenderDemographicReport

Use this report to discover how your campaigns and ad groups are resonating with audiences of diverse age and gender.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
AdDistribution String The ad distribution attribute of an ad group.
AgeGroup String The age group of the audience who viewed the ad.
Gender String The gender of the audience who might have viewed the ad, if known.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
EstimatedImpressionPercent Double The estimated number of impressions, or the number of times an ad could be served to a particular age group or gender, divided by the total number of estimated impressions across the ad group (including estimated impressions for unknown age & gender demographics). The value is expressed as a percent from 0 - 100.
EstimatedClickPercent Double The estimated number of times that an ad could be clicked by a particular age group or gender, divided by the total number of estimated clicks across the ad group (including estimated clicks for unknown age & gender demographics). The value is expressed as a percent from 0 - 100.
EstimatedCtr Double The estimated click-through rate (Ctr) as a percentage.
EstimatedImpressions Integer The estimated number of times an ad could be served to a particular age group or gender.
EstimatedClicks Integer The estimated number of times that an ad could be clicked by a particular age group or gender.
EstimatedConversions Integer The estimated number of conversions, which are the clicks that results in a sale or another measure of success, to a particular age group or gender. Conversions are measured by adding a small bit of code to your website pages so that a visitor's progress through your site can be tracked.
EstimatedConversionRate Double The estimated number of the conversions that results in a sale or another measure of success to a particular age group or gender, divided by the estimated number of clicks by a particular age group or gender.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

AudiencePerformanceReport

Use this report to compare delivery performance statistics by audience, ad group, campaign, or account attributes.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AudienceId Long The Bing Ads assigned identifier of the audience, for example the remarketing list ID.
AudienceName String The audienc name.
AssociationStatus String The status of the association between the ad group and remarketing list, which indicates whether ads are eligible to display. The possible values are Active, Paused, and Deleted.
BidAdjustment String This attribute reflects the current value of your ad group's audience bid adjustment, even if a different bid adjustment value was used when the ad was shown. This value is the requested percentage to increase or decrease the bid amount for the remarketing list.
TargetingSetting String This attribute reflects the current value of your ad group's audience targeting setting. The possible values are Target and bid or Bid only.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Audiences

Query the available Audiences in Bing Ads.

 

Table Specific Information
Select
Searches on this table are processed client-side by the driver; the following query is executed server-side.
SELECT * FROM [ Audiences ]
The client-side execution of the query can be turned off by setting SupportEnhancedSQL to false in which case any search query will return an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The Bing Ads identifier of the audience.
ParentId Long The Bing Ads identifier of the account or customer.
Name String The name of the audience. The name can contain a maximum of 128 characters.
Type String The type of the audience.

The allowed values are RemarketingList, Custom, InMarket.

Description String The description of the audience. Use a description to help you remember what audience you are targeting.
MembershipDuration Integer When you create an audience, you can specify how far back in time Bing Ads should look for actions that match your audience definition.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
Scope String Scope defines what accounts can use this audience.

The allowed values are Account, Customer.

TagId Long The unique Bing Ads identifier of the tag.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

BidOpportunities

Query the available Bid Opportunities in Bing Ads.

 

Table Specific Information
Select

 

You must specify the OpportunityType column in the WHERE clause to query this table. You can specify the following values for OpportunityType: FirstPage, MainLine, and MainLine1.

The driver will use the Bing Ads API to filter the results by OpportunityType while the rest of the filter is executed client side within the driver. For example, the following query is processed server side.

SELECT * FROM [ BidOpportunities ] WHERE OpportunityType = 'FirstPage'

 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than OpportunityType will cause an error.

Columns

 

 

 

   
Name Type Description
OpportunityKey String An identifier that uniquely identifies the opportunity.
OpportunityType String Defines the possible bid opportunity types you can request when calling GetBidOpportunities. Avaiable values are: FirstPage,MainLine and MainLine1.

The default value is FirstPage.

AdGroupId Long The identifier of the ad group that owns the keyword.
CampaignId Long The identifier of the campaign for the ad group that owns the keyword.
CurrentBid Double The current keyword bid amount specified for the match type in the MatchType element.
EstimatedIncreaseInClicks Double The estimated clicks opportunities corresponding to the suggested bid.
EstimatedIncreaseInCost Double The estimated increase in spend corresponding to the suggested bid.
EstimatedIncreaseInImpressions Long The estimated impressions opportunities corresponding to the suggested bid.
KeywordId Long The identifier of the keyword to which the bid opportunity applies.
MatchType String The match type to which the suggested bid value applies. The possible values are BroadMatch, ExactMatch, and PhraseMatch.
SuggestedBid Double The suggested bid based on the last 7 days of performance history for the corresponding ad group.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

BudgetOpportunities

Query the available Budget Opportunities in Bing Ads.

 

Table Specific Information
Select

 

You must specify the CampaignId column in the WHERE clause to query this table. The driver will use the Bing Ads API to filter the results by CampaignId while the rest of the filter is executed client side within the driver.

For example, the following query is processed server side:

SELECT * FROM [ BudgetOpportunities ] WHERE CampaignId = '234505536'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria in the WHERE clause that refers to columns other than CampaignId will cause an error.
Columns

 

 

 

   
Name Type Description
OpportunityKey String An identifier that uniquely identifies the opportunity.
BudgetAmount Double A potential new budget.
BudgetPointType String The type of budget relative to a list of budget points. For example, if the budget point type is Current then this object's BudgetAmount element would be equal to the corresponding campaign's daily budget.
EstimatedWeeklyClicks Double The estimated weekly clicks for the given budget amount.
EstimatedWeeklyCost Double The estimated weekly cost for the given budget amount.
EstimatedWeeklyImpressions Double The estimated weekly impressions for the given budget amount.
BudgetType String The type of budget that the campaign uses.
CampaignId Long The identifier of the campaign to which the suggested budget applies
CurrentBudget Double The campaign's current budget.
IncreaseInClicks Double The estimated clicks opportunities corresponding to the suggested budget.
IncreaseInImpressions Double The estimated impressions opportunities corresponding to the suggested budget.
PercentageIncreaseInClicks Integer The estimated percentage increase in clicks corresponding to the suggested budget.
PercentageIncreaseInImpressions Integer The estimated percentage increase in impressions corresponding to the suggested budget.
RecommendedBudget Double The suggested budget based on the last 15 days of performance history for the corresponding campaign.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Budgets

Query the available Budgets in Bing Ads.

 

Table Specific Information
Select

 

Searches on this table are processed client-side by the driver; the following query is processed server-side:

SELECT * FROM [ Budgets ]
The client-side execution of the query can be turned off by setting SupportEnhancedSQL to false in which case any search query will return an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The unique Bing Ads identifier of the budget.
Name String The name of the budget. The name must be unique among all budgets within the account. The name can contain a maximum of 255 characters.
Amount Double The amount to spend daily across all campaigns that share the budget.
AssociationCount Integer The number of Campaign objects that currently share this budget.
BudgetType String The budget type determines the pace at which the budget is spent throughout the day.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

BudgetSummaryReport

Use this report to discover how your campaign's budget is performing for the month. For example, the report shows your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.

 

Columns

 

 

 

   
Name Type Description
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Date String The date for the downloaded report records. The date will be in the time zone of the campaign.
CurrencyCode String The account currency type.
MonthlyBudget String The average amount of campaign budget spent during a calendar month.
DailySpend String The average amount of campaign budget spent per day.
MonthToDateSpend String The amount of money spent to date for the month.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisMonth, LastMonth.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

CampaignPerformanceReport

Use this report to view high-level performance statistics and quality attributes for each campaign or account. This is also a quick way to flag any major campaign or account problems.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
Status String The ad distribution attribute of an ad group.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
AccountStatus String The account status.
BudgetName String The name of the budget.
BudgetStatus String The budget status. The possible values are Active and Deleted.
BudgetAssociationStatus String Indicates whether or not the campaign is currently spending from the budget mentioned in the BudgetName column. The possible values are Current and Ended.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
LowQualityClicks Integer Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double The low-quality clicks as a percentage.
LowQualityImpressions Integer The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double The low-quality impressions as a percentage.
LowQualityConversions Integer The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double The low-quality conversion rate as a percentage.
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
QualityScore Integer The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ExpectedCtr Integer How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate. This metric tells you if a keyword is underperforming and causing a loss in impression share, so you can make keyword changes or remove ads altogether.
AdRelevance Integer How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience Integer An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
HistoricQualityScore Integer The historic quality score of the keyword. The historic quality score for each row is the value that was calculated for quality score on that date.
HistoricExpectedCtr Integer Historic average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period.
HistoricAdRelevance Integer Historic average of ad relevance scores back as far as 18 months from the current date.
HistoricLandingPageExperience Integer Historic average of landing page experience scores back as far as 18 months from the current date.
ImpressionLostToBidPercent Double The percentage of time your ads would have been displayed to users, but were not because your bid was too low or your bid and quality score was below minimum thresholds, which prevented you from entering the auction. The value of this column is empty if the data is not available.
ImpressionLostToAdRelevancePercent Double The percentage of impression share lost due to low ad relevance. The value of this column is empty if the data is not available.
ImpressionLostToExpectedCtrPercent Double The percentage of impression share lost due to low expected click-through rate. If this is high, figure out what you can do to increase your CTR. The value of this column is empty if the data is not available.
PhoneImpressions Integer The number of times your tracked number was shown on all devices.
PhoneCalls Integer The number of total calls to the tracked phone number that showed with your ad. The formula for calculating the phone calls is ManualCalls + ClickCalls.
ManualCalls Integer The number of calls dialed manually from any device to the tracked phone number.
ClickCalls Integer The number of phone calls initiated by clicks.
Ptr Double The phone-through rate (Ptr).
AverageCpp Double The average cost per phone call (CPP).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Double Clicks that are filtered by general methods, such as blacklists and activity-based detection, and that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualitySophisticatedClicks Double Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks. For more information, see Bing Ads click measurement: description of methodology.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Campaigns

Query the available Campaigns in Bing Ads.

 

Table Specific Information
Select
Searches on this table are processed client-side by the driver; the following query is processed server-side:
SELECT * FROM [ Campaigns ]
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search query will return an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The unique Bing Ads identifier of the campaign.
AccountId String The unique Bing Ads identifier of the account associated with this campaign.
Name String The name of the campaign. The name must be unique among all active or paused campaigns within the account.
Status String The status of the campaign.

The allowed values are Active, Paused.

Description String The description of the campaign.
CampaignType String The campaign type determines whether the campaign is a Bing Shopping campaign, Dynamic Search Ads campaign, or Search & Content campaign.

The allowed values are SearchAndContent, Shopping, DynamicSearchAds.

BiddingSchemeType String The bid strategy type for how you want to manage your bids.

The allowed values are EnhancedCpc, InheritFromParent, ManualCpc, MaxClicks, MaxConversions, TargetCpa.

BudgetType String The budget type determines how the budget is spent.

The allowed values are DailyBudgetAccelerated, DailyBudgetStandard.

DailyBudget Double The amount to spend daily on the campaign. You must set the daily budget amount if BudgetId is not set.
TimeZone String The time zone where the campaign operates.
TrackingUrlTemplate String The tracking template to use as a default for all URLs in your campaign.
BudgetId Long The unique Bing Ads identifier of the Budget that this campaign shares with other campaigns in the account.
Languages String The languages of the ads and keywords in the campaign.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

ConversionPerformanceReport

Use this report to understand which campaigns and keywords are leading an audience to complete a purchase or other conversion action.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
KeywordStatus String The keyword status.
KeywordId Long The Bing Ads assigned identifier of a keyword.
Keyword String The keyword text.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
Spend Double The cost per click (CPC) summed for each click.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

DestinationUrlPerformanceReport

Use this report to identify landing pages that met audience expectations and potentially resulted in high click-through or conversion rates.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long Ad Id
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
FinalURL String The Final URL of the ad, keyword, or criterion.
FinalMobileURL String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppURL String Reserved for future use.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

DSAAutoTargetPerformanceReport

Use this report to find out which DSA auto targets are performing well and those that are not.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign.
DynamicAdTarget String The dynamic ad target or webpage condition that Bing matched to your website. For example the condition could be returned in the report as URL contains xyz.
DynamicAdTargetStatus String The current status of the dynamic ad target.
DynamicAdTargetId Long The Bing Ads assigned identifier of the dynamic ad target, also known in Campaign Management and Bulk API as the ad group criterion ID.
AdGroupId Long The Bing Ads assigned identifier of an account.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
AdGroupStatus String The ad group status.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
TrackingTemplate String The current tracking template of the ad.
CustomParameters String The current custom parameters of the ad.
WebsiteCoverage String A score from 0.0 to 1.0 that indicates the percentage of pages in the requested language that belong to a particular domain out of all the pages that Bing has indexed for the same language your website's domain.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

DSACategoryPerformanceReport

Use this report to find out which DSA categories are performing well and those that are not.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdId Long The Bing Ads assigned identifier of an ad.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
Category0 String The top level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
Category1 String The mid level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
Category2 String The low level category that Bing matched to your website. For example if the category is US/CA/SFO, the Category0 value will be US.
CampaignName String The campaign name.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion.
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

DSASearchQueryPerformanceReport

Use this report to find out which search terms are in demand for your DSA campaign and the performance of dynamic headlines that are being displayed.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdId Long The Bing Ads assigned identifier of an ad.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String The operating system of the device reported in the DeviceType column.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignStatus String The campaign status.
AdGroupName String The ad group name.
Language String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignName String The campaign name.
AdGroupStatus String The ad group status.
AdStatus String The ad status.
SearchQuery String The search term used by your potential audience.
Headline String The Dynamic Search Ad headline that was dynamically generated by Bing Ads.
CategoryList String The list of categories that Bing matched to your website. Up to three category levels can be returned per category list item.
LandingPageTitle String The title of your webpage where the search user landed.
FinalUrl String The URL address of the page on your website that people reach when they click your ad from a desktop or laptop.
DynamicAdTarget String The dynamic ad target or webpage condition that Bing matched to your website. For example the condition could be returned in the report as URL contains xyz.
DynamicAdTargetId String The Bing Ads assigned identifier of the dynamic ad target, also known in Campaign Management and Bulk API as the ad group criterion ID.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion.
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

GeographicPerformanceReport

Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies either the physical location of the search user or the geographical location interest based on the user's search query.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Country String The country where the user was physically located when they clicked the ad.
State String The state where the user was physically located when they clicked the ad.
MetroArea String The metro area where the user was physically located when they clicked the ad.
City String The city where the user was physically located when they clicked the ad.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
ProximityTargetLocation String The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
LocationType String The location type used to deliver ads. For example to distinguish between people in versus searching for or viewing pages about the corresponding location of interest.
MostSpecificLocation String The most specific location used to deliver ads. For example if the city and country are both identified, this column will include the same value as the City column. If postal code information is available, then it will be included in the report instead of city or country.
County String The county where the user was physically located when they clicked the ad.
DeviceOS String The operating system of the device reported in the DeviceType column.
LocationId Long The Bing Ads identifier of the location where the user was physically located when they clicked the ad. For geographical location identifiers, see Geographical Location Codes.
PostalCode String The postal code where the user was physically located when they clicked the ad.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

GoalsAndFunnelsReport

Use this report to discover whether your audience completes each step through the land, browse, prospect, and conversion pages of your website. For example, you can use this report to determine the step that users leave the conversion funnel, so that you can improve or remove that step to increase the chance that the user will continue to the next step.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
Keyword String The keyword text.
KeywordStatus String The keyword status.
KeywordId String The Bing Ads assigned identifier of a keyword.
DeviceOS String The operating system of the device reported in the DeviceType column.
Goal String The name of your event tracking or campaign analytics goal.
GoalId String The Bing Ads assigned identifier of a goal.
GoalType String The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

KeywordDemographics

Query the available Keyword Demographics in Bing Ads.

 

Table Specific Information
Select

 

You must specify the Keywords, Language, and PublisherCountry columns in the WHERE clause to query this table. You can search on multiple keywords by setting the Keywords column value to a comma-separated list in the WHERE clause.

The driver will use the Bing Ads API to filter the results by Keywords, Language, and PublisherCountry while the rest of the filter is executed client side within the driver. For example, the following query is processed server side.

SELECT * FROM [ KeywordDemographics ] WHERE Keywords = 'Gmail Excel,PowerShell Excel' AND Language = 'English' AND PublisherCountry = 'US'

 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords, Language, and PublisherCountry will cause an error.

Columns

 

 

 

   
Name Type Description
Keywords String List of Keywords. Use to filter the table.
Keyword String The keyword.
Device String The device of the user who entered the search query.
Age18to24 Double The percentage of time that users 18 through 24 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
Age25to34 Double The percentage of time that users 25 through 34 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
Age35to49 Double The percentage of time that users 35 through 49 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
Age50to64 Double The percentage of time that users 50 through 64 years of age searched for the keyword. The value is specified in the range 0.0 through 1.0.
Age65Plus Double The percentage of time that users 65 years of age or older searched for the keyword. The value is specified in the range 0.0 through 1.0.
AgeUnknown Double Not used.
Female Double The percentage of time that female users searched for the keyword. The value is specified in the range 0.0 through 1.0.
Male Double The percentage of time that male users searched for the keyword. The value is specified in the range 0.0 through 1.0.
GenderUnknown Double Not Used.
Language String The language in which the keywords are written.
PublisherCountry String The country code of the country/region to use as the source of the demographics data. The country/region that you specify must support the language specified in the Language element.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordEstimatedBid

Query the available Keyword Estimated Bid in Bing Ads.

 

Table Specific Information
Select
You must set the KeywordText and MatchType columns in the WHERE clause to query this table. Set the MatchType column to one of the following values in the WHERE clause: Exact, Phrase, Broad, Content, or Aggregate.

 

The driver will use the Bing Ads API to filter the results by KeywordText and MatchType while the rest of the filter is executed client side within the driver.

For example, the following query is processed server side.

SELECT * FROM [ KeywordEstimatedBid ] WHERE KeywordText = 'SAP R/3 Developers' AND MatchType = 'Exact'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than KeywordText and MatchType will cause an error.
Columns

 

 

 

   
Name Type Description
KeywordText String The keyword text.
MatchType String The keyword match type used to determine the estimates.
MinClicksPerWeek Double The estimated minimum number of clicks per week.
MaxClicksPerWeek Double The estimated maximum number of clicks per week.
AverageCPC Double The estimated average CPC.
MinImpressionsPerWeek Long The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long The estimated maximum number of impressions per week.
ClickThroughRate Double The estimated CTR.
MinTotalCostPerWeek Double The estimated minimum cost per week.
MaxTotalCostPerWeek Double The estimated maximum cost per week.
Currency String The monetary unit of the cost values, such as AverageCPC.
EstimatedMinBid Double The position in the search results given the specified bid.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordEstimatedPosition

Query the available EstimatedPosition in Bing Ads.

 

Table Specific Information
Select

 

You must specify the Keywords and MatchType columns in the WHERE clause to query this table. Set MatchType to one of the following values: Exact, Phrase, Broad, Content and Aggregate. You can search on multiple keywords by setting the Keywords column value to a comma-separated list in the WHERE clause.

The driver will use the Bing Ads API to filter the results by KeywordText and MatchType while the rest of the filter is executed client side within the driver. For example, the following query is processed server side.

SELECT * FROM [ KeywordEstimatedPosition ] WHERE Keywords = 'SAP development,PowerShell Excel' AND MatchType = 'Exact'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords and MatchType will cause an error.
Columns

 

 

 

   
Name Type Description
Keywords String List of Keywords. Use to filter the table.
Keyword String The keyword.
MatchType String The keyword match type used to determine the estimates.
MinClicksPerWeek Double The estimated minimum number of clicks per week.
MaxClicksPerWeek Double The estimated maximum number of clicks per week.
AverageCPC Double The estimated average CPC.
MinImpressionsPerWeek Long The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long The estimated maximum number of impressions per week.
ClickThroughRate Double The estimated CTR.
MinTotalCostPerWeek Double The estimated minimum cost per week.
MaxTotalCostPerWeek Double The estimated maximum cost per week.
Currency String The monetary unit of the cost values, such as AverageCPC.
EstimatedAdPosition Double The position in the search results given the specified bid.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordHistoricalSearch

Query the available Keyword Historical Search in Bing Ads.

 

Table Specific Information
Select

 

You must specify the Keywords, Language, StartDate, and EndDate columns to query this table. You can search on multiple keywords by setting the Keywords column value to a comma-separated list in the WHERE clause.

The driver will use the Bing Ads API to filter the results by Keywords, Language, StartDate, and EndDate while the rest of the filter is executed client side within the driver. For example, the following query is processed server side:

SELECT * FROM [ KeywordHistoricalSearch ] WHERE Keywords = 'SAP development' AND Language = 'English' AND StartDate = '2014-01-01' AND EndDate = '2017-01-01'

 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords, Language, StartDate, and EndDate will cause an error.

Columns

 

 

 

   
Name Type Description
Keywords String List of Keywords. Use to filter the table.
Keyword String The keyword.
SearchCount Long The number of times that the keyword was used in a search query on the specified device type during the time period. The count aggregates data from all specified countries.
Language String The language in which the keywords are written.
SearchDate Date The time period in which the count was captured.
StartDate Date The start date of the date range that identifies the data that you want to use to determine the historical search count.
EndDate Date The end date of the date range that identifies the data that you want to use to determine the historical search count.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordLocations

Query the available Keyword Locations in Bing Ads.

 

Table Specific Information
Select
You must specify the Keywords and Language columns in the WHERE clause to query this table. You can search on multiple keywords by setting the Keywords column value to a comma-separated list.

 

The driver will use the Bing Ads API to filter the results by Keywords and Language while the rest of the filter is executed client side within the driver. For example, the following query is processed server side.

SELECT * FROM [ KeywordLocations ] WHERE Keywords = 'SAP development,PowerShell Excel' AND Language = 'English'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords and Language will cause an error.
Columns

 

 

 

   
Name Type Description
Keywords String List of Keywords. Use to filter the table.
Keyword String The keyword.
Device String The device of the user who entered the search query.
Location String The country, state, metropolitan area, or city where users entered the search query.
Percentage Double The percentage of time that users searched for the keyword from the location. The value is specified in the range 0.0 through 100.0
Language String The language in which the keywords are written.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordPerformance

Query the available Keyword Performance in Bing Ads.

 

Table Specific Information
Select
You must specify the Keywords, MatchType, Language, and PublisherCountry columns in the WHERE clause to query this table. Set the MatchType column to one of the following in the WHERE clause: Exact, Phrase, Broad, Content, or Aggregate.

 

The driver will use the Bing Ads API to filter the results by Keywords, MatchType, Language, and PublisherCountry while the rest of the filter is executed client side within the driver. For example, the preceding query is processed on the server.

SELECT * FROM [ KeywordPerformance ] WHERE Keywords = 'SAP development,PowerShell Excel' AND Language = 'English' AND PublisherCountry = 'US' AND MatchType = 'Exact'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords, Language, PublisherCountry, and MatchType will cause an error.
Columns

 

 

 

   
Name Type Description
Keywords String List of Keywords. Use to filter the table.
Keyword String The keyword.
Device String The device of the user who entered the search query.
MatchType String The match type that you specified in the request.
AdPosition String The position in the search results in which the ad appeared.
Clicks Integer The number of clicks that the keyword and match type generated during the specified time interval.
Impressions Long The number of impressions that the keyword and match type generated during the specified time interval.
AverageCPC Double The average cost per click (CPC). The average CPC is calculated by dividing the cost of all clicks by the number of clicks.
ClickThroughRate Double The click-through rate (CTR) as a percentage. The CTR is calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100.
TotalCost Double The cost of using the specified keyword and match type during the specified time interval.
AverageBid Double The average bid of the keyword.
Language String The language in which the keywords are written.
PublisherCountry String The country code of the country/region to use as the source of the demographics data. The country/region that you specify must support the language specified in the Language element.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

KeywordPerformanceReport

Use this report to find out which keywords are performing well and those that are not.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
Keyword String The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
AdId Long Ad Id
AdType String The ad type.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
FinalURL String The Final URL of the ad, keyword, or criterion.
FinalMobileURL String The Final Mobile URL of the ad, keyword, or criterion.
FinalAppURL String Reserved for future use.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
TrackingTemplate String The current tracking template for the ad group.
CustomParameters String The current set of custom parameters for the campaign.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
BusinessListingId String Reserved for internal use.
BusinessListingName String Reserved for internal use.
BusinessCategoryId String Reserved for internal use.
BusinessCategoryName String Reserved for internal use.
KeywordStatus String The keyword status.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc, ManualCpc, MaxClicks, MaxConversions, and TargetCpa. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g., one of the supported values listed above.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
QualityScore Integer The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms. If available, the quality score can range from a low of 1 to a high of 10.
ExpectedCtr Integer How well your keyword competes against other keywords targeting the same traffic. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
AdRelevance Integer How closely related your ads is to the search query or other input. It tells you how relevant your ad and landing page are to potential customers. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
LandingPageExperience Integer An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website. A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.
HistoricExpectedCtr Double Historic average of expected click-through rate scores going back as far as 18 months from the current date. This score may vary from the score in the ExpectedCtr column, which is the current score and same value for each day in the time period. You may include this column only with Daily aggregation.
HistoricQualityScore Integer The historic quality score of the keyword. The historic quality score for each row is the value that was calculated for quality score on that date.
HistoricAdRelevance Double Historic average of ad relevance scores back as far as 18 months from the current date.
HistoricLandingPageExperience Double Historic average of landing page experience scores back as far as 18 months from the current date.
QualityImpact Double The numeric score that indicates the possible increase in the number of impressions that the keyword could receive if the corresponding QualityScore column would rise above underperforming: 0 (not available), 1 (low impact), 2 (medium impact), or 3 (high impact).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Keywords

Query the available Keywords in Bing Ads.

 

Table Specific Information
Select
You must specify the AdGroupId column in the WHERE clause to query this table. The driver will use the Bing Ads API to filter the results by AdGroupId while the rest of the filter is executed client side within the driver.

 

For example, the following query is processed on the server.

SELECT * FROM [ Keywords ] WHERE AdGroupId = '5179946000'

 

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than AdGroupId in the WHERE clause will cause an error.

Columns

 

 

 

   
Name Type Description
Id [KEY] Long The system-generated identifier of the keyword.
AdGroupId Long The system generated identifier of the ad group.
Text String The keyword text. The text can contain a maximum of 100 characters. You should specify the keyword in the locale of the Language value that you specified for the ad group to which the keyword belongs.
Status String The keyword's status. By default, the status is set to Active.
BidAmount Double The bid to use when the user's search term and the keyword match.
DestinationUrl String The URL of the webpage to take the user to when they click the ad. The keyword's destination URL is used if specified; otherwise, the ad's destination URL is used.
BiddingSchemeType String The bid strategy type for how you want to manage your bids.
MatchType String The type of match to compare the keyword and the user's search term.
TrackingUrlTemplate String The tracking template to use as a default for all FinalUrls and FinalMobileUrls.
UrlCustomParameters String Your custom collection of key and value parameters for URL tracking.
ForwardCompatibilityMap String The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.
FinalUrls String The landing page URL. The keyword's final URL is used if specified; otherwise, the ad's final URL is used.
FinalMobileUrls String The mobile landing page URL. The keyword's final mobile URL is used if specified; otherwise, the ad's final mobile URL is used.
FinalAppUrls String Reserved for future use.
EditorialStatus String The editorial review status of the keyword, which indicates whether the keyword is pending review, has been approved, or has been disapproved.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

NegativeKeywordConflictReport

Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.

 

Columns

 

 

 

   
Name Type Description
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountStatus String The account status.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdGroupName String The ad group name.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
CampaignName String The campaign name.
CampaignStatus String The campaign status.
Keyword String The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
NegativeKeyword String The negative keyword text.
ConflictLevel String The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
NegativeKeywordListId Long The Bing Ads assigned identifier of a negative keyword list.
NegativeKeywordList String The name of the negative keyword list.
NegativeKeywordId Long The Bing Ads assigned identifier of a negative keyword.
NegativeKeywordMatchType String The type of match to compare the negative keyword and the user's search term. The possible values for a negative keyword are Exact and Phrase.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

ProductDimensionPerformanceReport

Use this report to find out which product dimensions are performing well and those that are not.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AdGroupName String The ad group name.
AdGroupId String The Bing Ads assigned identifier of an ad group.
AdId String The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
MerchantProductId String The report will include a column that contains the unique identifier provided by a merchant for each product offer.
Title String The product item name. For example the title of a book, DVD, or game.
Condition String The condition of a product item.
Brand String The product item's manufacturer, brand, or publisher.
CustomLabel0 String The value of the Custom_label_0 field in your Bing Merchant Center catalog.
CustomLabel1 String The value of the Custom_label_1 field in your Bing Merchant Center catalog.
CustomLabel2 String The value of the Custom_label_2 field in your Bing Merchant Center catalog.
CustomLabel3 String The value of the Custom_label_3 field in your Bing Merchant Center catalog.
CustomLabel4 String The value of the Custom_label_4 field in your Bing Merchant Center catalog.
ProductType1 String The first level value of the Product_type field in your Bing Merchant Center catalog.
ProductType2 String The second level value of the Product_type field in your Bing Merchant Center catalog.
ProductType3 String The third level value of the Product_type field in your Bing Merchant Center catalog.
ProductType4 String The fourth level value of the Product_type field in your Bing Merchant Center catalog.
ProductType5 String The fifth level value of the Product_type field in your Bing Merchant Center catalog.
ProductCategory1 String The first level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory2 String The second level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory3 String The third level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory4 String The fourth level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory5 String The fifth level value of the Product_category field in your Bing Merchant Center catalog.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId String The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
Price String The different price for products in your catalog.
SellerName String The report will include a column that contains the merchant or store name that offers the product.
OfferLanguage String The report will include a column that contains the language for the product offer.
CountryOfSale String The report will include a column that contains the country of sale for the product catalog.
AdStatus String The ad status.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String The ad distribution attribute of an ad group.
ClickTypeId Long The click type ID.
StoreId Long The unique identifier for the Bing Merchant Center store.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
ClickType String Click type refers to each component of an ad that a customer can click.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The cost per click (CPC) summed for each click.
ConversionRate Double The cost per click (CPC) summed for each click.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
BenchmarkBid Double Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double Shows you how other product ads for similar products are performing on average based on how often people who see the ad end up clicking on it.
TotalClicksOnAdElements Integer The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

ProductPartitionPerformanceReport

You can include details in the report such as impressions, clicks, and spend that you can use to identify whether or not the product partitions are performing well.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
OfferLanguage String The report will include a column that contains the language for the product offer.
CountryOfSale String The report will include a column that contains the country of sale for the product catalog.
AdStatus String The ad status.
PartitionType String The product partition type.
ProductGroup String The forward slash ('/') delimited list of product conditions, reported as Operand = Attribute.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
TrackingTemplate String The current tracking template of the criterion.
CustomParameters String The current custom parameter set of the criterion.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String The ad distribution attribute of an ad group.
ClickType String Click type refers to each component of an ad that a customer can click.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
ClickTypeId Long The click type ID.
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The cost per click (CPC) summed for each click.
ConversionRate Double The cost per click (CPC) summed for each click.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
BenchmarkBid Double Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double Shows you how other product ads for similar products are performing on average based on how often people who see the ad end up clicking on it.
TotalClicksOnAdElements Integer The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double The revenue per assist.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

ProductPartitionUnitPerformanceReport

Use this report to find out which product partition units are performing well and those that are not.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
CurrencyCode String The account currency type.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
AccountStatus String The account status.
CampaignStatus String The campaign status.
AdGroupStatus String The ad group status.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
AdStatus String The ad status.
ProductGroup String The forward slash ('/') delimited list of product conditions, reported as Operand = Attribute.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
TrackingTemplate String The current tracking template of the criterion.
CustomParameters String The current custom parameter set of the criterion.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above.
LocalStoreCode String An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The cost per click (CPC) summed for each click.
ConversionRate Double The cost per click (CPC) summed for each click.
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double The revenue per assist.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

ProductSearchQueryPerformanceReport

Use this report to get insight into what your audience is searching for when your ads are shown as well as ensure that your product titles are relevant to search queries.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String The Bing Ads assigned number of an account.
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long The Bing Ads assigned identifier of an ad.
AccountId Long The Bing Ads assigned identifier of an ad.
CampaignName String The campaign name.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
Language String The ad group language.
CampaignId Long The Bing Ads assigned identifier of a campaign.
Network String The current network setting of an ad group.
PartitionType String The product partition type.
ProductGroup String The forward slash ('/') delimited list of product conditions, reported as Operand = Attribute.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
ClickType String Click type refers to each component of an ad that a customer can click.
ClickTypeId Long The click type ID.
MerchantProductId Long The click type ID.
SearchQuery String The click type ID.
Title String The click type ID.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
Conversions Integer The cost per click (CPC) summed for each click.
ConversionRate Double The cost per click (CPC) summed for each click.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
TotalClicksOnAdElements Integer The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double The revenue per assist.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

PublisherUsagePerformanceReport

Use this report to see if any website URLs aren't performing well enough for your campaign or ad group target settings. For example, if ad impressions at those URLs yield a low click-through rate, then you might decide to exclude those websites from your campaign.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
PublisherUrl String The URL of the website that displayed the ad.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

SearchCampaignChangeHistoryReport

Use this report to discover when changes to an account were made, as well as which user made the changes.

 

Columns

 

 

 

   
Name Type Description
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
DateTime String The campaign name.
AdTitle String The ad title.
AdDescription String The campaign name.
DisplayUrl String The campaign name.
Keyword String The campaign name.
ItemChanged String The campaign name.
AttributeChanged String The campaign name.
ChangedBy String The username of the user that made the change to settings within the account. If the system made the change, the value will be Administrator.
HowChanged String The campaign name.
OldValue String The campaign name.
NewValue String The campaign name.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are LastSevenDays, LastMonth, LastThreeMonths.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

SearchQueryPerformanceReport

Use this report to see what your audience is searching for when your ads are shown. You can use this information to make informed additions, removals, or edits to both your keyword and negative keyword lists.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdId Long Ad Id
AdType String The ad type.
DestinationUrl String The destination URL attribute of the ad, keyword, or ad group criterion.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
AdGroupCriterionId Long The Bing Ads assigned identifier of an ad group criterion.
AdStatus String The ad status.
CampaignStatus String The campaign status.
CampaignType String The type of campaign. Possible values include Search & content, Shopping, and Dynamic search.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeviceOS String The operating system of the device reported in the DeviceType column.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
SearchQuery String The search term used by your potential audience.
Keyword String The keyword text.
KeywordId Long The Bing Ads assigned identifier of a keyword.
KeywordStatus String The keyword status.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

ShareOfVoiceReport

Use this report to view impression share (%) of successful bids for each keyword, and identify opportunities to increase impression share.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
HourOfDay String Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days
DayOfWeek String Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
CampaignName String The campaign name.
CampaignId Long The Bing Ads assigned identifier of a campaign..
AdGroupName String The ad group name.
AdGroupId Long The Bing Ads assigned identifier of an ad group.
AdDistribution String The ad distribution attribute of an ad group.
AccountStatus String The account status.
AdGroupStatus String The ad group status.
CampaignStatus String The campaign status.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Language String The ad group language.
Network String The current network setting of an ad group.
BidStrategyType String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match.
KeywordId String The Bing Ads assigned identifier of a keyword.
Keyword String The keyword text.
KeywordStatus String The keyword status.
AdRelevance String How closely related your ads is to the customer's search query or other input. It tells you how relevant your ad and landing page are to potential customers.
LandingPageExperience String An aggregate quality assessment of all landing pages on your site. The landing page experience score measures whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.
ExpectedCtr String How well your keyword competes against other keywords targeting the same traffic. Ads that are relevant to searchers' queries or other input are more likely to have a higher click-through rate.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ImpressionSharePercent Double The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available.
ImpressionLostToBudgetPercent Double The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available.
ImpressionLostToRankPercent Double The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available.
ImpressionLostToAdRelevancePercent Double The percentage of impression share lost due to low ad relevance. The value of this column is empty if the data is not available.
ImpressionLostToExpectedCtrPercent Double The percentage of impression share lost due to low expected click-through rate. If this is high, figure out what you can do to increase your CTR. The value of this column is empty if the data is not available.
ImpressionLostToRelevancePercent Double The percentage of impression share lost due to low ad relevance. The value of this column is empty if the data is not available.
ImpressionLostToBidPercent Double The percentage of time your ads would have been displayed to users, but were not because your bid was too low or your bid and quality score was below minimum thresholds, which prevented you from entering the auction. The value of this column is empty if the data is not available.
CurrentMaxCpc Double The maximum cost per click bid that was in effect at the time the report was generated. It is not a moving historical bid throughout the report time period.
QualityScore Integer The numeric score shows you how competitive your ads are in the marketplace by measuring how relevant your keywords and landing pages are to customers' search terms.
ClickSharePercent Double The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.

 

 

 

Tags

Query the available Tags in Bing Ads.

 

Table Specific Information
Select

 

Searches on this table are processed client-side by the driver; the following query is processed server-side.

SELECT * FROM [ Tags ]
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search will return an error.
Columns

 

 

 

   
Name Type Description
Id [KEY] Long The unique Bing Ads identifier of the UET tag.
Name String The UET tag name.
Description String Text to help you identify the UET tag. We recommend that you set this to the related website page name or URL.
TrackingNoScript String If your website doesn't support JavaScript, you can use this Non-JavaScript representation of the UET tag. If you use Non-JavaScript, you can't track custom events or variable revenue.
TrackingScript String The tracking script that you can add to your website to allow Bing Ads to collect actions people take on your website.
TrackingStatus String The system-determined status values of a UET tag, for example the system sets the status to Unverified if the UET tag has not yet been verified.

The allowed values are Unverified, Active, Inactive.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

UserLocationPerformanceReport

Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies the physical location of the user and the intended geographical location of the user's search query, for example a user in Seattle searching for services in Portland.

 

Columns

 

 

 

   
Name Type Description
Summary String The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily String Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. Each row of the report identifies the month, day, and year when the transaction occurred. The report will include a column named GregorianDate that contains the day formatted as yyyy-mm-dd.
Weekly String Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week. The report will include a column named WeekStartDate that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
Monthly String Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The report will include a column named MonthStartDate that contains the first day of the month formatted as yyyy-mm-dd.
Yearly String Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The report will include a column named Year that contains the year formatted as yyyy.
AccountName String The account name.
AccountNumber String The Bing Ads assigned number of an account.
AccountId Long The Bing Ads assigned identifier of an account.
AdGroupId Long The Bing Ads assigned identifier of an account.
CampaignId Long The Bing Ads assigned identifier of a campaign.
AdGroupName String The ad group name.
CampaignName String The campaign name.
Language String The ad group language.
Country String The country where the user was physically located when they clicked the ad.
State String The state where the user was physically located when they clicked the ad.
MetroArea String The metro area where the user was physically located when they clicked the ad.
City String The city where the user was physically located when they clicked the ad.
CurrencyCode String The account currency type.
AdDistribution String The ad distribution attribute of an ad group.
ProximityTargetLocation String The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
DeliveredMatchType String The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies.
Network String The current network setting of an ad group.
TopVsOther String The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String The device name attribute of a device OS target bid. The type of device which showed ads.
County String The county where the user was physically located when they clicked the ad.
DeviceOS String The operating system of the device reported in the DeviceType column.
LocationId Long The Bing Ads identifier of the location where the user was physically located when they clicked the ad. For geographical location identifiers, see Geographical Location Codes.
PostalCode String The postal code where the user was physically located when they clicked the ad.
QueryIntentCountry String The name of a country if the user's geographical intent can be determined. The country is set if the user's intent is related to a country, and not necessarily if they are physically located in the county.
QueryIntentState String The name of a state if the user's geographical intent can be determined. The state is set if the user's intent is a state or sub geography of the state, and not necessarily if they are physically located in the state.
QueryIntentCity String The name of a city if the user's geographical intent can be determined. The city is set if the user's intent is a city, and not necessarily if they are physically located in the city.
QueryIntentDMA String The postal code where the user was physically located when they clicked the ad.
QueryIntentCounty String The name of a county if the user's geographical intent can be determined. The county is set if the user's intent is related to a county, and not necessarily if they are physically located in the county.
QueryIntentPostalCode String The name of a postal code if the user's geographical intent can be determined. The postal code is set if the user's intent is a postal code, and not necessarily if they are physically located in the postal code.
QueryIntentLocationId String The location identifier if the user's geographical intent can be determined.
Impressions Integer The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Integer Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers).
Ctr Double The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%).
AverageCpc Double The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16.
Spend Double The cost per click (CPC) summed for each click.
AveragePosition Double The average position of the ad on a webpage.
Assists Integer The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Integer The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success
CostPerConversion Double The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ConversionRate Double The conversion rate as a percentage. The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).
Revenue Double The revenue optionally reported by the advertiser as a result of conversions. Corresponds to the optional revenue parameter of a Bing Ads campaign analytics tracking script.
ReturnOnAdSpend Double The return on ad spend (ROAS).
CostPerAssist Double The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
DatePreset String The time period to use for the report. You can specify a custom date range or select a predefined date range, for example, Today or ThisWeek.

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.

EndDate String The end date of the custom date range. The end date cannot be later than today's date.
StartDate String The start date of the custom date range. The start date must be earlier than or the same as the end date.