Export (0) Print
Expand All
Expand Minimize

GetAdGroupsByIds Service Operation

Gets the specified ad groups that exist within a specified campaign.

Request | Response

Error Codes

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

GetAdGroupsByIdsRequest Message

Request Body

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

AdGroupIds

A maximum of 1,000 identifiers of the ad groups to get.

long array

CampaignId

The identifier of the campaign that contains the ad groups to get.

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">GetAdGroupsByIds</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>
    <GetAdGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <CampaignId></CampaignId>
      <AdGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </AdGroupIds>
    </GetAdGroupsByIdsRequest>
  </s:Body>
</s:Envelope>

GetAdGroupsByIdsResponse Message

Response Body

Element

Description

Data Type

AdGroups

An array of AdGroup objects that corresponds directly to the ad group identifiers that you specified in the request. If an ad group does not exist, the corresponding element of the array is set to NULL.

AdGroup 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>
    <GetAdGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AdGroups p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <AdGroup>
          <AdDistribution p4:nil="false"></AdDistribution>
          <AdRotation p4:nil="false">
            <EndDate p4:nil="false"></EndDate>
            <StartDate p4:nil="false"></StartDate>
            <Type p4:nil="false"></Type>
          </AdRotation>
          <BiddingModel p4:nil="false"></BiddingModel>
          <BroadMatchBid p4:nil="false">
            <Amount p4:nil="false"></Amount>
          </BroadMatchBid>
          <ContentMatchBid p4:nil="false">
            <Amount p4:nil="false"></Amount>
          </ContentMatchBid>
          <EndDate p4:nil="false">
            <Day></Day>
            <Month></Month>
            <Year></Year>
          </EndDate>
          <ExactMatchBid p4:nil="false">
            <Amount p4:nil="false"></Amount>
          </ExactMatchBid>
          <ForwardCompatibilityMap xmlns:e10="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e10:KeyValuePairOfstringstring>
              <e10:key p4:nil="false"></e10:key>
              <e10:value p4:nil="false"></e10:value>
            </e10:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Language p4:nil="false"></Language>
          <Name p4:nil="false"></Name>
          <Network p4:nil="false"></Network>
          <PhraseMatchBid p4:nil="false">
            <Amount p4:nil="false"></Amount>
          </PhraseMatchBid>
          <PricingModel p4:nil="false"></PricingModel>
          <StartDate p4:nil="false">
            <Day></Day>
            <Month></Month>
            <Year></Year>
          </StartDate>
          <Status p4:nil="false"></Status>
        </AdGroup>
      </AdGroups>
    </GetAdGroupsByIdsResponse>
  </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