Query App Locale Details

Returns the default product page locale details for an app identified by its adamId.

URL

POST https://api.ads.apple.com/v1/apps/{adamId}/locale-details/query

Path Parameters

Name	Type	Description
`adamId` Required	int64

Header Parameters

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

Response Codes

Status	Reason	Type
200	OK Content-Type: application/json	`AppLocaleDetailsQueryResponse`
400	Bad Request Content-Type: application/json	`AppLocaleDetailsQueryResponse`
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

The default product page is the app’s main App Store listing, the page all users see unless directed to a custom product page. This endpoint returns its localized content for an app identified by adamId, using the same structure as Query Product Page Locale Details, so you don’t need a productPageId.

To retrieve locale details for a custom product page, see Query Product Page Locale Details.

Each object in the result corresponds to one supported language for the default product page.

Keep the following constraints in mind when querying default locale details:

Constraint	Detail
All locales returned	This endpoint returns all locales configured for the default product page. Filter by `languageCode` in the request body `filters` array if you need a specific locale.
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.

See QueryFilterOperator for the full set of supported comparison operators.

Filterable Fields

Field	Type	Operators	Sortable	Description
`languageCode`	string			Filter to a specific locale, such as `en-US` or `fr-FR`.

The adamId field identifies the app via the URL path (/v1/apps/{adamId}/locale-details/query), not a request body filter. The request body is a QueryRequest composed of QueryFilter conditions and QuerySort directives (QuerySortOrder), controlled by QueryPagination.