PublisherUsagePerformanceReportRequest Data Object
Defines a publisher usage performance report request that aggregates the performance data by publisher website for a specified time period. You can include details in the report (such as clicks, conversions, and spend) that you can use to identify websites that are performing well, and those that you may want to exclude from your campaign.
<xs:complexType name="PublisherUsagePerformanceReportRequest">
<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:ArrayOfPublisherUsagePerformanceReportColumn" />
<xs:element minOccurs="0" name="Filter" nillable="true" type="tns:PublisherUsagePerformanceReportFilter" />
<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>
<xs:element name="PublisherUsagePerformanceReportRequest" nillable="true" type="tns:PublisherUsagePerformanceReportRequest" />
Elements
Element | Description | Data Type | Required/Optional |
|---|---|---|---|
Aggregation | The type of aggregation to use to aggregate the report data. For example, you can aggregate the report data by day or month, or request a summary report. The Time element specifies the time period to use for the aggregation. For a list of aggregation types, see Aggregation and Time Periods. | Required | |
Columns | The list of columns to include in the report. The report will include the columns in the order that you specify them. | Required | |
Filter | The filter information to use to filter the report data. | 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. | Required | |
Time | The time period to use for the report. You can specify a custom data range or select a predefined date range (for example, Today, ThisWeek, or LastMonth). For a list of the time periods that you can specify for each aggregation type, see Aggregation and Time Periods. | Required |
The PublisherUsagePerformanceReportRequest object derives from the ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest object.
Business Rules
Aggregation and Time Periods
The following are the time periods that you can specify for each aggregation value.
Aggregation Value | Time Periods |
|---|---|
Daily | Today Yesterday LastSevenDays ThisMonth LastMonth Custom date range |
Monthly | ThisMonth LastMonth LastThreeMonths LastSixMonths LastYear Custom date range |
Summary | Yesterday LastSevenDays ThisMonth LastMonth Custom date range |
Weekly | ThisWeek LastWeek LastFourWeeks Custom date range |
Yearly | ThisYear LastYear Custom date range |
To request a report of this type, pass this object to the SubmitGenerateReport operation.
