account | GadsAccountItem or object or array of object or string or integer | Yes | - | Select the Google Ads account, ask user for it if not provided |
action_type | string or SelectableOption | Yes | - | Choose which keyword planner action to perform. Available options: ‘discover’ (Discover Keywords), ‘historical’ (Historical Metrics) |
seed_type | string or SelectableOption | No | - | Choose how to provide seed data for keyword discovery. Available options: ‘keywords’ (Keyword List), ‘url’ (Website URL) |
seed_keywords | string | No | - | Enter keywords to use as seeds for discovery. Use only when ‘discover’ action is selected. Separate multiple keywords with newlines or commas (e.g., ‘keyword1, keyword2’) |
seed_url | string | No | - | Enter a website URL to discover related keywords (e.g., https://example.com). Use only when ‘discover’ action is selected |
keywords | string | No | - | Enter keywords to get historical metrics for. Use only when ‘historical’ action is selected. Separate multiple keywords with newlines or commas (e.g., ‘keyword1, keyword2’) |
monthly_breakdown | boolean | No | False | Show search volume metrics broken down by month, only applicable for ‘historical’ action |
countries | array of string or SelectableOption | Yes | - | List of countries to target for keyword planning. Use 2-letter ISO country codes (e.g., ‘US’ for United States, ‘CA’ for Canada’) |
language | string or SelectableOption | Yes | - | The language for the keywords, 2-letter language code (e.g., ‘EN’ for English, ‘ES’ for Spanish’) |
limit | integer | No | 100 | Maximum number of keywords to return (1-10000) |
