Microsoft Advertising Connector Objects

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

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.

AccountPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
LowQualityClicks Int False No Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double False No The low-quality clicks as a percentage.
LowQualityImpressions Int False No The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double False No The low-quality impressions as a percentage.
LowQualityConversions Int False No The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double False No The low-quality conversion rate as a percentage.
ExactMatchImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No The number of times your tracked number was shown on all devices.
PhoneCalls Int False No The number of total calls to the tracked phone number that showed with your ad.
Ptr Double False No The phone-through rate (Ptr). The formula for calculating the Ptr is (PhoneCalls / PhoneImpressions) x 100.
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Int False No 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 False No Invalid clicks that use sophisticated means to appear valid. You are not billed for these clicks.
AudienceImpressionLostToBudgetPercent Double False No The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double False No The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double False No The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Accounts

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The system generated identifier of the account.
Name String False No The name of the account.
Number String False No The account number.
AccountLifeCycleStatus String False No The status of the account.
PauseReason Int False No 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.

Return to Top

AdAssets

Name Type ReadOnly References FilterOnly Description
AdGroupId Long False AdGroups.Id No The system generated identifier of the ad group.
AdId Long False Ads.Id No The unique Bing Ads identifier for the ad.
AdType String False No The ad type.
Id Long False No The ID of the asset.
AssetPerformanceLabel String False No This lets you know how well the asset is performing.
EditorialStatus String False No 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 False No 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 False No The asset name.
Type String False No The type of the asset.
Text String False No Text for the asset.
SubType String False No Represents the aspect ratio for the asset.
CropHeight Int False No The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int False No The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int False No 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 False No 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 False No The target height dimension of an image asset.
TargetWidth Int False No The target width dimension of an image asset.
ThumbnailImageSubType String False No Represents the aspect ratio for this image asset.
ThumbnailImageCropHeight Int False No The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
ThumbnailImageCropWidth Int False No The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
ThumbnailImageCropX Int False No 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 False No 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 False No The target height dimension of an image asset.
ThumbnailImageTargetWidth Int False No The target width dimension of an image asset.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AdDynamicTextPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
Keyword String False No The keyword text.
AdId Long False No Ad Id
AdTitle String False No The ad title.
AdType String False No The ad type.
AdLabels String False No The labels applied to the ad.
DestinationUrl String False No The destination URL attribute of the ad, keyword, or ad group criterion.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
Param1 String False No The first dynamic substitution parameter (Param1) of a keyword or biddable ad group criterion.
Param2 String False No The second dynamic substitution parameter (Param2) of a keyword or biddable ad group criterion.
Param3 String False No The third dynamic substitution parameter (Param3) of a keyword or biddable ad group criterion.
DeviceType String False No 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 False No The ad group language.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
KeywordStatus String False No The keyword status.
TitlePart1 String False No The title part 1 attribute of an ad.
TitlePart2 String False No The title part 2 attribute of an ad.
TitlePart3 String False No The title part 3 attribute of an ad.
Path1 String False No The path 1 attribute of an ad.
Path2 String False No The path 2 attribute of an ad.
FinalUrl String False No The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String False No The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String False No Reserved for future use.
AdDescription String False No The text attribute of an ad.
AdDescription2 String False No The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AdExtensionAssets

Name Type ReadOnly References FilterOnly Description
AdExtensionId Long False AdExtensions.Id No The ID of the ad extension.
AdExtensionType String False No The type of ad extension.
Id Long False No The ID for the asset.
Name String False No The asset name.
Type String False No The type of the asset.
SubType String False No Represents the aspect ratio for the asset.
CropHeight Int False No The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int False No The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int False No 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 False No 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 False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AdExtensionByAdReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdTitle String False No The ad title.
AdExtensionType String False No The type name that corresponds to the AdExtensionTypeId column.
AdExtensionVersion String False No The version attribute of an ad extension.
AdExtensionId Long False No The identifier of the ad extension.
AdId Long False No Ad Id
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
CampaignStatus String False No The campaign status.
DeviceType String False No 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 False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No Click type refers to each component of an ad that a customer can click.
TitlePart1 String False No The title part 1 attribute of an ad.
TitlePart2 String False No The title part 2 attribute of an ad.
TitlePart3 String False No The title part 3 attribute of an ad.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No The number of billable and non-billable times that the ad extension was clicked.
Ctr Double False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AdExtensionByKeywordReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdExtensionType String False No The Bing Ads assigned identifier of an ad extension.
AdExtensionId Long False No The version attribute of an ad extension.
AdExtensionVersion String False No The version attribute of an ad extension.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
CampaignStatus String False No The campaign status.
DeviceType String False No 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 False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No Click type refers to each component of an ad that a customer can click.
Keyword String False No The keyword text.
KeywordId String False No The Bing Ads assigned identifier of a keyword.
KeywordStatus String False No The keyword status.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No The number of billable and non-billable times that the ad extension was clicked.
Ctr Double False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AdExtensionDetailReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdTitle String False No The ad title.
AdId String False No The Bing Ads assigned identifier of an ad.
AdExtensionType String False No The Bing Ads assigned identifier of an ad extension.
AdExtensionTypeId String False No The system identifier that corresponds to the AdExtensionType column. The supported identifiers are 10, 11, and 12.
AdExtensionId Long False No The version attribute of an ad extension.
AdExtensionVersion String False No The version attribute of an ad extension.
AdExtensionPropertyValue String False No The human readable ad extension property value. For this report only one property is available for each type of ad extension.
AdStatus String False No The ad status.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
CampaignStatus String False No The campaign status.
DeviceType String False No 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 False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AdExtensions

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

Return to Top

AdGroupPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
Status String False No The ad distribution attribute of an ad group.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
AdGroupName String False No The ad group name.
AdGroupLabels String False No The labels applied to the ad group.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The account status.
CampaignStatus String False No The campaign status.
TrackingTemplate String False No The current tracking template for the ad group.
CustomParameters String False No The current custom parameters set for the ad group.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ExactMatchImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int False No Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int False No The number of times your tracked number was shown on all devices.
PhoneCalls Int False No 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 False No The phone-through rate (Ptr).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
AudienceImpressionLostToBudgetPercent Double False No The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double False No The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double False No The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AdGroups

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The system generated identifier of the ad group.
CampaignId Long False Campaigns.Id No The system generated identifier of the campaign.
Name String False No The name of the ad group.
AdRotationType String False No 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 False No 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 False No The date that the ads in the ad group will expire.
Language String False No The language of the ads and keywords in the ad group.
CpcBidAmount Double False No 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 False No The percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid.
BiddingSchemeType String False No The bid strategy type for how you want to manage your bids.
ForwardCompatibilityMap String False No 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 False No The search networks where you want your ads to display.
Status String False No The status of the ad group.
TrackingUrlTemplate String False No The tracking template to use as a default for all URLs in your ad group.
UrlCustomParameters String False No Your custom collection of key and value parameters for URL tracking.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AdPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdLabels String False No The labels applied to the ad.
AdGroupName String False No The ad group name.
AdId Long False No The Bing Ads Ad identifier
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdTitle String False No The ad title.
AdDescription String False No The text attribute of an ad.
AdDescription2 String False No The second ad description that appears below the path in your ad. Ad description 2 might not appear in your ad.
AdType String False No The ad type.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The account status.
CampaignStatus String False No The campaign status.
TrackingTemplate String False No The current tracking template of the ad, keyword, or criterion.
CustomParameters String False No The current custom parameters set of the ad, keyword, or criterion.
FinalUrl String False No The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String False No The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String False No Reserved for future use.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
Headline String False No The shorter of two possible responsive ad headlines for Audience campaigns.
LongHeadline String False No The longer of two possible responsive ad headlines for Audience campaigns.
TitlePart1 String False No The title part 1 attribute of an ad.
TitlePart2 String False No The title part 2 attribute of an ad.
TitlePart3 String False No The title part 3 attribute of an ad.
Path1 String False No The path 1 attribute of an ad.
Path2 String False No The path 2 attribute of an ad.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
DisplayUrl String False No The ad display URL.
BusinessName String False No 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 False No The operating system of the device reported in the DeviceType column. The possible values include Android, Blackberry, iOS, Other, Unknown, and Windows.
DestinationUrl String False No 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 False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Ads

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The unique Bing Ads identifier for the ad.
AdGroupId Long False AdGroups.Id No The system generated identifier of the ad group.
Type String False No The ad type.
Title String False No 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 False No The first title part of the ad.
TitlePart2 String False No The second title part of the ad.
Text String False No 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 False No The URL to display in the ad.
DestinationUrl String False No The URL of the webpage to take the user to when they click the ad.
UrlCustomParameters String False No Your custom collection of key and value parameters for URL tracking.
TrackingUrlTemplate String False No The tracking template to use as a default for all landing page URLs.
Status String False No The status of the ad.
ForwardCompatibilityMap String False No 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 False No 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 False No The mobile landing page URL.
FinalAppUrls String False No Reserved for future use.
EditorialStatus String False No The editorial review status of the ad, which indicates whether the ad is pending review, has been approved, or has been disapproved.
DevicePreference Int False No Determines the device preference for showing the ad.
AdFormatPreference String False No 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 False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AgeGenderAudienceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Microsoft Advertising assigned number of an account.
AccountId Long False No The Microsoft Advertising assigned identifier of an account.
AdGroupId Long False No The Microsoft Advertising assigned identifier of an ad group.
CampaignId Long False No The Microsoft Advertising assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
AdDistribution String False No The network where you want your ads to show.
Gender String False No The gender (male or female) of the search users to whom the ad was delivered..
AgeGroup String False No 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 False No This is the language of the country the ad is served in.
AccountStatus String False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
AllConversions Double False No The number of conversions. A conversion is the completion of an action by a customer after viewing your ad.
AllRevenue Decimal False No The revenue optionally reported by the advertiser as a result of conversions.
Assists Int False No 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 False No 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 False No The number of times an ad has been displayed on search results pages or other sites on the Audience Network.
Clicks Int False No 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 False No The number of conversions. A conversion is the completion of an action by a customer after viewing your ad.
ExtendedCost Decimal False No Cost information that is optionally provided by advertisers, including non-advertising costs, taxes, and shipping.
Revenue Decimal False No The revenue optionally reported by the advertiser as a result of conversions.
Spend Decimal False No The sum of your cost-per-click (CPC) charges for your ads and keywords. Spend helps you keep track of your budget.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

AssetGroupAssets

Name Type ReadOnly References FilterOnly Description
AssetGroupId Long False AssetGroups.Id No The asset group ID.
Id Long False No The ID for the asset.
AssetPerformanceLabel String False No This lets you know how well the asset is performing.
EditorialStatus String False No 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 False No 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 False No The asset name.
Type String False No The type of the asset.
Text String False No Text for the asset.
SubType String False No Represents the aspect ratio for the asset.
CropHeight Int False No The number of pixels to use from the image asset source, starting from the CropY position and moving upwards.
CropWidth Int False No The number of pixels to use from the image asset source, starting from the CropX position and moving to the right.
CropX Int False No 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 False No 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 False Campaigns.Id No The system generated identifier of the campaign.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AssetGroups

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The asset group ID.
Name String False No The name of the asset group.
BusinessName String False No The name of the business.
Status String False No The status of the Asset group.
EditorialStatus String False No 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 False No A brief, punchy reason for customers to click your ad right now.
FinalUrls String False No The landing page URL.
FinalMobileUrls String False No The mobile landing page URL.
Path1 String False No The first part of the optional path that will be appended to the domain portion of your display URL.
Path2 String False No The second part of the optional path that will be appended to the domain portion of your display URL.
StartDate Date False No 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 False No The date that the asset group will expire.
Descriptions String False No The descriptions that are shown below the path in your ad.
Headlines String False No Short headlines that appear in your ad.
LongHeadlines String False No Long headlines that appear in your ad.
Images String False No Image assets with different sizes and aspect ratios so they can flexibly display across a variety of publishers and placements.
AssetGroupSearchThemes String False No A list of asset group search themes.
CampaignId Long False Campaigns.Id No The system generated identifier of the campaign.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

AudiencePerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AudienceId Long False No The Bing Ads assigned identifier of the audience, for example the remarketing list ID.
AudienceName String False No The audienc name.
AudienceType String False No The audience type.
AssociationStatus String False No 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 False No 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 False No 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 False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Audiences

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The Bing Ads identifier of the audience.
ParentId Long False Accounts.Id No The Bing Ads identifier of the account or customer.
Name String False No The name of the audience. The name can contain a maximum of 128 characters.
Type String False No The type of the audience.
Description String False No The description of the audience. Use a description to help you remember what audience you are targeting.
MembershipDuration Int False No 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 False No 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 False No Scope defines what accounts can use this audience.
TagId Long False Tags.Id No The unique Bing Ads identifier of the tag.
AudienceNetworkSize Long False No The total number of people who are active members of this audience in the Audience network.
SearchSize Long False No The total number of people who are active members of this audience in the Search network.
SupportedCampaignTypes String False No The list of campaign types that support this audience.
CustomerShareAggregate String False No Contains information about CustomerAccountShares and OwnerCustomerId.
CombinationRules String False No Logical conditions used to determine who to add to your combined list.
AdGroupId Long False No The ad group identifier to associate with the impression-based remarketing list.
CampaignId Long False No The campaign identifier to associate with the impression-based remarketing list.
EntityType String False No The entity type of an impression-based remarketing list.
ProductAudienceType String False No Determines whether to remarket your products to general visitors, product searchers, product viewers, shopping cart abandoners, or past buyers.
RuleType String False No The type of the remarketing rule.
RuleNormalForm String False No Determines whether the rule item groups are evaluated based on conjunctive normal form (CNF) or disjunctive normal form (DNF).
RuleItemGroups String False No The list of rule item groups that you want applied to the remarketing list.
RuleAnotherRuleItemGroups String False No The list of rule item groups related to other pages the audience visited.
RuleExcludeRuleItemGroups String False No The list of rule item groups that you want applied as exclusions to the remarketing list.
RuleIncludeRuleItemGroups String False No The list of rule item groups that you want applied to the remarketing list.
RuleActionOperator String False No The operator that can be applied to the value of the Action element.
RuleAction String False No The type of user interaction you want to track. For example 'play' or 'pause'.
RuleCategoryOperator String False No The operator that can be applied to the value of the Category element.
RuleCategory String False No The category of event you want to track. For example, 'video'.
RuleLabelOperator String False No The operator that can be applied to the value of the Label element.
RuleLabel String False No The name of the element that caused the action. For example 'trailer' or 'behindthescenes'.
RuleValueOperator String False No The operator that can be applied to the value of the Value element.
RuleValue Int False No A positive integer value associated with that event. For example the value could be the duration of time that the video played.
SourceId Long False No The ID of the remarketing list that Bing Ads used to generate this similar audience.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

BidOpportunities

Name Type ReadOnly References FilterOnly Description
OpportunityKey String False No An identifier that uniquely identifies the opportunity.
AdGroupId Long False No The identifier of the ad group that owns the keyword.
CampaignId Long False No The identifier of the campaign for the ad group that owns the keyword.
OpportunityType String False No Defines the possible bid opportunity types you can request when calling GetBidOpportunities.
CurrentBid Double False No The current keyword bid amount specified for the match type in the MatchType element.
EstimatedIncreaseInClicks Double False No The estimated clicks opportunities corresponding to the suggested bid.
EstimatedIncreaseInCost Double False No The estimated increase in spend corresponding to the suggested bid.
EstimatedIncreaseInImpressions Long False No The estimated impressions opportunities corresponding to the suggested bid.
KeywordId Long False No The identifier of the keyword to which the bid opportunity applies.
MatchType String False No The match type to which the suggested bid value applies. The possible values are BroadMatch, ExactMatch, and PhraseMatch.
SuggestedBid Double False No The suggested bid based on the last 7 days of performance history for the corresponding ad group.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

BudgetOpportunities

Name Type ReadOnly References FilterOnly Description
OpportunityKey String False No An identifier that uniquely identifies the opportunity.
BudgetAmount Double False No A potential new budget.
BudgetPointType String False No 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 False No The estimated weekly clicks for the given budget amount.
EstimatedWeeklyCost Double False No The estimated weekly cost for the given budget amount.
EstimatedWeeklyImpressions Double False No The estimated weekly impressions for the given budget amount.
BudgetType String False No The type of budget that the campaign uses.
CampaignId Long False Campaigns.Id No The identifier of the campaign to which the suggested budget applies
CurrentBudget Double False No The campaign's current budget.
IncreaseInClicks Double False No The estimated clicks opportunities corresponding to the suggested budget.
IncreaseInImpressions Double False No The estimated impressions opportunities corresponding to the suggested budget.
PercentageIncreaseInClicks Int False No The estimated percentage increase in clicks corresponding to the suggested budget.
PercentageIncreaseInImpressions Int False No The estimated percentage increase in impressions corresponding to the suggested budget.
RecommendedBudget Double False No The suggested budget based on the last 15 days of performance history for the corresponding campaign.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

Budgets

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The unique Bing Ads identifier of the budget.
CampaignId Long False Campaigns.Id No The system generated identifier of the campaign.
Name String False No 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 False No The amount to spend daily across all campaigns that share the budget.
AssociationCount Int False No The number of Campaign objects that currently share this budget.
BudgetType String False No The budget type determines the pace at which the budget is spent throughout the day.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

BudgetSummaryReport

Name Type ReadOnly References FilterOnly Description
AccountName String False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
Date String False No The date for the downloaded report records. The date will be in the time zone of the campaign.
CurrencyCode String False No The account currency type.
MonthlyBudget String False No The average amount of campaign budget spent during a calendar month.
DailySpend String False No The average amount of campaign budget spent per day.
MonthToDateSpend String False No The amount of money spent to date for the month.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

CampaignPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AccountStatus String False No The account status.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
CampaignLabels String False No The labels applied to the campaign.
CampaignStatus String False No The campaign status.
CampaignType String False No The campaign type.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The name of the budget.
BudgetStatus String False No The budget status. The possible values are Active and Deleted.
BudgetAssociationStatus String False No 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 False No The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
TrackingTemplate String False No The current tracking template for the ad group.
CustomParameters String False No The current set of custom parameters for the campaign.
DeliveredMatchType String False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
LowQualityClicks Int False No Clicks that exhibit a low likelihood of commercial intent. You are not billed for these clicks.
LowQualityClicksPercent Double False No The low-quality clicks as a percentage.
LowQualityImpressions Int False No The number of impressions that result from low-quality keyword searches.
LowQualityImpressionsPercent Double False No The low-quality impressions as a percentage.
LowQualityConversions Int False No The number of conversions that originate from low-quality clicks.
LowQualityConversionRate Double False No The low-quality conversion rate as a percentage.
ExactMatchImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No Historical average of ad relevance scores back as far as 18 months from the current date.
HistoricalLandingPageExperience Int False No Historical average of landing page experience scores back as far as 18 months from the current date.
PhoneImpressions Int False No The number of times your tracked number was shown on all devices.
PhoneCalls Int False No 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 False No The phone-through rate (Ptr).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
LowQualityGeneralClicks Double False No 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 False No 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 False No The percentage of impression share you lost due to insufficient budget on the Microsoft Audience Network.
AudienceImpressionLostToRankPercent Double False No The percentage of impression share you lost due to low rank on the Microsoft Audience Network.
AudienceImpressionSharePercent Double False No The estimated percentage of impressions, out of the total available impressions you could have received on the Microsoft Audience Network.
TopImpressionSharePercent Double False No 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 False No 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.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Campaigns

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The unique Bing Ads identifier of the campaign.
AccountId String False No The unique Bing Ads identifier of the account associated with this campaign.
CampaignType String False No The campaign type determines whether the campaign is an Audience, Dynamic Search Ads, Search, Shopping or Search & Content campaign.
Name String False No The name of the campaign. The name must be unique among all active or paused campaigns within the account.
Status String False No The status of the campaign.
SubType String False No 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 False No The bid strategy type for how you want to manage your bids.
BudgetType String False No The budget type determines how the budget is spent.
DailyBudget Double False No The amount to spend daily on the campaign. You must set the daily budget amount if BudgetId is not set.
ExperimentId Long False No The system generated identifier of the Experiment.
TimeZone String False No The time zone where the campaign operates.
TrackingUrlTemplate String False No The tracking template to use as a default for all URLs in your campaign.
UrlCustomParameters String False No Your custom collection of key and value parameters for URL tracking.
BudgetId Long False Budgets.Id No The unique Bing Ads identifier of the Budget that this campaign shares with other campaigns in the account.
AudienceAdsBidAdjustment Int False No The percent amount by which to adjust your bid for audience ads above or below the base ad group or keyword bid.
Languages String False No The languages of the ads and keywords in the campaign.

Return to Top

ConversionPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
KeywordStatus String False No The keyword status.
KeywordId Long False No The Bing Ads assigned identifier of a keyword.
Keyword String False No The keyword text.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double False No 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 False No The return on ad spend (ROAS).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

DataExclusions

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

Return to Top

DestinationUrlPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdId Long False No Ad Id
DestinationUrl String False No The destination URL attribute of the ad, keyword, or ad group criterion.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
FinalUrl String False No The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String False No The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String False No Reserved for future use.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
CampaignStatus String False No The campaign status.
TrackingTemplate String False No The current tracking template for the ad group.
CustomParameters String False No The current set of custom parameters for the campaign.
DeviceType String False No 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 False No The ad group language.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

DSAAutoTargetPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
CampaignStatus String False No The campaign status.
DynamicAdTarget String False No 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 False No The current status of the dynamic ad target.
DynamicAdTargetId Long False No 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 False No The Bing Ads assigned identifier of an account.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdGroupName String False No The ad group name.
AdGroupStatus String False No The ad group status.
Language String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
TrackingTemplate String False No The current tracking template of the ad.
CustomParameters String False No The current custom parameters of the ad.
WebsiteCoverage String False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

DSACategoryPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdId Long False No The Bing Ads assigned identifier of an ad.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignStatus String False No The campaign status.
AdGroupName String False No The ad group name.
Language String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
Category0 String False No 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 False No 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 False No 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 False No The campaign name.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion.
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

DSASearchQueryPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdId Long False No The Bing Ads assigned identifier of an ad.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
CampaignStatus String False No The campaign status.
AdGroupName String False No The ad group name.
Language String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
CampaignName String False No The campaign name.
AdGroupStatus String False No The ad group status.
AdStatus String False No The ad status.
SearchQuery String False No The search term used by your potential audience.
Headline String False No The Dynamic Search Ad headline that was dynamically generated by Bing Ads.
CategoryList String False No The list of categories that Bing matched to your website. Up to three category levels can be returned per category list item.
LandingPageTitle String False No The title of your webpage where the search user landed.
FeedUrl String False No The feed URL will appear either as
FinalUrl String False No The URL address of the page on your website that people reach when they click your ad from a desktop or laptop.
DynamicAdTarget String False No 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 False No 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 False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion.
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

GeographicPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
Language String False No The ad group language.
AccountStatus String False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
Country String False No The country where the user was physically located when they clicked the ad.
State String False No The state where the user was physically located when they clicked the ad.
MetroArea String False No The metro area where the user was physically located when they clicked the ad.
City String False No The city where the user was physically located when they clicked the ad.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
ProximityTargetLocation String False No The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String False No The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String False No 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 False No 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 False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
LocationType String False No 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 False No 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 False No The county where the user was physically located when they clicked the ad.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
LocationId Long False No 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 False No The postal code where the user was physically located when they clicked the ad.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double False No 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 False No The return on ad spend (ROAS).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

GoalsAndFunnelsReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
AccountStatus String False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
Keyword String False No The keyword text.
KeywordStatus String False No The keyword status.
KeywordId String False No The Bing Ads assigned identifier of a keyword.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
Goal String False No The name of your event tracking or campaign analytics goal.
GoalId String False No The Bing Ads assigned identifier of a goal.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
AllConversions Int False No 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 False No 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.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

KeywordEstimatedBid

Name Type ReadOnly References FilterOnly Description
KeywordText String False No The keyword text.
MatchType String False No The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate.
CurrencyCode String False No The monetary unit of the cost values, such as AverageCPC.
CampaignId Long False Campaigns.Id No The system generated identifier of the campaign.
AdGroupId Long False AdGroups.Id No The system generated identifier of the ad group.
MinClicksPerWeek Double False No The estimated minimum number of clicks per week.
MaxClicksPerWeek Double False No The estimated maximum number of clicks per week.
AverageCPC Double False No The estimated average CPC.
MinImpressionsPerWeek Long False No The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long False No The estimated maximum number of impressions per week.
ClickThroughRate Double False No The estimated CTR.
MinTotalCostPerWeek Double False No The estimated minimum cost per week.
MaxTotalCostPerWeek Double False No The estimated maximum cost per week.
EstimatedMinBid Double False No The position in the search results given the specified bid.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

KeywordEstimatedPosition

Name Type ReadOnly References FilterOnly Description
Keywords String False No List of Keywords. Use to filter the table.
MaxBid Long False No The maximum bid value to use to determine the estimated position in the search results.
MatchType String False No The keyword match type used to determine the estimates. Can be one of Exact, Phrase, Broad, Aggregate.
CurrencyCode String False No The monetary unit of the cost values, such as AverageCPC.
CampaignId Long False Campaigns.Id No The system generated identifier of the campaign.
AdGroupId Long False AdGroups.Id No The system generated identifier of the ad group.
Keyword String False No The keyword.
MinClicksPerWeek Double False No The estimated minimum number of clicks per week.
MaxClicksPerWeek Double False No The estimated maximum number of clicks per week.
AverageCPC Double False No The estimated average CPC.
MinImpressionsPerWeek Long False No The estimated minimum number of impressions per week.
MaxImpressionsPerWeek Long False No The estimated maximum number of impressions per week.
ClickThroughRate Double False No The estimated CTR.
MinTotalCostPerWeek Double False No The estimated minimum cost per week.
MaxTotalCostPerWeek Double False No The estimated maximum cost per week.
EstimatedAdPosition Double False No The position in the search results given the specified bid.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

KeywordHistoricalSearch

Name Type ReadOnly References FilterOnly Description
Keywords String False No List of Keywords. Use to filter the table.
Language String False No The language in which the keywords are written.
StartDate Date False No The start date of the date range that identifies the data that you want to use to determine the historical search count.
EndDate Date False No The end date of the date range that identifies the data that you want to use to determine the historical search count.
Keyword String False No The keyword.
SearchCount Long False No 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 False No The time period in which the count was captured.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

KeywordPerformance

Name Type ReadOnly References FilterOnly Description
Keywords String False No List of Keywords. Use to filter the table.
AdPosition String False No The position in the search results in which the ad appeared.
MatchType String False No The match type that you specified in the request.
Language String False No The language in which the keywords are written.
PublisherCountry String False No 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 False No The device of the user who entered the search query. Default value is 'Computers'.
Keyword String False No The keyword.
Clicks Int False No The number of clicks that the keyword and match type generated during the specified time interval.
Impressions Long False No The number of impressions that the keyword and match type generated during the specified time interval.
AverageCPC Double False No 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 False No 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 False No The cost of using the specified keyword and match type during the specified time interval.
AverageBid Double False No The average bid of the keyword.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

KeywordPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
Keyword String False No The keyword text.
KeywordId Long False No The Bing Ads assigned identifier of a keyword.
KeywordLabels String False No The labels applied to the keyword.
AdId Long False No Ad Id
AdType String False No The ad type.
DestinationUrl String False No The destination URL attribute of the ad, keyword, or ad group criterion.
CurrentMaxCpc String False No 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 False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
FinalUrl String False No The Final URL of the ad, keyword, or criterion.
FinalMobileUrl String False No The Final Mobile URL of the ad, keyword, or criterion.
FinalAppUrl String False No Reserved for future use.
FirstPageBid Decimal False No 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 False No 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 False No 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 False No 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 False No 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 False No The account status.
AdGroupStatus String False No The ad group status.
CampaignStatus String False No The campaign status.
TrackingTemplate String False No The current tracking template for the ad group.
CustomParameters String False No The current set of custom parameters for the campaign.
DeviceType String False No 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 False No The ad group language.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The keyword status.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
QualityScore Int False No 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 False No 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 False No 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 False No 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 False No 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).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Keywords

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The system-generated identifier of the keyword.
AdGroupId Long False AdGroups.Id No The system generated identifier of the ad group.
Text String False No 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 False No The keyword's status. By default, the status is set to Active.
BidAmount Double False No The bid to use when the user's search term and the keyword match.
DestinationUrl String False No 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 False No The bid strategy type for how you want to manage your bids.
MatchType String False No The type of match to compare the keyword and the user's search term.
TrackingUrlTemplate String False No The tracking template to use as a default for all FinalUrls and FinalMobileUrls.
UrlCustomParameters String False No Your custom collection of key and value parameters for URL tracking.
ForwardCompatibilityMap String False No 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 False No The landing page URL. The keyword's final URL is used if specified; otherwise, the ad's final URL is used.
FinalMobileUrls String False No 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 False No Reserved for future use.
EditorialStatus String False No The editorial review status of the keyword, which indicates whether the keyword is pending review, has been approved, or has been disapproved.
Param1 String False No 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 False No 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 False No 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 False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

NegativeKeywordConflictReport

Name Type ReadOnly References FilterOnly Description
AccountName String False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountStatus String False No The account status.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdGroupName String False No The ad group name.
AdGroupStatus String False No The ad group status.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
CampaignName String False No The campaign name.
CampaignStatus String False No The campaign status.
Keyword String False No The keyword text.
KeywordId Long False No The Bing Ads assigned identifier of a keyword.
KeywordStatus String False No The keyword status.
NegativeKeyword String False No The negative keyword text.
ConflictLevel String False No The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign.
ConflictType String False No The type of negative keyword conflict encountered.The possible values are Possibly intentional conflict and True conflict.
BidMatchType String False No 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 False No The Bing Ads assigned identifier of a negative keyword list.
NegativeKeywordList String False No The name of the negative keyword list.
NegativeKeywordId Long False No The Bing Ads assigned identifier of a negative keyword.
NegativeKeywordMatchType String False No 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.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

ProductDimensionPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AdGroupName String False No The ad group name.
AdGroupId String False No The Bing Ads assigned identifier of an ad group.
AdId String False No The Bing Ads assigned identifier of an ad.
CampaignName String False No The campaign name.
CurrencyCode String False No The account currency type.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
MerchantProductId String False No The report will include a column that contains the unique identifier provided by a merchant for each product offer.
Title String False No The product item name. For example the title of a book, DVD, or game.
Condition String False No The condition of a product item.
Brand String False No The product item's manufacturer, brand, or publisher.
CustomLabel0 String False No The value of the Custom_label_0 field in your Bing Merchant Center catalog.
CustomLabel1 String False No The value of the Custom_label_1 field in your Bing Merchant Center catalog.
CustomLabel2 String False No The value of the Custom_label_2 field in your Bing Merchant Center catalog.
CustomLabel3 String False No The value of the Custom_label_3 field in your Bing Merchant Center catalog.
CustomLabel4 String False No The value of the Custom_label_4 field in your Bing Merchant Center catalog.
ProductType1 String False No The first level value of the Product_type field in your Bing Merchant Center catalog.
ProductType2 String False No The second level value of the Product_type field in your Bing Merchant Center catalog.
ProductType3 String False No The third level value of the Product_type field in your Bing Merchant Center catalog.
ProductType4 String False No The fourth level value of the Product_type field in your Bing Merchant Center catalog.
ProductType5 String False No The fifth level value of the Product_type field in your Bing Merchant Center catalog.
ProductCategory1 String False No The first level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory2 String False No The second level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory3 String False No The third level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory4 String False No The fourth level value of the Product_category field in your Bing Merchant Center catalog.
ProductCategory5 String False No The fifth level value of the Product_category field in your Bing Merchant Center catalog.
AccountStatus String False No The account status.
AssistedClicks String False No Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String False No 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 False No The campaign status.
AdGroupStatus String False No The ad group status.
CampaignId String False No The Bing Ads assigned identifier of a campaign.
Network String False No The current network setting of an ad group.
Price String False No The different price for products in your catalog.
SellerName String False No The report will include a column that contains the merchant or store name that offers the product.
OfferLanguage String False No The report will include a column that contains the language for the product offer.
CountryOfSale String False No The report will include a column that contains the country of sale for the product catalog.
AdStatus String False No The ad status.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String False No The ad distribution attribute of an ad group.
ClickTypeId Long False No The click type ID.
StoreId Long False No The unique identifier for the Bing Merchant Center store.
BidStrategyType String False No 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 False No Click type refers to each component of an ad that a customer can click.
LocalStoreCode String False No An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No The cost per click (CPC) summed for each click.
ConversionRate Double False No The cost per click (CPC) summed for each click.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double False No 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 False No 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 False No 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 False No Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double False No 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 False No The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

ProductNegativeKeywordConflictReport

Name Type ReadOnly References FilterOnly Description
AccountName String False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AccountStatus String False No The account status.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
CampaignStatus String False No The campaign status.
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdGroupStatus String False No The ad group status.
ConflictLevel String False No The entity level where the keyword and negative keyword conflict occurs. The possible values are AdGroup and Campaign.
NegativeKeywordListId Long False No The Bing Ads assigned identifier of a negative keyword list.
NegativeKeyword String False No The negative keyword text.
NegativeKeywordId Long False No The Bing Ads assigned identifier of a negative keyword.
NegativeKeywordMatchType String False No 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 False No 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 False No The report will include a column that contains the unique identifier provided by a merchant for each product offer.
AdGroupCriterionId Long False No The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
ProductGroup String False No The forward slash ('/') delimited list of product conditions, reported as Operand=
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

ProductPartitionPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdId Long False No The Bing Ads assigned identifier of an ad.
AssistedClicks String False No Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String False No 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 False No The campaign name.
CurrencyCode String False No The account currency type.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
AccountStatus String False No The account status.
CampaignStatus String False No The campaign status.
AdGroupStatus String False No The ad group status.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
Network String False No The current network setting of an ad group.
OfferLanguage String False No The report will include a column that contains the language for the product offer.
CountryOfSale String False No The report will include a column that contains the country of sale for the product catalog.
AdStatus String False No The ad status.
PartitionType String False No The product partition type.
ProductGroup String False No The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long False No The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String False No 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 False No The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String False No 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 False No 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 False No The current tracking template of the criterion.
CustomParameters String False No The current custom parameter set of the criterion.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AdDistribution String False No The ad distribution attribute of an ad group.
ClickType String False No Click type refers to each component of an ad that a customer can click.
BidStrategyType String False No 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 False No An alphanumeric identifier defined by the merchant to uniquely identify each local store.
ClickTypeId Long False No The click type ID.
CostPerConversion Double False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
AbsoluteTopImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No The cost per click (CPC) summed for each click.
ConversionRate Double False No The cost per click (CPC) summed for each click.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
ImpressionSharePercent Double False No 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 False No 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 False No 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 False No Shows you how much other advertisers are bidding on average on similar products as your current target.
BenchmarkCtr Double False No 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 False No 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 False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double False No The revenue per assist.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

ProductPartitionUnitPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdId Long False No The Bing Ads assigned identifier of an ad.
CampaignName String False No The campaign name.
CurrencyCode String False No The account currency type.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
AccountStatus String False No The account status.
AssistedClicks String False No Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String False No 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 False No The campaign status.
AdGroupStatus String False No The ad group status.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
Network String False No The current network setting of an ad group.
AdStatus String False No The ad status.
ProductGroup String False No The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long False No The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
CurrentMaxCpc String False No 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 False No The destination URL attribute of the ad, keyword, or ad group criterion.
BidMatchType String False No 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 False No 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 False No The current tracking template of the criterion.
CustomParameters String False No The current custom parameter set of the criterion.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidStrategyType String False No 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 False No An alphanumeric identifier defined by the merchant to uniquely identify each local store.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No The cost per click (CPC) summed for each click.
ConversionRate Double False No The cost per click (CPC) summed for each click.
CostPerConversion Double False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double False No The revenue per assist.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

ProductSearchQueryPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
AccountNumber String False No The Bing Ads assigned number of an account.
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdId Long False No The Bing Ads assigned identifier of an ad.
AccountId Long False No The Bing Ads assigned identifier of an ad.
AssistedClicks String False No Clicks on your ads that have received co-bids from your manufacturer partners. Clicks are what you pay for.
AssistedImpressions String False No 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 False No The campaign name.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
Language String False No The ad group language.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
Network String False No The current network setting of an ad group.
PartitionType String False No The product partition type.
ProductGroup String False No The forward slash ('/') delimited list of product conditions, reported as Operand=
AdGroupCriterionId Long False No The Bing Ads assigned identifier of an ad group criterion, or product group in the context of a Bing Shopping campaign.
DestinationUrl String False No The destination URL attribute of the ad, keyword, or ad group criterion.
ClickType String False No Click type refers to each component of an ad that a customer can click.
ClickTypeId Long False No The click type ID.
MerchantProductId Long False No The click type ID.
SearchQuery String False No The click type ID.
Title String False No The click type ID.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
Conversions Int False No The cost per click (CPC) summed for each click.
ConversionRate Double False No The cost per click (CPC) summed for each click.
Revenue Double False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
TotalClicksOnAdElements Int False No 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 False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerAssist Double False No The revenue per assist.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

PublisherUsagePerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Daily Date False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
CampaignStatus String False No The campaign status.
DeviceType String False No 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 False No The ad group language.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The URL of the website that displayed the ad.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

SearchCampaignChangeHistoryReport

Name Type ReadOnly References FilterOnly Description
AccountName String False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
EntityId String False No The Bing Ads system identifier of the entity that was updated.
EntityName String False No The name of the entity that was updated.
DateTime String False No The campaign name.
AdTitle String False No The ad title.
AdDescription String False No The campaign name.
DisplayUrl String False No The campaign name.
Keyword String False No The campaign name.
ItemChanged String False No The campaign name.
AttributeChanged String False No The campaign name.
ChangedBy String False No 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 False No The campaign name.
OldValue String False No The campaign name.
NewValue String False No The campaign name.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

SearchQueryPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdId Long False No Ad Id
AdType String False No The ad type.
DestinationUrl String False No The destination URL attribute of the ad, keyword, or ad group criterion.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
AdGroupCriterionId Long False No The Bing Ads assigned identifier of an ad group criterion.
AdStatus String False No The ad status.
CampaignStatus String False No The campaign status.
CampaignType String False No The type of campaign. Possible values include Search, Shopping, and Dynamic search.
CustomerId String False No The Bing Ads assigned identifier of a customer.
CustomerName String False No The customer name.
DeviceType String False No 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 False No The ad group language.
Network String False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No The operating system of the device reported in the DeviceType column.
DeliveredMatchType String False No 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 False No The search term used by your potential audience.
Keyword String False No The keyword text.
KeywordId Long False No The Bing Ads assigned identifier of a keyword.
KeywordStatus String False No The keyword status.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Revenue Double False No 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 False No The return on ad spend (ROAS). The formula for calculating the ROAS is (Revenue / Spend).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

SeasonalityAdjustments

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

Return to Top

ShareOfVoiceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
CampaignName String False No The campaign name.
CampaignId Long False No The Bing Ads assigned identifier of a campaign..
AdGroupName String False No The ad group name.
AdGroupId Long False No The Bing Ads assigned identifier of an ad group.
AdDistribution String False No The ad distribution attribute of an ad group.
AccountStatus String False No The account status.
AdGroupStatus String False No The ad group status.
CampaignStatus String False No The campaign status.
DeviceType String False No 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 False No The ad group language.
Network String False No The current network setting of an ad group.
BidStrategyType String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
BidMatchType String False No 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 False No 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 False No The Bing Ads assigned identifier of a keyword.
Keyword String False No The keyword text.
KeywordStatus String False No The keyword status.
KeywordLabels String False No The labels applied to the keyword.
AdRelevance String False No 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 False No 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 False No 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 False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Conversions Int False No 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 False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ExactMatchImpressionSharePercent Double False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured.
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top

Tags

Name Type ReadOnly References FilterOnly Description
Id [KEY] Long False No The unique Bing Ads identifier of the UET tag.
Name String False No The UET tag name.
Description String False No Text to help you identify the UET tag. We recommend that you set this to the related website page name or URL.
TrackingNoScript String False No 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 False No The tracking script that you can add to your website to allow Bing Ads to collect actions people take on your website.
TrackingStatus String False No 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.
CustomerShareAggregate String False No Contains information about CustomerAccountShares and OwnerCustomerId.
AccountId Long False Accounts.Id No The Bing Ads assigned identifier of an account.

Return to Top

UserLocationPerformanceReport

Name Type ReadOnly References FilterOnly Description
Summary String False No The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Hourly String False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No 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 False No The account name.
AccountNumber String False No The Bing Ads assigned number of an account.
AccountId Long False No The Bing Ads assigned identifier of an account.
AdGroupId Long False No The Bing Ads assigned identifier of an account.
CampaignId Long False No The Bing Ads assigned identifier of a campaign.
AdGroupName String False No The ad group name.
CampaignName String False No The campaign name.
Language String False No The ad group language.
Country String False No The country where the user was physically located when they clicked the ad.
State String False No The state where the user was physically located when they clicked the ad.
MetroArea String False No The metro area where the user was physically located when they clicked the ad.
City String False No The city where the user was physically located when they clicked the ad.
CurrencyCode String False No The account currency type.
AdDistribution String False No The ad distribution attribute of an ad group.
ProximityTargetLocation String False No The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad.
Radius String False No The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad.
BidMatchType String False No 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 False No 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 False No The current network setting of an ad group.
TopVsOther String False No The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere.
DeviceType String False No The device name attribute of a device OS target bid. The type of device which showed ads.
County String False No The county where the user was physically located when they clicked the ad.
DeviceOS String False No The operating system of the device reported in the DeviceType column.
LocationId Long False No 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 False No The postal code where the user was physically located when they clicked the ad.
QueryIntentCountry String False No 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 False No 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 False No 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 False No The postal code where the user was physically located when they clicked the ad.
QueryIntentCounty String False No 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 False No 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 False No The location identifier if the user's geographical intent can be determined.
Goal String False No The goal name.
GoalType String False No The goal type. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url.
Impressions Int False No The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Clicks Int False No 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 False No 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 False No 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 False No The cost per click (CPC) summed for each click.
AveragePosition Double False No The average position of the ad on a webpage.
Assists Int False No The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad.
Conversions Int False No 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 False No The cost per conversion. The formula for calculating the cost per conversion is (Spend / Conversions).
ConversionRate Double False No 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 False No 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 False No The return on ad spend (ROAS).
CostPerAssist Double False No The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
RevenuePerConversion Double False No The revenue per conversion. The formula for calculating the revenue per conversion is (Revenue / Conversions).
RevenuePerAssist Double False No The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
DatePreset String False Yes 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.
EndDate String False Yes The end date of the custom date range. The end date cannot be later than today's date.
StartDate String False Yes The start date of the custom date range. The start date must be earlier than or the same as the end date.

Return to Top