Export (0) Print
Expand All

GetBulkUploadUrl Service Operation

Submits a request for a URL where a bulk upload file may be posted.

Request | Response

Error Codes

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

GetBulkUploadUrlRequest Message

The GetBulkUploadUrlRequest 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

AccountId

The account identifier corresponding to the data that will be uploaded.

long

ResponseMode

Specify whether to return errors and their corresponding data, or only the errors in the results file. The default is ErrorsOnly.

ResponseMode

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">GetBulkUploadUrl</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>
    <GetBulkUploadUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <ResponseMode></ResponseMode>
      <AccountId></AccountId>
    </GetBulkUploadUrlRequest>
  </s:Body>
</s:Envelope>

GetBulkUploadUrlResponse Message

Response Body

Element

Description

Data Type

RequestId

The identifier of the upload request.

The identifier is valid for a maximum of two days. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL. For more information, see Bulk Upload.

string

UploadUrl

The URL where you may submit your bulk upload file with HTTP POST.

The upload URL is valid for a maximum of two days. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL. For more information, see Bulk Upload.

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

Community Additions

ADD
Show:
© 2014 Microsoft