REST Resource: deployments.configs

Risorsa: configurazione

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 si tratta dell'identificatore univoco degli oggetti Config e verrà generato dal server quando viene creato un nuovo Config.
title

string

(Facoltativo) Il titolo della configurazione.
description

string

(Facoltativo) La descrizione della configurazione.
defaultUpdateDescription

object (UpdateDescription)

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

object (LocalizedUpdateDescription)

(Facoltativo) Un elenco di descrizioni degli aggiornamenti localizzati, che hanno la priorità su defaultUpdateDescription se una di queste corrisponde alle impostazioni internazionali del dispositivo.
urgencyMode

enum (UrgencyMode)

(Facoltativo) L'urgenza di aggiornamento che determina come verrà richiesto all'utente. Se questo valore non è specificato, verrà utilizzato il valore predefinito MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

(Facoltativo) Un ritardo che determina quando verrà programmato l'aggiornamento per l'installazione durante la notte. Se non specificato, il valore predefinito è NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

(Facoltativo) Se il valore impostato è WIFI_ONLY_TIME_UNSPECIFIED, il valore predefinito è SEVEN_DAYS.

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

object (TimeWindow)

(Facoltativo) L'intervallo di tempo per l'installazione dell'OTA.
packageSizeAwareBatteryThreshold

boolean

(Facoltativo) Indica se l'aggiornamento deve avere soglie di installazione diverse della batteria a seconda delle dimensioni.
offPeakUpdate

object (OffPeakUpdate)

(Facoltativo) L'oggetto di aggiornamento fuori picco.
countryRestriction

object (IncludeExclude)

(Facoltativo) I possibili paesi inclusi/esclusi.
mobileNetworkRestriction

object (IncludeExclude)

(Facoltativo) Le possibili reti mobili incluse/escluse identificate dai codici Centro clienti/mnc. Tieni presente che deve essere utilizzato esclusivamente per mobileNetworkCarrierRestriction. Non è possibile impostare entrambi i campi contemporaneamente.
deviceBuildPropertyRestriction

object (IncludeExclude)

(Facoltativo) La possibile limitazione della proprietà build del dispositivo inclusa/esclusa.
mobileNetworkCarrierRestriction

object (IncludeExclude)

(Facoltativo) Gli eventuali operatori di rete mobile inclusi/esclusi. Tieni presente che deve essere utilizzato esclusivamente per mobileNetworkRestriction. Non è possibile impostare entrambi i campi contemporaneamente.

Per visualizzare le mappature, fai riferimento a Codice paese mobile e Codice di rete mobile.
updateRequiredSetup

boolean

(Facoltativo) Indica se l'aggiornamento è necessario durante la configurazione guidata. Il valore predefinito è false.
minimalSpaceRequired

enum (SpaceNeed)

(Facoltativo) Il requisito di spazio minimo è minimo. Se il valore è UNSPECIFIED, il server non imposterà alcuna limitazione. Richiede Google Play Services 6.1.11 o versioni successive.
immediateRelease

boolean

(Facoltativo) È obbligatorio specificare uno dei seguenti valori: immediateRelease o rolloutSteps. Indica se l'aggiornamento deve essere rilasciato immediatamente. In questo caso, l'impostazione di rolloutSteps deve essere annullata.
rolloutSteps[]

object (RolloutStep)

(Facoltativo) È obbligatorio specificare uno dei seguenti valori: rolloutSteps o immediateRelease. Il valore RolloutSteps deve essere in ordine: time_ms e frazione devono essere non decrescenti. L'ultimo passaggio deve avere una frazione == 100.
securityUpdate

boolean

(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 che per visualizzare il testo "Applicazione dell'aggiornamento della sicurezza in corso" anziché "applicazione di 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 comando deve essere restituito solo dal server quando restituisce la configurazione.
allowEncryptedScheduledInstall

boolean

(Facoltativo) Indica se è consentita o meno la pianificazione dell'installazione di un pacchetto sui dispositivi criptati.
reminderDialogSettings

object (ReminderDialogSettings)

(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 della finestra di dialogo dell'aggiornamento.
postSuccessMessage

string

Il messaggio di operazione riuscita dell'aggiornamento. Richiede un livello API pari o superiore a 14.
postFailureMessage

string

Il messaggio di pubblicazione dell'aggiornamento. Richiede un livello API pari o superiore a 14.

LocalizedUpdateDescription

La descrizione dell'aggiornamento in base alle impostazioni internazionali.

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

string

Le impostazioni internazionali che corrispondono 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 È consigliabile eseguire 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 tra il momento in cui è disponibile l'aggiornamento e il momento in cui l'installazione viene pianificata automaticamente.

Enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valore predefinito. verrà trattata come MAI.
SCHEDULED_INSTALL_DELAY_NEVER Non riassegnare mai la richiesta all'installazione automatica.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Finestra zero-day (immediatamente)
SCHEDULED_INSTALL_DELAY_ONE_DAY Periodo di un giorno.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Periodo di due giorni.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Periodo di tre giorni.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Finestra di quattro giorni.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Periodo 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 evita la rete mobile per il periodo di tempo successivo alla disponibilità dell'aggiornamento.

Enum
WIFI_ONLY_TIME_UNSPECIFIED Non specificato.
NONE Non bloccato.
TWENTY_FOUR_HOURS La finestra di 24 ore.
THREE_DAYS Periodo di tre giorni.
SEVEN_DAYS Finestra di sette giorni.
FOURTEEN_DAYS Finestra di 14 giorni.
TWENTY_ONE_DAYS Periodo di 21 giorni.
FOREVER Periodo definitivo.

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. 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 dell'attività.
minutes

integer

Minuti dell'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. Deve essere compreso tra 0 e 999.999.999.

OffPeakUpdate

Limitazione degli aggiornamenti al di fuori del periodo di picco.

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

object (TimeWindow)

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

enum (UpdateOffPeakDays)

(Facoltativo) Se il valore è OFF_PEAK_DAYS_UNSPECIFIED, il server utilizza il valore predefinito OFF_PEAK_UPDATE_ONE_DAY. Richiede Google Play Services 6.5 o versioni successive.
updateOperatorRestriction

enum (CellularOperatorRestriction)

(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 i tentativi di download dell'aggiornamento nella finestra 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 CELLULAR_OPERATOR_RESTRICTED per imporre una limitazione nella finestra fuori picco in modo che il download OTA sia limitato all'operatore di telefonia mobile sul quale è stato ricevuto per la prima volta. Destinato ai dispositivi multi-SIM quando utilizzato in combinazione con mobileNetworkRestriction per limitare i download al di fuori del periodo di picco a un operatore specifico.

Enum
OPERATOR_RESTRICTED_UNSPECIFIED Non specificato.
CELLULAR_OPERATOR_RESTRICTED La finestra fuori picco è valida solo per l'operatore di telefonia cellulare da cui è stata ricevuta l'OTA per la prima volta.
ALL_NETWORK_ALLOWED La finestra fuori picco è valida per 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 unione include_exclude. Una regola di inclusione o esclusione. include_exclude può essere solo uno dei seguenti:
include

string

Pattern incluso. 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 di implementazione.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 successive all'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 condizioni preliminari, l'ultimo pacchetto corrispondente vince 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 gestiscono 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)

Durata "Ricordamelo più tardi" .
frequency

enum (Frequency)

Il promemoria della frequenza viene mostrato dopo averlo chiuso.

Inizia

Quando mostrare una finestra di dialogo di promemoria. Ad esempio, se il criterio viene 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 di 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 Inizia dopo quattordici giorni. TAG SUCCESSIVO: 6

RemindLaterDuration

Per quanto tempo nella finestra di dialogo viene visualizzato "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 di 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 dopo sette giorni.
LATER_FOURTEEN_DAYS Rimuovi dopo 14 giorni.
LATER_TWENTY_ONE_DAYS Rimuovi dopo ventuno giorni.

Frequenza

Dopo che l'utente chiude la finestra di dialogo del promemoria, quanto tempo deve trascorrere prima che venga mostrata di nuovo. Se lasci FREQUENCY_UNSPECIFIED, verrà utilizzato il valore predefinito di 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

 Disabilita tutti i gruppi attivati che hanno la configurazione specificata.

get

 Ottiene una visualizzazione di config.

list

 Elenca configs di un deployment.

update

 Aggiorna un config.

updatePackages

 Aggiorna i pacchetti nel file di configurazione.