GetBulkUploadUrl Service Operation

 

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

Request | Response

Error Codes

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

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

Request Body

ElementDescriptionData Type
AccountIdThe account identifier corresponding to the data that will be uploaded.long
ResponseModeSpecify whether to return errors and their corresponding data, or only the errors in the results file. The default is ErrorsOnly.ResponseMode

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Managing User Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: This element is required.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: This element is required.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.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/v10">
    <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/v10">
      <ResponseMode></ResponseMode>
      <AccountId></AccountId>
    </GetBulkUploadUrlRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
RequestIdThe 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. .
string
UploadUrlThe 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.
string

Response Header

ElementDescriptionData Type
TrackingIdThe 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/v10">
    <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/v10">
      <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>

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

GetBulkUploadStatus

Show: