REST Resource: deployments.configs

資源：Config

部署作業的設定。

JSON 表示法 
{
  "name": string,
  "title": string,
  "description": string,
  "defaultUpdateDescription": {
    object (UpdateDescription)
  },
  "localizedUpdateDescriptions": [
    {
      object (LocalizedUpdateDescription)
    }
  ],
  "urgencyMode": enum (UrgencyMode),
  "scheduledInstallDelay": enum (ScheduledInstallDelay),
  "wifiOnlyTime": enum (WifiOnlyTime),
  "updateMaintenanceWindow": {
    object (TimeWindow)
  },
  "packageSizeAwareBatteryThreshold": boolean,
  "offPeakUpdate": {
    object (OffPeakUpdate)
  },
  "countryRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkRestriction": {
    object (IncludeExclude)
  },
  "deviceBuildPropertyRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkCarrierRestriction": {
    object (IncludeExclude)
  },
  "updateRequiredSetup": boolean,
  "minimalSpaceRequired": enum (SpaceNeed),
  "immediateRelease": boolean,
  "rolloutSteps": [
    {
      object (RolloutStep)
    }
  ],
  "securityUpdate": boolean,
  "details": {
    object (ConfigDetails)
  },
  "allowEncryptedScheduledInstall": boolean,
  "reminderDialogSettings": {
    object (ReminderDialogSettings)
  }
}
欄位
name

string

僅供輸出。設定的名稱。請注意，這是 Config 物件的專屬 ID，當建立新的 Config 時，伺服器會產生這個 ID。
title

string

選用設定。設定的標題。
description

string

選用設定。設定的說明。
defaultUpdateDescription

object (UpdateDescription)

必要欄位。裝置語言代碼與 localizedUpdateDescriptions 中指定的任何語言代碼不相符時使用的預設 UI 文字。
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

選用設定。本地化更新說明清單，如果其中一個與裝置語言代碼相符，則這些說明的優先順序高於 defaultUpdateDescription。
urgencyMode

enum (UrgencyMode)

選用設定。更新期限 (用於規定使用者收到提示的方式)。如未指定，系統會使用預設的 MANDATORY。
scheduledInstallDelay

enum (ScheduledInstallDelay)

選用設定。決定系統何時安排在夜間安裝更新。如未指定，則預設值為 NEVER。
wifiOnlyTime

enum (WifiOnlyTime)

選用設定。如果左側是 WIFI_ONLY_TIME_UNSPECIFIED，則預設為 SEVEN_DAYS。

注意：如果 urgencyMode 為 RECOMMENDED，這個項目會設為 FOREVER。
updateMaintenanceWindow

object (TimeWindow)

選用設定。OTA 的安裝時間範圍。
packageSizeAwareBatteryThreshold

boolean

選用設定。更新是否有不同的安裝電池閾值 (依更新大小而定)。
offPeakUpdate

object (OffPeakUpdate)

選用設定。離峰時段更新物件。
countryRestriction

object (IncludeExclude)

選用設定。可能納入/排除的國家/地區。
mobileNetworkRestriction

object (IncludeExclude)

選用設定。以 mcc/mnc 代碼識別的可能包含/排除行動網路。請注意，這只能從 mobileNetworkCarrierRestriction 中移除。這兩個欄位不得同時設定。
deviceBuildPropertyRestriction

object (IncludeExclude)

選用設定。可能納入/排除的裝置版本屬性限制。
mobileNetworkCarrierRestriction

object (IncludeExclude)

選用設定。可能納入/排除的行動網路電信業者。請注意，這只能從 mobileNetworkRestriction 中移除。這兩個欄位不得同時設定。

如要查看對應，請參閱「行動裝置國家/地區代碼和行動網路代碼」。
updateRequiredSetup

boolean

選用設定。指出在設定精靈中是否需要更新。預設值為 false。
minimalSpaceRequired

enum (SpaceNeed)

選用設定。最低空間要求。如果值為 UNSPECIFIED，伺服器就不會設定限制。必須安裝 Google Play 服務 6.1.11 以上版本。
immediateRelease

boolean

選用設定。必須提供 immediateRelease 或 rolloutSteps 其中之一。是否應立即發布更新。如果設為 true，就不設定 rolloutSteps。
rolloutSteps[]

object (RolloutStep)

選用設定。必須提供 rolloutSteps 或 immediateRelease 其中之一。RolloutSteps 的順序必須依序為：time_ms 和分數皆不可減去。最後一個步驟的分數應為 == 100。
securityUpdate

boolean

選用設定。將更新標示為安全性更新。系統會將這項資訊傳送至裝置，以協調正確的更新訊息的顯示方式。也就是說，裝置必須顯示「正在套用安全性更新」而非「套用系統更新」需要 API 級別 22 以上版本和 Google Play 服務 9.4 以上版本。
details

object (ConfigDetails)

僅供輸出。設定的詳細資料。只有伺服器在傳回設定時才能傳回這個引數。
allowEncryptedScheduledInstall

boolean

選用設定。是否允許安排在加密裝置上安裝套件。
reminderDialogSettings

object (ReminderDialogSettings)

選用設定。強制回應對話方塊的設定，提醒使用者有待更新。

UpdateDescription

傳送至裝置的更新說明。

JSON 表示法 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
欄位
description

string

更新說明文字。
title

string

更新說明標題。
dialogMessage

string

更新的對話方塊訊息。
postSuccessMessage

string

更新貼文的成功訊息。需要 API 級別 14 以上。
postFailureMessage

string

更新後的發布失敗訊息。需要 API 級別 14 以上。

LocalizedUpdateDescription

根據語言代碼提供的更新說明。

JSON 表示法 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
欄位
locales[]

string

用於與裝置語言代碼相符的語言代碼。
updateDescription

object (UpdateDescription)

傳送至裝置的更新說明。

UrgencyMode

升級緊急模式。

列舉
MODE_UNSPECIFIED 不指定。
RECOMMENDED 建議升級。系統會提示使用者下載並安裝更新。
MANDATORY 必須升級。系統會自動下載更新，但會提示使用者開始安裝。
AUTOMATIC 自動升級。系統會自動下載及安裝更新。

ScheduledInstallDelay

從可更新到自動排定安裝的延遲時間。

列舉
SCHEDULED_INSTALL_DELAY_UNSPECIFIED 預設值。將視為 NEVER。
SCHEDULED_INSTALL_DELAY_NEVER 永不提報至自動安裝。
SCHEDULED_INSTALL_DELAY_ZERO_DAYS 零時差 (立即)
SCHEDULED_INSTALL_DELAY_ONE_DAY 一天內。
SCHEDULED_INSTALL_DELAY_TWO_DAYS 兩天的回溯期。
SCHEDULED_INSTALL_DELAY_THREE_DAYS 三天的回溯期。
SCHEDULED_INSTALL_DELAY_FOUR_DAYS 四天期間。
SCHEDULED_INSTALL_DELAY_FIVE_DAYS 五個回溯期。
SCHEDULED_INSTALL_DELAY_TEN_DAYS 十天回溯期
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS 十五天期間。
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS 三十天。

WifiOnlyTime

在更新完成後的這段期間內，下載功能將避免使用行動網路。

列舉
WIFI_ONLY_TIME_UNSPECIFIED 不指定。
NONE 未封鎖。
TWENTY_FOUR_HOURS 二十四小時期間。
THREE_DAYS 三天的回溯期。
SEVEN_DAYS 七天回溯期。
FOURTEEN_DAYS 十四天期間。
TWENTY_ONE_DAYS 二十一天。
FOREVER 永久存在。

TimeWindow

用來定義一天中的開始時間和停止時間的時間範圍。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
欄位
startTime

object (TimeOfDay)

回溯期開始時間。
stopTime

object (TimeOfDay)

視窗停止時間。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
欄位
hours

integer

一天的營業時間，以 24 小時製表示。值應介於 0 到 23 之間。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

integer

一天內的分鐘數。值必須介於 0 到 59 之間。
seconds

integer

時間的秒數。正常情況下，值必須介於 0 到 59 之間。如果 API 允許閏秒，則可允許值為 60。
nanos

integer

秒數的小數，以奈秒表示。值必須介於 0 到 999,999,999 之間。

OffPeakUpdate

異常更新限制。

JSON 表示法 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
欄位
updateOffPeakWindow

object (TimeWindow)

下載更新的非尖峰時段。必須安裝 Google Play 服務 6.7.72 以上版本。
updateOffPeakDays

enum (UpdateOffPeakDays)

選用設定。如果值為 OFF_PEAK_DAYS_UNSPECIFIED，伺服器會使用預設值 OFF_PEAK_UPDATE_ONE_DAY。必須安裝 Google Play 服務 6.5 以上版本。
updateOperatorRestriction

enum (CellularOperatorRestriction)

選用設定。如未指定這個值，伺服器會使用預設值 ALL_NETWORK_ALLOWED。必須搭配 Google Play 服務 6.7.72 以上版本。

UpdateOffPeakDays

在離峰時段下載更新的天數。

列舉
OFF_PEAK_DAYS_UNSPECIFIED 不指定。
OFF_PEAK_UPDATE_ONE_DAY 1 天。
OFF_PEAK_UPDATE_THREE_DAYS 3 天。
OFF_PEAK_UPDATE_SEVEN_DAYS 7 天。
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 天。
OFF_PEAK_UPDATE_THIRTY_DAYS 30 天。

CellularOperatorRestriction

設為 CELLULAR_OPERATOR_RESTRICTED 即可在離峰時段施加限制，讓 OTA 下載範圍僅限於最初接收到的電信業者。適用於與 mobileNetworkRestriction 搭配使用的多 SIM 卡裝置，可限制只有特定電信業者的使用者下載離峰值。

列舉
OPERATOR_RESTRICTED_UNSPECIFIED 不指定。
CELLULAR_OPERATOR_RESTRICTED 只有首次透過 OTA 收到 OTA 的電信業者才適用這個休假期間。
ALL_NETWORK_ALLOWED 離峰期適用於所有電視網。

IncludeExclude

加入或排除某些以半形逗號分隔的格式。

JSON 表示法 
{

  // Union field include_exclude can be only one of the following:
  "include": string,
  "exclude": string
  // End of list of possible types for union field include_exclude.
}
欄位
聯集欄位 include_exclude。包含或排除的規則。include_exclude 只能是下列其中一項：
include

string

包含的模式。如果允許多個值，請以半形逗號分隔。
exclude

string

排除模式。如果允許多個值，請以半形逗號分隔。

SpaceNeed

空間要求 (以位元組為單位)。

列舉
SPACE_NEED_UNSPECIFIED 不指定。
ONE_HUNDRED_MB 100 MB。
ONE_HUNDRED_AND_FIFTY_MB 150 MB。
TWO_HUNDRED_AND_FIFTY_MB 250 MB。
FIVE_HUNDRED_MB 500 MB。

RolloutStep

推出步驟元件。

JSON 表示法 
{
  "rolloutTime": string,
  "fraction": number
}
欄位
rolloutTime

string (Timestamp format)

推出作業時間戳記。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
fraction

number

以 0.00 到 100.00 之間的百分比表示。

ConfigDetails

設定的詳細資料。

JSON 表示法 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
欄位
postConditions[]

object (Condition)

設定安裝後條件。
packages[]

object (PackageConfig)

這項設定的定義套件。重要事項：請務必留意套件的順序。如果裝置符合多組先決條件，則最後一個相符的套件將獲勝，然後套用至裝置。
groups[]

string

這項設定的相關群組。
versionTag

object (VersionTag)

僅供輸出。設定版本。

ReminderDialogSettings

這項設定可控制在指定時間後向使用者顯示強制回應提醒對話方塊的設定。

JSON 表示法 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
欄位
start

enum (Start)

何時開始顯示提醒。
remindMeLaterDuration

enum (RemindLaterDuration)

時間長度為「稍後提醒我」按鈕。
frequency

enum (Frequency)

頻率提醒關閉後會顯示。

開始

提醒對話方塊的顯示時機。舉例來說，如果設為 START_TWO_DAYS，使用者就會在收到更新的 2 天後看到提醒。如果保留 START_UNSPECIFIED，則會使用預設的 START_SEVEN_DAYS。

列舉
START_UNSPECIFIED 不指定。
NEVER_START 永遠不要啟動提醒。
START_ZERO_DAYS 立即開始使用。
START_TWO_DAYS 兩天後開始。
START_SEVEN_DAYS 七天後開始。
START_FOURTEEN_DAYS 14 天後開始。下一個標記：6

RemindLaterDuration

對話方塊顯示「稍後提醒我」訊息的時間長度按鈕。選擇 ALWAYS_SHOW 一律顯示按鈕，選擇 NEVER_SHOW 則不顯示。如果保留 LATER_DURATION_UNSPECIFIED，則會使用預設的 LATER_FOURTEEN_DAYS。

列舉
LATER_DURATION_UNSPECIFIED 不指定。
NEVER_SHOW 永不顯示按鈕。
ALWAYS_SHOW 一律顯示按鈕。
LATER_SEVEN_DAYS 7 天後移除按鈕。
LATER_FOURTEEN_DAYS 14 天後移除按鈕。
LATER_TWENTY_ONE_DAYS 20 天後移除按鈕。

頻率

使用者關閉提醒對話方塊後，需要多久時間才會再次顯示提醒。如果保留 FREQUENCY_UNSPECIFIED，則會使用預設的 FREQUENCY_SEVEN_DAYS。

列舉
FREQUENCY_UNSPECIFIED 不指定。
FREQUENCY_ONE_DAY 顯示每天的提醒。
FREQUENCY_THREE_DAYS 每三天顯示提醒。
FREQUENCY_SEVEN_DAYS 每 7 天顯示提醒一次。

方法

create

 建立 config，並傳回新的 Config。

delete

 刪除 config。

disable

 停用具有指定設定的所有已啟用群組。

get

 取得 config 檢視畫面。

list

 列出部署作業的 configs。

update

 更新 config。

updatePackages

 更新設定底下的套件。