REST Resource: deployments.configs

Recurso: Config

Una configuración de una implementación.

Representación 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)
  }
}
Campos
name

string

Solo salida. Es el nombre de la configuración. Ten en cuenta que este es el identificador único de los objetos Config y que lo generará el servidor cuando se cree un Config nuevo.
title

string

Opcional. Es el título de la configuración.
description

string

Opcional. Es la descripción de la configuración.
defaultUpdateDescription

object (UpdateDescription)

Obligatorio. El texto predeterminado de la IU que se usa cuando la configuración regional del dispositivo no coincide con ninguna configuración regional especificada en localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Opcional. Una lista de descripciones de actualizaciones localizadas, que tienen prioridad sobre defaultUpdateDescription si una de ellas coincide con la configuración regional del dispositivo.
urgencyMode

enum (UrgencyMode)

Opcional. La urgencia de la actualización que dicta cómo se le solicitará al usuario Si no se especifica, se usará un valor predeterminado de MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opcional. Una demora que determina cuándo se programará la actualización para la instalación nocturna. El valor predeterminado es NEVER si no se especifica.
wifiOnlyTime

enum (WifiOnlyTime)

Opcional. El valor predeterminado es SEVEN_DAYS si se deja como WIFI_ONLY_TIME_UNSPECIFIED.

Nota: Se establecerá como FOREVER si urgencyMode es RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Opcional. El período de instalación del inalámbrico.
packageSizeAwareBatteryThreshold

boolean

Opcional. Si la actualización debe tener diferentes umbrales de batería de instalación según su tamaño.
offPeakUpdate

object (OffPeakUpdate)

Opcional. El objeto de actualización de menor demanda.
countryRestriction

object (IncludeExclude)

Opcional. Los posibles países incluidos o excluidos.
mobileNetworkRestriction

object (IncludeExclude)

Opcional. Las posibles redes móviles incluidas o excluidas que se identifican mediante códigos MCC y MNC. Ten en cuenta que debe usarse exclusivamente para mobileNetworkCarrierRestriction. No se pueden establecer ambos campos al mismo tiempo.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opcional. La posible restricción de propiedades de compilación de dispositivos incluidos o excluidos.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opcional. Son los posibles proveedores de redes móviles incluidos o excluidos. Ten en cuenta que debe usarse exclusivamente para mobileNetworkRestriction. No se pueden establecer ambos campos al mismo tiempo.

Para ver las asignaciones, consulta Código móvil de país y Código de red móvil.
updateRequiredSetup

boolean

Opcional. Indica si se requiere la actualización durante el asistente de configuración. La configuración predeterminada es "false".
minimalSpaceRequired

enum (SpaceNeed)

Opcional. El requisito de espacio mínimo. Cuando el valor es UNSPECIFIED, el servidor no establecerá una restricción. Se requiere la versión 6.1.11 de los Servicios de Google Play o una posterior.
immediateRelease

boolean

Opcional. Se requiere uno de los siguientes valores: immediateRelease o rolloutSteps. Si la actualización debe lanzarse de inmediato. Si es verdadero, se debe desactivar rolloutSteps.
rolloutSteps[]

object (RolloutStep)

Opcional. Se requiere uno de los siguientes valores: rolloutSteps o immediateRelease. RolloutSteps debe estar en orden: tanto time_ms como fracción no deben ser decrecientes. El último paso debería tener una fracción == 100.
securityUpdate

boolean

Opcional. Marca la actualización como actualización de seguridad. Se pasa al dispositivo para coordinar la visualización del mensaje de actualización correcto. Es decir, para mostrar el texto "aplicando actualización de seguridad" en lugar de "aplicar una actualización del sistema". Se requiere el nivel de API 22 o una versión posterior y Servicios de Google Play 9.4 o una versión posterior.
details

object (ConfigDetails)

Solo salida. Más detalles de una configuración. Solo el servidor debe mostrar esto cuando muestra la configuración.
allowEncryptedScheduledInstall

boolean

Opcional. Indica si se permite o no programar la instalación de un paquete en dispositivos encriptados.
reminderDialogSettings

object (ReminderDialogSettings)

Opcional. La configuración del diálogo modal que les recuerda a los usuarios que tienen una actualización pendiente.

UpdateDescription

Es la descripción de la actualización que se envió al dispositivo.

Representación JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Campos
description

string

Es el texto de descripción de la actualización.
title

string

Es el título de la descripción de la actualización.
dialogMessage

string

Mensaje de diálogo de la actualización.
postSuccessMessage

string

El mensaje de publicación exitosa de la actualización. Se requiere un nivel de API 14 o superior.
postFailureMessage

string

El mensaje posterior al error de la actualización. Se requiere un nivel de API 14 o superior.

LocalizedUpdateDescription

Es la descripción de la actualización según la configuración regional.

Representación JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Campos
locales[]

string

Las configuraciones regionales que deben coincidir con las del dispositivo.
updateDescription

object (UpdateDescription)

Es la descripción de la actualización que se envía al dispositivo.

UrgencyMode

El modo de urgencia de la actualización

Enumeraciones
MODE_UNSPECIFIED No se especifica.
RECOMMENDED Recomienda una actualización. Se le pedirá al usuario que descargue e instale la actualización.
MANDATORY Actualización obligatoria. La actualización se descargará automáticamente, pero se le pedirá al usuario que inicie la instalación.
AUTOMATIC Actualización automática. La actualización se descargará y se instalará automáticamente.

ScheduledInstallDelay

Período de retraso desde que la actualización está disponible hasta el momento en que la instalación se programa automáticamente.

Enumeraciones
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valor predeterminado Se tratará como NUNCA.
SCHEDULED_INSTALL_DELAY_NEVER Nunca derivas a la instalación automática.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Período de día cero (inmediatamente)
SCHEDULED_INSTALL_DELAY_ONE_DAY Período de un día.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Período de dos días.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Período de tres días.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Período de cuatro días.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Período de cinco días
SCHEDULED_INSTALL_DELAY_TEN_DAYS Período de diez días.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Período de quince días.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Período de treinta días.

WifiOnlyTime

La descarga evitará el uso de la red móvil durante este período después de que la actualización esté disponible.

Enumeraciones
WIFI_ONLY_TIME_UNSPECIFIED No se especifica.
NONE No se bloqueó.
TWENTY_FOUR_HOURS Período de veinticuatro horas.
THREE_DAYS Período de tres días.
SEVEN_DAYS Período de siete días.
FOURTEEN_DAYS Período de catorce días.
TWENTY_ONE_DAYS Período de veintiún días.
FOREVER Período permanente.

TimeWindow

Un período que define la hora de inicio de un día y la hora de finalización de un día.

Representación JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

Es la hora de inicio de la ventana.
stopTime

object (TimeOfDay)

La hora de finalización de la ventana.

TimeOfDay

Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date y google.protobuf.Timestamp.

Representación JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas del día en formato de 24 horas. Debe ser del 0 al 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.
minutes

integer

Minutos de horas del día. Debe ser un valor entre 0 y 59.
seconds

integer

Segundos de minutos de la hora. Por lo general, debe ser un valor entre 0 y 59. Una API puede permitir el valor 60 si permite segundos bisiestos.
nanos

integer

Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999.

OffPeakUpdate

Limitación de la actualización con menor tráfico.

Representación JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Campos
updateOffPeakWindow

object (TimeWindow)

Período de baja actividad para descargar la actualización. Se requiere la versión 6.7.72 de los Servicios de Google Play o una posterior.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opcional. Cuando el valor es OFF_PEAK_DAYS_UNSPECIFIED, el servidor usará un valor predeterminado de OFF_PEAK_UPDATE_ONE_DAY. Se requiere la versión 6.5 de los Servicios de Google Play o una posterior.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opcional. Si no se especifica el valor, el servidor usará un valor predeterminado de ALL_NETWORK_ALLOWED. Se requiere la versión 6.7.72 de los Servicios de Google Play o una posterior.

UpdateOffPeakDays

Cantidad de días para intentar descargar la actualización en el período de menor demanda.

Enumeraciones
OFF_PEAK_DAYS_UNSPECIFIED No se especifica.
OFF_PEAK_UPDATE_ONE_DAY 1 día.
OFF_PEAK_UPDATE_THREE_DAYS 3 días.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 días
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 días.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 días.

CellularOperatorRestriction

Se establece en CELLULAR_OPERATOR_RESTRICTED para imponer una restricción en la ventana de menor demanda, de modo que la descarga inalámbrica se restrinja al operador de telefonía celular con el que se recibió por primera vez. Se diseñó para dispositivos multiSIM cuando se usa junto con mobileNetworkRestriction para restringir las descargas con menor demanda a un operador específico.

Enumeraciones
OPERATOR_RESTRICTED_UNSPECIFIED No se especifica.
CELLULAR_OPERATOR_RESTRICTED La ventana de menor demanda se aplica al operador de telefonía celular por el que se recibió la OTA por primera vez.
ALL_NETWORK_ALLOWED La ventana de menor demanda se aplica a todas las redes.

IncludeExclude

Incluye o excluye ciertos patrones separados por comas.

Representación 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.
}
Campos
Campo de unión include_exclude. Una regla de inclusión o exclusión Las direcciones (include_exclude) solo pueden ser una de las siguientes opciones:
include

string

Se incluye el patrón. Si se permiten varios valores, sepáralos con una coma.
exclude

string

Patrón excluido. Si se permiten varios valores, sepáralos con una coma.

SpaceNeed

El requisito de espacio en bytes.

Enumeraciones
SPACE_NEED_UNSPECIFIED No se especifica.
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

El componente del paso de lanzamiento

Representación JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Campos
rolloutTime

string (Timestamp format)

Es la marca de tiempo del lanzamiento.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
fraction

number

Fracción denominada por porcentaje entre 0.00 y 100.00.

ConfigDetails

Detalles de una configuración

Representación JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Campos
postConditions[]

object (Condition)

La instalación de la configuración después de las condiciones.
packages[]

object (PackageConfig)

Son los paquetes definidos de esta configuración. Importante: El orden de los paquetes es importante. Si un dispositivo coincide con varios conjuntos de condiciones previas, el último paquete que coincida gana y se aplicará al dispositivo.
groups[]

string

Los grupos asociados a esta configuración.
versionTag

object (VersionTag)

Solo salida. Es la versión de la configuración.

ReminderDialogSettings

Configuración que controla un diálogo modal de recordatorio que se muestra a los usuarios después de un período específico.

Representación JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Campos
start

enum (Start)

Cuándo comenzar a mostrar el recordatorio.
remindMeLaterDuration

enum (RemindLaterDuration)

Duración "Recuérdame más tarde" .
frequency

enum (Frequency)

El recordatorio de frecuencia se muestra después del descarte.

Iniciar

Cuándo mostrar un diálogo de recordatorio. Por ejemplo, si se establece como START_TWO_DAYS, los usuarios verán un recordatorio 2 días después de recibir la actualización. Si se deja START_UNSPECIFIED, se usará un valor predeterminado de START_SEVEN_DAYS.

Enumeraciones
START_UNSPECIFIED No se especifica.
NEVER_START Nunca iniciar el recordatorio.
START_ZERO_DAYS Comenzar de inmediato.
START_TWO_DAYS Comienza después de dos días.
START_SEVEN_DAYS Comenzar después de siete días
START_FOURTEEN_DAYS Comenzar después de catorce días. SIGUIENTE ETIQUETA: 6

RemindLaterDuration

El tiempo durante el cual el cuadro de diálogo muestra la opción "Recordarme más tarde" . Elige ALWAYS_SHOW para mostrar el botón todo el tiempo y NEVER_SHOW para no mostrarlo nunca. Si se deja LATER_DURATION_UNSPECIFIED, se usará un valor predeterminado de LATER_FOURTEEN_DAYS.

Enumeraciones
LATER_DURATION_UNSPECIFIED No se especifica.
NEVER_SHOW Nunca mostrar el botón
ALWAYS_SHOW Mostrar siempre el botón
LATER_SEVEN_DAYS Quitar el botón después de siete días
LATER_FOURTEEN_DAYS Quitar el botón después de catorce días
LATER_TWENTY_ONE_DAYS Quitar el botón después de veintiún días.

Frecuencia

Después de que el usuario descarte el diálogo del recordatorio, cuánto tiempo falta para que se vuelva a mostrar. Si se deja FREQUENCY_UNSPECIFIED, se usará un valor predeterminado de FREQUENCY_SEVEN_DAYS.

Enumeraciones
FREQUENCY_UNSPECIFIED No se especifica.
FREQUENCY_ONE_DAY Muestra el recordatorio todos los días.
FREQUENCY_THREE_DAYS Mostrar el recordatorio cada tres días.
FREQUENCY_SEVEN_DAYS Mostrar el recordatorio cada siete días

Métodos

create

 Crea un config y muestra el nuevo Config.

delete

 Borra un config.

disable

 Inhabilita todos los grupos habilitados que tienen la configuración especificada.

get

 Obtiene una vista config.

list

 Muestra una lista configs de una implementación.

update

 Actualiza un config.

updatePackages

 Actualiza los paquetes en la configuración.