Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

GetBulkUploadStatus Service Operation

System_CLiX_note Note

This operation is deprecated, and you should use GetDetailedBulkUploadStatus instead.

Gets the status of a bulk upload request.

Request | Response

Error Codes

Service: BulkService.svc v9 | Namespace: https://bingads.microsoft.com/CampaignManagement/v9

GetBulkUploadStatusRequest Message

The GetBulkUploadStatusRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Request Body

Element

Description

Data Type

RequestId

The identifier of the upload request.

string

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<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/v9">
    <Action mustUnderstand="1">GetBulkUploadStatus</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetBulkUploadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <RequestId i:nil="false"></RequestId>
    </GetBulkUploadStatusRequest>
  </s:Body>
</s:Envelope>

GetBulkUploadStatusResponse Message

Response Body

Element

Description

Data Type

RequestStatus

The status of the upload. The following are the possible returned status values.

Status

Description

Completed

The upload file was accepted and processed successfully without errors.

CompletedWithErrors

The upload completed with one or more errors.

System_CLiX_note Note

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.

string

ResultFileUrl

The URL of the file that contains the requested results, for example upload error information.

System_CLiX_note Note

The URL must be used within five minutes of the time that the GetBulkUploadStatus operation returns the Completed 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.

string

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of the API call.

string

Response SOAP

The following example shows the complete SOAP response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetBulkUploadStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <RequestStatus p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></RequestStatus>
      <ResultFileUrl p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></ResultFileUrl>
    </GetBulkUploadStatusResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Bulk Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

BulkServiceInvalidRequestId

Community Additions

ADD
Show:
© 2015 Microsoft