Contents

ProductPageLocaleDetails

Locale-specific metadata for an App Store product page.

Declaration

object ProductPageLocaleDetails

Properties

NameTypeDescription
adamIdint64

The app’s Adam ID. The unique App Store identifier for the promoted object. Used as promotedObjectId when creating a campaign.

languagestring

The language identifier, for example, en.

languageCodestring

The BCP-47 language code, for example, en-US.

appNamestring

The localized application display name as it appears on the App Store.

subTitlestring

The app subtitle for the locale.

promotionalTextstring

The promotional text for the locale. Max 170 characters.

shortDescriptionstring

A short description for the locale. Max 4000 characters.

deviceClasses[string]

Supported device classes. Use to verify targeting compatibility when configuring ad groups with device-class targeting. Possible values: IPHONE, IPAD.

assetsByDeviceProductPageLocaleDetails.AssetsByDevice

Map of device type (for example, iphone_6_5, iphone_6_7) to a DeviceAssetGroup object. Keys are specific device type strings, not limited to the values in deviceClasses.

productPageIdstring

The parent product page identifier (ASC product page ID).

Discussion

The ProductPageLocaleDetails object provides the locale-specific content for an App Store product page, including display text and creative assets organized by device type. Each record is tied to a specific languageCode, making it possible to retrieve the exact creative content users will see in a given locale.

The assetsByDevice map is the primary structure for accessing locale media.

Example

{
  "adamId": 324684580,
  "language": "en",
  "languageCode": "en-US",
  "appName": "AwayFinder - Travel Planner",
  "subTitle": "Plan your next getaway",
  "promotionalText": "Get 3 months of Premium free",
  "shortDescription": "Discover, plan, and book trips with AwayFinder's curated travel guides.",
  "deviceClasses": [
    "IPHONE",
    "IPAD"
  ],
  "assetsByDevice": {
    "iphone_6_5": {
      "assets": [
        {
          "assetId": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "appPreviewDeviceFallBackDevices": [
        "iphone_6_7"
      ]
    },
    "iphone_6_7": {
      "assets": [
        {
          "assetId": "661f9511-f3ac-52e5-b827-557766551111"
        }
      ],
      "appPreviewDeviceFallBackDevices": []
    }
  },
  "productPageId": "133fc807-d4d5-4c77-92ae-1d6ffdf0c7dc"
}

Topics

Dictionaries

See Also