This topic has not yet been rated - Rate this topic

AddTargetsToLibrary REST Template

Adds a target group to the target library.

/customer/target

Request Components

The following specifies the HTTP method, supported content types, and base URI to use in your request.

HTTP method: POST
Supported content types: XML and JSON
To use JSON, the following apply:
- Your request URL must include the “format=json” query string.
- For enumeration types, you must use numeric values instead of the value names defined in the value set. For example, to specify the TwentyFiveToThirtyFive value defined in the AgeRange value set, set the Age element of the AgeTargetBid object to 1 instead of to TwentyFiveToThirtyFive.
- All enumerations are zero-based, and increment by 1
- The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.
Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc
Sandbox base URI: Not available.

Request Headers

The following are the headers to include in your request.

Header	Description
ApplicationToken	The application access token. This header is not used.
CustomerAccountId	The account identifier. For more information, see Account and Customer Identifiers.
CustomerId	The customer identifier. For more information, see Account and Customer Identifiers.
DeveloperToken	The developer access token.
Password	The user’s logon password.
UserName	The user’s logon user name.

Request Body

The following XML fragment shows the elements to use to add target groups to the target library. For a description of each element and the header elements that your request must include, see AddTargetsToLibraryRequest Message Object.

other

<AddTargetsToLibraryRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Targets xmlns:d2p1="https://adcenter.microsoft.com/v8">
    <d2p1:Target>
      <d2p1:Age>
        <d2p1:Bid>
          <d2p1:Age></d2p1:Age>
          <d2p1:IncrementalBid></d2p1:IncrementalBid>
        </d2p1:Bid>
      </d2p1:Age>
      <d2p1:Day>
        <d2p1:Bid>
          <d2p1:Day></d2p1:Day>
          <d2p1:IncrementalBid></d2p1:IncrementalBid>
        </d2p1:Bid>
        <d2p1:TargetAllDays></d2p1:TargetAllDays>
      </d2p1:Day>
      <d2p1:Device>
        <d2p1:Devices>
          <d2p1:DeviceType></d2p1:DeviceType>
        </d2p1:Devices>
      </d2p1:Device>
      <d2p1:Gender>
        <d2p1:Bid>
          <d2p1:Gender></d2p1:Gender>
          <d2p1:IncrementalBid></d2p1:IncrementalBid>
        </d2p1:Bid>
      </d2p1:Gender>
      <d2p1:Hour>
        <d2p1:Bid>
          <d2p1:Hour></d2p1:Hour>
          <d2p1:IncrementalBid></d2p1:IncrementalBid>
        </d2p1:Bid>
        <d2p1:TargetAllHours></d2p1:TargetAllHours>
      <d2p1:Id i:nil="true" />
      <d2p1:IsLibraryTarget i:nil="true" />
      <d2p1:Location>
        <d2p1:BusinessTarget>
          <d2p1:Bids>
            <d2p1:BusinessId></d2p1:BusinessId>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
            <d2p1:Radius></d2p1:Radius>
          </d2p1:Bids>
        </d2p1:BusinessTarget>
        <d2p1:CityTarget>
          <d2p1:Bids>
            <d2p1:City></d2p1:City>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
          </d2p1:Bids>
        </d2p1:CityTarget>
        <d2p1:CountryTarget>
          <d2p1:Bids>
            <d2p1:CountryAndRegion></d2p1:CountryAndRegion>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
          </d2p1:Bids>
        </d2p1:CountryTarget>
        <d2p1:HasPhysicalIntent></d2p1:HasPhysicalIntent>
        <d2p1:MetroAreaTarget>
          <d2p1:Bids>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
            <d2p1:MetroArea></d2p1:MetroArea>
          </d2p1:Bids>
        </d2p1:MetroAreaTarget>
        <d2p1:RadiusTarget>
          <d2p1:Bids>
            <d2p1:Id></d2p1:Id>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
            <d2p1:LatitudeDegrees></d2p1:LatitudeDegrees>
            <d2p1:LongitudeDegrees></d2p1:LongitudeDegrees>
            <d2p1:Name></d2p1:Name>
            <d2p1:Radius></d2p1:Radius>
          </d2p1:Bids>
        </d2p1:RadiusTarget>
        <d2p1:StateTarget>
          <d2p1:Bids>
            <d2p1:IncrementalBid></d2p1:IncrementalBid>
            <d2p1:State></d2p1:State>
          </d2p1:Bids>
        </d2p1:StateTarget>
        <d2p1:TargetAllLocations></d2p1:TargetAllLocations>
      </d2p1:Location>
      <d2p1:Name></d2p1:Name>
    </d2p1:Target>
  </Targets>
</AddTargetsToLibraryRequest>

Response Body

The following XML fragment shows the elements that are included in the response. For a description of each element and the TrackingId header element that the response includes, see AddTargetsToLibraryResponse Message Object.

other

<AddTargetsToLibraryResponse xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <TargetIds xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:long></a:long>
  </TargetIds>
</AddTargetsToLibraryResponse>

Faults

If an error occurs, the service returns one of the following HTTP error codes.

Code	Description
400	Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes.
401	Not authorized.
404	Not found.
405	Method not allowed, which indicates that the URI template is not correct.
500	Server error.

Requirements

CampaignManagementServiceREST.svc v8

Community Additions

ADD