AppLocaleDetailsQueryResponse

Paginated response object for app locale detail queries.

Declaration

object AppLocaleDetailsQueryResponse

Properties

Name	Type	Description
`result`	[`AppLocaleDetails`]	Array of `AppLocaleDetails` objects, one per supported locale. Read-only.
`pagination`	`QueryPaginationResult`	Pagination metadata for the result set. See fields below. Read-only.
`error`	`Error`	Error details if the request failed. Omitted entirely on success. See Error. Read-only.

Discussion

The Query App Locale Details endpoint returns AppLocaleDetailsQueryResponse as the top-level envelope.

Example

{
  "result": [
    {
      "adamId": 123456789,
      "language": "en",
      "languageCode": "en-US",
      "isPrimaryLocale": true,
      "appName": "AwayFinder - Trip Planner",
      "subTitle": "Plan your next getaway",
      "promotionalText": "Get 3 months of Premium free",
      "shortDescription": "Plan, book, and track every trip in one place",
      "deviceClasses": [
        "IPHONE",
        "IPAD"
      ],
      "assetsByDevice": {
        "iphone_6_5": {
          "appPreviewDeviceFallBackDevices": [
            "iphone6",
            "iphone5"
          ],
          "assets": [
            {
              "assetId": "550e8400-e29b-41d4-a716-446655440000"
            }
          ]
        }
      }
    }
  ],
  "pagination": {
    "pageSize": 20,
    "offset": 0,
    "totalCount": 1
  }
}

The pagination object contains the following fields:

Field	Description
`pageSize`	Number of results per page
`offset`	Zero-based offset of the first result
`totalCount`	Total number of matching records. Only populated when the request sends `fetchTotalCount: true`

AppLocaleDetailsQueryResponse

Declaration

Properties

Discussion

Example

See Also