Export (0) Print
Expand All

Reporting API Release Notes

This page has been deprecated and the content will not be refreshed as of February 2013.

Instead please see Release Notes or Bing Ads API Overview.

This topic provides information about changes to the Reporting API.

Version 8 R4.7 (February 2013)

The ad extension reports now support the ClickType column. The ClickType column identifies the item within the ad extension that the user clicked. For example, the column will contain Click to Direction if the user clicked a location ad extension’s address. The following value sets include the ClickType column.

Added the list of location and call ad extension property IDs to the AdExtensionPropertyId column description (see AdExtensionDimensionReportColumn).

Version 8 R4.42 (November 2012)

Added QualityImpact to the Keyword Performance Report

Added the QualityImpact column to the keyword performance report. The QualityImpact column indicates the possible increase in the number of impressions that the keyword could receive if its quality score improved above a 5 (underperforming). For more information, see KeywordPerformanceReportColumn.

Added ClickSharePercent to the Share of Voice Report

Added the ClickSharePercent column to the share of voice report. The ClickSharePercent column contains the percentage of clicks that the advertiser gets compared to the percentage of clicks that other advertisers get for the same keyword. For more information, see ShareOfVoiceReportColumn.

Version 8 R4.41 (October 2012)

Updated the MetroAreaDemographics Report

Previously, you could use the metro area demographics report to identify the physical location of the user. Now, you can also include the following new columns in your report to learn the geographical intension of the user.

  • QueryIntentCity

  • QueryIntentCountry

  • QueryIntentDMA

  • QueryIntentState

For example, you can use these columns to determine how many clicks were made by Seattle-area users searching for Portland-area services.

For information about these columns, see the MetroAreaDemographicReportColumn value set.

Added New Change Items to Change History Report

The change history report new includes changes to location exclusions, IP exclusions, and site exclusions. To see the new AttributeChanged strings, see the Remarks section of SearchCampaignChangeHistoryReportColumn; the changed attribute strings are listed by entity.

No Longer Supporting the ComponentPosition Column

The ComponentPosition column is no longer being supported. (See RichAdComponentPerformanceReportColumn.) Because this column is no longer being supported and will contain only zeroes, you should remove it from your RichAd Component Performance report request.

Version 8 R4.4 (October 2012)

Added Ad Extension Reports

Ad extensions let you decorate text ads with additional information that helps customers find relevant information about your products and services. For example, you can include deep links into your website to quickly direct your customers to relevant promotional or technical information that may help increase conversions.

You can use the following new reports to get statistics about the effectiveness of the ad extensions you've included in your ads.

  • AdExtensionByAdsReportRequest – Aggregates ad extension performance data by ad for a specified time period. By including performance details, such as clicks, conversion, and spend, you can identify ad extensions that are performing well, and those that may need to be adjusted to optimize the monthly budget.

  • AdExtensionByKeywordReportRequest – Aggregates ad extension performance data by keyword for a specified time period. By including performance details, such as clicks, conversion, and spend, you can identify ad extensions that are performing well, and those that may need to be adjusted to optimize the monthly budget.

  • AdExtensionDimensionReportRequest – Lists all versions of an ad extension by account. You can use this information along with the performance data from the other two reports to determine which version performed better.

Version 8 R4.3 (September 2012)

Added Share of Voice Report

Added the share of voice (SOV) report that aggregates SOV data by keyword and match type for the specified time period. You can use the report’s data to focus on keywords with low impression share. After eliminating share lost to budget, you can use SOV to identify keywords with high impression share lost to rank, bid, keyword relevance, and landing page relevance. You can then adjust your bids and improve your ad copy in order to improve keyword impression share.

To request a SOV report, use the following entities.

Version 8 R3

Added the Change History Report

The change history report shows you the campaign entities that you have access to that have been added or deleted. In addition, the report includes the old and new value of the entities whose values have been updated. For more information, see the SearchCampaignChangeHistoryReportRequest request. For a list of entities and elements that the report can include, see the Remarks section in SearchCampaignChangeHistoryReportColumn.

Added the Keyword Migration Report

The keyword migration report shows you the list of your keyword objects that were included in the keyword migration process. The migration process creates new keyword objects for keywords that contain more than one match-type bid. The result is that each keyword object will contain a unique keyword and match-type combination.

The report will include a row for the original keyword object that shows the match type that it retained, and a row for each new keyword and match-type combination created from the original keyword object. If the object was created from another keyword object, the report shows the identifier of the original keyword object.

For more information, see the KeywordMigrationReportRequest request.

Updated the Share of Voice Columns

The following are the changes to the share of voice columns.

  • The ImpressionLostToOthersPercent column is no longer supported.

  • The ImpressionLostToRankPercent data was calculated using the bid ranking and the auction ranking. The bid ranking is now reported in the new ImpressionLostToBidPercent column. For more information about the difference between the two rankings, see the description of each column.

  • The ImpressionLostToRelevancePercent data was calculated using keyword relevance and landing-page relevance. The data is now being reported in the following two new columns and the ImpressionLostToRelevancePercent is no longer supported.

    • ImpressionLostToKeywordRelevancePercent

    • ImpressionLostToLandingPageRelevancePercent

These changes apply to the following reports.

Version 8 R2

Added the Negative Keyword Conflict Report

This report will be available as early as November 10, 2011.

The negative-keyword conflict report shows you the negative keywords in your account that conflict with the keywords in your account. For more information, see the NegativeKeywordConflictReportRequest request.

Added Columns to the Account Performance Report

The following columns have been added to the Account Performance report. For details about these columns, see the AccountPerformanceReportColumn value set.

  • DeviceOS

  • ImpressionLostToBudgetPercent

  • ImpressionLostToOthersPercent

  • ImpressionLostToRankPercent

  • ImpressionLostToRelevancePercent

  • ImpressionSharePercent

Added Columns to the Ad Group Performance Report

The following columns have been added to the Ad Group Performance report. For details about these columns, see the AdGroupPerformanceReportColumn value set.

  • DeviceOS

  • HistoricKeywordRelevance

  • HistoricLandingPageRelevance

  • HistoricLandingPageUserExperience

  • HistoricQualityScore

  • ImpressionLostToBudgetPercent

  • ImpressionLostToOthersPercent

  • ImpressionLostToRankPercent

  • ImpressionLostToRelevancePercent

  • ImpressionSharePercent

  • KeywordRelevance

  • LandingPageRelevance

  • LandingPageUserExperience

  • QualityScore

Added Columns to the Campaign Performance Report

The following columns have been added to the Campaign Performance report. For details about these columns, see the CampaignPerformanceReportColumn value set.

  • DeviceOS

  • HistoricKeywordRelevance

  • HistoricLandingPageRelevance

  • HistoricLandingPageUserExperience

  • HistoricQualityScore

  • ImpressionLostToBudgetPercent

  • ImpressionLostToOthersPercent

  • ImpressionLostToRankPercent

  • ImpressionLostToRelevancePercent

  • ImpressionSharePercent

  • KeywordRelevance

  • LandingPageRelevance

  • LandingPageUserExperience

  • QualityScore

Added Columns to the Keyword Performance Report

The following columns have been added to the Keyword Performance report. For details about these columns, see the KeywordPerformanceReportColumn value set.

  • HistoricKeywordRelevance

  • HistoricLandingPageRelevance

  • HistoricLandingPageUserExperience

  • HistoricQualityScore

Added Column to the Search Query Performance Report

The following column has been added to the Search Query Performance report. For details about these columns, see the SearchQueryPerformanceReportColumn value set.

  • KeywordId

Added a Filter Value to DeviceTypeReportFilter

Tablet has been added as a possible filter value to the DeviceTypeReportFilter value set, which lets you filter report data for ads that were displayed on tablet devices.

Version 8

Updated the Namespace

The namespace has been changed to reflect the new version number of this release. The new namespace name is https://adcenter.microsoft.com/v8. For the new service address, see Web Service Addresses.

Added New Columns to Search Query Performance Report

The following columns have been added to the SearchQueryPerformanceReportColumn value set.

ConversionRate

The report will include a column that contains the conversion rate as a percentage. The conversion rate is calculated by dividing the number of conversions by the total number of clicks.

Conversions

The report will include a column that contains the number of conversions.

CostPerConversion

The report will include a column that contains the cost per conversion. The cost per conversion is calculated by dividing the amount spent by the number of conversions.

June 22, 2011

Added New Columns to MetroArea Demographic Report

The following columns have been added to the MetroAreaDemographicReportColumn value set.

ProximityTargetLocation

The report will include a column that contains the address of the business if the ad group or campaign specifies business location targeting or the address or name of a landmark if radius targeting is specified.

Radius

The report will include a column that contains the radius, in miles, of the target area surrounding the business or landmark specified in the ProximityTargetLocation column.

April 25, 2011

Added Quality Score

The keyword performance report now includes quality score columns that you can use to determine the overall quality score of the keyword. The quality score factors in the relevance of the keyword and landing page, and the degree to which your landing pages adhere to Bing Ads Editorial Guidelines. For details, see the descriptions for the following quality score columns in the KeywordPerformanceReportColumn value set.

  • KeywordRelevance

  • LandingPageRelevance

  • LandingPageUserExperience

  • QualityScore

March 8, 2011

New Report Available

The following report request has been added. You can use this report to identify the components of a rich ad that are generating the most clicks.

The following filter object has been added. You can use it to filter the contents of the new RAIS report.

The following column object has been added. You can use it to specify the columns to include in the new RAIS report.

Added DeviceType to Several Reports and Filters

The following reports now include the DeviceType column, which identifies the type of device on which the ad appeared.

The following filter objects now include the DeviceType filter, which lets you filter the report data by the type of device on which the ad appeared.

October 19, 2010

Breaking Changes

Updated the Namespace

The namespace has been changed to reflect the new version number for this release. The name of the new namespace is https://adcenter.microsoft.com/v7.

The data type has been changed from int to long for elements in the following data objects:
The BiddedMatchType element name has been changed to BidMatchType in the KeywordPerformanceReportFilter data object. In addition, its corresponding data type has been changed to BidMatchTypeReportFilter.
The BiddedMatchTypeReportFilter value set has been replaced with the BidMatchTypeReportFilter value set.
The BiddedMatchType column name has been changed to BidMatchType in the KeywordPerformanceReportColumn value set.
The CustomDates element has been removed from the ReportTime and BudgetSummaryReportTime data objects.
The Hour column name has been removed from the MetroAreaDemographicReportColumn value set.

Documentation Changes Only

Removed the Report Measures and Columns Topic

This topic did not provide any information that was not already provided in the reference content. To find the value set that contains the columns that you can specify for a report, see the data type of the Columns element of the report request object. For example, the data type for the Columns element of the KeywordPerformanceReportRequest object is KeywordPerformanceReportColumn.

Removed the Use Data Objects Derived from Report Request Topic

This topic contained information that is provided in the Request and Download a Report topic.

Added the Books Closed Topic

This topic helps clarify when the books close for click data and when to request reports.

September 24, 2010

New Reports Available

The following analytic reports have been added.

The following filter objects have been added. You can use them to filter the contents of the new analytic reports.

The following column objects have been added. You can use them to specify the columns to include in the new analytic reports.

August 30, 2010

New Report Types

The reporting WSDL has been updated to include the following report requests; however, submitting requests for these reports will fail until the upcoming release of the Campaign Management service.

  • ConversionPerformanceReportRequest

  • GoalsAndFunnelsReportRequest

  • SegmentationReportRequest

  • TacticChannelReportRequest

  • TrafficSourcesReportRequest

Added Device Type as a Filter and Column Option

Device type has been added as a filter option to the following filter objects.

  1. AccountPerformanceReportFilter

  2. AdGroupPerformanceReportFilter

  3. CampaignPerformanceReportFilter

Device type has been added as a column option to the following column value sets.

  1. AccountPerformanceReportColumn

  2. AdPerformanceReportColumn

  3. CampaignPerformanceReportColumn

Added DestinationUrl as a Column Option

DestinationUrl has been added to the list of possible columns that you can specify for an ad performance report. For more information, see AdPerformanceReportColumn.

July 24, 2010

Updated Metropolitan Area Demographics Report

The following changes have been added to the report.

  • The service does not support specifying the monthly and yearly aggregation values in the Aggregation element of the MetroAreaDemographicReportRequest data object. If you specify monthly or yearly aggregation, the report will be empty.

  • The service does not support the Hour column in the MetroAreaDemographicReportColumn value set. If you specify the Hour column in the report request, the data in the Hour column of the report will contain Unknown.

June 29, 2010

Updated Data Objects

The KeywordPerformanceReportFilter data object has been updated to enable filtering by one or more bid match types (see the BiddedMatchType element).

Added Value Sets

The BiddedMatchTypeReportFilter value set has been added. This value set defines the possible bid match type values that you can use to filter the keyword performance report data.

Updated Column Name

The CampaignStatus column name in the SearchQueryPerformanceReportColumn value set has been changed to Status. If you specify this column in your search query performance report request, you must update your application to use the new column name.

Show:
© 2015 Microsoft