KeywordPerformanceReportFilter Data Object

 

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

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

ElementDescriptionData TypeRequired/Optional
AccountStatusThe 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.
AccountStatusReportFilterOptional
AdDistributionThe 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.
AdDistributionReportFilterOptional
AdGroupStatusThe 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.
AdGroupStatusReportFilterOptional
AdTypeThe 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.AdTypeReportFilterOptional
BidMatchTypeThe 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.
BidMatchTypeReportFilterOptional
BidStrategyTypeThe 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.
BidStrategyTypeReportFilterOptional
CampaignStatusThe 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.
CampaignStatusReportFilterOptional
DeliveredMatchTypeThe 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.
DeliveredMatchTypeReportFilterOptional
DeviceTypeThe 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.
DeviceTypeReportFilterOptional
KeywordRelevance

A numeric score that indicates how likely your ads will be clicked and how well your keyword competes against other keywords targeting the same traffic. This score predicts whether your keyword is likely to lead to a click on your ads, taking into account how well your keyword has performed in the past relative to your ad's position.

KeywordRelevance is equivalent to the Expected Click-Through Rate label used in the Bing Ads web application.

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.

Note: Data for this column is typically updated 14-18 hours after the UTC day ends.

int array
KeywordStatusThe 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.
KeywordStatusReportFilterOptional
KeywordsThe 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 arrayOptional
LandingPageRelevance

A numeric score that indicates whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.

LandingPageUserExperience is equivalent to the Landing Page Experience label used in the Bing Ads web application.

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.

Note: Data for this column is typically updated 14-18 hours after the UTC day ends.

int array
LandingPageUserExperience

A numeric score that indicates whether your landing page is likely to provide a good experience to customers who click your ad and land on your website.

LandingPageUserExperience is equivalent to the Landing Page Experience label used in the Bing Ads web application.

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.

Note: Data for this column is typically updated 14-18 hours after the UTC day ends.

int array
LanguageCodeThe report will include data for only websites that used the specified languages. For a list of possible values, see Ad Languages.string arrayOptional
QualityScoreThe 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 arrayOptional

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

ReportingService.svc v9

Namespace: https://bingads.microsoft.com/Reporting/v9

KeywordPerformanceReportRequest

Community Additions

ADD
Show: