Export (0) Print
Expand All

GetNegativeKeywordsByCampaignIds REST Template

Gets the negative keywords for the specified campaigns.

/customer/account/{AccountId}/campaign?$field=negativeKeywords

Variables

AccountId

The identifier of the account that contains the campaigns whose negative keywords you want to retrieve.

Query Parameters

field

The negativeKeywords value is a constant string that indicates that the POST method is getting the negative keywords for the specified campaigns. The body of the request includes the list of campaign identifiers of the campaigns whose negative keywords you want to retrieve.

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

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 that you use to get the negative keywords for the specified campaigns. For a description of each element and the header elements that your request must include, see GetNegativeKeywordsByCampaignIdsRequest Message Object.

<GetNegativeKeywordsByCampaignIdsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CampaignIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d4p1:long></d4p1:long>
  </CampaignIds>
</GetNegativeKeywordsByCampaignIdsRequest>

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 GetNegativeKeywordsByCampaignIdsResponse Message Object.

<GetNegativeKeywordsByCampaignIdsResponse xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <CampaignNegativeKeywords xmlns:c="https://adcenter.microsoft.com/v8">
    <c:CampaignNegativeKeywords>
      <c:CampaignId></c:CampaignId>
      <c:NegativeKeywords xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a:string></a:string>
      </c:NegativeKeywords>
    </c:CampaignNegativeKeywords>
  </CampaignNegativeKeywords>
</GetNegativeKeywordsByCampaignIdsResponse>

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.

Community Additions

Show:
© 2014 Microsoft