GetBulkUploadStatus Service Operation - Bulk
Gets the status and completion progress of a bulk upload request.
Request Elements
The GetBulkUploadStatusRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetBulkUploadStatusResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Errors | An array of OperationError objects corresponding to errors encountered during the system processing of the bulk file after your HTTP POST upload completed. For example, an OperationError would include the BulkServiceFormatVersionNotSupported error code if the uploaded file contains one or more bulk records that are not supported with the corresponding file format version. |
OperationError array |
| ForwardCompatibilityMap | The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this operation. |
KeyValuePairOfstringstring array |
| PercentComplete | The progress completion percentage for system processing of the uploaded bulk file. The value range is between 0 and 100. You should also compare the upload status. If the upload fails, the percent complete will reset to zero (0). |
int |
| RequestStatus | The status of the upload. The following are the possible returned status values. Completed - The upload file was accepted and processed successfully without errors. CompletedWithErrors - The upload completed with one or more errors. While the overall upload was successful, one or more add or update errors could have occurred. As a best practice you should request error information via the ResponseMode element when calling GetBulkUploadUrl and check the ResultFileUrl for any errors. Failed - The entire upload failed due to an unexpected error. You may submit a new upload with fewer entities or try again to submit the same upload later. FileUploaded - The upload request has been received and is in the queue for processing. InProgress - The upload file has been accepted and the upload is in progress. PendingFileUpload - The upload file has not been received for the corresponding RequestId. UploadFileRowCountExceeded - The limit of bulk records in the upload file has been exceeded. For more information about limits and upload best practices, see Bulk Upload. UploadFileFormatNotSupported - The Format Version Name field specified in the upload is not supported for this version of the Bulk API. |
string |
| ResultFileUrl | The URL of the file that contains the requested results, for example upload error information. The URL must be used within five minutes of the time that the GetBulkUploadStatus operation returns the Completed or CompletedWithErrors status response string. If you do not start the download within this period of time, you will need to call GetBulkUploadStatus again to get a new URL. You should not take a dependency on the domain of the download URL, as it is subject to change. |
string |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<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>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)
Requirements
Service: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://bulk.api.bingads.microsoft.com/Bulk/v13/BulkUploadStatus/Query
Request Elements
The GetBulkUploadStatusRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetBulkUploadStatusResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Errors | An array of OperationError objects corresponding to errors encountered during the system processing of the bulk file after your HTTP POST upload completed. For example, an OperationError would include the BulkServiceFormatVersionNotSupported error code if the uploaded file contains one or more bulk records that are not supported with the corresponding file format version. |
OperationError array |
| ForwardCompatibilityMap | The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this operation. |
KeyValuePairOfstringstring array |
| PercentComplete | The progress completion percentage for system processing of the uploaded bulk file. The value range is between 0 and 100. You should also compare the upload status. If the upload fails, the percent complete will reset to zero (0). |
int |
| RequestStatus | The status of the upload. The following are the possible returned status values. Completed - The upload file was accepted and processed successfully without errors. CompletedWithErrors - The upload completed with one or more errors. While the overall upload was successful, one or more add or update errors could have occurred. As a best practice you should request error information via the ResponseMode element when calling GetBulkUploadUrl and check the ResultFileUrl for any errors. Failed - The entire upload failed due to an unexpected error. You may submit a new upload with fewer entities or try again to submit the same upload later. FileUploaded - The upload request has been received and is in the queue for processing. InProgress - The upload file has been accepted and the upload is in progress. PendingFileUpload - The upload file has not been received for the corresponding RequestId. UploadFileRowCountExceeded - The limit of bulk records in the upload file has been exceeded. For more information about limits and upload best practices, see Bulk Upload. UploadFileFormatNotSupported - The Format Version Name field specified in the upload is not supported for this version of the Bulk API. |
string |
| ResultFileUrl | The URL of the file that contains the requested results, for example upload error information. The URL must be used within five minutes of the time that the GetBulkUploadStatus operation returns the Completed or CompletedWithErrors status response string. If you do not start the download within this period of time, you will need to call GetBulkUploadStatus again to get a new URL. You should not take a dependency on the domain of the download URL, as it is subject to change. |
string |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"RequestId": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{
"Errors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"Message": "ValueHere"
}
],
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"PercentComplete": IntValueHere,
"RequestStatus": "ValueHere",
"ResultFileUrl": "ValueHere"
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)