PollGenerateReport Service-Vorgang – Berichterstellung
Ruft die status einer Berichtsanforderung ab.
Die Berichterstellung ist ein asynchroner Prozess. Es folgt der allgemeine Ablauf zum Anfordern eines Berichts.
- Erstellen Sie eine Anforderung mit den Berichtsparametern. Verwenden Sie nicht das ReportRequest-Objekt . Stattdessen müssen Sie eines der abgeleiteten Berichtsanforderungsobjekte verwenden, z. B. CampaignPerformanceReportRequest. Eine Liste der Berichte finden Sie im Leitfaden berichtstypen .
- Senden Sie eine Anforderung an den Berichtsdienst, d. h. über SubmitGenerateReport.
- Der Dienst stellt die Anforderung in die Warteschlange, bis er sie verarbeiten kann.
- Rufen Sie den Dienst in regelmäßigen Abständen ab, um die status des Berichtsauftrags zu erhalten, z. B. über PollGenerateReport
- Wenn die Abfrage statusErfolg lautet, verwenden Sie die URL, die der Dienst bereitstellt, um den Bericht herunterzuladen.
Weitere Informationen finden Sie im Leitfaden zum Anfordern und Herunterladen eines Berichts .
Hinweis
Sie müssen die gleichen Benutzeranmeldeinformationen für SubmitGenerateReport und PollGenerateReport verwenden.
Anfordern von Elementen
Das PollGenerateReportRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| ReportRequestId | Der Bezeichner der Berichtsanforderung. Der SubmitGenerateReport-Vorgang gibt den Bezeichner zurück. Der Bezeichner ist maximal einen Tag gültig. Wenn Sie die Datei innerhalb dieses Zeitraums nicht erfolgreich heruntergeladen haben, wird sie von der Downloadwebsite entfernt, und Sie müssen einen neuen Berichtsanforderungsbezeichner abrufen. Die Zeichenfolge hat eine Länge bis zu 40 und kann beliebige Zeichen enthalten. |
Zeichenfolge |
Anforderungsheaderelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| AuthenticationToken | Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Weitere Informationen finden Sie unter Authentifizierung mit OAuth. |
Zeichenfolge |
| CustomerAccountId | Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| CustomerId | Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| DeveloperToken | Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird. Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens. |
Zeichenfolge |
| Kennwort | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
| UserName | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
Antwortelemente
Das PollGenerateReportResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.
Antworttextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| ReportRequestStatus | Enthält die status der Berichtsanforderung und die Download-URL. | ReportRequestStatus |
Antwortheaderelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| TrackingId | Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. | Zeichenfolge |
SOAP anfordern
Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
<Action mustUnderstand="1">PollGenerateReport</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<PollGenerateReportRequest xmlns="https://bingads.microsoft.com/Reporting/v13">
<ReportRequestId i:nil="false">ValueHere</ReportRequestId>
</PollGenerateReportRequest>
</s:Body>
</s:Envelope>
Antwort-SOAP
Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<PollGenerateReportResponse xmlns="https://bingads.microsoft.com/Reporting/v13">
<ReportRequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<ReportDownloadUrl d4p1:nil="false">ValueHere</ReportDownloadUrl>
<Status>ValueHere</Status>
</ReportRequestStatus>
</PollGenerateReportResponse>
</s:Body>
</s:Envelope>
Codesyntax
Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .
public async Task<PollGenerateReportResponse> PollGenerateReportAsync(
string reportRequestId)
{
var request = new PollGenerateReportRequest
{
ReportRequestId = reportRequestId
};
return (await ReportingService.CallAsync((s, r) => s.PollGenerateReportAsync(r), request));
}
static PollGenerateReportResponse pollGenerateReport(
java.lang.String reportRequestId) throws RemoteException, Exception
{
PollGenerateReportRequest request = new PollGenerateReportRequest();
request.setReportRequestId(reportRequestId);
return ReportingService.getService().pollGenerateReport(request);
}
static function PollGenerateReport(
$reportRequestId)
{
$GLOBALS['Proxy'] = $GLOBALS['ReportingProxy'];
$request = new PollGenerateReportRequest();
$request->ReportRequestId = $reportRequestId;
return $GLOBALS['ReportingProxy']->GetService()->PollGenerateReport($request);
}
response=reporting_service.PollGenerateReport(
ReportRequestId=ReportRequestId)
Anforderungen
Dienst: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13
Anforderungs-URL
https://reporting.api.bingads.microsoft.com/Reporting/v13/GenerateReport/Poll
Anfordern von Elementen
Das PollGenerateReportRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| ReportRequestId | Der Bezeichner der Berichtsanforderung. Der SubmitGenerateReport-Vorgang gibt den Bezeichner zurück. Der Bezeichner ist maximal einen Tag gültig. Wenn Sie die Datei innerhalb dieses Zeitraums nicht erfolgreich heruntergeladen haben, wird sie von der Downloadwebsite entfernt, und Sie müssen einen neuen Berichtsanforderungsbezeichner abrufen. Die Zeichenfolge hat eine Länge bis zu 40 und kann beliebige Zeichen enthalten. |
Zeichenfolge |
Anforderungsheaderelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| Authorization | Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich. Weitere Informationen finden Sie unter Authentifizierung mit OAuth. |
Zeichenfolge |
| CustomerAccountId | Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| CustomerId | Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| DeveloperToken | Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird. Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens. |
Zeichenfolge |
| Kennwort | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
| UserName | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
Antwortelemente
Das PollGenerateReportResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.
Antworttextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| ReportRequestStatus | Enthält die status der Berichtsanforderung und die Download-URL. | ReportRequestStatus |
Antwortheaderelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| TrackingId | Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. | Zeichenfolge |
JSON anfordern
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .
{
"ReportRequestId": "ValueHere"
}
Antwort-JSON
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.
{
"ReportRequestStatus": {
"ReportDownloadUrl": "ValueHere",
"Status": "ValueHere"
}
}
Codesyntax
Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .
public async Task<PollGenerateReportResponse> PollGenerateReportAsync(
string reportRequestId)
{
var request = new PollGenerateReportRequest
{
ReportRequestId = reportRequestId
};
return (await ReportingService.CallAsync((s, r) => s.PollGenerateReportAsync(r), request));
}
static PollGenerateReportResponse pollGenerateReport(
java.lang.String reportRequestId) throws RemoteException, Exception
{
PollGenerateReportRequest request = new PollGenerateReportRequest();
request.setReportRequestId(reportRequestId);
return ReportingService.getService().pollGenerateReport(request);
}
static function PollGenerateReport(
$reportRequestId)
{
$GLOBALS['Proxy'] = $GLOBALS['ReportingProxy'];
$request = new PollGenerateReportRequest();
$request->ReportRequestId = $reportRequestId;
return $GLOBALS['ReportingProxy']->GetService()->PollGenerateReport($request);
}
response=reporting_service.PollGenerateReport(
ReportRequestId=ReportRequestId)