Contents

AppLocaleDetails

Localized content for an app’s Default Product Page.

Declaration

object AppLocaleDetails

Properties

NameTypeDescription
adamIdint64

App Store identifier for the app.

languagestring

Language identifier (for example, "en").

languageCodestring

BCP-47 language code (for example, "en-US").

isPrimaryLocaleboolean

True if this locale’s languageCode matches the app’s primary language.

appNamestring

Localized app name.

subTitlestring

Localized app subtitle.

promotionalTextstring

Promotional text for this locale (max 170 characters).

shortDescriptionstring

Short description for this locale (max 4000 characters).

deviceClasses[string]

Device families with available assets for this locale.

assetsByDeviceAppLocaleDetails.AssetsByDevice

Map of device type (for example, "iphone_6_5") to a DeviceAssetGroup containing the ordered list of asset IDs and any fallback device references.

Discussion

The AppLocaleDetails object represents the localized metadata and asset groupings for a single locale of an app’s Default Product Page (DPP). The language (for example, "en") and languageCode (for example, "en-US") fields identify each locale entry.

Example

{
  "adamId": 324684580,
  "language": "en",
  "languageCode": "en-US",
  "isPrimaryLocale": true,
  "appName": "AwayFinder - Travel Planner",
  "subTitle": "Discover new destinations",
  "promotionalText": "Get 3 months of Premium free",
  "shortDescription": "Plan trips and discover destinations with AwayFinder",
  "deviceClasses": [
    "IPHONE",
    "IPAD"
  ],
  "assetsByDevice": {
    "iphone_6_5": {
      "appPreviewDeviceFallBackDevices": [
        "iphone6",
        "iphone5"
      ],
      "assets": [
        {
          "assetId": "550e8400-e29b-41d4-a716-446655440000"
        },
        {
          "assetId": "660f9511-f3ac-52e5-b827-557766551111"
        }
      ]
    }
  }
}

Topics

Dictionaries

See Also