BudgetSummaryReportRequest Data Object - Reporting
Defines a budget summary report request. Use this report to discover how your campaign's budget is performing for the month. For example, the report shows your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.
You can request your monthly budget, how much you have spent to date, and whether you are on target to spend your monthly budget.
To request a report of this type, pass this object to the SubmitGenerateReport operation.
<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:BudgetSummaryReportTime" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
|Columns||The list of attributes and performance statistics to include in the report. The report will include the columns in the order that you specify them.||BudgetSummaryReportColumn array|
|Scope||The scope of the report. Use this element to limit the report to include data for a combination of accounts and campaigns.||AccountThroughCampaignReportScope|
|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 ThisMonth.||BudgetSummaryReportTime|
Inherited Elements from ReportRequest
The BudgetSummaryReportRequest object derives from the ReportRequest object, and inherits the following elements. The descriptions below are specific to BudgetSummaryReportRequest, and might not apply to other objects that inherit the same elements from the ReportRequest object.
|ExcludeColumnHeaders||Determines whether or not the downloaded report should contain header descriptions for each column. The report column header matches the requested column name e.g. Impressions and Clicks.
Set this property true if you want the report column headers excluded from the downloaded report. The default value is false.
|ExcludeReportFooter||Determines whether or not the downloaded report should contain footer metadata such as Microsoft copyright (@2017 Microsoft Corporation. All rights reserved.).
Set this property true if you want the report footer metadata excluded from the downloaded report. The default value is false.
|ExcludeReportHeader||Determines whether or not the downloaded report should contain header metadata such as report name, date range, and aggregation.
Set this property true if you want the report header metadata excluded from the downloaded report. The default value is false.
|Format||The 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.
All downloaded files are ZIP compressed.
|Language||The language to use to generate the report headers and columns.
The default is English.
|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.
The maximum length of the report name is 200.
|ReturnOnlyCompleteData||Determines 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.
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: