keyword_planner.py Example Uses Deprecated Ad Insight APIs #330
Description
Repository: BingAds/BingAds-Python-SDK
Affected File: examples/v13/keyword_planner.py
Status: Bug / Documentation Update Required
Summary
The keyword_planner.py example script fails at runtime with Error Code 3601 (UnsupportedEndpoint) because it uses APIs that were deprecated by Microsoft on August 21, 2023.
Error Message
ErrorCode: UnsupportedEndpoint
Code: 3601
Details: Invalid client data. The Endpoint is deprecated.
Message: The Endpoint is deprecated.
The error occurs when calling GetKeywordIdeaCategories().
Root Cause
According to the official Microsoft Tech Community announcement:
Deprecation of legacy Ad Insight Keyword APIs and features
Published: July 19, 2023
Effective Date: August 21, 2023
Deprecated APIs Used in keyword_planner.py
| API/Feature | Status | Line Reference |
|---|---|---|
GetKeywordIdeaCategories |
DEPRECATED | Line 29 |
CategorySearchParameter |
DEPRECATED | Lines 62-64 |
Proposed Fix
Option A: Remove Deprecated Example (Recommended if APIs are permanently removed)
Delete or archive keyword_planner.py with a note explaining the deprecation.
Option B: Update Example to Use Only Supported APIs
Remove the deprecated GetKeywordIdeaCategories and CategorySearchParameter usage. The GetKeywordIdeas and GetKeywordTrafficEstimates operations may still work without category-based search.