The SubphraseKeywordRequestType object represents a request for keyword phrase suggestions based on keyword specifications and phrase filters.
ExcludedKeywords and PhraseFilters can consist of a list of keywords, each consisting of one or more words. For example: [Acme DVD, ABC DVD Player] is treated as two items.
The suggested results will not contain any items in the list of ExcludedKeywords. In this case, "Acme DVD" would be excluded, in the list of suggested phrases but "DVD Player" would not be.
ExcludedPhraseFilters and RequiredPhraseFilters can also consist of a list of items, but they are treated more broadly. If an ExcludedPhraseFilter consists of [ABC, Acme, "DVD Player"], then any phrase which includes ABC or Acme or the phrase "DVD Player" would be excluded, but it does not need to be an exact match. In this case, "ABC Preschool" and "Quality DVD Player" would be excluded, but "Quality CD Player" would not be. If that same list were used as a RequiredPhraseFilter, then those keywords would be included.
| Element | Data Type | Description | Restrictions * |
|---|---|---|---|
| excludedKeywords | string[] | A list of keywords (limit 1000) that will be excluded from the result set if they match exactly. If any of the excludedKeywords match any item in the result set, that item will be excluded. | Opt |
| excludedPhrase Filters |
string[] | A list of keyword phrases (limit 5) that will be excluded from the result set if they match all or part of an item in the result set. If any of the keyword phrases are contained within an item in the result set, that item will be excluded. | Opt |
| market | string | The two-letter market ID. | Opt |
| maxKeywords | int | The maximum number of keyword suggestions (limit 50) to return in the result set. The actual number of suggestions returned may be less than than the value you specify. | Opt |
| offset | int | The starting point for the next set of keywords. | Opt |
| requiredPhrase Filters |
string[] | A list of keyword phrases (limit 5) that will be included in the result set if they match all or part of an item in the result set. If any of the keyword phrases are contained within an item in the result set, that item will be included. | Req |