keywords_query
Query bounded targeting-keyword inventory with required profile and ad account scope, plus filters, fields, sorting, and pagination for reporting.
Instructions
Query bounded targeting-keyword inventory with a required typed scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | legacy exact keyword ID shortcut | |
| fields | No | report fields to return | |
| filters | No | endpoint-specific filter conditions | |
| groupBy | No | report dimensions | |
| options | No | report or insight options | |
| profile | Yes | local Apple Ads profile name | |
| sorting | No | ordered sort fields | |
| adGroupId | No | ad group scope shortcut | |
| keywordId | No | exact keyword ID shortcut | |
| timeRange | No | report or insight time range | |
| campaignId | No | campaign scope shortcut | |
| pagination | No | bounded result window | |
| adAccountId | Yes | Apple Ads ad account ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | payload | |
| error | No | ||
| summary | Yes | ||
| rateLimit | No | ||
| pagination | No |