Keywords

Warning

This replaces the version 2 of SP Keywords

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

create_keyword(**kwargs)

Creating product keywords.

Request Body (required): nativeLanguageKeyword : (string), The unlocalized keyword text in the preferred locale of the advertiser

nativeLanguageLocale : (string), The locale preference of the advertiser.

campaignId: string, The identifer of the campaign to which the keyword is associated.

adGroupId: string, The identifier of the ad group to which this keyword is associated

state: string, The current resource state.’ , ‘Enum’: ‘[ enabled ]

keywordText: string, The text of the expression to match against a search query.

matchType: string, ‘The type of match.’ , ‘Enum’: ‘[EXACT, PHRASE, BROAD]
Returns: ApiResponse

delete_keywords(**kwargs)

Deleting product keywords.

Request Body (required): keywordIdFilter {} : Filter keywords by the list of objectIds include [string] : list of keywordsIds as String to be used as filter. MinItems : 0, MaxItems :1000
Returns: ApiResponse

edit_keyword(**kwargs)

Updating product keywords.

Request Body (required): ‘keywordId’: string, (required) {‘description’: ‘The identifer of the campaign to which the keyword is associated.’}

‘state’: string, {‘description’: ‘The current resource state.’ , ‘Enum’: ‘[ enabled, paused, archived ]’}

‘bid’: float {‘description’: ‘Bid associated with this keyword. Applicable to biddable match types only.’}
Returns: ApiResponse

list_keywords(**kwargs)

Listing product keywords.

Request Body (optional)

Returns: ApiResponse