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 Standardtext der Benutzeroberfläche, der verwendet wird, wenn die Sprache des Geräts mit keiner der in localizedUpdateDescriptions angegebenen Sprachen übereinstimmt.

localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

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

urgencyMode

enum (UrgencyMode)

Optional. Die Aktualisierungsdringlichkeit, die vorgibt, wie ein Nutzer zur Eingabeaufforderung aufgefordert wird. Wenn nicht angegeben, wird der Standardwert MANDATORY verwendet.

scheduledInstallDelay

enum (ScheduledInstallDelay)

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

wifiOnlyTime

enum (WifiOnlyTime)

Optional. Wenn WIFI_ONLY_TIME_UNSPECIFIED beibehalten wird, ist die Standardeinstellung SEVEN_DAYS.

Hinweis: Dieser Wert wird auf FOREVER gesetzt, wenn urgencyMode RECOMMENDED ist.

updateMaintenanceWindow

object (TimeWindow)

Optional. Das Zeitfenster für die Installation des OTA.

packageSizeAwareBatteryThreshold

boolean

Optional. Gibt an, ob für das Update je nach Größe unterschiedliche Grenzwerte für den Akkuladestand gelten sollen.

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 mcc-/mnc-Codes identifiziert werden. Diese Angabe darf ausschließlich für mobileNetworkCarrierRestriction verwendet werden. Es können nicht beide Felder gleichzeitig festgelegt werden.

deviceBuildPropertyRestriction

object (IncludeExclude)

Optional. Die mögliche Beschränkung der Eigenschaften des Geräte-Builds ein- oder ausgeschlossen.

mobileNetworkCarrierRestriction

object (IncludeExclude)

Optional. Die möglichen Mobilfunkanbieter, die ein- oder ausgeschlossen sind. Diese Angabe darf ausschließlich für mobileNetworkRestriction verwendet werden. Es können nicht beide Felder gleichzeitig festgelegt werden.

Informationen zu den Zuordnungen finden Sie unter Ländercode für Mobilgeräte und Code für Mobilfunknetze.

updateRequiredSetup

boolean

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

minimalSpaceRequired

enum (SpaceNeed)

Optional. Den minimalen Platzbedarf Wenn der Wert UNSPECIFIED ist, legt der Server keine Einschränkung fest. Erfordert die 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 dies auf „true“ gesetzt ist, sollte „rolloutSteps“ nicht festgelegt werden.

rolloutSteps[]

object (RolloutStep)

Optional. Entweder rolloutSteps oder immediateRelease ist erforderlich. RolloutSteps müssen in der richtigen Reihenfolge angegeben werden: Sowohl time_ms als auch fraction sollten nicht abnehmen. Der letzte Schritt sollte den Wert == 100 haben.

securityUpdate

boolean

Optional. Kennzeichnet das Update als Sicherheitsupdate. Diese wird an das Gerät übergeben, um die Anzeige der richtigen Aktualisierungsnachricht zu koordinieren. Das heißt, um den Text „Sicherheitsupdate wird angewendet“ anzuzeigen anstatt ein Systemupdate anzuwenden. 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. Diese sollte nur vom Server zurückgegeben werden, wenn die Konfiguration zurückgegeben wird.

allowEncryptedScheduledInstall

boolean

Optional. Gibt an, ob die Installation eines Pakets 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.