Query Keyword Suggestions
Query keyword suggestions based on search terms and App Store countries or regions using structured filters.
URL
POST https://api.ads.apple.com/v1/suggestions/keywords/queryHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RecommendationQueryKeywordSuggestionResponse | |
| 400 | Bad Request Content-Type: application/json | RecommendationResponseBody | |
| 401 | Unauthorized Content-Type: application/json | RecommendationResponseBody | |
| 403 | Forbidden Content-Type: application/json | RecommendationResponseBody | |
| 404 | Not Found Content-Type: application/json | RecommendationResponseBody | |
| 429 | Too Many Requests Content-Type: application/json | RecommendationResponseBody | |
| 500 | Internal Server Error Content-Type: application/json | RecommendationResponseBody |
Discussion
Each KeywordSuggestion result contains text (the suggested keyword string) and popularity (a relative score). Sort by popularity DESC and use pagination to page through results.
See FilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Description |
|---|---|---|---|
| string |
| Required. The app Adam ID. Keyword suggestions are scoped to the promoted app. |
| string (enum) |
| Required. The type of promoted object. |
| array of strings |
| Optional. Specific search terms to get suggestions for. |
| array of strings |
| Optional. App Store country or region codes to scope results to. |
Payload Examples
This example queries keyword suggestions for an app scoped to the US and GB App Store countries or regions, seeded by specific search terms. The response returns suggested keyword strings with their relative popularity scores.