Export (0) Print
Expand All

ReportRequest Data Object

Defines the base object for all report requests.


<xs:complexType name="ReportRequest">
  <xs:sequence>
    <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
    <xs:element minOccurs="0" name="Language" nillable="true" type="tns:ReportLanguage" />
    <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Required/Optional

Format

The format of the report data. For example, you can request the data in comma-separated values (CSV) format or XML format. The default is CSV format.

All files are compressed (zipped).

ReportFormat

Optional

Language

The language to use to generate the report headers and columns. The default is English.

ReportLanguage

Optional

ReportName

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

string

Optional

ReturnOnlyCompleteData

Determines whether you want the service to generate the report only if all the data is available (has been processed).

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.

System_CLiX_noteNote

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.

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 the Time element contains one of the following predefined time values:

  • Today

  • ThisWeek

  • ThisMonth

  • ThisYear

boolean

Optional

Requirements

ReportingService.svc v8

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

Community Additions

Show:
© 2014 Microsoft