ReportRequest-Datenobjekt – Berichterstellung
Definiert das Basisobjekt für alle Berichtsanforderungen.
Instanziieren Sie dieses Objekt nicht. Stattdessen können Sie eines der Berichtsanforderungsobjekte instanziieren, die von diesem Objekt abgeleitet sind, z. B. CampaignPerformanceReportRequest. Eine Liste der Berichte finden Sie im Leitfaden berichtstypen .
Syntax
<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>
Elemente
Das ReportRequest-Objekt verfügt über die folgenden Elemente: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData.
| Element | Beschreibung | Datentyp |
|---|---|---|
| ExcludeColumnHeaders | Bestimmt, ob der heruntergeladene Bericht Headerbeschreibungen für jede Spalte enthalten soll. Die Berichtsspaltenüberschrift entspricht dem angeforderten Spaltennamen, z. B. Impressionen und Klicks. Legen Sie diese Eigenschaft auf true fest, wenn die Berichtsspaltenüberschriften aus dem heruntergeladenen Bericht ausgeschlossen werden sollen. Der Standardwert ist false. |
boolean |
| ExcludeReportFooter | Bestimmt, ob der heruntergeladene Bericht Fußzeilenmetadaten wie Microsoft Copyright (@2020 Microsoft Corporation) enthalten soll. Alle Rechte vorbehalten.). Legen Sie diese Eigenschaft auf true fest, wenn die Metadaten der Berichtsfußzeile aus dem heruntergeladenen Bericht ausgeschlossen werden sollen. Der Standardwert ist false. |
boolean |
| ExcludeReportHeader | Bestimmt, ob der heruntergeladene Bericht Headermetadaten wie Berichtsname, Datumsbereich und Aggregation enthalten soll. Legen Sie diese Eigenschaft auf true fest, wenn die Berichtsheadermetadaten aus dem heruntergeladenen Bericht ausgeschlossen werden sollen. Der Standardwert ist false. |
boolean |
| Format | Das Format der Berichtsdaten. Sie können die Daten beispielsweise im Csv-Format (Durch Trennzeichen getrennte Werte) oder im Tsv-Format (Tsv) anfordern. Der Standardwert ist CSV. Alle heruntergeladenen Dateien sind ZIP-komprimiert. |
ReportFormat |
| Formatversion | Bestimmt das Format für bestimmte Felder in der heruntergeladenen Berichtsdatei. Das Datenformat für bestimmte Felder kann innerhalb der aktuellen API-Version aktualisiert werden, ohne vorhandene Clientanwendungen zu unterbrechen. Sie können das neueste Datenformat abrufen, indem Sie dieses optionale Anforderungsfeld auf 2.0 festlegen. Wenn Sie dieses Feld nicht festlegen, wird für den Dienst standardmäßig Version 1.0 verwendet. Ausführliche Informationen zu Änderungen zwischen Formatversionen finden Sie unter Version des Berichtsformats. |
Zeichenfolge |
| ReportName | Der Name des Berichts. Der Name ist im Berichtsheader enthalten. Wenn Sie keinen Berichtsnamen angeben, generiert das System einen Namen im Formular ReportType-ReportDateTime. Die maximale Länge des Berichtsnamens beträgt 200. |
Zeichenfolge |
| ReturnOnlyCompleteData | Bestimmt, ob der Dienst sicherstellen muss, dass alle Daten verarbeitet wurden und verfügbar sind. Bei Festlegung auf true und wenn das System die Verarbeitung aller Daten basierend auf der angeforderten Aggregation, dem Umfang und der angeforderten Zeit noch nicht abgeschlossen hat, gibt der Dienst den Fehlercode NoCompleteDataAvaliable (2004) zurück. Andernfalls kann die Anforderung standardmäßig erfolgreich sein, es gibt keinen Hinweis darauf, ob die Daten vollständig sind, und der Bericht enthält nur die Daten, die das System zum Zeitpunkt der Anforderung verarbeitet hat. Bitte beachten Sie, dass Sie dieses Element nicht auf "true" festlegen können, wenn der Zeitraum (ob benutzerdefiniertes oder vordefiniertes Datum) das heutige Datum enthält, da heute noch ausgeführt wird und die Daten nicht vollständig sind. Weitere Informationen finden Sie unter Zeitzonen in der Berichterstellung. |
boolean |
Anforderungen
Dienst: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13