Query Product Pages
Queries App Store product pages available to your account.
URL
POST https://api.ads.apple.com/v1/product-pages/queryHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ProductPageDetailsQueryResponse | |
| 400 | Bad Request Content-Type: application/json | ProductPageDetailsQueryResponse | |
| 401 | Unauthorized Content-Type: application/json | Error | |
| 403 | Forbidden Content-Type: application/json | Error | |
| 404 | Not Found Content-Type: application/json | Error | |
| 429 | Too Many Requests Content-Type: application/json | Error | |
| 500 | Internal Server Error Content-Type: application/json | Error |
Discussion
This endpoint queries product pages available to your ad account, returning Default Product Pages (DPPs), Custom Product Pages (CPPs), and Product Page Optimization (PPO) variants. Product pages come from App Store Connect and reflect the current publishing state of your product pages.
Filter by adamId to list all product pages for a specific app. This is the recommended starting point when building a CUSTOM_PRODUCT_PAGE creative: use this endpoint to discover the available productPageId values for an app, then fetch locale details or pass the ID directly to the creative creation endpoint.
Changes made in App Store Connect, such as publishing, hiding, or editing a product page, appear in this endpoint’s results after a short propagation delay.
See QueryFilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Sortable | Description |
|---|---|---|---|---|
| integer |
| Filter to all product pages for a specific app. | |
| string |
| Filter by page state. |
The request body is a QueryRequest composed of QueryFilter conditions and QuerySort directives (QuerySortOrder), controlled by QueryPagination.
Keep the following constraints in mind when querying product pages:
Constraint | Detail |
|---|---|
Filter by adamId | Always filter by |
App Store Connect source | Product page data originates in App Store Connect. This endpoint is read-only. |