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 )

Необязательный. По умолчанию используется SEVEN_DAYS , если оставить WIFI_ONLY_TIME_UNSPECIFIED .

Примечание : для этого параметра будет установлено значение FOREVER , если RECOMMENDED urgencyMode .

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

Необязательный. Указывает, требуется ли обновление во время работы мастера установки. По умолчанию ложь.

minimalSpaceRequired

enum ( SpaceNeed )

Необязательный. Минимальные требования к пространству. Если значение UNSPECIFIED , сервер не будет устанавливать ограничение. Требуются сервисы Google Play 6.1.11 или более поздней версии.

immediateRelease

boolean

Необязательный. Требуется один из шагов immediateRelease или rolloutSteps . Следует ли выпускать обновление немедленно. Если это правда, то rolloutSteps должен быть отключен.

rolloutSteps[]

object ( RolloutStep )

Необязательный. Требуется один из rolloutSteps или immediateRelease . RolloutSteps должен быть в порядке: и time_ms, и Fraction не должны уменьшаться. Последний шаг должен иметь дробь == 100.

securityUpdate

boolean

Необязательный. Помечает обновление как обновление безопасности. Оно передается устройству для координации отображения правильного сообщения об обновлении. То есть отображать текст «применение обновления безопасности», а не «применение обновления системы». Требуется уровень API 22 или более поздней версии и Сервисы Google Play 9,4 или более поздней версии.

details

object ( ConfigDetails )

Только вывод. Более подробная информация о конфиге. Сервер должен возвращать это значение только при возврате конфигурации.

allowEncryptedScheduledInstall

boolean

Необязательный. Разрешено ли планировать пакет для установки на зашифрованные устройства.

reminderDialogSettings

object ( ReminderDialogSettings )

Необязательный. Настройки модального диалогового окна, напоминающего пользователям о наличии ожидающего обновления.

ОбновлениеОписание

Описание обновления отправлено на устройство.

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 или выше.

ЛокализованноеОбновлениеОписание

Описание обновления на основе локали.

JSON-представление
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Поля
locales[]

string

Локали, соответствующие локали устройства.

updateDescription

object ( UpdateDescription )

Описание обновления, которое отправляется на устройство.

Режим срочности

Режим срочности обновления.

Перечисления
MODE_UNSPECIFIED Не указан.
RECOMMENDED Рекомендую обновить. Пользователю будет предложено загрузить и установить обновление.
MANDATORY Обязательное обновление. Обновление загрузится автоматически, но пользователю будет предложено начать установку.
AUTOMATIC Автоматическое обновление. Обновление будет загружено и установлено автоматически.

ЗапланированнаяустановкаDelay

Окно задержки с момента доступности обновления до автоматического планирования установки.

Перечисления
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 Окно навсегда.

ВремяОкно

Временное окно, определяющее время начала дня и время окончания дня.

JSON-представление
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Поля
startTime

object ( TimeOfDay )

Время начала окна.

stopTime

object ( 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.

OffPeakОбновление

Ограничение обновления в непиковое время.

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 или более поздней версии.

ОбновлениеOffPeakDays

Количество дней, в течение которых можно попытаться загрузить обновление в непиковое время.

Перечисления
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 дней.

Ограничение сотового оператора

Установите значение CELLULAR_OPERATOR_RESTRICTED , чтобы наложить ограничение на окно внепиковой нагрузки, чтобы загрузка OTA ограничивалась оператором сотовой связи, от которого она была получена впервые. Предназначен для устройств с несколькими SIM-картами при использовании в сочетании с mobileNetworkRestriction для ограничения загрузок в непиковое время определенным оператором.

Перечисления
OPERATOR_RESTRICTED_UNSPECIFIED Не указан.
CELLULAR_OPERATOR_RESTRICTED Окно внепиковой нагрузки применимо только к оператору сотовой связи, через которого OTA было получено впервые.
ALL_NETWORK_ALLOWED Внепиковое окно применимо для всех сетей.

ВключитьИсключить

Включает или исключает определенные шаблоны, разделенные запятыми.

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 МБ.
ONE_HUNDRED_AND_FIFTY_MB 150 МБ.
TWO_HUNDRED_AND_FIFTY_MB 250 МБ.
FIVE_HUNDRED_MB 500 МБ.

шаг развертывания

Компонент шага развертывания.

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.

Подробности конфигурации

Подробности конфига.

JSON-представление
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Поля
postConditions[]

object ( Condition )

Постусловия установки конфигурации.

packages[]

object ( PackageConfig )

Определенные пакеты этой конфигурации. Важно: порядок пакетов важен. Если устройство соответствует нескольким наборам предварительных условий, последний соответствующий пакет выигрывает и будет применен к устройству.

groups[]

string

Связанные группы этой конфигурации.

versionTag

object ( VersionTag )

Только вывод. Версия конфигурации.

НапоминаниеDialogSettings

Настройки, управляющие модальным диалоговым напоминанием, которое отображается пользователям через указанный промежуток времени.

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 Начало через четырнадцать дней. СЛЕДУЮЩАЯ ТЕГКА: 6

НапомнитьПозжеПродолжительность

Как долго в диалоговом окне отображается кнопка «Напомнить позже». Выберите ALWAYS_SHOW , чтобы кнопка отображалась постоянно, и NEVER_SHOW , чтобы никогда ее не показывать. Если оставить LATER_DURATION_UNSPECIFIED , будет использоваться значение по умолчанию LATER_FOURTEEN_DAYS .

Перечисления
LATER_DURATION_UNSPECIFIED Не указан.
NEVER_SHOW Никогда не показывайте кнопку.
ALWAYS_SHOW Всегда показывать кнопку.
LATER_SEVEN_DAYS Удалите кнопку через семь дней.
LATER_FOURTEEN_DAYS Удалите кнопку через четырнадцать дней.
LATER_TWENTY_ONE_DAYS Удалите кнопку через двадцать один день.

Частота

Через какое время после того, как пользователь закроет диалоговое окно напоминания, оно появится снова. Если оставить 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

 Обновите пакеты в конфиге.