GetBulkUploadStatus-Dienstvorgang – Massenvorgang
Ruft den status und den Abschlussstatus einer Massenuploadanforderung ab.
Anfordern von Elementen
Das GetBulkUploadStatusRequest-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
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 GetBulkUploadStatusResponse-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 abschluss des HTTP POST-Uploads aufgetreten sind. Beispielsweise würde ein OperationError den Fehlercode BulkServiceFormatVersionNotSupported enthalten, wenn die hochgeladene Datei einen oder mehrere Massendatensätze enthält, die von der entsprechenden Dateiformatversion nicht unterstützt werden. |
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 hochgeladenen Massendatei. Der Wertbereich liegt zwischen 0 und 100. Sie sollten auch die Upload-status vergleichen. Wenn der Upload fehlschlägt, wird der Prozentsatz abgeschlossen auf null (0) zurückgesetzt. |
int |
| RequestStatus | Die status des Uploads. Im Folgenden werden die möglichen status Werte zurückgegeben. Abgeschlossen: Die Uploaddatei wurde akzeptiert und ohne Fehler erfolgreich verarbeitet. CompletedWithErrors: Der Upload wurde mit einem oder mehreren Fehlern abgeschlossen. Während der gesamte Upload erfolgreich war, ist möglicherweise ein oder mehrere Fehler beim Hinzufügen oder Aktualisieren aufgetreten. Als bewährte Methode sollten Sie fehlerinformationen über das ResponseMode-Element anfordern, wenn Sie GetBulkUploadUrl aufrufen und die ResultFileUrl auf Fehler überprüfen. Fehler: Der gesamte Upload ist aufgrund eines unerwarteten Fehlers fehlgeschlagen. Sie können einen neuen Upload mit weniger Entitäten übermitteln oder später erneut versuchen, denselben Upload zu übermitteln. FileUploaded: Die Uploadanforderung wurde empfangen und befindet sich zur Verarbeitung in der Warteschlange. InProgress: Die Uploaddatei wurde akzeptiert, und der Upload wird ausgeführt. PendingFileUpload: Die Uploaddatei wurde für die entsprechende RequestId nicht empfangen. UploadFileRowCountExceeded: Der Grenzwert für Massendatensätze in der Uploaddatei wurde überschritten. Weitere Informationen zu Grenzwerten und bewährten Methoden zum Hochladen finden Sie unter Massenupload. UploadFileFormatNotSupported: Das im Upload angegebene Feld Formatversionsname wird für diese Version der Massen-API nicht unterstützt. |
Zeichenfolge |
| ResultFileUrl | Die URL der Datei, die die angeforderten Ergebnisse enthält, z. B. Uploadfehlerinformationen. Die URL muss innerhalb von fünf Minuten nach dem Zeitpunkt verwendet werden, zu dem der GetBulkUploadStatus-Vorgang die Antwortzeichenfolge Completed oder CompletedWithErrors status zurückgibt. Wenn Sie den Download nicht innerhalb dieses Zeitraums starten, müssen Sie GetBulkUploadStatus 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. |
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">GetBulkUploadStatus</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>
<GetBulkUploadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<RequestId i:nil="false">ValueHere</RequestId>
</GetBulkUploadStatusRequest>
</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>
<GetBulkUploadStatusResponse 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:e455="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e455:KeyValuePairOfstringstring>
<e455:key d4p1:nil="false">ValueHere</e455:key>
<e455:value d4p1:nil="false">ValueHere</e455:value>
</e455: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>
</GetBulkUploadStatusResponse>
</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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
string requestId)
{
var request = new GetBulkUploadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkUploadStatusAsync(r), request));
}
static GetBulkUploadStatusResponse getBulkUploadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkUploadStatus(request);
}
static function GetBulkUploadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkUploadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkUploadStatus($request);
}
response=bulk_service.GetBulkUploadStatus(
RequestId=RequestId)
Anforderungen
Dienst: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Anforderungs-URL
https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkUploadStatus/Query
Anfordern von Elementen
Das GetBulkUploadStatusRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
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 GetBulkUploadStatusResponse-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 abschluss des HTTP POST-Uploads aufgetreten sind. Beispielsweise würde ein OperationError den Fehlercode BulkServiceFormatVersionNotSupported enthalten, wenn die hochgeladene Datei einen oder mehrere Massendatensätze enthält, die von der entsprechenden Dateiformatversion nicht unterstützt werden. |
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 hochgeladenen Massendatei. Der Wertbereich liegt zwischen 0 und 100. Sie sollten auch die Upload-status vergleichen. Wenn der Upload fehlschlägt, wird der Prozentsatz abgeschlossen auf null (0) zurückgesetzt. |
int |
| RequestStatus | Die status des Uploads. Im Folgenden werden die möglichen status Werte zurückgegeben. Abgeschlossen: Die Uploaddatei wurde akzeptiert und ohne Fehler erfolgreich verarbeitet. CompletedWithErrors: Der Upload wurde mit einem oder mehreren Fehlern abgeschlossen. Während der gesamte Upload erfolgreich war, ist möglicherweise ein oder mehrere Fehler beim Hinzufügen oder Aktualisieren aufgetreten. Als bewährte Methode sollten Sie fehlerinformationen über das ResponseMode-Element anfordern, wenn Sie GetBulkUploadUrl aufrufen und die ResultFileUrl auf Fehler überprüfen. Fehler: Der gesamte Upload ist aufgrund eines unerwarteten Fehlers fehlgeschlagen. Sie können einen neuen Upload mit weniger Entitäten übermitteln oder später erneut versuchen, denselben Upload zu übermitteln. FileUploaded: Die Uploadanforderung wurde empfangen und befindet sich zur Verarbeitung in der Warteschlange. InProgress: Die Uploaddatei wurde akzeptiert, und der Upload wird ausgeführt. PendingFileUpload: Die Uploaddatei wurde für die entsprechende RequestId nicht empfangen. UploadFileRowCountExceeded: Der Grenzwert für Massendatensätze in der Uploaddatei wurde überschritten. Weitere Informationen zu Grenzwerten und bewährten Methoden zum Hochladen finden Sie unter Massenupload. UploadFileFormatNotSupported: Das im Upload angegebene Feld Formatversionsname wird für diese Version der Massen-API nicht unterstützt. |
Zeichenfolge |
| ResultFileUrl | Die URL der Datei, die die angeforderten Ergebnisse enthält, z. B. Uploadfehlerinformationen. Die URL muss innerhalb von fünf Minuten nach dem Zeitpunkt verwendet werden, zu dem der GetBulkUploadStatus-Vorgang die Antwortzeichenfolge Completed oder CompletedWithErrors status zurückgibt. Wenn Sie den Download nicht innerhalb dieses Zeitraums starten, müssen Sie GetBulkUploadStatus 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. |
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<GetBulkUploadStatusResponse> GetBulkUploadStatusAsync(
string requestId)
{
var request = new GetBulkUploadStatusRequest
{
RequestId = requestId
};
return (await BulkService.CallAsync((s, r) => s.GetBulkUploadStatusAsync(r), request));
}
static GetBulkUploadStatusResponse getBulkUploadStatus(
java.lang.String requestId) throws RemoteException, Exception
{
GetBulkUploadStatusRequest request = new GetBulkUploadStatusRequest();
request.setRequestId(requestId);
return BulkService.getService().getBulkUploadStatus(request);
}
static function GetBulkUploadStatus(
$requestId)
{
$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];
$request = new GetBulkUploadStatusRequest();
$request->RequestId = $requestId;
return $GLOBALS['BulkProxy']->GetService()->GetBulkUploadStatus($request);
}
response=bulk_service.GetBulkUploadStatus(
RequestId=RequestId)