AdPerformanceReportRequest Data Object
Defines an ad performance report request. Use this report to help you determine which ads lead to clicks and conversions, and which are not performing. Having underperforming ads in your account can pull down the quality of your campaigns. You can request impressions, clicks, spend, and average cost per click for each ad. Once downloaded, this data can be sorted by ad ID, ad status, ad title, display URL, and destination URL.
To request a report of this type, pass this object to the SubmitGenerateReport operation.
<xs:complexType name="AdPerformanceReportRequest"> <xs:complexContent mixed="false"> <xs:extension base="tns:ReportRequest"> <xs:sequence> <xs:element name="Aggregation" type="tns:NonHourlyReportAggregation" /> <xs:element name="Columns" nillable="true" type="tns:ArrayOfAdPerformanceReportColumn" /> <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:AdPerformanceReportFilter" /> <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>
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.
The list of columns to include in the report. The report will include the columns in the order that you specify them.
The filter information to use to filter the report data.
The scope of the report. Use this element to limit the report to include data for a combination of accounts, ad groups, and campaigns.
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.
The AdPerformanceReportRequest object derives from the ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest object.