REST Resource: deployments.configs

Risorsa: Config

La configurazione di un deployment.

Rappresentazione 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)
  }
}
Campi
name

string

Solo output. Il nome della configurazione. Tieni presente che questo è l'identificatore univoco per gli oggetti Config e verrà generato dal server quando verrà creato un nuovo Config.
title

string

Campo facoltativo. Il titolo della configurazione.
description

string

Campo facoltativo. La descrizione della configurazione.
defaultUpdateDescription

object (UpdateDescription)

Obbligatorio. Il testo predefinito dell'interfaccia utente quando le impostazioni internazionali del dispositivo non corrispondono a nessuna delle impostazioni internazionali specificate in localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Campo facoltativo. Un elenco di descrizioni di aggiornamenti localizzati, che hanno la priorità su defaultUpdateDescription se una delle quali corrisponde alle impostazioni internazionali del dispositivo.
urgencyMode

enum (UrgencyMode)

Campo facoltativo. L'urgenza dell'aggiornamento che determina la modalità di richiesta all'utente. Se non specificato, verrà utilizzato il valore predefinito MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Campo facoltativo. Un ritardo che determina quando verrà pianificato l'aggiornamento per l'installazione durante la notte. Se non specificato, il valore predefinito è NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

Campo facoltativo. Il valore predefinito è SEVEN_DAYS, se lasciato WIFI_ONLY_TIME_UNSPECIFIED.

Nota: verrà impostato su FOREVER se urgencyMode è RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Campo facoltativo. L'intervallo di tempo per l'installazione dell'OTA.
packageSizeAwareBatteryThreshold

boolean

Campo facoltativo. Indica se l'aggiornamento deve avere soglie della batteria di installazione diverse in base alle dimensioni.
offPeakUpdate

object (OffPeakUpdate)

Campo facoltativo. L'oggetto di aggiornamento al di fuori delle ore di punta.
countryRestriction

object (IncludeExclude)

Campo facoltativo. I possibili paesi inclusi/esclusi.
mobileNetworkRestriction

object (IncludeExclude)

Campo facoltativo. Le possibili reti mobili incluse/escluse identificate dai codici Centro clienti/mnc. Tieni presente che questo campo deve essere utilizzato esclusivamente di mobileNetworkCarrierRestriction. Non è possibile impostare entrambi i campi contemporaneamente.
deviceBuildPropertyRestriction

object (IncludeExclude)

Campo facoltativo. La possibile limitazione delle proprietà della build del dispositivo inclusa/esclusa.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Campo facoltativo. I possibili operatori di rete mobile inclusi/esclusi. Tieni presente che questo campo deve essere utilizzato esclusivamente di mobileNetworkRestriction. Non è possibile impostare entrambi i campi contemporaneamente.

Per visualizzare le mappature, fai riferimento all'articolo relativo al codice paese mobile e al codice rete mobile.
updateRequiredSetup

boolean

Campo facoltativo. Indica se è necessario eseguire l'aggiornamento durante la configurazione guidata. Il valore predefinito è false.
minimalSpaceRequired

enum (SpaceNeed)

Campo facoltativo. Il requisito di spazio minimo. Se il valore è UNSPECIFIED, il server non imposterà alcuna restrizione. Richiede Google Play Services 6.1.11 o versioni successive.
immediateRelease

boolean

Campo facoltativo. Il campo immediateRelease o rolloutSteps è obbligatorio. Indica se l'aggiornamento deve essere rilasciato immediatamente. Se questo valore è true, l'impostazione di rolloutSteps deve essere annullata.
rolloutSteps[]

object (RolloutStep)

Campo facoltativo. Il campo rolloutSteps o immediateRelease è obbligatorio. Le implementazioni devono essere in ordine: sia time_ms che frazione non devono essere decrescenti. L'ultimo passaggio deve contenere una frazione == 100.
securityUpdate

boolean

Campo facoltativo. Contrassegna l'aggiornamento come aggiornamento della sicurezza. Questo viene trasmesso al dispositivo per coordinare la visualizzazione del messaggio di aggiornamento corretto. Vale a dire, per visualizzare il testo "applicazione aggiornamento della sicurezza" anziché "applicazione aggiornamento di sistema". Richiede il livello API 22 o versioni successive e Google Play Services 9.4 o versioni successive.
details

object (ConfigDetails)

Solo output. Ulteriori dettagli di una configurazione. Questo valore deve essere restituito dal server solo quando restituisce il file di configurazione.
allowEncryptedScheduledInstall

boolean

Campo facoltativo. Indica se è consentita o meno l'installazione di un pacchetto sui dispositivi criptati.
reminderDialogSettings

object (ReminderDialogSettings)

Campo facoltativo. Impostazioni della finestra di dialogo modale che ricorda agli utenti che hanno un aggiornamento in attesa.

UpdateDescription

La descrizione dell'aggiornamento inviata al dispositivo.

Rappresentazione JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Campi
description

string

Il testo della descrizione dell'aggiornamento.
title

string

Il titolo della descrizione dell'aggiornamento.
dialogMessage

string

Il messaggio di dialogo dell'aggiornamento.
postSuccessMessage

string

Il messaggio di pubblicazione riuscita dell'aggiornamento. Richiede il livello API 14 o successivo.
postFailureMessage

string

Il messaggio di pubblicazione dell'aggiornamento non riuscito. Richiede il livello API 14 o successivo.

LocalizedUpdateDescription

La descrizione dell'aggiornamento in base alle impostazioni internazionali.

Rappresentazione JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Campi
locales[]

string

Le impostazioni internazionali corrispondenti a quelle del dispositivo.
updateDescription

object (UpdateDescription)

La descrizione dell'aggiornamento inviata al dispositivo.

UrgencyMode

La modalità di urgenza dell'upgrade.

Enum
MODE_UNSPECIFIED Non specificato.
RECOMMENDED Consiglia l'upgrade. All'utente verrà chiesto di scaricare e installare l'aggiornamento.
MANDATORY Upgrade obbligatorio. L'aggiornamento verrà scaricato automaticamente, ma all'utente verrà chiesto di avviare l'installazione.
AUTOMATIC Upgrade automatico. L'aggiornamento verrà scaricato e installato automaticamente.

ScheduledInstallDelay

Finestra di ritardo dal momento in cui è disponibile l'aggiornamento al momento in cui l'installazione viene pianificata automaticamente.

Enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valore predefinito. Verrà trattato come MAI.
SCHEDULED_INSTALL_DELAY_NEVER Non riassegnare mai all'installazione automatica.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Finestra di zero giorni (immediatamente)
SCHEDULED_INSTALL_DELAY_ONE_DAY Finestra di un giorno.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Finestra di due giorni.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Finestra di tre giorni.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Finestra di quattro giorni.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Finestra di cinque giorni.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Finestra di dieci giorni.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Finestra di quindici giorni.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Finestra di 30 giorni.

WifiOnlyTime

Il download consente di evitare la rete mobile per questo periodo una volta che l'aggiornamento è disponibile.

Enum
WIFI_ONLY_TIME_UNSPECIFIED Non specificato.
NONE Non bloccato.
TWENTY_FOUR_HOURS Finestra di ventiquattro ore.
THREE_DAYS Finestra di tre giorni.
SEVEN_DAYS Finestra di sette giorni.
FOURTEEN_DAYS Finestra di 14 giorni.
TWENTY_ONE_DAYS Finestra di venti un giorno.
FOREVER Finestra per sempre.

TimeWindow

Una finestra temporale che definisce l'ora di inizio di un giorno e l'ora di fine di un giorno.

Rappresentazione JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Campi
startTime

object (TimeOfDay)

L'ora di inizio della finestra.
stopTime

object (TimeOfDay)

L'ora di fine della finestra.

TimeOfDay

Rappresenta un'ora del giorno. La data e il fuso orario non sono significativi o sono specificati altrove. Un'API può scegliere di consentire i secondi intercalari. I tipi correlati sono google.type.Date e google.protobuf.Timestamp.

Rappresentazione JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campi
hours

integer

Le ore del giorno nel formato 24 ore. Il valore deve essere compreso tra 0 e 23. Un'API può scegliere di consentire il valore "24:00:00" per scenari come l'orario di chiusura di un'attività.
minutes

integer

Minuti di ora del giorno. Il valore deve essere compreso tra 0 e 59.
seconds

integer

Secondi di minuti del tempo. Normalmente deve essere compreso tra 0 e 59. Un'API potrebbe consentire il valore 60 se consente i secondi intercalari.
nanos

integer

Frazioni di secondi in nanosecondi. Il valore deve essere compreso tra 0 e 999.999.999.

OffPeakUpdate

Limitazione degli aggiornamenti al di fuori delle ore di punta.

Rappresentazione JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Campi
updateOffPeakWindow

object (TimeWindow)

Periodo di tempo non di punta per scaricare l'aggiornamento. Richiede Google Play Services 6.7.72 o versioni successive.
updateOffPeakDays

enum (UpdateOffPeakDays)

Campo facoltativo. Quando il valore è OFF_PEAK_DAYS_UNSPECIFIED, il server utilizzerà un valore predefinito di OFF_PEAK_UPDATE_ONE_DAY. Richiede Google Play Services 6.5 o versioni successive.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Campo facoltativo. Se il valore non viene specificato, il server utilizza il valore predefinito ALL_NETWORK_ALLOWED. Richiede Google Play Services 6.7.72 o versioni successive.

UpdateOffPeakDays

Numero di giorni per cui provare a scaricare l'aggiornamento in un periodo non di picco.

Enum
OFF_PEAK_DAYS_UNSPECIFIED Non specificato.
OFF_PEAK_UPDATE_ONE_DAY 1 giorno.
OFF_PEAK_UPDATE_THREE_DAYS 3 giorni.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 giorni.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 giorni.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 giorni.

CellularOperatorRestriction

Imposta su CELLULAR_OPERATOR_RESTRICTED per applicare una limitazione alla finestra di fuori picco in modo che il download OTA sia limitato all'operatore di telefonia mobile su cui è stato ricevuto per la prima volta. Destinato ai dispositivi multi-SIM quando utilizzati insieme a mobileNetworkRestriction per limitare i download al di fuori delle ore di punta a un operatore specifico.

Enum
OPERATOR_RESTRICTED_UNSPECIFIED Non specificato.
CELLULAR_OPERATOR_RESTRICTED La finestra al di fuori delle ore di punta è valida solo per l'operatore di telefonia mobile su cui l'OTA è stato ricevuto per la prima volta.
ALL_NETWORK_ALLOWED Questa finestra si applica a tutte le reti.

IncludeExclude

Include o esclude alcuni pattern separati da virgole.

Rappresentazione 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.
}
Campi
Campo di unione include_exclude. Una regola di inclusione o esclusione. include_exclude può essere solo uno dei seguenti:
include

string

Sequenza inclusa. Se sono consentiti più valori, utilizza una virgola per separarli.
exclude

string

Pattern escluso. Se sono consentiti più valori, utilizza una virgola per separarli.

SpaceNeed

Il requisito di spazio in byte.

Enum
SPACE_NEED_UNSPECIFIED Non specificato.
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

Il componente del passaggio di implementazione.

Rappresentazione JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Campi
rolloutTime

string (Timestamp format)

Il timestamp dell'implementazione.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
fraction

number

Frazione denominata in percentuale compresa tra 0,00 e 100,00.

ConfigDetails

Dettagli di una configurazione.

Rappresentazione JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Campi
postConditions[]

object (Condition)

Le condizioni post-installazione della configurazione.
packages[]

object (PackageConfig)

I pacchetti definiti di questa configurazione. Importante: l'ordine dei pacchetti è importante. Se un dispositivo soddisfa più serie di precondizioni, vince l'ultimo pacchetto corrispondente e verrà applicato al dispositivo.
groups[]

string

I gruppi associati di questa configurazione.
versionTag

object (VersionTag)

Solo output. La versione della configurazione.

ReminderDialogSettings

Impostazioni che controllano una finestra di dialogo di promemoria modale mostrata agli utenti dopo il periodo di tempo specificato.

Rappresentazione JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Campi
start

enum (Start)

Quando iniziare a mostrare il promemoria.
remindMeLaterDuration

enum (RemindLaterDuration)

Viene visualizzato il pulsante "Ricordamelo più tardi".
frequency

enum (Frequency)

Il promemoria della frequenza viene visualizzato dopo la chiusura.

Inizia

Quando mostrare la finestra di dialogo di un promemoria. Ad esempio, se è impostato su START_TWO_DAYS, gli utenti vedranno un promemoria due giorni dopo aver ricevuto l'aggiornamento. Se lasci START_UNSPECIFIED, verrà utilizzato il valore predefinito START_SEVEN_DAYS.

Enum
START_UNSPECIFIED Non specificato.
NEVER_START Non avviare mai il promemoria.
START_ZERO_DAYS Inizia subito.
START_TWO_DAYS Inizia dopo due giorni.
START_SEVEN_DAYS Inizia dopo sette giorni.
START_FOURTEEN_DAYS Iniziare dopo quattordici giorni. TAG SUCCESSIVO: 6

RemindLaterDuration

Per quanto tempo la finestra di dialogo mostra il pulsante "Ricordamelo più tardi". Scegli ALWAYS_SHOW per mostrare sempre il pulsante e NEVER_SHOW per non mostrarlo mai. Se lasci LATER_DURATION_UNSPECIFIED, verrà utilizzato il valore predefinito LATER_FOURTEEN_DAYS.

Enum
LATER_DURATION_UNSPECIFIED Non specificato.
NEVER_SHOW Non mostrare mai il pulsante.
ALWAYS_SHOW Mostra sempre il pulsante.
LATER_SEVEN_DAYS Rimuovi il pulsante dopo sette giorni.
LATER_FOURTEEN_DAYS Rimuovi il pulsante dopo 14 giorni.
LATER_TWENTY_ONE_DAYS Rimuovi il pulsante dopo ventuno giorni.

Frequenza

Dopo che l'utente ha ignorato la finestra di dialogo del promemoria, il tempo che deve trascorrere prima che venga mostrata di nuovo. Se lasci FREQUENCY_UNSPECIFIED, verrà utilizzato il valore predefinito FREQUENCY_SEVEN_DAYS.

Enum
FREQUENCY_UNSPECIFIED Non specificato.
FREQUENCY_ONE_DAY Mostra il promemoria ogni giorno.
FREQUENCY_THREE_DAYS Mostra il promemoria ogni tre giorni.
FREQUENCY_SEVEN_DAYS Mostra il promemoria ogni sette giorni.

Metodi

create

 Crea un config e restituisce il nuovo Config.

delete

 Elimina un config.

disable

 Disattiva tutti i gruppi attivati con la configurazione specificata.

get

 Ottieni una visualizzazione config.

list

 Elenca configs di un deployment.

update

 Aggiorna un config.

updatePackages

 Aggiorna i pacchetti nel file di configurazione.