Contents

Query App Locale Details

Return 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

NameTypeDescription
adamId Requiredint64

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppLocaleDetailsQueryResponse
400Bad Request
Content-Type: application/json
AppLocaleDetailsQueryResponse
401Unauthorized
Content-Type: application/json
Error
403Forbidden
Content-Type: application/json
Error
404Not Found
Content-Type: application/json
ErrorResponse
429Too Many Requests
Content-Type: application/json
Error
500Internal Server Error
Content-Type: application/json
Error

Discussion

This endpoint returns the default product page locale details for an app identified by its adamId. The default product page represents the app’s main App Store listing: the page that all users see unless directed to a custom product page.

In App Store Connect, there is no explicit “default product page” entity. The app’s main listing is the default. This endpoint surfaces that listing through the same AppLocaleDetails structure, so the response format is consistent across both endpoints.

To quickly fetch the default page content for an app without needing to first look up the product page ID, use this endpoint. 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

Default page only

This endpoint returns only the default product page. Custom product pages require the Query Product Page Locale Details endpoint.

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.

Payload Examples

See Also