Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
AddAds
Collapse the table of content
Expand the table of content

AddAds Service Operation

System_CLiX_note Note

Version 10 of the Campaign Management service is in preview. The service and documentation are subject to change prior to general availability.

Adds one or more ads to an ad group.

Request | Response

Error Codes

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

AddAdsRequest Message

Request Body

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

AdGroupId

The identifier of the ad group to add the ads to.

long

Ads

An array of ads to add to the specified ad group. The maximum number of ads that you can add to an ad group is 50.

Ad array

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/v10">
    <Action mustUnderstand="1">AddAds</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>
    <AddAdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AdGroupId></AdGroupId>
      <Ads i:nil="false">
        <Ad i:type="-- specify derived type here with the appropriate prefix --">
          <DevicePreference i:nil="false"></DevicePreference>
          <EditorialStatus i:nil="false"></EditorialStatus>
          <FinalAppUrls xmlns:e11="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" i:nil="false">
            <e11:AppUrl>
              <e11:OsType i:nil="false"></e11:OsType>
              <e11:Url i:nil="false"></e11:Url>
            </e11:AppUrl>
          </FinalAppUrls>
          <FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalMobileUrls>
          <FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalUrls>
          <ForwardCompatibilityMap xmlns:e12="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e12:KeyValuePairOfstringstring>
              <e12:key i:nil="false"></e12:key>
              <e12:value i:nil="false"></e12:value>
            </e12:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false"></Id>
          <Status i:nil="false"></Status>
          <TrackingUrlTemplate i:nil="false"></TrackingUrlTemplate>
          <Type i:nil="false"></Type>
          <UrlCustomParameters xmlns:e13="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" i:nil="false">
            <e13:Parameters i:nil="false">
              <e13:CustomParameter>
                <e13:Key i:nil="false"></e13:Key>
                <e13:Value i:nil="false"></e13:Value>
              </e13:CustomParameter>
            </e13:Parameters>
          </UrlCustomParameters>
          <!--Keep these fields if you set the i:type attribute to TextAd-->
          <DestinationUrl i:nil="false"></DestinationUrl>
          <DisplayUrl i:nil="false"></DisplayUrl>
          <Text i:nil="false"></Text>
          <Title i:nil="false"></Title>
          <!--Keep these fields if you set the i:type attribute to ProductAd-->
          <PromotionalText i:nil="false"></PromotionalText>
        </Ad>
      </Ads>
    </AddAdsRequest>
  </s:Body>
</s:Envelope>

AddAdsResponse Message

Response Body

Element

Description

Data Type

AdIds

A list of unique system identifiers corresponding to the ads that were added.

The list of identifiers corresponds directly to the list of ads in the request. Items of the list may be returned as null. For each list index where an ad was not added, the corresponding element will be null.

long array

PartialErrors

An array of BatchError objects that contain details for any ads that were not successfully added.

The list of errors corresponds directly to the list of ads in the request. Items of the list may be returned as null. For each list index where an ad was successfully added, the corresponding error element will be null. Ideally all ads are added successfully and all elements in this list are null.

BatchError array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about 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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <AddAdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AdIds p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long></a1:long>
      </AdIds>
      <PartialErrors p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError p4:type="-- specify derived type here with the appropriate prefix --">
          <Code></Code>
          <Details p4:nil="false"></Details>
          <ErrorCode p4:nil="false"></ErrorCode>
          <FieldPath p4:nil="false"></FieldPath>
          <ForwardCompatibilityMap xmlns:e14="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e14:KeyValuePairOfstringstring>
              <e14:key p4:nil="false"></e14:key>
              <e14:value p4:nil="false"></e14:value>
            </e14:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index></Index>
          <Message p4:nil="false"></Message>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to EditorialError-->
          <Appealable p4:nil="false"></Appealable>
          <DisapprovedText p4:nil="false"></DisapprovedText>
          <Location p4:nil="false"></Location>
          <PublisherCountry p4:nil="false"></PublisherCountry>
          <ReasonCode></ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddAdsResponse>
  </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 Campaign Management 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:
© 2015 Microsoft