Hierarchy

  • Operation
    • SponsoredProductsSuggestedKeywordsOperation

Constructors

Methods

  • Provides keyword suggestions for specified list of ASINs. Suggested keywords are ordered by most effective to least effective.

    Returns

    Parameters

    • asinValue: string[]
    • Optional maxNumSuggestions: number

    Returns Promise<{ keywordText: string; matchType: string }[]>

  • Retrieve suggested keyword data for the specified adGroupId.

    Returns

    Parameters

    • adGroupId: number
    • Optional params: { adStateFilter: ("paused" | "enabled" | "archived")[]; maxNumSuggestions: number }
      • adStateFilter: ("paused" | "enabled" | "archived")[]

        Ad state filter (values are comma separated), to filter out the Ads to get suggested keywords for their ASINs. Valid values are: enabled, paused, and archived. Default values are enabled and paused

      • maxNumSuggestions: number

        Maximum number of returned suggested keywords. Default is 100, maximum is 1000

    Returns Promise<{ adGroupId: number; suggestedKeywords: ({ keywordText: string; matchType: string; })[] }>

  • Retrieve extended suggested keyword data for the specified adGroupId.

    Returns

    Parameters

    • adGroupId: number
    • Optional params: { adStateFilter: ("paused" | "enabled" | "archived")[]; maxNumSuggestions: number } & { suggestBids: undefined | "yes" | "no" }

    Returns Promise<({ adGroupId: number; campaignId: number; keywordText: string; matchType: string; state: string } & { bid: undefined | number })[]>

  • Provides suggested keywords for specified ASIN. Suggested keywords are ordered by most effective to least effective.

    Returns

    Parameters

    • asinValue: string
    • maxNumSuggestions: number = 100

    Returns Promise<{ keywordText: string; matchType: string }[]>