REST Resource: deployments.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.

UpdateDescription

Die Beschreibung des Updates, die an das Gerät gesendet wurde.

JSON-Darstellung 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Felder
description

string

Der Beschreibungstext des Updates.
title

string

Der Titel der Beschreibung des Updates.
dialogMessage

string

Die Dialogmeldung des Updates.
postSuccessMessage

string

Die Erfolgsmeldung des Updates. Erfordert API-Level 14 oder höher.
postFailureMessage

string

Die Fehlermeldung nach der Aktualisierung. Erfordert API-Level 14 oder höher.

LocalizedUpdateDescription

Die Beschreibung des Updates basierend auf der Sprache.

JSON-Darstellung 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Felder
locales[]

string

Die Sprachen, die den Sprachen des Geräts entsprechen.
updateDescription

object (UpdateDescription)

Die Beschreibung des Updates, die an das Gerät gesendet wird.

UrgencyMode

Der Modus „Dringlichkeit des Upgrades“.

Enums
MODE_UNSPECIFIED Nicht angegeben.
RECOMMENDED Upgrade empfehlen. Der Nutzer wird aufgefordert, das Update herunterzuladen und zu installieren.
MANDATORY Obligatorisches Upgrade. Das Update wird automatisch heruntergeladen, aber der Nutzer wird aufgefordert, die Installation zu starten.
AUTOMATIC Automatisches Upgrade. Das Update wird automatisch heruntergeladen und installiert.

ScheduledInstallDelay

Zeitfenster zwischen dem Zeitpunkt, an dem das Update verfügbar ist, bis zu dem Zeitpunkt, zu dem die Installation automatisch geplant wird.

Enums
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Standardwert. Wird wie NIE behandelt.
SCHEDULED_INSTALL_DELAY_NEVER Eskalieren Sie den Fall niemals zur automatischen Installation.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Zero-Day-Fenster (sofort)
SCHEDULED_INSTALL_DELAY_ONE_DAY Zeitfenster von einem Tag.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Zeitfenster von zwei Tagen.
SCHEDULED_INSTALL_DELAY_THREE_DAYS 3-Tage-Fenster.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Vier-Tage-Fenster.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Fünf-Tage-Fenster.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Zehn-Tage-Fenster.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS 15-Tage-Fenster.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS 30-Tage-Fenster.

WifiOnlyTime

Sobald ein Update verfügbar ist, wird in diesem Zeitraum das Mobilfunknetz für den Download deaktiviert.

Enums
WIFI_ONLY_TIME_UNSPECIFIED Nicht angegeben.
NONE Nicht blockiert.
TWENTY_FOUR_HOURS 24-Stunden-Fenster.
THREE_DAYS 3-Tage-Fenster.
SEVEN_DAYS Sieben-Tage-Fenster.
FOURTEEN_DAYS 14-Tage-Fenster.
TWENTY_ONE_DAYS Ein Zeitfenster von 20 Tagen.
FOREVER Endlose Zeitfenster.

TimeWindow

Ein Zeitfenster, das die Start- und Endzeit eines Tages definiert.

JSON-Darstellung 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Felder
startTime

object (TimeOfDay)

Die Startzeit des Fensters.
stopTime

object (TimeOfDay)

Die Stoppzeit des Fensters.

TimeOfDay

Stellt eine Tageszeit dar. Das Datum und die Zeitzone sind entweder nicht relevant oder werden an anderer Stelle angegeben. Eine API kann Schaltsekunden zulassen. Vergleichbare Typen sind google.type.Date und google.protobuf.Timestamp.

JSON-Darstellung 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Felder
hours

integer

Stunden im 24-Stunden-Format. Sollte zwischen 0 und 23 liegen. Eine API kann den Wert "24:00:00" für Szenarien wie Geschäftsschlusszeit zulassen.
minutes

integer

Minuten der Zeitangabe. Muss zwischen 0 und 59 liegen.
seconds

integer

Sekunden der Zeitangabe. Muss normalerweise zwischen 0 und 59 liegen. Eine API kann den Wert 60 zulassen, wenn sie Schaltsekunden zulässt.
nanos

integer

Sekundenbruchteile in Nanosekunden. Muss zwischen 0 und 999.999.999 liegen.

OffPeakUpdate

Die Updatebeschränkung außerhalb der Spitzenzeiten.

JSON-Darstellung 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Felder
updateOffPeakWindow

object (TimeWindow)

Außerhalb der Spitzenzeiten zum Herunterladen des Updates. Erfordert die Google Play-Dienste 6.7.72 oder höher.
updateOffPeakDays

enum (UpdateOffPeakDays)

Optional. Wenn der Wert OFF_PEAK_DAYS_UNSPECIFIED ist, verwendet der Server den Standardwert OFF_PEAK_UPDATE_ONE_DAY. Erfordert Google Play-Dienste 6.5 oder höher.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Optional. Wenn kein Wert angegeben ist, verwendet der Server den Standardwert ALL_NETWORK_ALLOWED. Erfordert die Google Play-Dienste 6.7.72 oder höher.

UpdateOffPeakDays

Anzahl der Tage für den Versuch, das Update außerhalb der Spitzenzeiten herunterzuladen.

Enums
OFF_PEAK_DAYS_UNSPECIFIED Nicht angegeben.
OFF_PEAK_UPDATE_ONE_DAY 1 Tag.
OFF_PEAK_UPDATE_THREE_DAYS 3 Tage.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 Tage
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 Tage.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 Tage.

CellularOperatorRestriction

Legen Sie CELLULAR_OPERATOR_RESTRICTED fest, um das Zeitfenster außerhalb der Spitzenzeiten einzuschränken, sodass der OTA-Download auf den Mobilfunkanbieter beschränkt wird, über den er zuerst empfangen wurde. Vorgesehen für Geräte mit mehreren SIM-Karten in Verbindung mit mobileNetworkRestriction, um Downloads außerhalb der Spitzenzeiten auf einen bestimmten Mobilfunkanbieter zu beschränken.

Enums
OPERATOR_RESTRICTED_UNSPECIFIED Nicht angegeben.
CELLULAR_OPERATOR_RESTRICTED Das Zeitfenster außerhalb der Spitzenlast gilt nur für den Mobilfunkanbieter, über den das Over-the-Air-Update (OTA) erstmals empfangen wurde.
ALL_NETWORK_ALLOWED Das Zeitfenster außerhalb der Spitzenzeiten gilt für alle Netzwerke.

IncludeExclude

Schließt bestimmte durch Kommas getrennte Muster ein oder aus.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld include_exclude. Eine Regel zum Ein- oder Ausschließen. Für include_exclude ist nur einer der folgenden Werte zulässig:
include

string

Enthaltenes Muster. Wenn mehrere Werte zulässig sind, trennen Sie sie mit einem Komma.
exclude

string

Ausgeschlossenes Muster. Wenn mehrere Werte zulässig sind, trennen Sie sie mit einem Komma.

SpaceNeed

Der Speicherplatzbedarf in Byte.

Enums
SPACE_NEED_UNSPECIFIED Nicht angegeben.
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

Die Komponente für den Roll-out-Schritt.

JSON-Darstellung 
{
  "rolloutTime": string,
  "fraction": number
}
Felder
rolloutTime

string (Timestamp format)

Der Einführungszeitstempel.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
fraction

number

Anteil als Prozentsatz zwischen 0,00 und 100,00

ConfigDetails

Details zu einer Konfiguration.

JSON-Darstellung 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Felder
postConditions[]

object (Condition)

Die Bedingungen der Konfigurationsinstallation.
packages[]

object (PackageConfig)

Die definierten Pakete dieser Konfiguration. Wichtig: Die Reihenfolge der Pakete ist wichtig. Wenn ein Gerät mehrere Bedingungen erfüllt, erhält das letzte passende Paket den Zuschlag und wird auf das Gerät angewendet.
groups[]

string

Die verknüpften Gruppen dieser Konfiguration.
versionTag

object (VersionTag)

Nur Ausgabe. Die Konfigurationsversion.

ReminderDialogSettings

Einstellungen, mit denen ein modales Erinnerungsdialogfeld gesteuert wird, das Nutzern nach einer bestimmten Zeit angezeigt wird.

JSON-Darstellung 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Felder
start

enum (Start)

Zeitpunkt für das Anzeigen der Erinnerung.
remindMeLaterDuration

enum (RemindLaterDuration)

Dauer „Später erinnern“ wird angezeigt.
frequency

enum (Frequency)

Nach dem Schließen wird eine Erinnerung an die Häufigkeit angezeigt.

Start

Wann ein Erinnerungsdialogfeld angezeigt werden soll. Wenn Sie beispielsweise START_TWO_DAYS festlegen, sehen Nutzer zwei Tage nach dem Erhalt des Updates eine Erinnerung. Bleibt START_UNSPECIFIED, wird der Standardwert START_SEVEN_DAYS verwendet.

Enums
START_UNSPECIFIED Nicht angegeben.
NEVER_START Erinnerung nie starten
START_ZERO_DAYS Sofort beginnen.
START_TWO_DAYS Starte nach zwei Tagen.
START_SEVEN_DAYS Starte nach sieben Tagen.
START_FOURTEEN_DAYS Starte nach vierzehn Tagen. NÄCHSTES TAG: 6

RemindLaterDuration

Wie lange wird im Dialogfeld die Option „Später erinnern“ angezeigt? Schaltfläche. Wähle ALWAYS_SHOW aus, damit die Schaltfläche immer angezeigt wird, und NEVER_SHOW, wenn sie nie angezeigt werden soll. Bleibt LATER_DURATION_UNSPECIFIED, wird der Standardwert LATER_FOURTEEN_DAYS verwendet.

Enums
LATER_DURATION_UNSPECIFIED Nicht angegeben.
NEVER_SHOW Schaltfläche nie anzeigen.
ALWAYS_SHOW Schaltfläche immer anzeigen.
LATER_SEVEN_DAYS Schaltfläche „Entfernen“ nach sieben Tagen.
LATER_FOURTEEN_DAYS Schaltfläche „Entfernen“ nach 14 Tagen.
LATER_TWENTY_ONE_DAYS Schaltfläche nach 21 Tagen entfernen.

Häufigkeit

Wie lange dauert es, bis das Dialogfeld für die Erinnerung wieder angezeigt wird, nachdem der Nutzer das Dialogfeld für die Erinnerung geschlossen hat? Bleibt FREQUENCY_UNSPECIFIED, wird der Standardwert FREQUENCY_SEVEN_DAYS verwendet.

Enums
FREQUENCY_UNSPECIFIED Nicht angegeben.
FREQUENCY_ONE_DAY Erinnerung täglich anzeigen
FREQUENCY_THREE_DAYS Erinnerung alle drei Tage anzeigen.
FREQUENCY_SEVEN_DAYS Erinnerung alle sieben Tage anzeigen.

Methoden

create

 Erstellt ein config und gibt das neue Config zurück.

delete

 Löscht ein config.

disable

 Deaktiviert alle aktivierten Gruppen mit der angegebenen Konfiguration.

get

 Ruft eine config-Ansicht ab.

list

 Listet configs einer Bereitstellung auf.

update

 Aktualisiert eine config.

updatePackages

 Aktualisieren Sie die Pakete unter der Konfiguration.