AddMedia Service Operation - Campaign Management

Adds the specified media to an account's asset library.

Depending on the type of Media, you can then add the media to one or more ImageAdExtension or ResponsiveAd objects.

Request Elements

The AddMediaRequest 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 identifier of the account that owns the asset library.	long
Media	An array of Media to add to the account's asset library. You can add a maximum of 10 media in a single call.	Media array

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 AddMediaResponse 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
MediaIds	The identifiers of the media that you added to the library. You use the identifier to set the appropriate media ID field in the ImageAdExtension or ResponsiveAd object. You can get the media indentifiers for image ad extensions and responsive ads with the GetMediaMetaDataByAccountId and GetMediaMetaDataByIds operations.	long array

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">AddMedia</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>
    <AddMediaRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <Media i:nil="false">
        <Media i:type="-- derived type specified here with the appropriate prefix --">
          <Id i:nil="false">ValueHere</Id>
          <MediaType i:nil="false">ValueHere</MediaType>
          <Text i:nil="false">ValueHere</Text>
          <Type i:nil="false">ValueHere</Type>
          <!--This field is applicable if the derived type attribute is set to Image-->
          <Data i:nil="false">ValueHere</Data>
        </Media>
      </Media>
    </AddMediaRequest>
  </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>
    <AddMediaResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MediaIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </MediaIds>
    </AddMediaResponse>
  </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<AddMediaResponse> AddMediaAsync(
	long accountId,
	IList<Media> media)
{
	var request = new AddMediaRequest
	{
		AccountId = accountId,
		Media = media
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddMediaAsync(r), request));
}

static AddMediaResponse addMedia(
	java.lang.Long accountId,
	ArrayOfMedia media) throws RemoteException, Exception
{
	AddMediaRequest request = new AddMediaRequest();

	request.setAccountId(accountId);
	request.setMedia(media);

	return CampaignManagementService.getService().addMedia(request);
}

static function AddMedia(
	$accountId,
	$media)
{

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

	$request = new AddMediaRequest();

	$request->AccountId = $accountId;
	$request->Media = $media;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddMedia($request);
}

response=campaignmanagement_service.AddMedia(
	AccountId=AccountId,
	Media=Media)

Requirements

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

Request Url

Production URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Media

Sandbox URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/Media

Request Elements

The AddMediaRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
AccountId	The identifier of the account that owns the asset library.	long
Media	An array of Media to add to the account's asset library. You can add a maximum of 10 media in a single call.	Media array

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. 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 AddMediaResponse 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 JSON.

Response Body Elements

Element	Description	Data Type
MediaIds	The identifiers of the media that you added to the library. You use the identifier to set the appropriate media ID field in the ImageAdExtension or ResponsiveAd object. You can get the media indentifiers for image ad extensions and responsive ads with the GetMediaMetaDataByAccountId and GetMediaMetaDataByIds operations.	long array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

Below is an example that is applicable if the type of Media is Image.

{
  "AccountId": "LongValueHere",
  "Media": [
    {
      "Id": "LongValueHere",
      "MediaType": "ValueHere",
      "Text": "ValueHere",
      "Type": "Image",
      "Data": "ValueHere"
    }
  ]
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "MediaIds": [
    "LongValueHere"
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<AddMediaResponse> AddMediaAsync(
	long accountId,
	IList<Media> media)
{
	var request = new AddMediaRequest
	{
		AccountId = accountId,
		Media = media
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddMediaAsync(r), request));
}

static AddMediaResponse addMedia(
	java.lang.Long accountId,
	ArrayOfMedia media) throws RemoteException, Exception
{
	AddMediaRequest request = new AddMediaRequest();

	request.setAccountId(accountId);
	request.setMedia(media);

	return CampaignManagementService.getService().addMedia(request);
}

static function AddMedia(
	$accountId,
	$media)
{

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

	$request = new AddMediaRequest();

	$request->AccountId = $accountId;
	$request->Media = $media;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddMedia($request);
}

response=campaignmanagement_service.AddMedia(
	AccountId=AccountId,
	Media=Media)