Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

SearchQueryPerformanceReportRequest Data Object

Defines a search query performance report request. 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. You can request impressions, clicks, click-through rate, and average position for search terms that have triggered your ads. For example, if you are a mortgage lender who is running a campaign with the following keywords: mortgage, home mortgage, and home equity loans; and the report shows that the search query “mortgage rates” results in many impressions of your ad, you would probably add “rates” to your keyword list. However, if you do not provide reverse mortgages and the report shows that the search query “reverse mortgage” results in many impressions, you would probably add “reverse mortgage” to your negative keywords list.

The report will include only search terms that resulted in a significant number of clicks in the last 30 days.

Since this data might change over time, please use the KeywordPerformanceReportRequest Data Object to get the performance metrics for your keywords.

To request a report of this type, pass this object to the SubmitGenerateReport operation.


<xs:complexType name="SearchQueryPerformanceReportRequest">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:SearchQueryReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfSearchQueryPerformanceReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:SearchQueryPerformanceReportFilter" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughAdGroupReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element

Description

Data Type

Required

Aggregation

The type of aggregation to use to aggregate the report data. For example, you can aggregate the report data by day or week, or request a summary report.

The default is Summary.

The Time element specifies the time period to use for the aggregation.

SearchQueryReportAggregation

Optional

Columns

The list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.

SearchQueryPerformanceReportColumn array

Required

Filter

The filter information to use to filter the report data.

SearchQueryPerformanceReportFilter

Optional

Scope

The scope of the report. Use this element to limit the report to include data for a combination of accounts, ad groups, and campaigns.

AccountThroughAdGroupReportScope

Required

Time

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.

For a list of the time periods that you can specify for each aggregation type, see Aggregation and Time.

ReportTime

Required

The SearchQueryPerformanceReportRequest object derives from the ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest object.

Requirements

ReportingService.svc v9

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

Community Additions

ADD
Show:
© 2015 Microsoft