Contents

Get Product Pages by Identifier

Fetches metadata for a specific product page.

URL

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

Path Parameters

NameTypeDescription
adamId Requiredint64

Your unique App Store app identifier.

Your adamId in the resource path must match the adamId in your campaign. Use Get a Campaign or Get all Campaigns to obtain your adamId and correlate it to the correct campaign.

productPageId Requiredstring

A unique string to identify a product page on App Store Connect. For example, 45812c9b-c296-43d3-c6a0-c5a02f74bf6e.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
ProductPageDetailResponse

If the call succeeds, the API returns the ProductPageDetailResponse 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.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not 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.

500Internal 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

Discussion

Use this endpoint to fetch metadata assigned to a specific product page using your adamId and productPageId in the resource path. Your productPageId is an identifier appended to your app product page. For example, https://apps.apple.com/us/app/trip-trek/id12345678?45812c9b-c296-43d3-c6a0-c5a02f74bf6e.

Use your productPageId to create a Creative and obtain a creativeId. See Create a Creative.

Payload example: Get product pages by identifier

See Also

Product Page Endpoints