CampaignPerformanceReportRequest-Datenobjekt – Berichterstellung

Artikel
12/21/2023

Definiert eine Anforderung eines Kampagnenleistungsberichts. Verwenden Sie diesen Bericht, um allgemeine Leistungsstatistiken und Qualitätsattribute für jede Kampagne oder jedes Konto anzuzeigen. Dies ist auch eine schnelle Möglichkeit, wichtige Kampagnen- oder Kontoprobleme zu kennzeichnen.

Sie können Impressionen, Impressionen (%), Klicks, Ausgaben und durchschnittliche Kosten pro Klick für jede Kampagne oder jedes Konto anfordern. Nach dem Herunterladen können diese Daten nach Kampagne, Kampagnen-status und Qualitätsbewertung sortiert werden.

Um einen Bericht dieses Typs anzufordern, übergeben Sie dieses Objekt an den SubmitGenerateReport-Vorgang .

Syntax

<xs:complexType name="CampaignPerformanceReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:ReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfCampaignPerformanceReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:CampaignPerformanceReportFilter" />
        <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>

Elemente

Das CampaignPerformanceReportRequest-Objekt verfügt über die folgenden Elemente: Aggregation, Columns, Filter, Scope, Time.

Element	Beschreibung	Datentyp
Aggregation	Der Aggregationstyp, der zum Aggregieren der Berichtsdaten verwendet werden soll. Beispielsweise können Sie die Berichtsdaten nach Tag oder Woche aggregieren oder einen Zusammenfassungsbericht anfordern. Die Standardaggregation ist Zusammenfassung. Beachten Sie folgendes: Wenn Sie TimePeriod nicht in die Liste der Spalten aufnehmen, wird die ausgewählte Aggregation ignoriert, und die Zusammenfassungsaggregation wird unabhängig davon verwendet.	ReportAggregation
Spalten	Die Liste der Attribute und Leistungsstatistiken, die in den Bericht aufgenommen werden sollen. Der Bericht enthält die Spalten in der Reihenfolge, in der Sie sie angeben.	CampaignPerformanceReportColumn-Array
Filter	Die Filterinformationen, die zum Filtern der Berichtsdaten verwendet werden sollen.	CampaignPerformanceReportFilter
Bereich	Der Entitätsbereich des Berichts. Verwenden Sie dieses Element, um die Berichtsdaten auf bestimmte Konten oder Kampagnen zu beschränken.	AccountThroughCampaignReportScope
Zeit	Der Zeitraum, der für den Bericht verwendet werden soll. Sie können einen benutzerdefinierten Datumsbereich angeben oder einen vordefinierten Datumsbereich auswählen, z. B. Heute oder ThisWeek. Eine Liste der Zeiträume, die Sie für jeden Aggregationstyp angeben können, finden Sie unter Aggregation und Zeit. Sie können die Zeitzone innerhalb des ReportTime-Objekts festlegen, sodass Sie Daten für den angeforderten Zeitraum genau festlegen können. Wenn Sie keine Zeitzone auswählen, verwendet der Berichtsdienst standardmäßig PacificTimeUSCanadaTijuana.	ReportTime

Das CampaignPerformanceReportRequest-Objekt verfügt über geerbte Elemente.

Geerbte Elemente

Geerbte Elemente von ReportRequest

Das CampaignPerformanceReportRequest-Objekt wird vom ReportRequest-Objekt abgeleitet und erbt die folgenden Elemente: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. Die folgenden Beschreibungen gelten spezifisch für CampaignPerformanceReportRequest und gelten möglicherweise nicht für andere Objekte, die dieselben Elemente vom ReportRequest-Objekt erben.

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. Wenn true festgelegt ist und das System die Verarbeitung aller Daten basierend auf der angeforderten Aggregation, dem Bereich 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. 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