AdExtensionDimensionReportRequest Data Object

System_CAPS_ICON_warning.jpg Warning

This report request is deprecated and is not supported. Using this data object will throw an exception.

This content is for archive purposes only.

Defines an ad extension dimension report request that lists all versions of an ad extension by account. You may use this information along with the performance data from the AdExtensionByAdReportRequest, AdExtensionByKeywordReportRequest, and AdExtensionDetailReportRequest reports to determine which version performed better.

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

<xs:complexType name="AdExtensionDimensionReportRequest">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfAdExtensionDimensionReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:AdExtensionDimensionReportFilter" />
        <xs:element name="Scope" nillable="true" type="tns:AccountReportScope" />

This object inherits elements from the ReportRequest object. For a list of the inherited elements, see Inherited Elements below.

ElementDescriptionData TypeRequired
ColumnsThe list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.AdExtensionDimensionReportColumn arrayRequired
FilterThe criteria to use to filter the report data.AdExtensionDimensionReportFilter arrayOptional
ScopeThe scope of the report. Use this element to limit the report to include data for one or more accounts.AccountReportScopeRequired

This object inherits the following elements from the ReportRequest object.

ElementDescriptionData TypeRequired/Optional
FormatThe format of the report data. For example, you can request the data in comma-separated values (Csv) format or tab-separated values (Tsv) format.

The default value is Csv.

Note: All downloaded files are ZIP compressed.
LanguageThe language to use to generate the report headers and columns.

The default is English.
ReportNameThe name of the report. The name is included in the report header. If you do not specify a report name, the system generates a name in the form, ReportType-ReportDateTime.

The maximum length of the report name is 200.
ReturnOnlyCompleteDataDetermines whether you want the service to generate the report only if all the data has been processed and is available.

If true, the request fails if the system has not finished processing all the data based on the aggregation, scope, and time period values that you specify. However, if false, the request succeeds but the report will contain only the data that the system has finished processing at the time of the request (there is no indication as to whether the data is complete). The default is false.

Note: When a user clicks an ad, it can take from three to four hours for the system to process the click and make it available for reporting. For more information, see Determining When the Books Close.

Because you cannot retrieve complete data for today, you must set this element to false if the end date of the custom date range specified in the Time element of the derived report object is set to today, or if you specify one of the following predefined time values:
- Today
- ThisWeek
- ThisMonth
- ThisYear

ReportingService.svc v9