REST Resource: deployments.groups

資源:群組

與多個 OTA 設定相關聯的群組。

JSON 表示法
{
  "name": string,
  "enabled": boolean,
  "bypassRolloutSchedule": boolean,
  "descriptions": [
    {
      object (GroupDescription)
    }
  ],
  "defaultDescription": string,
  "production": boolean,
  "memberCount": string,
  "details": {
    object (GroupDetails)
  }
}
欄位
name

string

必要欄位。群組名稱。這個名稱只能包含英文字母、數字和底線。

enabled

boolean

選用設定。群組是否已啟用。預設值為 false。

bypassRolloutSchedule

boolean

選用設定。群組會略過推出時間表。預設值為 false。

descriptions[]

object (GroupDescription)

選用設定。系統可能會向使用者顯示這個群組的說明,說明為何他們收到不符合「production」的更新內容。

defaultDescription

string

必要欄位。用於任何未明確相符語言代碼的說明。

production

boolean

唯讀。表示群組是否夠大,可視為可視為生產群組。

memberCount

string (int64 format)

唯讀。目前群組中的裝置數量。

details

object (GroupDetails)

僅供輸出。進一步瞭解群組。這個欄位應在傳回群組時由伺服器傳回。

GroupDescription

單一翻譯的說明。

JSON 表示法
{
  "description": string,
  "locales": [
    string
  ]
}
欄位
description

string

此群組的本地化說明。請注意,這些訊息可能會向使用者顯示,說明他們收到特定更新的原因。

locales[]

string

應顯示這項說明的地區。

GroupDetails

群組的詳細資料,包括相關聯的 OTA 設定。所有此類資訊都是唯讀狀態。

JSON 表示法
{
  "configs": [
    string
  ],
  "members": [
    {
      object (GroupMember)
    }
  ],
  "disabledConfigs": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
欄位
configs[]

string

群組的相關設定。

members[]

object (GroupMember)

此群組的成員。

disabledConfigs[]

string

與群組相關聯的已停用設定。

versionTag

object (VersionTag)

群組版本。

方法

create

建立群組,並傳回新的 Group

delete

刪除 group

disable

停用定義的 groups

enable

啟用定義的 groups

get

取得 group

list

列出部署的 groups

update

更新 group

updateConfigs

更新 group 下的 config