related_applications

實驗性: 這是一項實驗性技術
在生產中使用此技術之前,請仔細檢查瀏覽器相容性表格

related_applications 清單成員用於指定與您的 Web 應用相關的一個或多個應用。這些可以是特定於平臺的應用或漸進式 Web 應用 (PWA)。

這使您能夠使用 Web API,例如 Navigator.getInstalledRelatedApps(),來檢查您的 Web 應用的特定平臺版本或 Web 應用本身是否已安裝在裝置上。

related_applications 清單成員還可以與 prefer_related_applications 清單成員一起使用,後者指示優先安裝相關的原生應用或您的 Web 應用。

語法

json
/* Related native application on one platform specified by both url and id */
"related_applications": [
  {
    "platform": "play",
    "url": "https://play.google.com/store/apps/details?id=com.example.app1",
    "id": "com.example.app1"
  }
]

/* Related native application on one platform specified only by id */
"related_applications": [
  {
    "platform": "windows",
    "id": "example.app1"
  }
]

/* Related native applications on two platforms */
"related_applications": [
  {
    "platform": "play",
    "url": "https://play.google.com/store/apps/details?id=com.example.app1",
    "id": "com.example.app1"
  },
  {
    "platform": "amazon",
    "url": "https://www.amazon.com/product/dp/B000XA1000"
  }
]

/* Related web application specified by id */
"related_applications": [
  {
    "platform": "webapp",
    "id": "com.example.app1"
  }
]

一個物件陣列,每個物件代表一個與 Web 應用相關的、特定於平臺的應用。每個物件必須包含一個 platform 屬性和一個 urlid(或兩者都包含)。

platform

一個字串,用於標識應用所在的平臺。示例包括 amazon (Amazon App Store)、play (Google Play Store)、windows (Windows Store) 和 webapp (適用於漸進式 Web 應用)。有關可能的 平臺值 的完整列表,請參閱。

url 可選

一個字串,表示可以在其中找到特定平臺應用的位置 URL。如果未指定,則必須提供 id

id 可選

一個字串,包含用於在指定平臺上表示該應用的 ID。如果未指定,則必須提供 url

描述

“相關應用”是指 Web 應用本身(在安裝為漸進式 Web 應用 (PWA) 時),或提供與您的 Web 應用類似功能的 原生 應用,後者通常具有更多功能或與使用者裝置的更好整合。

related_applications 清單成員可讓您識別與您的 Web 應用相關的特定平臺應用。例如,假設您有一個產品對應的原生 Android 應用,可透過 Google Play 商店獲取。它提供了與您的 Web 應用相同核心功能,並能更好地整合裝置通知系統。您可以使用 related_applications 在您的 Web 應用的清單檔案中指定此原生 Android 應用。

關於 related_applications 成員的一些要點包括:

  • 它允許您在不同平臺上指定多個相關應用,為使用者提供各種裝置和作業系統上的原生應用選項。

  • 它在您的 Web 應用和指定平臺之間建立了單向關係。原生應用無需反向引用您的 Web 應用。

  • Web 爬蟲可能會使用這些資料來收集有關與您的 Web 應用相關的原生應用的更多資訊,從而可能提高這些應用的可見性。

  • 當與 prefer_related_applications 成員一起使用並設定為 true 時,它允許瀏覽器建議安裝相關原生應用,而不是您的 Web 應用。

    注意: 對於基於 Chromium 的瀏覽器,應將 prefer_related_applications 設定為 false 或省略,以使您的 Web 應用可安裝。

示例

此示例展示瞭如何在您的 Web 應用清單檔案中指定相關的原生 Android 應用。它使用了最少的資訊來識別在 Google Play 商店中可用的原生應用。

json
{
  "related_applications": [
    {
      "platform": "play",
      "id": "com.example.app1"
    }
  ]
}

如果您的 Web 應用在 Google Play 商店和 Windows 商店上都有原生版本,您可以在 Web 應用的清單檔案中這樣指定它們:

json
{
  "related_applications": [
    {
      "platform": "play",
      "url": "https://play.google.com/store/apps/details?id=com.example.app1",
      "id": "com.example.app1"
    },
    {
      "platform": "windows",
      "url": "https://apps.microsoft.com/store/detail/example-app1/9WZDNCRFHVJL"
    }
  ]
}

如果您希望向瀏覽器表明您希望使用者可以選擇安裝您的原生應用(可在 Google App Store 上獲得),而不是您的 Web 應用,則可以將 prefer_related_applications 設定為 true。瀏覽器隨後可能會提示使用者安裝原生 Android 應用,而不是您的 Web 應用。

json
{
  "prefer_related_applications": true,
  "related_applications": [
    {
      "platform": "play",
      "id": "com.example.app1"
    }
  ]
}

如果您的 Web 應用可以安裝為裝置上的漸進式 Web 應用 (PWA),例如,為了利用將 PWA 整合到作業系統中的功能,您可以在清單檔案中自我引用您的 Web 應用。

json
{
  "related_applications": [
    {
      "platform": "webapp",
      "id": "com.example.app1"
    }
  ]
}

規範

規範
清單孵化
# related_applications 成員

瀏覽器相容性

另見