Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

GetTargetsByAdGroupIds Service Operation

Retrieves detailed information about the targets that are associated with the specified ad groups.

Request | Response

Error Codes

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

GetTargetsByAdGroupIdsRequest Message

Request Body

The GetTargetsByAdGroupIdsRequest 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 list of identifiers of the ad groups that contain the targets that you want to get. The list can contain a maximum of 100 identifiers.

long array

LocationTargetVersion

The version of the location codes to return if the target contains location targets. The following are the possible values. If null, the default is the oldest supported version.

  • Latest – Use the latest supported version

  • 1 – Metro- codes (deprecated)

  • 2 – Nielsen DMA® codes

Because older versions may not be supported in the future, consider setting this element to Latest to avoid breaking changes.

string

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

GetTargetsByAdGroupIdsResponse Message

Response Body

Element

Description

Data Type

Targets

An array of Target objects that corresponds directly to the list of ad group identifiers in the request. If the ad group does not contain a reference to a target object, the corresponding target element in the array is NULL.

Target 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>
    <GetTargetsByAdGroupIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <Targets p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <Target>
          <Age p4:nil="false">
            <Bids p4:nil="false">
              <AgeTargetBid>
                <Age></Age>
                <BidAdjustment></BidAdjustment>
              </AgeTargetBid>
            </Bids>
          </Age>
          <Day p4:nil="false">
            <Bids p4:nil="false">
              <DayTargetBid>
                <BidAdjustment></BidAdjustment>
                <Day></Day>
              </DayTargetBid>
            </Bids>
            <TargetAllDays></TargetAllDays>
          </Day>
          <DeviceOS p4:nil="false">
            <Bids p4:nil="false">
              <DeviceOSTargetBid>
                <BidAdjustment></BidAdjustment>
                <DeviceName p4:nil="false"></DeviceName>
                <OSNames p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string></a1:string>
                </OSNames>
              </DeviceOSTargetBid>
            </Bids>
          </DeviceOS>
          <ForwardCompatibilityMap xmlns:e19="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e19:KeyValuePairOfstringstring>
              <e19:key p4:nil="false"></e19:key>
              <e19:value p4:nil="false"></e19:value>
            </e19:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Gender p4:nil="false">
            <Bids p4:nil="false">
              <GenderTargetBid>
                <BidAdjustment></BidAdjustment>
                <Gender></Gender>
              </GenderTargetBid>
            </Bids>
          </Gender>
          <Hour p4:nil="false">
            <Bids p4:nil="false">
              <HourTargetBid>
                <BidAdjustment></BidAdjustment>
                <Hour></Hour>
              </HourTargetBid>
            </Bids>
            <TargetAllHours></TargetAllHours>
          </Hour>
          <Id p4:nil="false"></Id>
          <IsLibraryTarget p4:nil="false"></IsLibraryTarget>
          <Location p4:nil="false">
            <CityTarget p4:nil="false">
              <Bids p4:nil="false">
                <CityTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <City p4:nil="false"></City>
                  <IsExcluded></IsExcluded>
                </CityTargetBid>
              </Bids>
            </CityTarget>
            <CountryTarget p4:nil="false">
              <Bids p4:nil="false">
                <CountryTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <CountryAndRegion p4:nil="false"></CountryAndRegion>
                  <IsExcluded></IsExcluded>
                </CountryTargetBid>
              </Bids>
            </CountryTarget>
            <HasPhysicalIntent p4:nil="false"></HasPhysicalIntent>
            <MetroAreaTarget p4:nil="false">
              <Bids p4:nil="false">
                <MetroAreaTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <IsExcluded></IsExcluded>
                  <MetroArea p4:nil="false"></MetroArea>
                </MetroAreaTargetBid>
              </Bids>
            </MetroAreaTarget>
            <RadiusTarget p4:nil="false">
              <Bids p4:nil="false">
                <RadiusTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <Id p4:nil="false"></Id>
                  <IsExcluded></IsExcluded>
                  <LatitudeDegrees></LatitudeDegrees>
                  <LongitudeDegrees></LongitudeDegrees>
                  <Name p4:nil="false"></Name>
                  <Radius></Radius>
                </RadiusTargetBid>
              </Bids>
            </RadiusTarget>
            <StateTarget p4:nil="false">
              <Bids p4:nil="false">
                <StateTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <IsExcluded></IsExcluded>
                  <State p4:nil="false"></State>
                </StateTargetBid>
              </Bids>
            </StateTarget>
          </Location>
          <Name p4:nil="false"></Name>
        </Target>
      </Targets>
    </GetTargetsByAdGroupIdsResponse>
  </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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.