Get Product Pages

Fetches metadata of all your custom product pages.

URL

GET https://api.searchads.apple.com/api/v5/apps/{adamId}/product-pages

Path Parameters

Name	Type	Description
`adamId` Required	int64	The unique identifier for the ad group.

Query Parameters

Name	Type	Description
`name` Optional	string	Filters by `name` field. For example, the name of your custom product page on App Store Connect.
`states` Optional	string	Filters by `states`, which indicates whether the product page is visible or not.

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`ProductPageDetailListResponse`	If the call succeeds, the API returns the ProductPageDetailListResponse object in the response payload with an HTTP status code of `200(OK)`. If unsuccessful, the HTTP status code indicates the error with details in the error message.
400	Bad Request Content-Type: application/json	`ApiErrorResponse`	An invalid query or missing required parameters.
401	Unauthorized Content-Type: application/json	`ApiErrorResponse`	An unauthenticated call fails to get the requested response.
403	Forbidden Content-Type: application/json	`ApiErrorResponse`	Insufficient rights to the resource.
404	Not Found Content-Type: application/json	`ApiErrorResponse`	The API can’t locate the resource.
429	Content-Type: application/json	`ApiErrorResponse`	The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API.
500	Internal Server Error Content-Type: application/json	`ApiErrorResponse`	The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later.

Mentioned in

Apple Ads Campaign Management API 5

Discussion

Use this endpoint to fetch your product page metadata using your adamId in the resource path. Use your productPageId to Create a Creative obtain a creativeId.

Payload example: Get product pages

The id in the response is your productPageId, an identifier for your app product page. For example, 45812c9b-c296-43d3-c6a0-c5a02f74bf6e.