Export (0) Print
Expand All
Expand Minimize

AdExtensionByKeywordReportRequest Data Object

Defines an ad extension by keyword report request. Use this report to compare how well different versions of your ad extensions are performing for each keyword. You can request impressions, clicks, spend, and average cost per click of your extensions for each keyword. Once downloaded, this data can be sorted by keyword, keyword ID, ad extension type, and ad extension version.

To request a report of this type, pass this object to the SubmitGenerateReport operation.

<xs:complexType name="AdExtensionByKeywordReportRequest">
  <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:ArrayOfAdExtensionByKeywordReportColumn" />
        <xs:sequence>
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:AdExtensionByKeywordReportFilter" />
        <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

Aggregation

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.

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.

AdExtensionByKeywordReportColumn array

Required

Filter

The criteria to use to filter the report data.

AdExtensionByKeywordReportFilter array

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 or ThisWeek.

For a list of the time periods that you can specify for each aggregation type, see Aggregation and Time.

ReportTime

Required

The AdExtensionByKeywordReportRequest object derives from the ReportRequest object. For a list of additional elements that you can specify, see the ReportRequest object.

Requirements

ReportingService.svc v9

Namespace: https://bingads.microsoft.com/Reporting/v9

Community Additions

ADD
Show:
© 2014 Microsoft