REST Resource: deployments.configs

资源：配置

部署的配置。

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 对象的唯一标识符，将在创建新的 Config 时由服务器生成。
title

string

可选。配置的标题。
description

string

可选。配置的说明。
defaultUpdateDescription

object (UpdateDescription)

必需。当设备语言区域与 localizedUpdateDescriptions 中指定的任何语言区域均不匹配时，使用的默认界面文本。
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)

可选。可能包含/排除的设备 build 属性限制。
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 四天的回溯期。
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 允许闰秒，则 API 可以允许 60 一值。
nanos

integer

秒数的小数部分（以纳秒为单位）。值必须是介于 0 和 999999999 之间的数字。

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 的移动网络运营商可以下载 OTA。与 mobileNetworkRestriction 结合使用时，适合多 SIM 卡设备，用于将非高峰时段的下载限定为特定运营商。

枚举
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 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："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 请在 21 天后移除按钮。

频率

用户关闭“提醒”对话框后，过了多久才会再次显示该对话框。如果保留为 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

 更新该配置下的软件包。