Microsoft Ads Connector for CData Sync

Build 24.0.9175
  • Microsoft Ads
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Views
        • AccountPerformanceReport
        • Accounts
        • AdAssets
        • AdDynamicTextPerformanceReport
        • AdExtensionAssets
        • AdExtensionByAdReport
        • AdExtensionByKeywordReport
        • AdExtensionDetailReport
        • AdExtensions
        • AdGroupPerformanceReport
        • AdGroups
        • AdPerformanceReport
        • Ads
        • AgeGenderAudienceReport
        • AssetGroupAssets
        • AssetGroups
        • AudiencePerformanceReport
        • Audiences
        • BidOpportunities
        • BudgetOpportunities
        • Budgets
        • BudgetSummaryReport
        • CampaignPerformanceReport
        • Campaigns
        • ConversionPerformanceReport
        • DataExclusions
        • DestinationUrlPerformanceReport
        • DSAAutoTargetPerformanceReport
        • DSACategoryPerformanceReport
        • DSASearchQueryPerformanceReport
        • GeographicPerformanceReport
        • GoalsAndFunnelsReport
        • KeywordEstimatedBid
        • KeywordEstimatedPosition
        • KeywordHistoricalSearch
        • KeywordPerformance
        • KeywordPerformanceReport
        • Keywords
        • NegativeKeywordConflictReport
        • ProductDimensionPerformanceReport
        • ProductNegativeKeywordConflictReport
        • ProductPartitionPerformanceReport
        • ProductPartitionUnitPerformanceReport
        • ProductSearchQueryPerformanceReport
        • PublisherUsagePerformanceReport
        • SearchCampaignChangeHistoryReport
        • SearchQueryPerformanceReport
        • SeasonalityAdjustments
        • ShareOfVoiceReport
        • Tags
        • UserLocationPerformanceReport
    • Connection String Options
      • Authentication
        • DeveloperToken
        • CustomerId
        • UseSandbox
      • Connection
        • AccountId
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PseudoColumns
        • ReportScopes
        • Timeout
        • UserDefinedViews

Microsoft Ads Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Microsoft Ads data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Microsoft Ads connector can be used from the CData Sync application to pull data from Microsoft Ads and move it to any of the supported destinations.

Microsoft Ads Version Support

The Sync App models reports and other entities in the Microsoft Ads API as relational views.

Microsoft Ads Connector for CData Sync

Establishing a Connection

Adding a Connection to Microsoft Ads

To add a connection to Microsoft Ads:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Microsoft Ads icon is not available, click the Add More icon to download and install the Microsoft Ads connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Microsoft Ads

You need to register a Microsoft Ads account, get a developer token, and authenticate using OAuth to connect to the Microsoft Ads APIs.

Register a Bing Ads Account

Complete the following steps to sign up for a Microsoft Ads account and obtain the CustomerId and (optional) AccountId:

  1. Sign up for a Microsoft Ads account in the Bing Ads Web application or at the Sandbox Site for a sandbox account.
  2. Select Settings > Accounts and Billing and select a single account. The AccountId and CustomerId (cid) are displayed on the account's page and in the page's URL.

Get a Developer Token

To use the Microsoft Ads APIs, you must have a DeveloperToken in addition to the CustomerId. You must have the Super Admin role in Microsoft Ads to create a developer token, though you do not need special permissions to use the token.

  1. Log in at the Bing Ads Developer Portal as a Microsoft Account user with the Microsoft Ads Super Admin role.
  2. Click Request Token and take note of your developer token. You will set it in the DeveloperToken connection property.

Authenticating to Microsoft Ads

OAuth

AuthScheme must be set to OAuth in all user account flows.

Microsoft Ads Connector for CData Sync

Advanced Features

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Microsoft Ads Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Microsoft Ads Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Microsoft Ads Connector for CData Sync

Data Model

The CData Sync App models entities in the Microsoft Ads API as database views and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

The following sections provide information on executing SQL to the available API objects. The Sync App offloads as much of the SELECT statement processing as possible to Microsoft Ads and then processes the rest of the query in memory; API limitations and requirements are documented in this section.

Views

The Sync App Microsoft Ads objects as Views, including reports.

You can query Reports based on an aggregation and time period. The default time period is this year; to change the time period, see the following Time Filter section.

When retrieving only some report columns, you should select all columns marked as 'Select Requirement' and at least one of the columns marked as 'Metric' to issue a valid report request. On the other hand, if you are retrieving all columns, then the driver defaults to including the minimally required columns in the request.

Specifying a Time Filter

Date Ranges

You can specify date ranges in the WHERE clause using the "Date" field with these operators: =, <,>

These predefined date fields are supported:

  • Today
  • Yesterday
  • LastSevenDays
  • ThisWeek
  • LastWeek
  • LastFourWeeks
  • ThisMonth
  • LastMonth
  • LastThreeMonths
  • LastSixMonths
  • ThisYear
  • LastYear
The default DatePreset value is "ThisYear".

To search on a predefined date range, set the DatePreset pseudo column in the WHERE clause to one of the predefined date fields.

SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM [ AccountPerformanceReport ] WHERE DatePreset = 'LastYear'
To specify a custom date range, specify the StartDate and EndDate pseudo columns in the WHERE clause.
SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM [ AccountPerformanceReport ] WHERE StartDate = '2014-01-01' AND EndDate = '2017-09-19'
Aggregation

Aggregation is the process of reducing and summarizing data. You can aggregate the report data by selecting one of the following aggregation columns:

  • Daily: Each row of the report identifies the month, day, and year when the transaction occurred. The report data is aggregated by each day. The report includes a column named Daily that contains the day formatted as yyyy-mm-dd.
    SELECT Daily, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • DayOfWeek: Each row of the report identifies the day of the week when the transaction occurred. The report data is aggregated by each of the seven days in a week. The report includes a column named DayOfWeek, and the possible values are 1 - 7 where 1 represents Sunday and 7 represents Saturday.

    If the report time spans multiple weeks, then the performance data across all weeks for a given day of the week is aggregated in one row. For example, if Campaign A has 5 impressions every Monday (day 2) throughout each of the 3 weeks included in the report time range, then the report includes one row with DayOfWeek set to 2 and impressions in that row totaling 15.

    SELECT DayOfWeek, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

  • Hourly: Each row of the report identifies the hour when the transaction occurred. The report data is aggregated by each hour of the day. The report includes a column named Hourly, and the possible values are 0 - 23.
    SELECT Hourly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • HourOfDay: Each row of the report identifies the hour of the day when the transaction occurred. The report data is aggregated by each of the 24 hours across all days. The report includes a column named HourOfDay, and the possible values are 0 - 23.

    If the report time spans multiple days, then the performance data across all days for a given hour is aggregated in one row. For example, if Campaign A has 5 impressions during hour 7 on each of the 3 days included in the report time range, then the report includes one row with impressions for HourOfDay totaling 15.

    SELECT HourOfDay, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

  • Monthly: Each row of the report identifies the month when the transaction occurred. The report data is aggregated by each month. The report includes a column named Monthly that contains the first day of the month formatted as yyyy-mm-dd.
    SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • Weekly: Each row of the report identifies the week when the transaction occurred. The report data is aggregated by each week. The report includes a column named Weekly that contains the date of the Sunday for each week formatted as yyyy-mm-dd.
    SELECT Weekly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport
  • Yearly: Each row of the report identifies the year when the transaction occurred. The report data is aggregated by each year. The report includes a column named Yearly that contains the year formatted as yyyy.
    SELECT Yearly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate FROM AccountPerformanceReport

Stored Procedures

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

Microsoft Ads Connector for CData Sync

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft Ads Connector for CData Sync Views

Name Description
AccountPerformanceReport Use this report to observe long-term account performance and trends.
Accounts Query the available Accounts in Bing Ads.
AdAssets Query the available Assets linked to Ads in Bing Ads.
AdDynamicTextPerformanceReport Use this report to identify which dynamic text strings are performing well and which strings you should consider changing.
AdExtensionAssets Query the available Assets linked to Ad Extensions in Bing Ads.
AdExtensionByAdReport Use this report to compare how well different versions of your ad extensions are performing with each ad.
AdExtensionByKeywordReport Use this report to compare how well different versions of your ad extensions are performing for each keyword.
AdExtensionDetailReport Use this report to discover the effectiveness of individual ad extension items, for example, each link of a sitelink extension.
AdExtensions Query the available Ad Extensions in Bing Ads.
AdGroupPerformanceReport Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.
AdGroups Query the available AdGroups in Bing Ads.
AdPerformanceReport Use this report to help you determine which ads lead to clicks and conversions, and which are not performing. Having underperforming ads in your account can pull down the quality of your campaigns.
Ads Query the available Ads in Bing Ads.
AgeGenderAudienceReport Use this report to discover how your campaigns and ad groups are resonating with audiences of diverse age and gender.
AssetGroupAssets Query the available Assets linked to Asset Groups in Bing Ads.
AssetGroups Query the available Asset Groups in Bing Ads.
AudiencePerformanceReport Use this report to compare delivery performance statistics by audience, ad group, campaign, or account attributes.
Audiences Query the available Audiences in Bing Ads.
BidOpportunities Query the available Bid Opportunities in Bing Ads.
BudgetOpportunities Query the available Budget Opportunities in Bing Ads.
Budgets Query the available Budgets in Bing Ads.
BudgetSummaryReport Use this report to discover how your campaign's budget is performing for the month. For example, the report shows your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.
CampaignPerformanceReport Use this report to view high-level performance statistics and quality attributes for each campaign or account. This is also a quick way to flag any major campaign or account problems.
Campaigns Query the available Campaigns in Bing Ads.
ConversionPerformanceReport Use this report to understand which campaigns and keywords are leading an audience to complete a purchase or other conversion action.
DataExclusions Query the available Data Exclusions in Bing Ads.
DestinationUrlPerformanceReport Use this report to identify landing pages that met audience expectations and potentially resulted in high click-through or conversion rates.
DSAAutoTargetPerformanceReport Use this report to find out which DSA auto targets are performing well and those that are not.
DSACategoryPerformanceReport Use this report to find out which DSA categories are performing well and those that are not.
DSASearchQueryPerformanceReport Use this report to find out which search terms are in demand for your DSA campaign and the performance of dynamic headlines that are being displayed.
GeographicPerformanceReport Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies either the physical location of the search user or the geographical location interest based on the user's search query.
GoalsAndFunnelsReport Use this report to discover whether your audience completes each step through the land, browse, prospect, and conversion pages of your website. For example, you can use this report to determine the step that users leave the conversion funnel, so that you can improve or remove that step to increase the chance that the user will continue to the next step.
KeywordEstimatedBid Query the available Keyword Estimated Bid in Bing Ads.
KeywordEstimatedPosition Query the available EstimatedPosition in Bing Ads.
KeywordHistoricalSearch Query the available Keyword Historical Search in Bing Ads.
KeywordPerformance Query the available Keyword Performance in Bing Ads.
KeywordPerformanceReport Use this report to find out which keywords are performing well and those that are not.
Keywords Query the available Keywords in Bing Ads.
NegativeKeywordConflictReport Use this report to discover which keywords and negative keywords are in conflict, and whether the conflict is at the campaign or ad group level. Use this list to figure out which negative keywords to delete.
ProductDimensionPerformanceReport Use this report to find out which product dimensions are performing well and those that are not.
ProductNegativeKeywordConflictReport 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.
ProductPartitionPerformanceReport You can include details in the report such as impressions, clicks, and spend that you can use to identify whether or not the product partitions are performing well.
ProductPartitionUnitPerformanceReport Use this report to find out which product partition units are performing well and those that are not.
ProductSearchQueryPerformanceReport Use this report to get insight into what your audience is searching for when your ads are shown as well as ensure that your product titles are relevant to search queries.
PublisherUsagePerformanceReport Use this report to see if any website URLs aren't performing well enough for your campaign or ad group target settings. For example, if ad impressions at those URLs yield a low click-through rate, then you might decide to exclude those websites from your campaign.
SearchCampaignChangeHistoryReport Use this report to discover when changes to an account were made, as well as which user made the changes.
SearchQueryPerformanceReport Use this report to see what your audience is searching for when your ads are shown. You can use this information to make informed additions, removals, or edits to both your keyword and negative keyword lists.
SeasonalityAdjustments Query the available Seasonality Adjustments in Bing Ads.
ShareOfVoiceReport Use this report to view impression share (%) of successful bids for each keyword, and identify opportunities to increase impression share.
Tags Query the available Tags in Bing Ads.
UserLocationPerformanceReport Use this report to see which locations your traffic is coming from. You can then validate whether your location targeting strategy is successful, and identify opportunities to improve. The report also identifies the physical location of the user and the intended geographical location of the user's search query, for example a user in Seattle searching for services in Portland.

Microsoft Ads Connector for CData Sync

AccountPerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int True The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double True The low-quality impressions as a percentage.
LowQualityConversions Int 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 Int True The number of times your tracked number was shown on all devices.
PhoneCalls Int 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 Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Accounts

Query the available Accounts in Bing Ads.

Table Specific Information

Select

Searches on this table are processed client-side by the Sync App. The following query is processed server-side:
SELECT * FROM Accounts
The client-side execution of the query can be turned off by setting SupportEnhancedSQL to false in which case any query other than SELECT * will return an error.

Columns

Name Type 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 Int 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.

Microsoft Ads Connector for CData Sync

AdAssets

Query the available Assets linked to Ads in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdAssets
SELECT * FROM AdAssets WHERE AdGroupId = '2562405'
SELECT * FROM AdAssets WHERE AdGroupId IN ('1562405', '2562405', '3562405')
SELECT * FROM AdAssets WHERE AdType = 'ResponsiveAd'
SELECT * FROM AdAssets WHERE AdType IN ('ResponsiveAd', 'ResponsiveSearch')
SELECT * FROM AdAssets WHERE AccountId = '2562405'
SELECT * FROM AdAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AdGroupId Long The system generated identifier of the ad group.
AdId Long The unique Bing Ads identifier for the ad.
AdType String The ad type.

The allowed values are ResponsiveAd, ResponsiveSearch.

Id Long The ID of the asset.
AssetPerformanceLabel String This lets you know how well the asset is performing.
EditorialStatus String The editorial review status of the asset link, which indicates whether the asset is pending review, has been approved, or has been disapproved.
PinnedField String Determines whether the asset should only be used for a specific ad component, or whether you want Bing AI to optimize the layout for this asset.
Name String The asset name.
Type String The type of the asset.
Text String Text for the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
TargetHeight Int The target height dimension of an image asset.
TargetWidth Int The target width dimension of an image asset.
ThumbnailImageSubType String Represents the aspect ratio for this image asset.
ThumbnailImageCropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
ThumbnailImageCropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
ThumbnailImageCropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
ThumbnailImageCropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
ThumbnailImageTargetHeight Int The target height dimension of an image asset.
ThumbnailImageTargetWidth Int The target width dimension of an image asset.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

AdDynamicTextPerformanceReport

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

Columns

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 Int 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.
Path2 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

AdExtensionAssets

Query the available Assets linked to Ad Extensions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdExtensionAssets
SELECT * FROM AdExtensionAssets WHERE AdExtensionId = '2562405'
SELECT * FROM AdExtensionAssets WHERE AdExtensionId IN ('1562405', '2562405', '3562405')
SELECT * FROM AdExtensionAssets WHERE AdExtensionType = 'ImageAdExtension'
SELECT * FROM AdExtensionAssets WHERE AccountId = '2562405'
SELECT * FROM AdExtensionAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AdExtensionId Long The ID of the ad extension.
AdExtensionType String The type of ad extension.

The allowed values are ImageAdExtension.

Id Long The ID for the asset.
Name String The asset name.
Type String The type of the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

AdExtensionByAdReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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 Int 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-Columns

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

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

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

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

Microsoft Ads Connector for CData Sync

AdExtensionByKeywordReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

AdExtensionDetailReport

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

Columns

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 Int 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 Int 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 Int 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 Int True True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

AdExtensions

Query the available Ad Extensions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AdExtensions
SELECT * FROM AdExtensions WHERE Id = '2562405'
SELECT * FROM AdExtensions WHERE Id IN ('1562405', '2562405', '3562405')
SELECT * FROM AdExtensions WHERE Type = 'ActionAdExtension'
SELECT * FROM AdExtensions WHERE Type IN ('ActionAdExtension', 'AppAdExtension')
SELECT * FROM AdExtensions WHERE AccountId = '2562405'
SELECT * FROM AdExtensions WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The ID of the ad extension.
Type String The type of ad extension.

The allowed values are ActionAdExtension, AppAdExtension, CallAdExtension, CalloutAdExtension, DisclaimerAdExtension, FilterLinkAdExtension, FlyerAdExtension, ImageAdExtension, LocationAdExtension, LogoAdExtension, PriceAdExtension, PromotionAdExtension, ReviewAdExtension, SitelinkAdExtension, StructuredSnippetAdExtension, VideoAdExtension.

Version Int Tracks the number of times the ad extension has been updated.
DevicePreference Long This element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices.
SchedulingStartDate Date The scheduled start date.
SchedulingEndDate Date The scheduled end date.
SchedulingUseSearcherTimeZone Bool Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered.
SchedulingDayTimeRanges String The list of day and time ranges.
Language String The language for the ad extension.
ActionType String The action text.
FinalUrls String The landing page URL.
FinalUrlSuffix String The suffix added to the landing page URL.
FinalMobileUrls String The mobile landing page URL.
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.
AppPlatform String The application platform.
AppStoreId String The application identifier provided by the app store.
DestinationUrl String The URL of the webpage to take the user to when they click.
DisplayText String The text displayed in the ad extension.
CountryCode String The country code where the phone number is registered.
IsCallOnly Bool The option to show both your phone number and website, or just your phone number, to people seeing your ads on a smartphone.
IsCallTrackingEnabled Bool Determines whether call tracking is enabled for the call ad extension.
PhoneNumber String The phone number to include in the ad.
RequireTollFreeTrackingNumber Bool You can either use your own phone number or use a Bing Ads forwarding phone number.
Text String Text value relevant to the extension.
AdExtensionHeaderType String The header that is appended with a colon and precedes the filter link values in the ad that is shown.
Texts String The text values that follow after the AdExtensionHeaderType component of the ad that is shown.
Description String Description that can be used by the advertiser, agency, or account manager to track, label, or manage extensions.
FlyerName String The flyer name.
ImageMediaIds String The identifier of the image to include in the ad.
Images String Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements.
ImageMediaUrls String The URL of the media that you already added.
StoreId Long The unique identifier of a Microsoft Merchant Center store used for product ads.
AlternativeText String Alternative description of the image media for usability. If the image could not be displayed, the alternative text is used instead.
Layouts String The list of eligible image layouts.
SourceType String The source type.
AddressCityName String The name of the city where the street address is located.
AddressCountryCode String The country where the street address is located.
AddressPostalCode String The postal or zip code.
AddressProvinceCode String A code that identifies the state or province where the street address is located.
AddressProvinceName String The name of the state or province where the street address is located.
AddressStreetAddress String The first line of the address.
AddressStreetAddress2 String The second line of the address.
CompanyName String The name of the business.
GeoCodeStatus String A status value that indicates whether the business latitude and longitude coordinates have been determined.
GeoPointLatitudeInMicroDegrees Int The latitude specified in micro degrees
GeoPointLongitudeInMicroDegrees Int The longitude specified in micro degrees
BusinessLogo Long The asset ID for the business logo.
BusinessLogoUrl String The URL of the business logo.
BusinessName String The business name.
DomainName String The domain name.
PriceExtensionType String The type of the price ad extension.
TableRows String The price table rows.
CurrencyCode String The currency code for the promotion price or discount.
DiscountModifier String The promotion discount modifier.
MoneyAmountOff Double The money off promotion value.
OrdersOverAmount Double The orders over amount value appended to the promotion target.
PercentOff Double The percent off promotion value.
PromotionCode String The promotion code appended to the promotion target.
PromotionItem String The promotion target or item.
PromotionOccasion String The promotion occasion.
PromotionStartDate Date The start date helps to inform the promotion date or dates that will be displayed in the ad.
PromotionEndDate Date The end date helps to inform the promotion date or dates that will be displayed in the ad.
IsExact Bool Determines whether the review text is an exact quote or paraphrased.
Source String The review source name.
Url String The review source Url.
Description1 String The site link description line 1.
Description2 String The site link description line 2.
Header String The header that is appended with a colon and precedes the snippet values.
Values String The snippet values that follow after the Header component of the ad that is shown.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

AdGroupPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int True Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int True Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int True The number of times your tracked number was shown on all devices.
PhoneCalls Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

AdGroups

Query the available AdGroups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

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

Columns

Name Type 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.

Microsoft Ads Connector for CData Sync

AdPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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.
Path2 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Ads

Query the available Ads in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Ads
SELECT * FROM Ads WHERE AdGroupId = '5179946006'
SELECT * FROM Ads WHERE Type = 'Text'
SELECT * FROM Ads WHERE Type IN ('ExpandedText','Text')
SELECT * FROM Ads WHERE AdGroupId = '5179946006' AND Type = 'Text'
SELECT * FROM Ads WHERE AdGroupId IN ('5179946006',''5179946007'') AND Type = 'Text'
SELECT * FROM Ads WHERE AdGroupId IN ('5179946006',''5179946007'') AND Type IN ('ExpandedText','Text')
SELECT * FROM Ads WHERE AdGroupId = '1297424037031698' AND Type = 'DynamicSearch' AND AccountId = '135093022'
SELECT * FROM Ads WHERE AccountId IN ('2562405', '141163457', '180394748')

Columns

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.

The allowed values are Text, Image, Product, AppInstall, ExpandedText, DynamicSearch, ResponsiveAd, ResponsiveSearch, Hotel.

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

Microsoft Ads Connector for CData Sync

AgeGenderAudienceReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

AssetGroupAssets

Query the available Assets linked to Asset Groups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AssetGroupAssets
SELECT * FROM AssetGroupAssets WHERE CampaignId = '2562405'
SELECT * FROM AssetGroupAssets WHERE CampaignId IN ('1562405', '2562405', '3562405')
SELECT * FROM AssetGroupAssets WHERE AccountId = '2562405'
SELECT * FROM AssetGroupAssets WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
AssetGroupId Long The asset group ID.
Id Long The ID for the asset.
AssetPerformanceLabel String This lets you know how well the asset is performing.
EditorialStatus String The editorial review status of the asset link, which indicates whether the asset is pending review, has been approved, or has been disapproved.
PinnedField String Determines whether the asset should only be used for a specific ad component, or whether you want Bing AI to optimize the layout for this asset.
Name String The asset name.
Type String The type of the asset.
Text String Text for the asset.
SubType String Represents the aspect ratio for the asset.
CropHeight Int The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int Starting from the lower left corner of image asset source, this is the number of pixels to skip to the right on the x-axis before applying the CropWidth.
CropY Int Starting from the lower left corner of image asset source, this is the number of pixels to skip upwards on the y-axis before applying the CropHeight.
CampaignId Long The system generated identifier of the campaign.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

AssetGroups

Query the available Asset Groups in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM AssetGroups
SELECT * FROM AssetGroups WHERE CampaignId = '2562405'
SELECT * FROM AssetGroups WHERE CampaignId IN ('1562405', '2562405', '3562405')
SELECT * FROM AssetGroups WHERE AccountId = '2562405'
SELECT * FROM AssetGroups WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The asset group ID.
Name String The name of the asset group.
BusinessName String The name of the business.
Status String The status of the Asset group.
EditorialStatus String The editorial review status of the asset group, which indicates whether the asset group is pending review, has been approved, or has been disapproved.
CallToAction String A brief, punchy reason for customers to click your ad right now.
FinalUrls String The landing page URL.
FinalMobileUrls String The mobile landing page URL.
Path1 String The first part of the optional path that will be appended to the domain portion of your display URL.
Path2 String The second part of the optional path that will be appended to the domain portion of your display URL.
StartDate Date The date that the asset group can begin serving; otherwise, the service can begin serving ads the day that the asset group becomes active.
EndDate Date The date that the asset group will expire.
Descriptions String The descriptions that are shown below the path in your ad.
Headlines String Short headlines that appear in your ad.
LongHeadlines String Long headlines that appear in your ad.
Images String Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements.
AssetGroupSearchThemes String A list of asset group search themes.
CampaignId Long The system generated identifier of the campaign.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

AudiencePerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Audiences

Query the available Audiences in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Audiences
SELECT * FROM Audiences WHERE Type = 'RemarketingList'
SELECT * FROM Audiences WHERE AccountId = '65098547' AND Type = 'RemarketingList'

Columns

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

The allowed values are RemarketingList, Custom, InMarket, Product, SimilarRemarketingList, CombinedList, CustomerList.

Description String The description of the audience. Use a description to help you remember what audience you are targeting.
MembershipDuration Int 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 Contains information about CustomerAccountShares and OwnerCustomerId.
CombinationRules String Logical conditions used to determine who to add to your combined list.
AdGroupId Long The ad group identifier to associate with the impression-based remarketing list.
CampaignId Long The campaign identifier to associate with the impression-based remarketing list.
EntityType String The entity type of an impression-based remarketing list.
ProductAudienceType String Determines whether to remarket your products to general visitors, product searchers, product viewers, shopping cart abandoners, or past buyers.
RuleType String The type of the remarketing rule.
RuleNormalForm String Determines whether the rule item groups are evaluated based on conjunctive normal form (CNF) or disjunctive normal form (DNF).
RuleItemGroups String The list of rule item groups that you want applied to the remarketing list.
RuleAnotherRuleItemGroups String The list of rule item groups related to other pages the audience visited.
RuleExcludeRuleItemGroups String The list of rule item groups that you want applied as exclusions to the remarketing list.
RuleIncludeRuleItemGroups String The list of rule item groups that you want applied to the remarketing list.
RuleActionOperator String The operator that can be applied to the value of the Action element.
RuleAction String The type of user interaction you want to track. For example 'play' or 'pause'.
RuleCategoryOperator String The operator that can be applied to the value of the Category element.
RuleCategory String The category of event you want to track. For example, 'video'.
RuleLabelOperator String The operator that can be applied to the value of the Label element.
RuleLabel String The name of the element that caused the action. For example 'trailer' or 'behindthescenes'.
RuleValueOperator String The operator that can be applied to the value of the Value element.
RuleValue Int A positive integer value associated with that event. For example the value could be the duration of time that the video played.
SourceId Long The ID of the remarketing list that Bing Ads used to generate this similar audience.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

BidOpportunities

Query the available Bid Opportunities in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

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

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

Columns

Name Type 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.

The allowed values are FirstPage, MainLine, MainLine1.

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.

Microsoft Ads Connector for CData Sync

BudgetOpportunities

Query the available Budget Opportunities in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

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

Columns

Name Type 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 Int The estimated percentage increase in clicks corresponding to the suggested budget.
PercentageIncreaseInImpressions Int 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.

Microsoft Ads Connector for CData Sync

Budgets

Query the available Budgets in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Budgets
SELECT * FROM Budgets WHERE CampaignId = '431046229' AND AccountId = '65098547'

Columns

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

Microsoft Ads Connector for CData Sync

BudgetSummaryReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

CampaignPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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.
CampaignType String The campaign 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.
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 Int 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 Int 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 Int 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 Int 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 Int True The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double True The low-quality impressions as a percentage.
LowQualityConversions Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int True Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int True Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int True The number of times your tracked number was shown on all devices.
PhoneCalls Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Campaigns

Query the available Campaigns in Bing Ads.

Table Specific Information

Select

The following query is processed server-side:

SELECT * FROM Campaigns

Columns

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, Hotel, PerformanceMax, App.

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

Microsoft Ads Connector for CData Sync

ConversionPerformanceReport

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

Columns

Name Type 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

DataExclusions

Query the available Data Exclusions in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM DataExclusions
SELECT * FROM DataExclusions WHERE AccountId = '2562405'
SELECT * FROM DataExclusions WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The data exclusion ID.
Name String The data exclusion name.
Description String A description for the data exclusion.
CampaignAssociations String Which campaigns to include for the data exclusion.
CampaignTypeFilter String Which campaign types to include for the data exclusion.
DeviceTypeFilter String Which devices types to include for the data exclusion.
StartDate Datetime The start date.
EndDate Datetime The end date.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

DestinationUrlPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

DSAAutoTargetPerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

DSACategoryPerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

DSASearchQueryPerformanceReport

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

Columns

Name Type 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

GeographicPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

GoalsAndFunnelsReport

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

Columns

Name Type 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 Int 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 Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
AllConversions Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

KeywordEstimatedBid

Query the available Keyword Estimated Bid in Bing Ads.

Table Specific Information

Select

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

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

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.

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

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.

Microsoft Ads Connector for CData Sync

KeywordEstimatedPosition

Query the available EstimatedPosition in Bing Ads.

Table Specific Information

Select

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

The Sync App will use the Microsoft Ads API to filter the results by KeywordText and MatchType while the rest of the filter is executed client side within the Sync App. 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 = 50
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to columns other than Keywords and MatchType will cause an error.

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

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.

Microsoft Ads Connector for CData Sync

KeywordHistoricalSearch

Query the available Keyword Historical Search in Bing Ads.

Table Specific Information

Select

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

The Sync App will use the Microsoft Ads API to filter the results by Keywords, Language, StartDate, and EndDate while the rest of the filter is executed client side within the Sync App. For example,

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.

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

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.

Microsoft Ads Connector for CData Sync

KeywordPerformance

Query the available Keyword Performance in Bing Ads.

Table Specific Information

Select

You must specify the Keywords, Language, and PublisherCountry columns in the WHERE clause to query this table. If not set, MatchType will match all possible values: Exact, Phrase, Broad, Content, Aggregate.

The Sync App will use the Microsoft Ads API to filter the results by Keywords, MatchType, Language, and PublisherCountry while the rest of the filter is executed client side within the Sync App. 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.

Filtering by accountid

You can filter by accountid using the IN condition. For example,

SELECT * FROM KeywordEstimatedBid 
WHERE KeywordText IN ('Text', 'Gmail') 
AND MatchType = 'Exact' 
AND AccountId IN ('141163452', '2562405', '141163453', '141163454', '141163455', '141163456', '141163457')

Columns

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.

The allowed values are Exact, Aggregate, Broad, Phrase.

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

Microsoft Ads Connector for CData Sync

KeywordPerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Keywords

Query the available Keywords in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Keywords
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 causes an error.

Columns

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.

Microsoft Ads Connector for CData Sync

NegativeKeywordConflictReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

ProductDimensionPerformanceReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

ProductNegativeKeywordConflictReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

ProductPartitionPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

ProductPartitionUnitPerformanceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

ProductSearchQueryPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

PublisherUsagePerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

SearchCampaignChangeHistoryReport

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

Columns

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

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

SearchQueryPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

SeasonalityAdjustments

Query the available Seasonality Adjustments in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM SeasonalityAdjustments
SELECT * FROM SeasonalityAdjustments WHERE AccountId = '2562405'
SELECT * FROM SeasonalityAdjustments WHERE AccountId IN ('1562405', '2562405', '3562405')

Columns

Name Type Select requirement Metric Aggregate Description
Id [KEY] Long The seasonality adjustment ID.
Name String The name of the seasonality adjustment.
Description String A description for the seasonality adjustment.
AdjustmentPercentage Double The percentage of the conversion rate adjustment.
CampaignAssociations String Make the seasonality adjustment to these campaigns.
CampaignTypeFilter String Make the seasonality adjustment to these campaign types.
DeviceTypeFilter String Make the seasonality adjustment to these device types.
StartDate Datetime The start date.
EndDate Datetime The end date.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

ShareOfVoiceReport

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

Columns

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 Int 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 Int 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 Int 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 Int True True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int 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 Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Tags

Query the available Tags in Bing Ads.

Table Specific Information

Select

The following queries are processed server-side:

SELECT * FROM Tags
SELECT * FROM Tags WHERE AccountId = '135096904'

Columns

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 Contains information about CustomerAccountShares and OwnerCustomerId.
AccountId Long The Bing Ads assigned identifier of an account.

Microsoft Ads Connector for CData Sync

UserLocationPerformanceReport

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

Columns

Name Type 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 Int 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 Int 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 Int 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 Int True The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int 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 Int True The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int 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-Columns

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

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

The allowed values are Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, Last14Days, Last30Days, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear, ThisWeekStartingMonday, LastWeekStartingMonday, LastFourWeeksStartingMonday.

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.

Microsoft Ads Connector for CData Sync

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
DeveloperTokenDeveloperToken of the currently authenticated user.
CustomerIdCustomerId of the currently authenticated user.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

Connection


PropertyDescription
AccountIdThe id of the account that you want to get data for.

Azure Authentication


PropertyDescription
AzureTenantIdentifies the Microsoft Ads tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
ReportScopesAllows you to narrow or broaden the scope of access when getting data from Reporting service views.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Microsoft Ads Connector for CData Sync

Authentication

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


PropertyDescription
DeveloperTokenDeveloperToken of the currently authenticated user.
CustomerIdCustomerId of the currently authenticated user.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.
Microsoft Ads Connector for CData Sync

DeveloperToken

DeveloperToken of the currently authenticated user.

Remarks

DeveloperToken of the currently authenticated user.

Get a Developer Token

To use the Microsoft Ads APIs, you must have a DeveloperToken in addition to the CustomerId and AccountId. You must have the Super Admin role in Microsoft Ads to create a developer token, though you do not need special permissions to use the token. BBD37VB98 may be used for sandbox accounts.

  1. Log in at the Bing Ads Developer Portal as a Microsoft Account user with the Microsoft Ads Super Admin role.
  2. Click the Request Token button and take note of your developer token. You will set it in the DeveloperToken connection property.

Microsoft Ads Connector for CData Sync

CustomerId

CustomerId of the currently authenticated user.

Remarks

CustomerId of the currently authenticated user.

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

Microsoft Ads Connector for CData Sync

UseSandbox

A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

Remarks

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

Microsoft Ads Connector for CData Sync

Connection

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


PropertyDescription
AccountIdThe id of the account that you want to get data for.
Microsoft Ads Connector for CData Sync

AccountId

The id of the account that you want to get data for.

Remarks

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 Microsoft Ads Web application, under Settings -> Accounts and Billing -> Your Account -> Account.

Microsoft Ads Connector for CData Sync

Azure Authentication

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


PropertyDescription
AzureTenantIdentifies the Microsoft Ads tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironmentSpecifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
Microsoft Ads Connector for CData Sync

AzureTenant

Identifies the Microsoft Ads tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

Microsoft Ads Connector for CData Sync

AzureEnvironment

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

Microsoft Ads Connector for CData Sync

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Microsoft Ads Connector for CData Sync

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Microsoft Ads Connector for CData Sync

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Microsoft Ads Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Microsoft Ads Connector for CData Sync

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

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

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Microsoft Ads Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Microsoft Ads Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Microsoft Ads. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Microsoft Ads. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Microsoft Ads. If the SOCKS 5 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.

Microsoft Ads Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Microsoft Ads Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Microsoft Ads Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Microsoft Ads Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Microsoft Ads Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Microsoft Ads Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

Microsoft Ads Connector for CData Sync

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Microsoft Ads Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Microsoft Ads Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

Microsoft Ads Connector for CData Sync

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The user name of a user registered with the proxy server.
DIGEST The user name of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

Microsoft Ads Connector for CData Sync

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

Microsoft Ads Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Microsoft Ads Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Microsoft Ads Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Microsoft Ads Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Microsoft Ads Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Microsoft Ads Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Microsoft Ads Connector for CData Sync

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Microsoft Ads Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Microsoft Ads Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Microsoft Ads Connector for CData Sync

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
ReportScopesAllows you to narrow or broaden the scope of access when getting data from Reporting service views.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Microsoft Ads Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Microsoft Ads Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Microsoft Ads Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Microsoft Ads Connector for CData Sync

ReportScopes

Allows you to narrow or broaden the scope of access when getting data from Reporting service views.

Remarks

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.

  • Accounts should be specified in this format: AccountId, AccountId, AccountId;
  • Campaigns should be specified in this comma-separated format: CampaignId:AccountId, CampaignId:AccountId;
  • AdGroups should be specified in this format (again, comma-separated): AdGroupId:CampaignId:AccountId, AdGroupId:CampaignId:AccountId, AdGroupId:CampaignId:AccountId;

Here are a few examples:

  • ReportScopes='Accounts=1494730,969378; Campaigns=234401540:18503857,1730399:96740690; AdGroups=1958:9607:1655,0973:192782:1655;';
  • ReportScopes='AdGroups=1958:9607:1655, 0973:192782:1655;';
  • ReportScopes='Campaigns=234401540:18503857, 1730399:96740690;';
  • ReportScopes='Accounts=1494730,969378;';

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.

Microsoft Ads Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Microsoft Ads Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:


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

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175