Query Product Page Locale Details

Queries the localized content of custom product pages (CPPs).

URL

POST https://api.ads.apple.com/v1/product-pages/locale-details/query

Header Parameters

Name	Type	Description
`X-AP-Context` Required	string

Response Codes

Status	Reason	Type
200	OK Content-Type: application/json	`ProductPageLocaleDetailsQueryResponse`
400	Bad Request Content-Type: application/json	`ProductPageLocaleDetailsQueryResponse`
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 returns locale details for custom product pages. For each language version, the response returns the metadata that Apple Ads will show (including the localized appName, subTitle, promotionalText, and shortDescription) along with asset references organized by device class in the assetsByDevice field.

To preview how a product page creative will appear across different locales before using it in a campaign, use this endpoint. This is especially useful when managing multi-locale campaigns to verify that all required language variants are present and correctly populated.

To retrieve locale details for an app’s default product page, see Query App Locale Details.

Filter on productPageId to retrieve the locale details for one custom product page. Omitting the languageCode filter returns all of that page’s locales. Add a languageCode filter to retrieve a specific locale.

See QueryFilterOperator for the full set of supported comparison operators.

Request Body

Filterable Fields

Field	Type	Operators	Description
`productPageId`	string (UUID)	`EQUALS`	Scopes the query to a specific product page. See Key Constraints below.
`language`	string	`EQUALS`	Filter to a specific language identifier, such as `en`, `fr`, or `yue`.
`languageCode`	string	`EQUALS`	Filter to a specific locale, such as `en-US`, `fr-FR`, or `zh-Hans`.

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 locale details:

Constraint	Detail
X-AP-Context header	Required. Send `X-AP-Context: adAccountId=<id>`. Without it, the API returns `403 Forbidden`.
productPageId filter	Include a `productPageId` filter. A `productPageId` that doesn’t match any page returns `200` with an empty `result`.
All locales by default	Omitting `languageCode` returns all locales configured for the product page.
assetsByDevice structure	The `assetsByDevice` field maps each specific device type (for example, `iphone_6_5`, `iphone_6_7`) to a `DeviceAssetGroup` containing an `assets` array of asset references and an `appPreviewDeviceFallBackDevices` array.

Payload Examples

HTTP Body

See QueryRequest.