Export (0) Print
Expand All

GetDownloadStatus Service Operation

System_CLiX_note Note

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

Gets the status of a bulk download request.

Request | Response

Error Codes

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

GetDownloadStatusRequest Message

Request Element

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

Element

Description

Data Type

DownloadRequestId

The identifier of the download request.

The DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations return this identifier.

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">GetDownloadStatus</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>
    <GetDownloadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <DownloadRequestId i:nil="false"></DownloadRequestId>
    </GetDownloadStatusRequest>
  </s:Body>
</s:Envelope>

GetDownloadStatusResponse Message

Response Body

Element

Description

Data Type

DownloadUrl

The URL that contains the download data. This element contains the URL when the Status element is Success.

System_CLiX_note Note

You have five minutes from the time that GetDownloadStatus returns success to start downloading the file. If you do not start the download within this time period, you will need to call GetDownloadStatus again to get a new URL.

The download file is compressed (in zip format), so you must unzip the file to access the data.

For information about the bulk file format, see Bulk File Schema.

string

RequestStatus

The status of the download. The possible values are as follows.

Status

Description

Completed

The download completed successfully.

InProgress

The download is in progress.

Failed

The download failed. You may submit a new download with fewer entities, without performance data, or try again to submit the same download later.

FailedFullSyncRequired

The last sync time must be null.

The request's LastSyncTimeInUTC element must be set to null if the specified account was included in a data migration, for example the URL by match type migration. After requesting a full download, you may begin requesting delta downloads again.

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 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>
    <GetDownloadStatusResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <DownloadUrl p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></DownloadUrl>
      <RequestStatus p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></RequestStatus>
    </GetDownloadStatusResponse>
  </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.

Symbolic

InvalidCredentials

CampaignServiceInvalidDownloadRequestId

Community Additions

ADD
Show:
© 2014 Microsoft