UpdateAds Service Operation

 

Updates the specified ads within an ad group.

System_CAPS_ICON_important.jpg Important

Standard Text Ads have been deprecated in favor of Expanded Text Ads (EXTAs). Support for adding and updating standard text ads (STAs) ended on July 31, 2017. Now, advertisers can get and delete, but can no longer add new STAs or update existing standard text ads with Destination URLs. One exception to the rule, is that you can still update the STA status e.g. from Active to Paused. Otherwise attempts to add or update STAs will result in the CampaignServiceAdTypeInvalid error.

It is important to note that all your existing STAs will continue to serve alongside EXTAs for the foreseeable future. While there is no date on when STAs will stop serving, you can expect an update to all of our customers well in advance once we make the decision to sunset serving STAs.

Request | Response

Error Codes

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

Request Body

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

ElementDescriptionData Type
AdGroupIdThe ID of the ad group that contains the ads to update.long
AdsA list of ads to update. You may update a maximum of 50 ads.

The Id element must specify the ID of the ad to update. Specify only those elements that you want to update. The call will fail if you specify a non-null value for a read-only element such as Id.
Ad array

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 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: Required for most service operations, and as a best practice you should always specify this element.
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: Required for most service operations, and as a best practice you should always specify this element.
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/v11">
    <Action mustUnderstand="1">UpdateAds</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>
    <UpdateAdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <AdGroupId></AdGroupId>
      <Ads i:nil="false">
        <Ad i:type="-- specify derived type here with the appropriate prefix --">
          <AdFormatPreference i:nil="false"></AdFormatPreference>
          <DevicePreference i:nil="false"></DevicePreference>
          <EditorialStatus i:nil="false"></EditorialStatus>
          <FinalAppUrls xmlns:e174="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" i:nil="false">
            <e174:AppUrl>
              <e174:OsType i:nil="false"></e174:OsType>
              <e174:Url i:nil="false"></e174:Url>
            </e174: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:e175="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e175:KeyValuePairOfstringstring>
              <e175:key i:nil="false"></e175:key>
              <e175:value i:nil="false"></e175:value>
            </e175:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false"></Id>
          <Status i:nil="false"></Status>
          <TrackingUrlTemplate i:nil="false"></TrackingUrlTemplate>
          <Type i:nil="false"></Type>
          <UrlCustomParameters xmlns:e176="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" i:nil="false">
            <e176:Parameters i:nil="false">
              <e176:CustomParameter>
                <e176:Key i:nil="false"></e176:Key>
                <e176:Value i:nil="false"></e176:Value>
              </e176:CustomParameter>
            </e176: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>
          <!--Keep these fields if you set the i:type attribute to AppInstallAd-->
          <AppPlatform i:nil="false"></AppPlatform>
          <AppStoreId i:nil="false"></AppStoreId>
          <Text i:nil="false"></Text>
          <Title i:nil="false"></Title>
          <!--Keep these fields if you set the i:type attribute to ExpandedTextAd-->
          <DisplayUrl i:nil="false"></DisplayUrl>
          <Path1 i:nil="false"></Path1>
          <Path2 i:nil="false"></Path2>
          <Text i:nil="false"></Text>
          <TitlePart1 i:nil="false"></TitlePart1>
          <TitlePart2 i:nil="false"></TitlePart2>
          <!--Keep these fields if you set the i:type attribute to DynamicSearchAd-->
          <Path1 i:nil="false"></Path1>
          <Path2 i:nil="false"></Path2>
          <Text i:nil="false"></Text>
        </Ad>
      </Ads>
    </UpdateAdsRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
PartialErrorsAn array of BatchError objects that contain details for any request items that were not successful.

The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
BatchError array

Response Header

ElementDescriptionData Type
TrackingIdThe 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/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <UpdateAdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <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:e171="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e171:KeyValuePairOfstringstring>
              <e171:key p4:nil="false"></e171:key>
              <e171:value p4:nil="false"></e171:value>
            </e171: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>
    </UpdateAdsResponse>
  </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 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

AddAds
DeleteAds
GetAdsByAdGroupId
GetAdsByEditorialStatus
GetAdsByIds

Show: