Collapse the table of content
Expand the table of content

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 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: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" />

This object inherits elements from the ReportRequest object. For a list of the inherited elements, see Inherited Elements below.

ElementDescriptionData TypeRequired
AggregationThe 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.
ColumnsThe 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 arrayRequired
FilterThe filter information to use to filter the report data.SearchQueryPerformanceReportFilterOptional
ScopeThe scope of the report. Use this element to limit the report to include data for a combination of accounts, ad groups, and campaigns.AccountThroughAdGroupReportScopeRequired
TimeThe 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.

This object inherits the following elements from the ReportRequest object.

ElementDescriptionData TypeRequired/Optional
FormatThe format of the report data. For example, you can request the data in comma-separated values (Csv) format or tab-separated values (Tsv) format.

The default value is Csv.

Note: All downloaded files are ZIP compressed.
LanguageThe language to use to generate the report headers and columns.

The default is English.
ReportNameThe name of the report. The name is included in the report header. If you do not specify a report name, the system generates a name in the form, ReportType-ReportDateTime.

The maximum length of the report name is 200.
ReturnOnlyCompleteDataDetermines whether you want the service to generate the report only if all the data has been processed and is available.

If true, the request fails if the system has not finished processing all the data based on the aggregation, scope, and time period values that you specify. However, if false, the request succeeds but the report will contain only the data that the system has finished processing at the time of the request (there is no indication as to whether the data is complete). The default is false.

Note: When a user clicks an ad, it can take from three to four hours for the system to process the click and make it available for reporting. For more information, see Determining When the Books Close.

Because you cannot retrieve complete data for today, you must set this element to false if the end date of the custom date range specified in the Time element of the derived report object is set to today, or if you specify one of the following predefined time values:
- Today
- ThisWeek
- ThisMonth
- ThisYear

ReportingService.svc v9



Community Additions

© 2016 Microsoft