GetBulkDownloadStatus-Dienstvorgang – Massenvorgang
Ruft die status einer Massendownloadanforderung ab.
Hinweis
Sie müssen die gleichen Benutzeranmeldeinformationen für den Downloadanforderungsvorgang (entweder DownloadCampaignsByAccountIds oder DownloadCampaignsByCampaignIds) und den GetBulkDownloadStatus-Abrufvorgang verwenden.
Anfordern von Elementen
Das GetBulkDownloadStatusRequest-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 |
|---|---|---|
| Anfrage-ID | Der Bezeichner der Downloadanforderung. Die Vorgänge DownloadCampaignsByAccountIds und DownloadCampaignsByCampaignIds geben dieses Element als DownloadRequestId zurück. Der Bezeichner ist maximal zwei Tage gültig. Wenn Sie die Datei innerhalb dieses Zeitraums nicht erfolgreich heruntergeladen haben, wird sie von der Downloadwebsite entfernt, und Sie müssen eine neue Downloadanforderungs-ID 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 GetBulkDownloadStatusResponse-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 |
|---|---|---|
| Fehler | Ein Array von OperationError-Objekten , die Fehlern entsprechen, die bei der Systemverarbeitung der Massendatei nach dem Übermitteln der Downloadanforderung aufgetreten sind. | OperationError-Array |
| ForwardCompatibilityMap | Die Liste der Schlüssel- und Wertzeichenfolgen für die Vorwärtskompatibilität, um andere Breaking Changes zu vermeiden, wenn neue Elemente in der aktuellen API-Version hinzugefügt werden. Änderungen an der Vorwärtskompatibilität werden in zukünftigen Versionen hier notiert. Es gibt derzeit keine Änderungen an der Forward-Kompatibilität für diesen Vorgang. |
KeyValuePairOfstring-Array |
| PercentComplete | Der Prozentsatz des Statusabschlusses für die Systemverarbeitung der Massendownloaddatei. | int |
| RequestStatus | Die status des Downloads. Die möglichen Werte sind wie folgt. Abgeschlossen: Der Download wurde erfolgreich abgeschlossen. InProgress: Der Download wird ausgeführt. Fehler: Fehler beim Herunterladen. Sie können einen neuen Download mit weniger Entitäten ohne Qualitätsbewertung und Gebotsvorschläge übermitteln oder denselben Download später erneut übermitteln. FailedFullSyncRequired: Das LastSyncTimeInUTC-Element der Anforderung muss auf NULL festgelegt werden, z. B. wenn das angegebene Konto in eine Datenmigration einbezogen wurde. Nachdem Sie einen vollständigen Download angefordert haben, können Sie erneut Deltadownloads anfordern. |
Zeichenfolge |
| ResultFileUrl | Die URL, die die Downloaddaten enthält, wenn der RequestStatus-WertAbgeschlossen ist. Nach der Rückgabe dieser URL haben Sie fünf Minuten Zeit, um die Datei herunterzuladen. Wenn Sie den Download nicht innerhalb dieses Zeitraums starten, müssen Sie GetBulkDownloadStatus erneut aufrufen, um eine neue URL zu erhalten. Sie sollten keine Abhängigkeit von der Domäne der Download-URL übernehmen, da sie sich ändern kann. Die Downloaddatei ist komprimiert (im ZIP-Format), sodass Sie die Datei entzippen müssen, um auf die Daten zuzugreifen. Informationen zum Massendateiformat finden Sie unter Massendateischema. |
Zeichenfolge |
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/CampaignManagement/v13">
<Action mustUnderstand="1">GetBulkDownloadStatus</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>
<GetBulkDownloadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<RequestId i:nil="false">ValueHere</RequestId>
</GetBulkDownloadStatusRequest>
</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/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetBulkDownloadStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Errors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<OperationError>
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<Message d4p1:nil="false">ValueHere</Message>
</OperationError>
</Errors>
<ForwardCompatibilityMap xmlns:e143="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e143:KeyValuePairOfstringstring>
<e143:key d4p1:nil="false">ValueHere</e143:key>
<e143:value d4p1:nil="false">ValueHere</e143:value>
</e143:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<PercentComplete>ValueHere</PercentComplete>
<RequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</RequestStatus>
<ResultFileUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</ResultFileUrl>
</GetBulkDownloadStatusResponse>
</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<GetBulkDownloadStatusResponse> GetBulkDownloadStatusAsync(
string requestId)
{
var request = new GetBulkDownloadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkDownloadStatusAsync(r), request));
}
static GetBulkDownloadStatusResponse getBulkDownloadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkDownloadStatusRequest request = new GetBulkDownloadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkDownloadStatus(request);
}
static function GetBulkDownloadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkDownloadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkDownloadStatus($request);
}
response=bulk_service.GetBulkDownloadStatus(
RequestId=RequestId)
Anforderungen
Dienst: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Anforderungs-URL
https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkDownloadStatus/Query
Anfordern von Elementen
Das GetBulkDownloadStatusRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| Anfrage-ID | Der Bezeichner der Downloadanforderung. Die Vorgänge DownloadCampaignsByAccountIds und DownloadCampaignsByCampaignIds geben dieses Element als DownloadRequestId zurück. Der Bezeichner ist maximal zwei Tage gültig. Wenn Sie die Datei innerhalb dieses Zeitraums nicht erfolgreich heruntergeladen haben, wird sie von der Downloadwebsite entfernt, und Sie müssen eine neue Downloadanforderungs-ID 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 GetBulkDownloadStatusResponse-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 |
|---|---|---|
| Fehler | Ein Array von OperationError-Objekten , die Fehlern entsprechen, die bei der Systemverarbeitung der Massendatei nach dem Übermitteln der Downloadanforderung aufgetreten sind. | OperationError-Array |
| ForwardCompatibilityMap | Die Liste der Schlüssel- und Wertzeichenfolgen für die Vorwärtskompatibilität, um andere Breaking Changes zu vermeiden, wenn neue Elemente in der aktuellen API-Version hinzugefügt werden. Änderungen an der Vorwärtskompatibilität werden in zukünftigen Versionen hier notiert. Es gibt derzeit keine Änderungen an der Forward-Kompatibilität für diesen Vorgang. |
KeyValuePairOfstring-Array |
| PercentComplete | Der Prozentsatz des Statusabschlusses für die Systemverarbeitung der Massendownloaddatei. | int |
| RequestStatus | Die status des Downloads. Die möglichen Werte sind wie folgt. Abgeschlossen: Der Download wurde erfolgreich abgeschlossen. InProgress: Der Download wird ausgeführt. Fehler: Fehler beim Herunterladen. Sie können einen neuen Download mit weniger Entitäten ohne Qualitätsbewertung und Gebotsvorschläge übermitteln oder denselben Download später erneut übermitteln. FailedFullSyncRequired: Das LastSyncTimeInUTC-Element der Anforderung muss auf NULL festgelegt werden, z. B. wenn das angegebene Konto in eine Datenmigration einbezogen wurde. Nachdem Sie einen vollständigen Download angefordert haben, können Sie erneut Deltadownloads anfordern. |
Zeichenfolge |
| ResultFileUrl | Die URL, die die Downloaddaten enthält, wenn der RequestStatus-WertAbgeschlossen ist. Nach der Rückgabe dieser URL haben Sie fünf Minuten Zeit, um die Datei herunterzuladen. Wenn Sie den Download nicht innerhalb dieses Zeitraums starten, müssen Sie GetBulkDownloadStatus erneut aufrufen, um eine neue URL zu erhalten. Sie sollten keine Abhängigkeit von der Domäne der Download-URL übernehmen, da sie sich ändern kann. Die Downloaddatei ist komprimiert (im ZIP-Format), sodass Sie die Datei entzippen müssen, um auf die Daten zuzugreifen. Informationen zum Massendateiformat finden Sie unter Massendateischema. |
Zeichenfolge |
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 .
{
"RequestId": "ValueHere"
}
Antwort-JSON
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.
{
"Errors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"Message": "ValueHere"
}
],
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"PercentComplete": IntValueHere,
"RequestStatus": "ValueHere",
"ResultFileUrl": "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<GetBulkDownloadStatusResponse> GetBulkDownloadStatusAsync(
string requestId)
{
var request = new GetBulkDownloadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkDownloadStatusAsync(r), request));
}
static GetBulkDownloadStatusResponse getBulkDownloadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkDownloadStatusRequest request = new GetBulkDownloadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkDownloadStatus(request);
}
static function GetBulkDownloadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkDownloadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkDownloadStatus($request);
}
response=bulk_service.GetBulkDownloadStatus(
RequestId=RequestId)