NegativeKeyword Data Object - Campaign Management

Article
03/20/2023

Defines a negative keyword with match type.

A negative keyword can be added and deleted, but cannot be updated.

You may choose to assign negative keywords to an individual campaign or ad group. An assigned set of negative keywords cannot be shared with other campaigns or ad groups.

Negative keywords can also be added and deleted from a shared negative keyword list. The negative keyword list can be shared or associated with multiple campaigns.

Note

The same negative keyword and match type can be added to all campaigns, ad groups, and negative keyword lists if you choose. Each instance must be added and associated individually and would be assigned a unique negative keyword identifier.

For more information about managing negative keywords and negative keyword lists, see the Negative Keywords technical guide.

Syntax

<xs:complexType name="NegativeKeyword" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:SharedListItem">
      <xs:sequence>
        <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="MatchType" nillable="true" type="tns:MatchType" />
        <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The NegativeKeyword object has the following elements: Id, MatchType, Text.

Element	Description	Data Type
Id	The unique Microsoft Advertising identifier of the negative keyword. Add: Read-only Delete: Required	long
MatchType	The type of match to compare the negative keyword and the user's search term. The supported values for a negative keyword are Exact and Phrase. Add: Required Delete: Optional	MatchType
Text	The negative keyword text. The text can contain a maximum of 100 characters. Add: Required Delete: Optional	string

The NegativeKeyword object has Inherited Elements.

Inherited Elements

Inherited Elements from SharedListItem

The NegativeKeyword object derives from the SharedListItem object, and inherits the following elements: ForwardCompatibilityMap, Type. The descriptions below are specific to NegativeKeyword, and might not apply to other objects that inherit the same elements from the SharedListItem object.

Element	Description	Data Type
ForwardCompatibilityMap	The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.	KeyValuePairOfstringstring array
Type	The type of the shared list item. This value is NegativeKeyword when you retrieve a negative keyword. For more information about shared list item types, see SharedListItem Data Object Remarks. Add: Read-only	string

Requirements

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

Used By

EntityNegativeKeyword

Share via