This topic has not yet been rated - Rate this topic

KeywordPerformanceReportFilter Data Object

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


<xs:complexType name="KeywordPerformanceReportFilter">
  <xs:sequence>
    <xs:element minOccurs="0" name="AdDistribution" nillable="true" type="tns:AdDistributionReportFilter" />
    <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="Cashback" nillable="true" type="tns:CashbackReportFilter" />
    <xs:element minOccurs="0" name="DeliveredMatchType" nillable="true" type="tns:DeliveredMatchTypeReportFilter" />
    <xs:element minOccurs="0" name="DeviceType" nillable="true" type="tns:DeviceTypeReportFilter" />
    <xs:element name="KeywordRelevance" type="q13:ArrayOfint" nillable="true" minOccurs="0" xmlns:q13="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
    <xs:element xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Keywords" nillable="true" type="q2:ArrayOfstring" />
    <xs:element name="LandingPageRelevance" type="q15:ArrayOfint" nillable="true" minOccurs="0" xmlns:q15="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
    <xs:element name="LandingPageUserExperience" type="q16:ArrayOfint" nillable="true" minOccurs="0" xmlns:q16="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
    <xs:element minOccurs="0" name="LanguageAndRegion" nillable="true" type="tns:LanguageAndRegionReportFilter" />
    <xs:element name="LanguageCode" type="q30:ArrayOfstring" nillable="true" minOccurs="0" xmlns:q30="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
    <xs:element name="QualityScore" type="q18:ArrayOfint" nillable="true" minOccurs="0" xmlns:q18="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Required/Optional

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

Optional

AdType

The report will include data for only the specified ad types. For example, the report can include data for mobile or text ads. You can specify one or more ad types.

AdTypeReportFilter

Optional

BidMatchType

The report will include data for only the specified bid match types (as opposed to the delivered match type).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

Optional

CashBack

The report will include data for only those keywords that have the Bing Ads cashback rebate coin icon applied.

Note
The cashback rebate program is no longer supported.

CashbackReportFilter

Optional

DeliveredMatchType

The report will include data for only the specified delivered match types (as opposed to the bid match type).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

Optional

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

Optional

KeywordRelevance

The report will include data for only keywords with the specified relevance. You can filter the report by one or more of the following relevance values.

0 – N/A (as shown in the web application)
1 – Poor relevance
2 – No issue with relevance
3 – Good relevance

int[]

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[]

Optional

LandingPageRelevance

The report will include data for only the specified landing page relevance. You can filter the report by one or more of the following relevance values.

0 – N/A (as shown in the web application)
1 – Poor relevance
2 – No issue with relevance

int[]

LandingPageUserExperience

The report will include data for only the specified landing page user experience. You can filter the report by one or more of the following user experience values.

0 – N/A (as shown in the web application)
1 – Poor experience
2 – No issue with the experience

int[]

LanguageAndRegion

Do not use this filter; it is for backwards compatibility only. Instead, use the LanguageCode filter.

The report will include data for only the specified language and regions where the ads are displayed. For example, you can use the filter to include data for only English ads displayed in the United States.

You can specify one or more language and regions.

LanguageAndRegionReportFilter

Optional

LanguageCode

The report will include data for only websites that used the specified languages. For a list of possible values, see LanguageCode Values.

string[]

Optional

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[]

Remarks

Setting all filter criteria elements to NULL is the same as setting the Filter element of KeywordPerformanceReportRequest to NULL.

Requirements

ReportingService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

ADD

KeywordPerformanceReportFilter Data Object

Elements

Requirements

See Also

Reference

Community Additions