Get Product Page by ID
Retrieves a specific Custom Product Page (CPP) by its unique UUID.
URL
GET https://api.ads.apple.com/v1/product-pages/{productPageId}Path Parameters
| Name | Type | Description |
|---|---|---|
productPageId Required | string |
Header Parameters
| Name | Type | Description |
|---|---|---|
X-AP-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ProductPageDetailsResponse | |
| 400 | Bad Request Content-Type: application/json | Error | |
| 401 | Unauthorized Content-Type: application/json | Error | |
| 403 | Forbidden Content-Type: application/json | Error | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Too Many Requests Content-Type: application/json | Error | |
| 500 | Internal Server Error Content-Type: application/json | Error |
Discussion
This endpoint retrieves a single App Store Custom Product Page (CPP) by its unique UUID. You create and manage product pages in App Store Connect. This endpoint reads the product page state as it appears to the Apple Ads Platform API.
The state field is VISIBLE for an available page or HIDDEN for a hidden page.
The deepLink field can use a custom URL scheme, and it is an empty string when the product page has no deep link configured. The response also includes the product page name, the associated adamId of the app, and creationTime and modificationTime timestamps.
Keep the following constraints in mind when fetching a product page:
Constraint | Detail |
|---|---|
X-AP-Context header | Required. Send |
UUID format |
|
Discovery | Use Query Product Pages to list all product pages for an app by |