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 預設值。這會視為「一律不」。
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 4 天回溯期。
SCHEDULED_INSTALL_DELAY_FIVE_DAYS 五天的回溯期。
SCHEDULED_INSTALL_DELAY_TEN_DAYS 10 天回溯期。
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS 15 天回溯期。
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS 30 天的回溯期。

WifiOnlyTime

這樣一來，即使有可用的更新，你仍可在這段時間內使用行動網路下載。

列舉
WIFI_ONLY_TIME_UNSPECIFIED 未指定。
NONE 未封鎖。
TWENTY_FOUR_HOURS 24 小時回溯期，
THREE_DAYS 三天回溯期。
SEVEN_DAYS 7 天回溯期。
FOURTEEN_DAYS 14 天回溯期。
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 下載作業僅限於當初收到該電信業者的行動電信業者。適用於多 SIM 卡裝置搭配 mobileNetworkRestriction 使用，可限制只透過特定電信業者下載。

列舉
OPERATOR_RESTRICTED_UNSPECIFIED 未指定。
CELLULAR_OPERATOR_RESTRICTED 如果是首次透過 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 七天過後移除按鈕。
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 每七天顯示提醒一次。

方法

create

 建立 config，並傳回新的 Config。

delete

 刪除 config。

disable

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

get

 取得 config 檢視畫面。

list

 列出部署的 configs。

update

 更新 config。

updatePackages

 更新設定下的套件。