Export (0) Print
Expand All
Expand Minimize

AddAdGroups Service Operation

Adds new ad groups to a specified campaign.

Request | Response

Error Codes

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

AddAdGroupsRequest Message

Request Body

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

AdGroups

An array of AdGroup objects to add to the specified campaign.

You can add a maximum of 1,000 ad groups in a single call. The total number of ad groups that you can add to a campaign depends on your service level. For a list of limits for a standard user, see Entity Hierarchy and Limits.

AdGroup array

CampaignId

The identifier of the campaign to add the ad groups to.

long

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/v9">
    <Action mustUnderstand="1">AddAdGroups</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>
    <AddAdGroupsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <CampaignId></CampaignId>
      <AdGroups i:nil="false">
        <AdGroup>
          <AdDistribution i:nil="false"></AdDistribution>
          <AdRotation i:nil="false">
            <EndDate i:nil="false"></EndDate>
            <StartDate i:nil="false"></StartDate>
            <Type i:nil="false"></Type>
          </AdRotation>
          <BiddingModel i:nil="false"></BiddingModel>
          <BroadMatchBid i:nil="false">
            <Amount i:nil="false"></Amount>
          </BroadMatchBid>
          <ContentMatchBid i:nil="false">
            <Amount i:nil="false"></Amount>
          </ContentMatchBid>
          <EndDate i:nil="false">
            <Day></Day>
            <Month></Month>
            <Year></Year>
          </EndDate>
          <ExactMatchBid i:nil="false">
            <Amount i:nil="false"></Amount>
          </ExactMatchBid>
          <ForwardCompatibilityMap xmlns:e2="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e2:KeyValuePairOfstringstring>
              <e2:key i:nil="false"></e2:key>
              <e2:value i:nil="false"></e2:value>
            </e2:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false"></Id>
          <Language i:nil="false"></Language>
          <Name i:nil="false"></Name>
          <Network i:nil="false"></Network>
          <PhraseMatchBid i:nil="false">
            <Amount i:nil="false"></Amount>
          </PhraseMatchBid>
          <PricingModel i:nil="false"></PricingModel>
          <StartDate i:nil="false">
            <Day></Day>
            <Month></Month>
            <Year></Year>
          </StartDate>
          <Status i:nil="false"></Status>
        </AdGroup>
      </AdGroups>
    </AddAdGroupsRequest>
  </s:Body>
</s:Envelope>

AddAdGroupsResponse Message

Response Body

Element

Description

Data Type

AdGroupIds

An array of long values that represents the identifiers for the ad groups that were added.

long 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/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <AddAdGroupsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AdGroupIds 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>
      </AdGroupIds>
    </AddAdGroupsResponse>
  </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:
© 2014 Microsoft