REST Resource: deployments.groups.configs

Ressource: Config

Eine Konfiguration einer Bereitstellung.

JSON-Darstellung
{
  "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)
  }
}
Felder
name

string

Nur Ausgabe Der Name der Konfiguration. Dies ist die eindeutige Kennung für Config-Objekte. Sie wird vom Server generiert, wenn eine neue Config erstellt wird.

title

string

Optional. Der Titel der Konfiguration.

description

string

Optional. Die Beschreibung der Konfiguration.

defaultUpdateDescription

object (UpdateDescription)

Erforderlich. Der Standard-UI-Text, der verwendet wird, wenn die Sprache des Geräts mit keiner Sprache in localizedUpdateDescriptions übereinstimmt.

localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Optional. Eine Liste lokalisierter Update-Beschreibungen, die Vorrang vor defaultUpdateDescription haben, wenn eine davon mit der Sprache des Geräts übereinstimmt.

urgencyMode

enum (UrgencyMode)

Optional. Die Dringlichkeit der Aktualisierung, die vorgibt, wie ein Nutzer aufgefordert wird. Wenn nicht angegeben, wird der Standardwert MANDATORY verwendet.

scheduledInstallDelay

enum (ScheduledInstallDelay)

Optional. Eine Verzögerung, die bestimmt, wann das Update über Nacht installiert wird. Wenn keine Angabe gemacht wird, wird standardmäßig NEVER verwendet.

wifiOnlyTime

enum (WifiOnlyTime)

Optional. Die Standardeinstellung ist SEVEN_DAYS, wenn WIFI_ONLY_TIME_UNSPECIFIED beibehalten wird.

Hinweis: Er wird auf FOREVER gesetzt, wenn urgencyMode gleich RECOMMENDED ist.

updateMaintenanceWindow

object (TimeWindow)

Optional. Das Zeitfenster für die Installation des OTA

packageSizeAwareBatteryThreshold

boolean

Optional. Gibt an, ob das Update je nach Größe unterschiedliche Schwellenwerte für die Akkuinstallation haben soll.

offPeakUpdate

object (OffPeakUpdate)

Optional. Das Update-Objekt außerhalb der Spitzenzeiten.

countryRestriction

object (IncludeExclude)

Optional. Die möglichen ein-/ausgeschlossenen Länder.

mobileNetworkRestriction

object (IncludeExclude)

Optional. Die möglichen ein-/ausgeschlossenen Mobilfunknetze, die durch Kundencenter-Codes identifiziert werden. Dieser Name darf ausschließlich für mobileNetworkCarrierRestriction verwendet werden. Beide Felder können nicht gleichzeitig festgelegt werden.

deviceBuildPropertyRestriction

object (IncludeExclude)

Optional. Die mögliche Einschränkung für die ein-/ausgeschlossenen Geräte-Build-Eigenschaften.

mobileNetworkCarrierRestriction

object (IncludeExclude)

Optional. Die möglichen ein-/ausgeschlossenen Mobilfunkanbieter. Dieser Name darf ausschließlich für mobileNetworkRestriction verwendet werden. Beide Felder können nicht gleichzeitig festgelegt werden.

Die Zuordnungen finden Sie unter Ländercode für Mobil- und Mobilfunknetz.

updateRequiredSetup

boolean

Optional. Gibt an, ob das Update während des Einrichtungsassistenten erforderlich ist. Die Standardeinstellung ist "false".

minimalSpaceRequired

enum (SpaceNeed)

Optional. Minimaler Speicherplatzbedarf Wenn der Wert UNSPECIFIED ist, legt der Server keine Einschränkung fest. Erfordert Google Play-Dienste 6.1.11 oder höher.

immediateRelease

boolean

Optional. Entweder immediateRelease oder rolloutSteps ist erforderlich. Gibt an, ob das Update sofort veröffentlicht werden soll. Wenn dieser Wert „true“ ist, sollte rolloutSteps nicht festgelegt werden.

rolloutSteps[]

object (RolloutStep)

Optional. Entweder rolloutSteps oder immediateRelease ist erforderlich. RolloutSteps müssen in einer bestimmten Reihenfolge angegeben werden: Sowohl „time_ms“ als auch „fraction“ sollten nicht abnehmend sein. Der letzte Schritt muss als Bruchwert == 100 angegeben werden.

securityUpdate

boolean

Optional. Kennzeichnet das Update als Sicherheitsupdate. Sie wird an das Gerät übergeben, um die Anzeige der richtigen Update-Nachricht zu koordinieren. Es wird also der Text „Sicherheitsupdate wird angewendet“ anstelle von „Systemupdate wird angewendet“ angezeigt. Erfordert API-Level 22 oder höher und Google Play-Dienste 9.4 oder höher.

details

object (ConfigDetails)

Nur Ausgabe Weitere Details zu einer Konfiguration. Dies sollte nur beim Zurückgeben der Konfiguration vom Server zurückgegeben werden.

allowEncryptedScheduledInstall

boolean

Optional. Gibt an, ob ein Paket für die Installation auf verschlüsselten Geräten geplant werden darf.

reminderDialogSettings

object (ReminderDialogSettings)

Optional. Einstellungen für das modale Dialogfeld, mit dem Nutzer daran erinnert werden, dass ein Update aussteht.

Methoden

list

Listet Konfigurationen der Gruppe auf.