AdGroupPerformanceReportRequest Data Object
Defines an ad group performance report request. Use this report to more broadly compare delivery performance statistics by ad group, campaign, or account attributes rather than at the keyword level.
You can request impressions, impression share (%), clicks, spend, and average cost per click of your ad groups. Once downloaded, this data can be sorted by ad group, ad group status, language, and network.
To request a report of this type, pass this object to the SubmitGenerateReport operation.
<xs:complexType name="AdGroupPerformanceReportRequest"> <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:ArrayOfAdGroupPerformanceReportColumn" /> <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:AdGroupPerformanceReportFilter" /> <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 list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.||AdGroupPerformanceReportColumn array||Required|
|The filter information to use to filter the report data.||AdGroupPerformanceReportFilter||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|
|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.
AdGroupPerformanceReportRequest object derives from the
ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest.