SetNegativeSitesToCampaigns REST Template

Variables

AccountId

The identifier of the account that contains the campaigns to which you want to add negative site URLs.

Query Parameters

field

The negativeSites value is a constant string that indicates that the PUT method is adding negative site URLs to the specified campaigns. The body of the request includes the list of campaign identifiers and the negative site URLs to add to each campaign.

Request Components

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

• HTTP method: PUT

• Supported content types: XML and JSON

  • To use JSON, your request URL must include the “format=json” query string.

  • 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.

If the web browser or firewall does not support the PUT method, use the POST method and include the X-HTTP-Method-Override header. Set the X-HTTP-Method-Override header value to PUT.

Request Headers

The following are the headers to include in your request.

Request Body

The following XML fragment shows the elements to use to set the negative site URLs for the specified campaigns. For a description of each element and the header elements that your request must include, see SetNegativeSitesToCampaignsRequest Message.

<SetNegativeSitesToCampaignsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CampaignNegativeSites xmlns:c="https://adcenter.microsoft.com/v8">
    <c:CampaignNegativeSites>
      <c:CampaignId></c:CampaignId>
      <c:NegativeSites xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a:string></a:string>
      </c:NegativeSites>
    </c:CampaignNegativeSites>
  </CampaignNegativeSites>
</SetNegativeSitesToCampaignsRequest>

Response Body

The response does not include a body. For a description of the TrackingId header element that the response includes, see SetNegativeSitesToCampaignsResponse Message.

Faults

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

Requirements

CampaignManagementServiceREST.svc v8

See Also

Reference

SetNegativeSitesToCampaigns Service Operation