Objeto de datos ReportRequest: generación de informes
Define el objeto base para todas las solicitudes de informe.
No cree instancias de este objeto. En su lugar, puede crear una instancia de uno de los objetos de solicitud de informe que derivan de este objeto, por ejemplo , CampaignPerformanceReportRequest. Para obtener una lista de informes, consulte la guía Tipos de informe.
Sintaxis
<xs:complexType name="ReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="ExcludeColumnHeaders" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="ExcludeReportFooter" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="ExcludeReportHeader" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
<xs:element minOccurs="0" name="FormatVersion" nillable="true" type="xs:string" />
<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>
Elementos
El objeto ReportRequest tiene los siguientes elementos: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData.
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| ExcludeColumnHeaders | Determina si el informe descargado debe contener descripciones de encabezado para cada columna. El encabezado de columna del informe coincide con el nombre de columna solicitado, por ejemplo , Impresiones y Clics. Establezca esta propiedad en true si desea que los encabezados de columna de informe se excluyan del informe descargado. El valor predeterminado es False. |
boolean |
| ExcludeReportFooter | Determina si el informe descargado debe contener o no metadatos de pie de página, como los derechos de autor de Microsoft (@2020 Microsoft Corporation. Todos los derechos reservados). Establezca esta propiedad en true si desea que los metadatos del pie de página del informe se excluyan del informe descargado. El valor predeterminado es False. |
boolean |
| ExcludeReportHeader | Determina si el informe descargado debe contener o no metadatos de encabezado, como el nombre del informe, el intervalo de fechas y la agregación. Establezca esta propiedad en true si desea que los metadatos del encabezado del informe se excluyan del informe descargado. El valor predeterminado es False. |
boolean |
| Formato | Formato de los datos del informe. Por ejemplo, puede solicitar los datos en formato de valores separados por comas (Csv) o en formato de valores separados por tabulaciones (Tsv). El valor predeterminado es Csv. Todos los archivos descargados están comprimidos con ZIP. |
ReportFormat |
| FormatVersion | Determina el formato de determinados campos del archivo de informe descargado. El formato de datos de determinados campos se puede actualizar dentro de la versión actual de la API sin interrumpir las aplicaciones cliente existentes. Para obtener el formato de datos más reciente, establezca este campo de solicitud opcional en 2.0. Si no establece este campo, el servicio tiene como valor predeterminado la versión 1.0. Para obtener más información sobre los cambios entre las versiones de formato, consulte Versión de formato de informe. |
string |
| ReportName | Nombre del informe. El nombre se incluye en el encabezado del informe. Si no especifica un nombre de informe, el sistema genera un nombre en el formulario ReportType-ReportDateTime. La longitud máxima del nombre del informe es 200. |
string |
| ReturnOnlyCompleteData | Determina si el servicio debe asegurarse de que todos los datos se han procesado y están disponibles. Si se establece en true y si el sistema no ha terminado de procesar todos los datos en función de la agregación, el ámbito y la hora solicitados, el servicio devuelve el código de error NoCompleteDataAvaliable (2004). De lo contrario, la solicitud puede realizarse correctamente de forma predeterminada, no hay ninguna indicación de si los datos están completos y el informe solo contendrá los datos que el sistema haya terminado de procesar en el momento de la solicitud. Tenga en cuenta que, dado que hoy en día todavía está en curso y los datos no están completos, no puede establecer este elemento en true si el período de tiempo (ya sea una fecha personalizada o predefinida) incluye la fecha de hoy. Para obtener más información, vea Zonas horarias en Informes. |
boolean |
Requisitos
Servicio: ReportingService.svc v13
Nombres: https://bingads.microsoft.com/Reporting/v13