Yahoo! Search Marketing

ExcludedWordsService

ExcludedWordsService provides operations for creating and managing excluded words for accounts and ad groups. Excluded words are used to filter out unwanted user queries when Sponsored Search with the advanced match type is enabled (see Setting Tactics).

Operations

addExcludedWordsToAccount

Add one or more excluded words to an account.

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWords ExcludedWord[] A list of excluded words for the account.

Response

ExcludedWordResponse[] - A list of responses, which indicate if the operations succeeded or failed.

addExcludedWordsToAdGroup

Add one or more excluded words to an ad group.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWords ExcludedWord[] A list of excluded words for the ad group.

Response

ExcludedWordResponse[] - A list of responses, which indicate if the operations succeeded or failed.

addExcludedWordToAccount

Add an excluded word to an account.

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWord ExcludedWord The excluded word.

Response

ExcludedWordResponse - The response, which indicates if the operation succeeded or failed.

addExcludedWordToAdGroup

Add an excluded word to an ad group.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWord ExcludedWord The excluded word.

Response

ExcludedWordResponse - The response, which indicates if the operation succeeded or failed.

deleteExcludedWord

Delete the excluded word (specified by excludedWordID).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWordID long The excluded word ID.

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteExcludedWords

Delete one or more excluded words (specified by the list of excludedWordIDs).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWordIDs long[] A list of excluded word IDs.

Response

BasicResponse[] - A list of responses, which indicate if the operations succeeded or failed.

getExcludedWord

Return the excluded word (specified by excludedWordID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWordID long The excluded word ID.

Response

ExcludedWord - The excluded word.

getExcludedWords

Return a list of excluded words (specified by a list of excludedWordIDs).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter Data Type Description
excludedWordIDs long[] A list of excluded word IDs.

Response

ExcludedWord[] - A list of all excluded words.

getExcludedWordsByAccountID

Return the excluded words for the account (specified by accountID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter Data Type Description
accountID string The account ID.

Response

ExcludedWord[] - A list of all excluded words for the account.

getExcludedWordsByAdGroupID

Return the excluded words for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter Data Type Description
adGroupID long The ad group ID.

Response

ExcludedWord[] - A list of all excluded words for the ad group.