KeywordPerformanceReportFilter Data Object - Reporting

Defines the criteria to use to filter the keyword performance report data.

Syntax

<xs:complexType name="KeywordPerformanceReportFilter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountStatus" nillable="true" type="tns:AccountStatusReportFilter" />
    <xs:element minOccurs="0" name="AdDistribution" nillable="true" type="tns:AdDistributionReportFilter" />
    <xs:element minOccurs="0" name="AdGroupStatus" nillable="true" type="tns:AdGroupStatusReportFilter" />
    <xs:element minOccurs="0" name="AdRelevance" nillable="true" type="q7:ArrayOfint" xmlns:q7="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="AdType" nillable="true" type="tns:AdTypeReportFilter" />
    <xs:element minOccurs="0" name="BidMatchType" nillable="true" type="tns:BidMatchTypeReportFilter" />
    <xs:element minOccurs="0" name="BidStrategyType" nillable="true" type="tns:BidStrategyTypeReportFilter" />
    <xs:element minOccurs="0" name="CampaignStatus" nillable="true" type="tns:CampaignStatusReportFilter" />
    <xs:element minOccurs="0" name="DeliveredMatchType" nillable="true" type="tns:DeliveredMatchTypeReportFilter" />
    <xs:element minOccurs="0" name="DeviceType" nillable="true" type="tns:DeviceTypeReportFilter" />
    <xs:element minOccurs="0" name="ExpectedCtr" nillable="true" type="q8:ArrayOfint" xmlns:q8="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="KeywordStatus" nillable="true" type="tns:KeywordStatusReportFilter" />
    <xs:element minOccurs="0" name="Keywords" nillable="true" type="q9:ArrayOfstring" xmlns:q9="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="LandingPageExperience" nillable="true" type="q10:ArrayOfint" xmlns:q10="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="LanguageCode" nillable="true" type="q11:ArrayOfstring" xmlns:q11="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="QualityScore" nillable="true" type="q12:ArrayOfint" xmlns:q12="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  </xs:sequence>
</xs:complexType>

Elements

Element Description Data Type
AccountStatus The report will include data for only the account status. For example, you can use the filter to include data for only active accounts.

You can specify one or more account statuses.
AccountStatusReportFilter
AdDistribution The report will include data for only the specified distribution medium. For example, you can use the filter to include data for only search ads.

You can specify one or more distribution mediums.
AdDistributionReportFilter
AdGroupStatus The report will include data for only the ad group status. For example, you can use the filter to include data for only active ad groups.

You can specify one or more ad group statuses.
AdGroupStatusReportFilter
AdRelevance 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.

A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.

If you specify a time period that spans multiple days, the score will be the same for each day in the time period, and the value is the most recent calculated score.

Data for this column is typically updated 14-18 hours after the UTC day ends.
int array
AdType The report will include data for only the specified ad types. For example, the report can include data for product or text ads. You can specify one or more ad types. AdTypeReportFilter
BidMatchType The report will include data for only the specified bid match types. For example, you can use the filter to include data for ads that were bid on using the exact or phrase match type.

You can specify one or more bid match types.

To filter on delivered match types, see the DeliveredMatchType element.
BidMatchTypeReportFilter
BidStrategyType The report will include data for only the specified bid strategy type or types. For example, you can use the filter to include data only for keywords that were bid on using the enhanced bid strategy type.

You can specify one or more bid strategy types.
BidStrategyTypeReportFilter
CampaignStatus The report will include data for only the campaign status. For example, you can use the filter to include data for only active campaigns.

You can specify one or more campaign statuses.
CampaignStatusReportFilter
DeliveredMatchType The report will include data for only the specified delivered match types.For example, you can use the filter to include data for ads that were delivered using the exact or phrase match type.

You can specify one or more delivered match types.

To filter on bid match types, see the BidMatchType element.
DeliveredMatchTypeReportFilter
DeviceType The report will include data for only the specified types of devices on which the ad is displayed. For example, you can use the filter to include data for only text ads displayed on smartphones.

You can specify one or more device types.
DeviceTypeReportFilter
ExpectedCtr 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.

A score of 3 is Above Average; a score of 2 is Average; and a score of 1 is considered Below Average.

If you specify a time period that spans multiple days, the score will be the same for each day in the time period, and the value is the most recent calculated score.

Data for this column is typically updated 14-18 hours after the UTC day ends.
int array
Keywords The report will include data for only the specified keywords. You can specify a maximum of 75 keywords. Each keyword can contain a maximum of 100 characters. string array
KeywordStatus The report will include data for only the keyword status. For example, you can use the filter to include data for only active keywords.

You can specify one or more keyword statuses.
KeywordStatusReportFilter
LandingPageExperience 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.

If you specify a time period that spans multiple days, the score will be the same for each day in the time period, and the value is the most recent calculated score.

Data for this column is typically updated 14-18 hours after the UTC day ends.
int array
LanguageCode The report will include data for only websites that used the specified languages. For a list of possible values, see Ad Languages. string array
QualityScore The report will include data for only keywords with the specified quality scores. You can filter the report based on one or more of the following relevance values:

0 - N/A (as shown in the web application)

1 - Underperforming

2 - Underperforming

3 - Underperforming

4 - Underperforming

5 - Underperforming

6 - Average performance

7 - Competitive

8 - Competitive

9 - Competitive

10 - Competitive
int array

Requirements

Service: ReportingService.svc v12
Namespace: https://bingads.microsoft.com/Reporting/v12

Used By

KeywordPerformanceReportRequest