Objeto de datos BudgetSummaryReportRequest: informes

Artículo
12/21/2023

Define una solicitud de informe de resumen del presupuesto. Usa este informe para descubrir cómo funciona el presupuesto de tu campaña para el mes. Por ejemplo, el informe muestra el presupuesto mensual, cuánto ha gastado hasta la fecha y si está en el objetivo de gastar su presupuesto mensual.

Puede solicitar su presupuesto mensual, cuánto ha gastado hasta la fecha y si está destinado a gastar su presupuesto mensual.

Para solicitar un informe de este tipo, pase este objeto a la operación SubmitGenerateReport .

Sintaxis

<xs:complexType name="BudgetSummaryReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfBudgetSummaryReportColumn" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughCampaignReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elementos

El objeto BudgetSummaryReportRequest tiene los siguientes elementos: Columns, Scope, Time.

Elemento	Descripción	Tipo de datos
Columnas	Lista de atributos y estadísticas de rendimiento que se incluirán en el informe. El informe incluirá las columnas en el orden en que las especifique.	Matriz BudgetSummaryReportColumn
Ámbito	Ámbito de entidad del informe. Use este elemento para limitar los datos del informe a cuentas o campañas específicas.	AccountThroughCampaignReportScope
Hora	Período de tiempo que se va a usar para el informe. Puede especificar un intervalo de fechas personalizado o seleccionar un intervalo de fechas predefinido, por ejemplo, Today o ThisMonth. El informe de resumen del presupuesto siempre se agrega por día. Puede establecer la zona horaria dentro del objeto ReportTime , lo que le ayuda a limitar con precisión los datos del período de tiempo solicitado. Si no elige una zona horaria, el servicio de informes usa PacificTimeUSCanadaTijuana de forma predeterminada.	ReportTime

El objeto BudgetSummaryReportRequest tiene elementos heredados.

Elementos heredados

Elementos heredados de ReportRequest

El objeto BudgetSummaryReportRequest deriva del objeto ReportRequest y hereda los siguientes elementos: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. Las descripciones siguientes son específicas de BudgetSummaryReportRequest y es posible que no se apliquen a otros objetos que hereden los mismos elementos del objeto ReportRequest .

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 del á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

Compartir a través de