AddTargetsToLibrary Service Operation

 

Adds targets to your target library.

Request | Response

Error Codes

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

Request Body

The AddTargetsToLibraryRequest 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
TargetsAn array of Target objects to add to the target library.

You can add a maximum of one target to the target library in a single call.
Target 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 Managing User 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/v10">
    <Action mustUnderstand="1">AddTargetsToLibrary</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>
    <AddTargetsToLibraryRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <Targets i:nil="false">
        <Target>
          <Age i:nil="false">
            <Bids i:nil="false">
              <AgeTargetBid>
                <Age></Age>
                <BidAdjustment></BidAdjustment>
              </AgeTargetBid>
            </Bids>
          </Age>
          <DayTime i:nil="false">
            <Bids i:nil="false">
              <DayTimeTargetBid>
                <BidAdjustment></BidAdjustment>
                <Day></Day>
                <FromHour></FromHour>
                <FromMinute></FromMinute>
                <ToHour></ToHour>
                <ToMinute></ToMinute>
              </DayTimeTargetBid>
            </Bids>
          </DayTime>
          <Device p4:nil="false">
            <Bids p4:nil="false">
              <DeviceOSTargetBid>
                <BidAdjustment></BidAdjustment>
                <DeviceName p4:nil="false"></DeviceName>
              </DeviceOSTargetBid>
            </Bids>
          </Device>
          <ForwardCompatibilityMap xmlns:e29="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e29:KeyValuePairOfstringstring>
              <e29:key i:nil="false"></e29:key>
              <e29:value i:nil="false"></e29:value>
            </e29:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Gender i:nil="false">
            <Bids i:nil="false">
              <GenderTargetBid>
                <BidAdjustment></BidAdjustment>
                <Gender></Gender>
              </GenderTargetBid>
            </Bids>
          </Gender>
          <Id i:nil="false"></Id>
          <IsLibraryTarget i:nil="false"></IsLibraryTarget>
          <Location i:nil="false">
            <CityTarget i:nil="false">
              <Bids i:nil="false">
                <CityTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <City i:nil="false"></City>
                  <IsExcluded></IsExcluded>
                </CityTargetBid>
              </Bids>
            </CityTarget>
            <CountryTarget i:nil="false">
              <Bids i:nil="false">
                <CountryTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <CountryAndRegion i:nil="false"></CountryAndRegion>
                  <IsExcluded></IsExcluded>
                </CountryTargetBid>
              </Bids>
            </CountryTarget>
            <IntentOption i:nil="false"></IntentOption>
            <MetroAreaTarget i:nil="false">
              <Bids i:nil="false">
                <MetroAreaTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <IsExcluded></IsExcluded>
                  <MetroArea i:nil="false"></MetroArea>
                </MetroAreaTargetBid>
              </Bids>
            </MetroAreaTarget>
            <PostalCodeTarget i:nil="false">
              <Bids i:nil="false">
                <PostalCodeTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <IsExcluded></IsExcluded>
                  <PostalCode i:nil="false"></PostalCode>
                </PostalCodeTargetBid>
              </Bids>
            </PostalCodeTarget>
            <RadiusTarget i:nil="false">
              <Bids i:nil="false">
                <RadiusTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <Id i:nil="false"></Id>
                  <IsExcluded></IsExcluded>
                  <LatitudeDegrees></LatitudeDegrees>
                  <LongitudeDegrees></LongitudeDegrees>
                  <Name i:nil="false"></Name>
                  <Radius></Radius>
                  <RadiusUnit></RadiusUnit>
                </RadiusTargetBid>
              </Bids>
            </RadiusTarget>
            <StateTarget i:nil="false">
              <Bids i:nil="false">
                <StateTargetBid>
                  <BidAdjustment></BidAdjustment>
                  <IsExcluded></IsExcluded>
                  <State i:nil="false"></State>
                </StateTargetBid>
              </Bids>
            </StateTarget>
          </Location>
          <Name i:nil="false"></Name>
        </Target>
      </Targets>
    </AddTargetsToLibraryRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
TargetIdsAn array of long values that contains the identifiers of the targets that were added to your target library.long 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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <AddTargetsToLibraryResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <TargetIds 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>
      </TargetIds>
    </AddTargetsToLibraryResponse>
  </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

DeleteTargetFromAdGroup
DeleteTargetFromCampaign
DeleteTargetsFromLibrary
GetTargetsByAdGroupIds
GetTargetsByCampaignIds
GetTargetsByIds
GetTargetsInfoFromLibrary
SetTargetToAdGroup
SetTargetToCampaign
UpdateTargetsInLibrary

Community Additions

ADD
Show: