Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

AdPerformanceReportRequest Data Object

Defines an ad performance report request that aggregates the performance data by ad for a specified time period. You can use this report to identify ads that are performing well (in terms of clicks, conversions, and spend), and those that you may need to adjust to improve the click-through rate.


<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>

Elements

Element

Description

Data Type

Required/Optional

Aggregation

The type of aggregation to use for 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.

NonHourlyReportAggregation

Required

Columns

The list of columns to include in the report. The report will include the columns in the order that you specify them.

AdPerformanceReportColumn array

Required

Filter

The filter information to use to filter the report data.

AdPerformanceReportFilter

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.

AccountThroughAdGroupReportScope

Required

Time

The time period to use for the report. You can specify a custom date 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.

ReportTime

Required

The AdPerformanceReportRequest 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.

Requirements

ReportingService.svc v8

Namespace: https://adcenter.microsoft.com/v8

See Also

Reference

ReportRequest Data Object

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.