Suggested Keywords

class ad_api.api.sp.SuggestedKeywords(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, proxies=None, verify=True, timeout=None, debug=False, access_token=None)

get_asin_keywords(self, asinValue, \*\*kwargs) → ApiResponse

Gets suggested keywords for the specified ad group.

path asinValue:string | Required. An ASIN.

query maxNumSuggestions:integer | Optional. The maxiumum number of suggested keywords for the response. Default value 100.

Returns:

ApiResponse

get_asins_keywords(self, \*\*kwargs) → ApiResponse:

Gets suggested keyword for a specified list of ASINs.

body: | REQUIRED {‘description’: ‘An object with ASINs.}’

‘asins’: string, {‘description’: ‘A list of ASINs.’}

‘maxNumSuggestions’: integer, {‘description’: ‘The maximum number of suggested keywords in the response. minItems: 1. maxItems: 1000. default: 100’}

Returns:

ApiResponse

get_keywords(**kwargs)

get_keywords_request(self, adGroupId, **kwargs) -> ApiResponse

Gets suggested keywords for the specified ad group.

path adGroupId:number | Required. The identifier of a valid ad group.

query maxNumSuggestions:integer | Optional. The maxiumum number of suggested keywords for the response. Default value 100.

query adStateFilter:string | Optional. Filters results to ad groups with state matching the comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived.

Returns:

ApiResponse

get_keywords_extended(self, adGroupId, \*\*kwargs) → ApiResponse

Gets suggested keywords with extended data for the specified ad group.

path adGroupId:number | Required. The identifier of a valid ad group.

query maxNumSuggestions:integer | Optional. The maxiumum number of suggested keywords for the response. Default value 100.

query suggestBids:string | Optional. Set to yes to include a suggest bid for the suggested keyword in the response. Otherwise, set to no. Available values : yes, no. Default value : no.

query adStateFilter:string | Optional. Filters results to ad groups with state matching the comma-delimited list. Available values : enabled, paused, archived, enabled, paused, enabled, archived, paused, archived, enabled, paused, archived.

Returns:

ApiResponse

Campaigns explanation goes here.