KeywordPerformanceReportRequest Data Object
Defines a keyword performance report request. Use this report to find out which keywords are performing well and those that are not.
You can request impressions, clicks, spend, and average cost per click for your landing pages. Once downloaded, this data can be sorted by keyword, account, campaign, and ad group.
To request a report of this type, pass this object to the SubmitGenerateReport operation.
You should not use this report to get performance data for Bing Shopping campaigns. It is only applicable for other campaign types.
<xs:complexType name="KeywordPerformanceReportRequest"> <xs:complexContent mixed="false"> <xs:extension base="tns:ReportRequest"> <xs:sequence> <xs:element name="Aggregation" type="tns:ReportAggregation" /> <xs:element name="Columns" nillable="true" type="tns:ArrayOfKeywordPerformanceReportColumn" /> <xs:element name="Filter" type="tns:KeywordPerformanceReportFilter" nillable="true" minOccurs="0"/> <xs:element name="MaxRows" type="xs:int" minOccurs="0"/> <xs:element name="Scope" nillable="true" type="tns:AccountThroughAdGroupReportScope" /> <xs:element name="Sort" type="tns:ArrayOfKeywordPerformanceReportSort" nillable="true" minOccurs="0"/> <xs:element name="Time" nillable="true" type="tns:ReportTime" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
|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 list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.||KeywordPerformanceReportColumn array||Required|
|The filter information to use to filter the report data.||KeywordPerformanceReportFilter||Optional|
|The top number of data rows to return in the report.||Optional|
|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|
|A list of the columns to sort, and the corresponding sort order.||KeywordPerformanceReportSort array||Optional|
|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.
This object inherits the following elements from the ReportRequest object.
|The 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.
|The language to use to generate the report headers and columns.|
The default is English.
|The 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.
|Determines 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: