Contents

Get Product Page Locales

Fetches product page locales by identifier.

URL

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

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.

Query Parameters

NameTypeDescription
deviceClasses Optionalstring

Filters by device type.

expand Optionalboolean

Detailed app asset details of a device. Use true for expanded values in the API response.

languageCodes Optionalstring

Filters by ISO 639-1 language code appended to the ISO alpha-2 country code, such as en-US. The languageCodes paramater can have multiple values such as en-US, fr-CA.

languages Optionalstring

Filters by ISO alpha-2 country code, such as US.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
ProductPageLocaleDetailListResponse

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

400Bad Request
Content-Type: application/json
ApiErrorResponse

An invalid query or missing required parameters.

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.

Discussion

Use this endpoint to return localized product page metadata using your adamId and productPageId in the resource path.

Payload example: Get product page locales

Payload example: Expanded format

See Also

Product Page Endpoints