Matillion ETL Data Model for Bing Ads
|
string
""
DeveloperToken of the currently authenticated user.
To use the Bing Ads APIs, you must have a DeveloperToken in addition to the CustomerId and AccountId. You must have the Super Admin role in Bing Ads to create a developer token, though you do not need special permissions to use the token. BBD37VB98 may be used for sandbox accounts.
string
""
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.
bool
false
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'.
string
""
If it is not specified the driver will use the first AccountId it finds from querying the API.
You can find a value either by querying Accounts table or by going to the Bing Ads Web application, under Settings -> Accounts and Billing -> Your Account -> Account.
string
"common"
The Microsoft Online tenant being used to access data.
common | Allows users with both personal Microsoft accounts and work/school accounts from Azure AD to sign into the application. |
organizations | Allows only users with work/school accounts from Azure AD to sign into the application. |
consumers | Allows only users with personal Microsoft accounts (MSA) to sign into the application. |
8eaef023-2b34-4da1-9baa-8bc8c9d6a490 or contoso.onmicrosoft.com | Allows only users with work/school accounts from a particular Azure AD tenant to sign into the application. Either the friendly domain name of the Azure AD tenant or the tenant's GUID identifier can be used. You can find Tenant Id in Azure Portal > Azure Active Directory > Properties. |
string
"GLOBAL"
In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, GERMANY, USGOVT, and USGOVTDOD.
string
"OFF"
The following options are available:
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
string
""
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
string
"%APPDATA%\\CData\\BingAds Data Provider\\OAuthSettings.txt"
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.
Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
If left unspecified, the default location is "%APPDATA%\\CData\\BingAds Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
string
""
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
See Establishing a Connection to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
string
"NONE"
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the driver opens a connection to 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.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
bool
false
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
string
""
Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
Java logging is also supported. To enable Java logging, set Logfile to:
Logfile=JAVALOG://myloggername
As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.
The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.
When Java logging is enabled, the Verbosity will now correspond to specific logging levels.
string
"1"
The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
string
"%APPDATA%\\CData\\BingAds Data Provider\\Schema"
The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\BingAds Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
bool
false
When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
string
""
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.
Note that you must also add the CacheDriver JAR file 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.
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:
jdbc: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;
The following 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;
The following 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 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;
The following is a JDBC URL for the Oracle Thin Client:
jdbc:bingads:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;AccountId=442311;CustomerId=5521444;DeveloperToken=11112332233;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
The following JDBC URL uses the official PostgreSQL JDBC driver:
jdbc:bingads:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;AccountId=442311;CustomerId=5521444;DeveloperToken=11112332233;
string
""
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.
The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.
The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.
Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory
To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:
jdbc:sqlite:dataSource
The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:
The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:
string
"%APPDATA%\\CData\\BingAds Data Provider"
The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
If left unspecified, the default location is "%APPDATA%\\CData\\BingAds Data Provider" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
bool
false
As you execute queries with this property set, table metadata in the 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.
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.
int
0
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
int
0
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
bool
false
When set to true, a connection will be made to 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).
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
CachePartial=True | Caches only a subset of columns, which you can specify in your query. |
QueryPassthrough=True | Passes the specified query to the cache database instead of using the SQL parser of the driver. |
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
int
60
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
int
100
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
int
1
The minimum number of connections in the pool. The default is 1.
int
60
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
string
""
For example, the AccountPerformanceReport, CampaignPerformanceReport, AdGroupPerformanceReport, and other views with Report in the name are part of the Report Service.
You can specify the scope so that you include specific Accounts, Campaigns or AdGroups.
Here are a few examples:
By default this connection property will be empty. In that case the driver uses the first AccountId that it finds from querying the API.
You can specify up to 1000 Accounts, 300 Campaigns and 300 AdGroups.
string
""
The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
bool
true
When SupportEnhancedSQL = 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 = false, the driver limits SQL execution to what is supported by the Bing Ads API.
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.
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.
The driver retrieves all rows necessary to process the aggregation in memory.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
bool
false
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
Use this report to observe long-term account performance and trends.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | |
AbsoluteTopImpressionSharePercent | Double | True | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. | ||
Clicks | Integer | True | 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). | ||
ClickSharePercent | Double | True | The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
LowQualityClicks | Integer | True | Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks. | ||
LowQualityClicksPercent | Double | True | The low-quality clicks as a percentage. | ||
LowQualityImpressions | Integer | True | The number of impressions that result from low-quality keyword searches. | ||
LowQualityImpressionsPercent | Double | True | The low-quality impressions as a percentage. | ||
LowQualityConversions | Integer | True | The number of conversions that originate from low-quality clicks. | ||
LowQualityConversionRate | Double | True | The low-quality conversion rate as a percentage. | ||
ExactMatchImpressionSharePercent | Double | True | The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive. | ||
ImpressionSharePercent | Double | True | 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 | True | 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. | ||
ImpressionLostToRankAggPercent | Double | True | 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. | ||
PhoneImpressions | Integer | True | The number of times your tracked number was shown on all devices. | ||
PhoneCalls | Integer | True | The number of total calls to the tracked phone number that showed with your ad. | ||
Ptr | Double | True | The phone-through rate (Ptr). The formula for calculating the Ptr is (PhoneCalls / PhoneImpressions) x 100. | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). | ||
LowQualityGeneralClicks | Integer | True | 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 | True | Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks. | ||
AudienceImpressionLostToBudgetPercent | Double | True | The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network. | ||
AudienceImpressionLostToRankPercent | Double | True | The percentage of impression share you lost due to low rank on the Microsoft Audience Network. | ||
AudienceImpressionSharePercent | Double | True | The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network. |
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. |
Query the available Accounts in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | 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. |
Use this report to identify which dynamic text strings are performing well and which strings you should consider changing.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | True | The ad title. | ||
AdType | String | The ad type. | |||
AdLabels | String | The labels applied to the ad. | |||
DestinationUrl | String | True | 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 | True | The first dynamic substitution parameter (Param1) of a keyword or biddable ad group criterion. | ||
Param2 | String | True | The second dynamic substitution parameter (Param2) of a keyword or biddable ad group criterion. | ||
Param3 | String | True | 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. | |||
TitlePart3 | String | The title part 3 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. | |||
AdDescription2 | String | The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). |
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. |
Use this report to compare how well different versions of your ad extensions are performing with each ad.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | The Bing Ads assigned identifier of an ad group. | ||
AdTitle | String | True | The ad title. | ||
AdExtensionType | String | True | 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. | |||
TitlePart3 | String | The title part 3 attribute of an ad. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | The number of billable and non-billable times that the ad extension was clicked. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to compare how well different versions of your ad extensions are performing for each keyword.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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 | True | The keyword text. | ||
KeywordId | String | The Bing Ads assigned identifier of a keyword. | |||
KeywordStatus | String | The keyword status. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | The number of billable and non-billable times that the ad extension was clicked. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to discover the effectiveness of individual ad extension items, for example, each link of a sitelink extension.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | The Bing Ads assigned identifier of an ad extension. | ||
AdExtensionTypeId | String | True | The system identifier that corresponds to the AdExtensionType column. The supported identifiers are 10, 11, and 12. | ||
AdExtensionId | Long | True | The version attribute of an ad extension. | ||
AdExtensionVersion | String | The version attribute of an ad extension. | |||
AdExtensionPropertyValue | String | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | |
Clicks | Integer | True | True | 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 | True | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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.. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
AdGroupName | String | The ad group name. | |||
AdGroupLabels | String | The labels applied to the ad group. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
AbsoluteTopImpressionSharePercent | Double | True | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. | ||
Clicks | Integer | True | 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). | ||
ClickSharePercent | Double | True | The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
ExactMatchImpressionSharePercent | Double | True | The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive. | ||
ImpressionSharePercent | Double | True | 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 | True | 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. | ||
ImpressionLostToRankAggPercent | Double | True | 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 | True | 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 | True | 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 | True | 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 | True | 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. | ||
HistoricalQualityScore | Integer | True | 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. | ||
HistoricalExpectedCtr | Integer | True | Historical 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. | ||
HistoricalAdRelevance | Integer | True | Historical average of ad relevance scores back as far as 18 months from the current date. | ||
HistoricalLandingPageExperience | Integer | True | Historical average of landing page experience scores back as far as 18 months from the current date. | ||
PhoneImpressions | Integer | True | The number of times your tracked number was shown on all devices. | ||
PhoneCalls | Integer | True | 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. | ||
Ptr | Double | True | The phone-through rate (Ptr). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). | ||
AudienceImpressionLostToBudgetPercent | Double | True | The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network. | ||
AudienceImpressionLostToRankPercent | Double | True | The percentage of impression share you lost due to low rank on the Microsoft Audience Network. | ||
AudienceImpressionSharePercent | Double | True | The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network. |
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. |
Query the available AdGroups in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
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. | |||
CpcBidAmount | 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.. | |||
AudienceAdsBidAdjustment | String | The percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid. | |||
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. | |||
Network | String | The search networks where you want your ads to display. | |||
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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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.. | |||
AdLabels | String | The labels applied to the ad. | |||
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. | |||
AdDescription2 | String | The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad. | |||
AdType | String | The ad type. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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. | |||
Headline | String | The shorter of two possible responsive ad headlines for Audience campaigns. | |||
LongHeadline | String | The longer of two possible responsive ad headlines for Audience campaigns. | |||
TitlePart1 | String | The title part 1 attribute of an ad. | |||
TitlePart2 | String | The title part 2 attribute of an ad. | |||
TitlePart3 | String | The title part 3 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. | |||
BusinessName | String | Depending on your responsive ad's placement, your business's name may appear in your ad. This column only applies to Audience campaigns. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Query the available Ads in Bing Ads.
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' SELECT * FROM Ads WHERE AdGroupId='1297424037031698' AND Type='DynamicSearch' AND AccountId='135093022'
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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
TitlePart1 | String | The first title part of the ad. | |||
TitlePart2 | String | The second title part of the ad. | |||
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. | |||
Domain | 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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Use this report to discover how your campaigns and ad groups are resonating with audiences of diverse age and gender.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | True | The account name. | ||
AccountNumber | String | The Microsoft Advertising assigned number of an account. | |||
AccountId | Long | The Microsoft Advertising assigned identifier of an account. | |||
AdGroupId | Long | The Microsoft Advertising assigned identifier of an ad group. | |||
CampaignId | Long | The Microsoft Advertising assigned identifier of a campaign. | |||
AdGroupName | String | True | The ad group name. | ||
CampaignName | String | The campaign name. | |||
AdDistribution | String | The network where you want your ads to show. | |||
Gender | String | True | The gender (male or female) of the search users to whom the ad was delivered.. | ||
AgeGroup | String | True | The age group of the audience who viewed the ad. The possible values are 13-17, 18-24, 25-34, 35-49, 50-64, and 65+. | ||
Language | String | This is the language of the country the ad is served in. | |||
AccountStatus | String | The account status. | |||
CampaignStatus | String | The campaign status. | |||
AdGroupStatus | String | The ad group status. | |||
AllConversions | Double | The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. | |||
AllRevenue | Decimal | The revenue optionally reported by the advertiser as a result of conversions. | |||
Assists | Integer | The number of times an entity (an account, campaign, ad group, or keyword, for example) contributed to a conversion that is associated with a different entity. | |||
BaseCampaignId | Long | The Microsoft Advertising assigned identifier of an experiment campaign. This will be the same value as the CampaignId if the campaign is not an experiment. | |||
Impressions | Long | True | The number of times an ad has been displayed on search results pages or other sites on the Audience Network. | ||
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. | |||
Conversions | Integer | The number of conversions. A conversion is the completion of an action by a customer after viewing your ad. | |||
ExtendedCost | Decimal | Cost information that is optionally provided by advertisers, including non-advertising costs, taxes, and shipping. | |||
Revenue | Decimal | The revenue optionally reported by the advertiser as a result of conversions. | |||
Spend | Decimal | The sum of your cost-per-click (CPC) charges for your ads and keywords. Spend helps you keep track of your budget. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. |
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. |
Use this report to compare delivery performance statistics by audience, ad group, campaign, or account attributes.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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 | True | The Bing Ads assigned identifier of the audience, for example the remarketing list ID. | ||
AudienceName | String | The audienc name. | |||
AudienceType | String | The audience type. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). |
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. |
Query the available Audiences in Bing Ads.
SELECT * FROM [Audiences] SELECT * FROM Audiences WHERE AccountId='65098547' AND Type='RemarketingList'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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Id [KEY] | Long | The Bing Ads identifier of the audience. | |||
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. | |||
AudienceNetworkSize | Long | The total number of people who are active members of this audience in the Audience network. | |||
SearchSize | Long | The total number of people who are active members of this audience in the Search network. | |||
SupportedCampaignTypes | String | The list of campaign types that support this audience. | |||
CustomerShareAggregate | String | True | Contains information about CustomerAccountShares and OwnerCustomerId. | ||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Bid Opportunities in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
OpportunityKey | String | An identifier that uniquely identifies the opportunity. | |||
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. | |||
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. | |||
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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Budget Opportunities in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Budgets in Bing Ads.
Searches on this table are processed client-side by the driver; the following query is processed server-side:
SELECT * FROM [Budgets] SELECT * FROM Budgets WHERE CampaignId='431046229' AND AccountId='65098547'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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Id [KEY] | Long | The unique Bing Ads identifier of the budget. | |||
CampaignId | Long | The system generated identifier of the campaign. | |||
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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
AccountName | String | True | The account name. | ||
AccountNumber | String | True | The Bing Ads assigned number of an account. | ||
AccountId | Long | The Bing Ads assigned identifier of an account. | |||
CampaignName | String | True | The campaign name. | ||
CampaignId | Long | The Bing Ads assigned identifier of a campaign. | |||
Date | String | True | The date for the downloaded report records. The date will be in the time zone of the campaign. | ||
CurrencyCode | String | True | The account currency type. | ||
MonthlyBudget | String | The average amount of campaign budget spent during a calendar month. | |||
DailySpend | String | True | The average amount of campaign budget spent per day. | ||
MonthToDateSpend | String | The amount of money spent to date for the month. |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | The account name. | ||
AccountNumber | String | The Bing Ads assigned number of an account. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. | |||
AccountStatus | String | The account status. | |||
CampaignName | String | The campaign name. | |||
CampaignId | Long | The Bing Ads assigned identifier of a campaign. | |||
CampaignLabels | String | The labels applied to the campaign. | |||
CampaignStatus | String | The campaign status. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
AbsoluteTopImpressionSharePercent | Double | True | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. | ||
Clicks | Integer | True | 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). | ||
ClickSharePercent | Double | True | The percentage of clicks that went to your ads.It is the share of the prospective customer's mindshare and buying intent you captured. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
LowQualityClicks | Integer | True | Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks. | ||
LowQualityClicksPercent | Double | True | The low-quality clicks as a percentage. | ||
LowQualityImpressions | Integer | True | The number of impressions that result from low-quality keyword searches. | ||
LowQualityImpressionsPercent | Double | True | The low-quality impressions as a percentage. | ||
LowQualityConversions | Integer | True | The number of conversions that originate from low-quality clicks. | ||
LowQualityConversionRate | Double | True | The low-quality conversion rate as a percentage. | ||
ExactMatchImpressionSharePercent | Double | True | The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive. | ||
ImpressionSharePercent | Double | True | 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 | True | 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. | ||
ImpressionLostToRankAggPercent | Double | True | 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 | True | 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 | True | 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 | True | 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 | True | 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. | ||
HistoricalQualityScore | Integer | True | 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. | ||
HistoricalExpectedCtr | Integer | True | Historical 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. | ||
HistoricalAdRelevance | Integer | True | Historical average of ad relevance scores back as far as 18 months from the current date. | ||
HistoricalLandingPageExperience | Integer | True | Historical average of landing page experience scores back as far as 18 months from the current date. | ||
PhoneImpressions | Integer | True | The number of times your tracked number was shown on all devices. | ||
PhoneCalls | Integer | True | 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. | ||
Ptr | Double | True | The phone-through rate (Ptr). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). | ||
LowQualityGeneralClicks | Double | True | 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 | True | 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. | ||
AudienceImpressionLostToBudgetPercent | Double | True | The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network. | ||
AudienceImpressionLostToRankPercent | Double | True | The percentage of impression share you lost due to low rank on the Microsoft Audience Network. | ||
AudienceImpressionSharePercent | Double | True | The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network. | ||
TopImpressionSharePercent | Double | True | The percentage of impressions for your ad in the mainline, the top ad placements above the search results, out of the estimated number of mainline impressions you were eligible to receive. | ||
TopImpressionRatePercent | Double | True | The percentage of times your ad showed in the mainline, the top placement where ads appear above the search results, out of your total impressions. |
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. |
Query the available Campaigns in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
CampaignType | String | The campaign type determines whether the campaign is an Audience, Dynamic Search Ads, Search, Shopping or Search & Content campaign.
The allowed values are Search, Shopping, DynamicSearchAds, Audience. | |||
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. | |||
SubType | String | The campaign sub type. This element is only applicable for campaigns of type Shopping, and will be nil for all other campaign types. | |||
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. | |||
ExperimentId | Long | The system generated identifier of the Experiment. | |||
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. | |||
UrlCustomParameters | String | Your custom collection of key and value parameters for URL tracking. | |||
BudgetId | Long | The unique Bing Ads identifier of the Budget that this campaign shares with other campaigns in the account. | |||
AudienceAdsBidAdjustment | Integer | The percent amount by which to adjust your bid for audience ads above or below the base ad group or keyword bid. | |||
Languages | String | The languages of the ads and keywords in the campaign. |
Use this report to understand which campaigns and keywords are leading an audience to complete a purchase or other conversion action.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to identify landing pages that met audience expectations and potentially resulted in high click-through or conversion rates.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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 | True | 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 | True | The destination URL attribute of the ad, keyword, or ad group criterion. | ||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to find out which DSA auto targets are performing well and those that are not.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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. | |||
CampaignStatus | String | The campaign status. | |||
DynamicAdTarget | String | True | 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. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to find out which DSA categories are performing well and those that are not.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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. | |||
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 | True | 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 | True | 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 | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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 | True | 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. | |||
FeedUrl | String | The feed URL will appear either as | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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 ad group. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | True | 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 | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
AllConversions | Integer | True | 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 | ||
AllRevenue | Double | True | 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 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. |
Query the available Keyword Demographics in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Keywords | String | List of Keywords. Use to filter the table. | |||
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. | |||
Device | String | The device of the user who entered the search query. Default value is 'Computers'.
The allowed values are Computers, NonSmartphones, Smartphones, Tablets. | |||
Keyword | String | The keyword. | |||
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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Keyword Estimated Bid in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
KeywordText | String | The keyword text. | |||
MatchType | String | The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate. | |||
CurrencyCode | String | The monetary unit of the cost values, such as AverageCPC. | |||
CampaignId | Long | The system generated identifier of the campaign. | |||
AdGroupId | Long | The system generated identifier of the ad group. | |||
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. | |||
EstimatedMinBid | Double | The position in the search results given the specified bid. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available EstimatedPosition in Bing Ads.
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' SELECT * FROM KeywordEstimatedPosition WHERE Keywords='ssh transfer' AND MatchType='Exact' AND AccountId='135093022' AND MaxBid=50You 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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Keywords | String | List of Keywords. Use to filter the table. | |||
MaxBid | Long | The maximum bid value to use to determine the estimated position in the search results. | |||
MatchType | String | The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate. | |||
CurrencyCode | String | The monetary unit of the cost values, such as AverageCPC. | |||
CampaignId | Long | The system generated identifier of the campaign. | |||
AdGroupId | Long | The system generated identifier of the ad group. | |||
Keyword | String | The keyword. | |||
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. | |||
EstimatedAdPosition | Double | The position in the search results given the specified bid. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Keyword Historical Search in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Keywords | String | List of Keywords. Use to filter the table. | |||
Language | String | The language in which the keywords are written. | |||
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. | |||
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. | |||
SearchDate | Date | The time period in which the count was captured. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Keyword Locations in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Keywords | String | List of Keywords. Use to filter the table. | |||
Language | String | The language in which the keywords are written. | |||
Device | String | The device of the user who entered the search query. | |||
Keyword | String | The keyword. | |||
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 | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Query the available Keyword Performance in Bing Ads.
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Keywords | String | List of Keywords. Use to filter the table. | |||
AdPosition | String | The position in the search results in which the ad appeared. | |||
MatchType | String | The match type that you specified in the request. | |||
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. | |||
Device | String | The device of the user who entered the search query. Default value is 'Computers'.
The allowed values are Computers, NonSmartphones, Smartphones, Tablets. | |||
Keyword | String | The keyword. | |||
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. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
Use this report to find out which keywords are performing well and those that are not.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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. | |||
KeywordLabels | String | The labels applied to the 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. | |||
FirstPageBid | Decimal | Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates for your ad to be placed on the first page in the search results. | |||
Mainline1Bid | Decimal | Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates will place your ad at the top of search results. | |||
MainlineBid | Decimal | Based on your campaign performance and marketplace dynamics, this estimate is the bid amount that Bing Ads calculates for your ad to be placed on the first page in the search results. | |||
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. | |||
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. | |||
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. | |||
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. | |||
KeywordStatus | String | The keyword status. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). | ||
QualityScore | Integer | True | 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 | True | 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 | True | 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 | True | 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. | ||
QualityImpact | Double | True | 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 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. |
Query the available Keywords in Bing Ads.
For example, the following query is processed on the server.
SELECT * FROM [Keywords] WHERE AdGroupId = '5179946000' SELECT * FROM Keywords WHERE AdGroupId='1311717627185807' AND AccountId='135096904'
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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
Param1 | String | The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param1} dynamic substitution string | |||
Param2 | String | The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param2} dynamic substitution string | |||
Param3 | String | The string to use as the substitution value in an ad if the ad's title, text, display URL, or destination URL contains the {Param3} dynamic substitution string | |||
AccountId | Long | The Bing Ads assigned identifier of an account. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
AccountName | String | True | 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 | True | The keyword text. | ||
KeywordId | Long | The Bing Ads assigned identifier of a keyword. | |||
KeywordStatus | String | The keyword status. | |||
NegativeKeyword | String | True | The negative keyword text. | ||
ConflictLevel | String | The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign. | |||
ConflictType | String | The type of negative keyword conflict encountered.The possible values are Possibly intentional conflict and True conflict. | |||
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 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. |
Use this report to find out which product dimensions are performing well and those that are not.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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. | |||
AssistedClicks | String | Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for. | |||
AssistedImpressions | String | The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network. | |||
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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
AbsoluteTopImpressionSharePercent | Double | True | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. | ||
Clicks | Integer | True | 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). | ||
ClickSharePercent | Double | True | The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | The cost per click (CPC) summed for each click. | ||
ConversionRate | Double | True | The cost per click (CPC) summed for each click. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
ImpressionSharePercent | Double | True | 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 | True | 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 | True | 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 | True | Shows you how much other advertisers are bidding on average on similar products as your current target. | ||
BenchmarkCtr | Double | True | 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 | True | The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on. |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
AccountName | String | True | The account name. | ||
AccountNumber | String | The Bing Ads assigned number of an account. | |||
AccountId | Long | The Bing Ads assigned identifier of an account. | |||
AccountStatus | String | The account status. | |||
CampaignName | String | The campaign name. | |||
CampaignId | Long | The Bing Ads assigned identifier of a campaign. | |||
CampaignStatus | String | The campaign status. | |||
AdGroupName | String | The ad group name. | |||
AdGroupId | Long | The Bing Ads assigned identifier of an ad group. | |||
AdGroupStatus | String | The ad group status. | |||
ConflictLevel | String | The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign. | |||
NegativeKeywordListId | Long | The Bing Ads assigned identifier of a negative keyword list. | |||
NegativeKeyword | String | True | The negative keyword text. | ||
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. | |||
Title | 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. | |||
MerchantProductId | String | True | The report will include a column that contains the unique identifier provided by a merchant for each product offer. | ||
AdGroupCriterionId | Long | The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign. | |||
ProductGroup | String | True | The forward slash ('/') delimited list of product conditions, reported as Operand= |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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. | |||
AssistedClicks | String | Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for. | |||
AssistedImpressions | String | The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network. | |||
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 | True | The product partition type. | ||
ProductGroup | String | True | The forward slash ('/') delimited list of product conditions, reported as Operand= | ||
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). | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
AbsoluteTopImpressionSharePercent | Double | True | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. | ||
Clicks | Integer | True | 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). | ||
ClickSharePercent | Double | True | The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. | ||
Ctr | Double | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | The cost per click (CPC) summed for each click. | ||
ConversionRate | Double | True | The cost per click (CPC) summed for each click. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
ImpressionSharePercent | Double | True | 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 | True | 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 | True | 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 | True | Shows you how much other advertisers are bidding on average on similar products as your current target. | ||
BenchmarkCtr | Double | True | 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 | True | 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 | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerAssist | Double | True | The revenue per assist. |
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. |
Use this report to find out which product partition units are performing well and those that are not.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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. | |||
AssistedClicks | String | Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for. | |||
AssistedImpressions | String | The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network. | |||
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 | True | The forward slash ('/') delimited list of product conditions, reported as Operand= | ||
AdGroupCriterionId | Long | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | The cost per click (CPC) summed for each click. | ||
ConversionRate | Double | True | The cost per click (CPC) summed for each click. | ||
CostPerConversion | Double | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerAssist | Double | True | The revenue per assist. |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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. | |||
AssistedClicks | String | Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for. | |||
AssistedImpressions | String | The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Bing Network. | |||
CampaignName | String | True | The campaign name. | ||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer 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 | True | 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= | |||
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 | True | The click type ID. | ||
SearchQuery | String | True | The click type ID. | ||
Title | String | The click type ID. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
Conversions | Integer | True | The cost per click (CPC) summed for each click. | ||
ConversionRate | Double | True | The cost per click (CPC) summed for each click. | ||
Revenue | Double | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
TotalClicksOnAdElements | Integer | True | 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 | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerAssist | Double | True | The revenue per assist. |
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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Daily | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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 | True | 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 | True | The URL of the website that displayed the ad. | ||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to discover when changes to an account were made, as well as which user made the changes.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
EntityId | String | The Bing Ads system identifier of the entity that was updated. | |||
EntityName | String | The name of the entity that was updated. | |||
DateTime | String | True | 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 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. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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, Shopping, and Dynamic search. | |||
CustomerId | String | The Bing Ads assigned identifier of a customer. | |||
CustomerName | String | The customer name. | |||
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 | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Revenue | Double | True | 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 | True | The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |
Use this report to view impression share (%) of successful bids for each keyword, and identify opportunities to increase impression share.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | The Bing Ads assigned identifier of a keyword. | ||
Keyword | String | The keyword text. | |||
KeywordStatus | String | The keyword status. | |||
KeywordLabels | String | The labels applied to the keyword. | |||
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 | True | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | |
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Conversions | Integer | True | 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 | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
ExactMatchImpressionSharePercent | Double | True | The estimated percentage of impressions that your account received for searches that exactly matched your keyword, out of the total available exact match impressions you were eligible to receive. | ||
ImpressionSharePercent | Double | True | True | 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 | True | 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. | ||
ImpressionLostToRankAggPercent | Double | True | 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. | ||
CurrentMaxCpc | Double | True | 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 | True | 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 | True | 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 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. |
Query the available Tags in Bing Ads.
Searches on this table are processed client-side by the driver; the following query is processed server-side.
SELECT * FROM [Tags] SELECT * FROM Tags WHERE AccountId='135096904'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.
Name | Type | Select requirement | Metric | Aggregate | 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. | |||
CustomerShareAggregate | String | True | Contains information about CustomerAccountShares and OwnerCustomerId. | ||
AccountId | Long | The Bing Ads assigned identifier of an account. |
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.
Name | Type | Select requirement | Metric | Aggregate | Description |
Summary | String | True | The report data will be aggregated by the entire specified report time. The report will not include a time period column. | ||
Hourly | String | True | 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 | Date | True | 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 | Date | True | 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 | Date | True | 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 | Integer | True | 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 | Integer | True | 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 | Integer | True | 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 | True | 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. | |||
Goal | String | The goal name. | |||
GoalType | String | The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. | |||
Impressions | Integer | True | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. | ||
Clicks | Integer | True | 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 | True | 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 | True | 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 | True | The cost per click (CPC) summed for each click. | ||
AveragePosition | Double | True | The average position of the ad on a webpage. | ||
Assists | Integer | True | The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. | ||
Conversions | Integer | True | 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 | True | The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions). | ||
ConversionRate | Double | True | 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 | True | 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 | True | The return on ad spend (ROAS). | ||
CostPerAssist | Double | True | The cost per assist. The formula for calculating the cost per assist is (Spend / Assists). | ||
RevenuePerConversion | Double | True | The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions). | ||
RevenuePerAssist | Double | True | The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists). |
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. |