GetBulkUploadUrl Service Operation - Bulk

Article
03/20/2023

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

Request Elements

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

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 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 GetBulkUploadUrlResponse 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
RequestId	The identifier of the upload request. The identifier is valid for up to 15 minutes. If you have not successfully uploaded the file within this period, you will need to get a new request identifier and upload URL.	string
UploadUrl	The URL where you may submit your bulk upload file via HTTP POST. The upload URL is valid for up to 15 minutes. 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 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">GetBulkUploadUrl</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>
    <GetBulkUploadUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ResponseMode>ValueHere</ResponseMode>
      <AccountId>ValueHere</AccountId>
    </GetBulkUploadUrlRequest>
  </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>
    <GetBulkUploadUrlResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</RequestId>
      <UploadUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</UploadUrl>
    </GetBulkUploadUrlResponse>
  </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<GetBulkUploadUrlResponse> GetBulkUploadUrlAsync(
	ResponseMode responseMode,
	long accountId)
{
	var request = new GetBulkUploadUrlRequest
	{
		ResponseMode = responseMode,
		AccountId = accountId
	};

	return (await BulkService.CallAsync((s, r) => s.GetBulkUploadUrlAsync(r), request));
}

static GetBulkUploadUrlResponse getBulkUploadUrl(
	ResponseMode responseMode,
	java.lang.Long accountId) throws RemoteException, Exception
{
	GetBulkUploadUrlRequest request = new GetBulkUploadUrlRequest();

	request.setResponseMode(responseMode);
	request.setAccountId(accountId);

	return BulkService.getService().getBulkUploadUrl(request);
}

static function GetBulkUploadUrl(
	$responseMode,
	$accountId)
{

	$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];

	$request = new GetBulkUploadUrlRequest();

	$request->ResponseMode = $responseMode;
	$request->AccountId = $accountId;

	return $GLOBALS['BulkProxy']->GetService()->GetBulkUploadUrl($request);
}

response=bulk_service.GetBulkUploadUrl(
	ResponseMode=ResponseMode,
	AccountId=AccountId)

Requirements

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

Share via