Edit

Share via

NegativeKeywordList

  • Article

Contains the methods for adding keywords to a negative keywords list. For information about negative keyword lists, see Negative Keywords.

Methods

Method Name Return Type Description
addNegativeKeyword(string keywordText) void Adds a keyword to this negative keywords list.
addNegativeKeywords(string[] keywordTexts) void Adds a list of keywords to this negative keywords list.
campaigns CampaignSelector Gets a selector used to filter the list of campaigns that the negative keyword list is associated with.
getEntityType String Gets this entity's type.
getId string Gets the ID that uniquely identifies this negative keyword list.
getName String Gets this negative keyword list's name.
setName(string name) void Sets this negative keyword list's name.

addNegativeKeyword(string keywordText)

Adds a keyword to this negative keyword list. For information about negative keyword limits, see Negative keywords.

To specify the match type for negative keywords:

  • For phrase match, use quotes around the keyword. For example:

    nkwList.addNegativeKeyword("\"books\"")

  • For exact match, use square brackets around the keyword. For example:

    nkwList.addNegativeKeyword("[hardcover books]")

If the keyword does not include match-type syntax, phrase match type is assumed (broad match type is not supported).

Arguments

Name Type Description
keywordText String The negative keyword's text. Negative keywords may contain a maximum of 100 characters.

Returns

Type Description
void Returns nothing.

addNegativeKeywords(string[] keywordTexts)

Adds a list of keywords to this negative keyword list. For information about negative keyword limits, see Negative keywords.

To specify the match type for negative keywords:

  • For phrase match, use quotes around the keyword. For example:

    nkwList.addNegativeKeywords(["\"trucks\"", "\"cars\""]).

  • For exact match, use square brackets around the keyword. For example:

    nkwList.addNegativeKeywords(["[offroad trucks]", "[sport cars]"]).

If the keyword does not include match-type syntax, phrase match type is assumed (broad match type is not supported).

Arguments

Name Type Description
keywordTexts string[] An array of keyword strings. The array may contain a maximum of 5,000 keywords and each keyword may contain a maximum of 100 characters.

Returns

Type Description
void Returns nothing.

campaigns

Gets a selector used to filter the list of campaigns that the negative keyword list is associated with.

Returns

Type Description
CampaignSelector A selector used to filter the list of campaigns that the negative keyword list is associated with.

getEntityType

Returns this entity's type.

Returns

Type Description
string This entity's type, which is NegativeKeywordList.

getId

Gets the ID that uniquely identifies this negative keyword list.

Returns

Type Description
string The ID that uniquely identifies this negative keyword list.

getName

Gets this negative keyword list's name.

Returns

Type Description
string The name of this negative keyword list.

setName(string name)

Sets this negative keyword list's name.

Arguments

Name Type Description
name string The list's name. The name may contain a maximum of 255 characters.

Returns

Type Description
void Returns nothing.