Export (0) Print
Expand All

KeywordPerformanceReportRequest Data Object

Defines a keyword performance report request that aggregates the performance data by keyword for a specified time period. You can include details in the report (such as clicks, conversion, and spend) that you can use to identify keywords that are performing well, and those that are not.


<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 minOccurs="0" name="Filter" nillable="true" type="tns:KeywordPerformanceReportFilter" />
        <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 to aggregate the report data. For example, you can aggregate the report data by day or month, or request a summary report. The default is Summary.

The Time element specifies the time period to use for the aggregation.

If you include the QualityScore, KeywordRelevance, LandingPageRelevance, or LandingPageUserExperience, you can specify only hourly, daily, or summary aggregation.

For a list of aggregation types, see Aggregation and Time Periods.

ReportAggregation

Optional

Columns

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

KeywordPerformanceReportColumn array

Required

Filter

The filter information to use to filter the report data.

KeywordPerformanceReportFilter

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

Hourly

Today

Yesterday

Custom date range

Monthly

ThisMonth

LastMonth

LastThreeMonths

LastSixMonths

ThisYear

LastYear

Custom date range

Summary

Today

Yesterday

LastSevenDays

ThisMonth

LastMonth

Custom date range

Weekly

ThisWeek

LastWeek

LastFourWeeks

ThisMonth

LastMonth

ThisYear

LastYear

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

Community Additions

Show:
© 2014 Microsoft