CampaignManagement UpdateAdGroups Service Operation

Switch on low bandwidth view

Collapse All

Language Filter

Microsoft Advertising APIs

Updates the specified ad groups in a specified campaign.

Syntax

<wsdl:operation name="UpdateAdGroups">
  <soap:operation soapAction="UpdateAdGroups" style="document" />
  <wsdl:input name="UpdateAdGroupsRequest">
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="ApplicationToken" use="literal" />
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="CustomerAccountId" use="literal" />
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="CustomerId" use="literal" />
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="DeveloperToken" use="literal" />
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="Password" use="literal" />
    <soap:header message="tns:UpdateAdGroupsRequest_Headers" part="UserName" use="literal" />
    <soap:body use="literal" />
  </wsdl:input>
  <wsdl:output name="UpdateAdGroupsResponse">
    <soap:header message="tns:UpdateAdGroupsResponse_Headers" part="TrackingId" use="literal" />
    <soap:body use="literal" />
  </wsdl:output>
  <wsdl:fault name="ApiFaultDetailFault">
    <soap:fault use="literal" name="ApiFaultDetailFault" namespace="" />
  </wsdl:fault>
  <wsdl:fault name="AdApiFaultDetailFault">
    <soap:fault use="literal" name="AdApiFaultDetailFault" namespace="" />
  </wsdl:fault>
</wsdl:operation>

Request

An UpdateAdGroupsRequest object that contains the header and parameter information for the service operation.

Response

An UpdateAdGroupsResponse object that contains the response information for the service request.

Fault

If a Microsoft adCenter API error occurs, a FaultException exception is thrown. It contains one of the following objects:

For more information about fault detail objects, see Microsoft adCenter API Error Handling. For a list of campaign-management–specific error codes, see Campaign Management Error Codes. For a list of generic error codes, see Common Error Codes.

Example SOAP Request

The following is a fictitious example of an UpdateAdGroups request.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ApplicationToken 
      i:nil="true" 
      xmlns:h="https://adcenter.microsoft.com/v6" 
      xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
    <h:CustomerAccountId 
      xmlns:h="https://adcenter.microsoft.com/v6">XXXXX</h:CustomerAccountId>
    <h:CustomerId 
      xmlns:h="https://adcenter.microsoft.com/v6">XXXXX</h:CustomerId>
    <h:DeveloperToken 
      xmlns:h="https://adcenter.microsoft.com/v6">XXXXX</h:DeveloperToken>
    <h:Password 
      xmlns:h="https://adcenter.microsoft.com/v6">XXXXX</h:Password>
    <h:UserName 
      xmlns:h="https://adcenter.microsoft.com/v6">XXXXX</h:UserName>
  </s:Header>
  <s:Body>
    <UpdateAdGroupsRequest xmlns="https://adcenter.microsoft.com/v6">
      <CampaignId>123456</CampaignId>
      <AdGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <AdGroup>
          <AdDistribution i:nil="true"/>
          <BiddingModel i:nil="true"/>
          <BroadMatchBid i:nil="true"/>
          <CashBackInfo i:nil="true"/>
          <ContentMatchBid i:nil="true"/>
          <EndDate i:nil="true"/>
          <ExactMatchBid i:nil="true"/>
          <Id>1234</Id>
          <LanguageAndRegion i:nil="true"/>
          <Name>New ad group name</Name>
          <NegativeKeywords 
            i:nil="true" 
            xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
          <NegativeSiteUrls 
            i:nil="true" 
            xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
          <PhraseMatchBid i:nil="true"/>
          <PricingModel i:nil="true"/>
          <StartDate i:nil="true"/>
          <Status i:nil="true"/>
        </AdGroup>
        <AdGroup>
          <AdDistribution i:nil="true"/>
          <BiddingModel i:nil="true"/>
          <BroadMatchBid i:nil="true"/>
          <CashBackInfo i:nil="true"/>
          <ContentMatchBid i:nil="true"/>
          <EndDate>
            <Day>8</Day>
            <Month>7</Month>
            <Year>2009</Year>
          </EndDate>
          <ExactMatchBid i:nil="true"/>
          <Id>5678</Id>
          <LanguageAndRegion i:nil="true"/>
          <Name i:nil="true"/>
          <NegativeKeywords 
            i:nil="true" 
            xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
          <NegativeSiteUrls 
            i:nil="true" 
            xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
          <PhraseMatchBid i:nil="true"/>
          <PricingModel i:nil="true"/>
          <StartDate>
            <Day>8</Day>
            <Month>6</Month>
            <Year>2009</Year>
          </StartDate>
          <Status i:nil="true"/>
        </AdGroup>
      </AdGroups>
    </UpdateAdGroupsRequest>
  </s:Body>
</s:Envelope>

Remarks

Because this service operation uses arrays, we recommend that you read the Quotas in Microsoft adCenter topic before you use this service operation. Arrays can consume a large percentage of your allocated quota.

Requirements

WSDL: CampaignManagementService.svc in version 6.

Concepts

Quotas in Microsoft adCenter