REST Resource: deployments.configs

Recurso: Config

Es 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. El nombre de la configuración. Ten en cuenta que este es el identificador único para los objetos Config y lo generará el servidor cuando se cree un Config nuevo.
title

string

Opcional. El título de la configuración.
description

string

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

object (UpdateDescription)

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

object (LocalizedUpdateDescription)

Opcional. Es 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 determina cómo se le solicitará al usuario Si no se especifica, se usará el valor predeterminado MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opcional. Es un retraso que determina cuándo se programará la actualización para la instalación durante la noche. 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 para la OTA.
packageSizeAwareBatteryThreshold

boolean

Opcional. Indica 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 con menor demanda.
countryRestriction

object (IncludeExclude)

Opcional. Indica los posibles países incluidos o excluidos.
mobileNetworkRestriction

object (IncludeExclude)

Opcional. Son las posibles redes para celulares incluidas o excluidas que se identifican mediante códigos mcc/mnc. Ten en cuenta que se debe usar exclusivamente de mobileNetworkCarrierRestriction. No se pueden configurar ambos campos al mismo tiempo.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opcional. La posible restricción de propiedad de compilación del dispositivo incluida o excluido.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opcional. Los posibles proveedores de red móvil incluidos o excluidos. Ten en cuenta que se debe usar exclusivamente de mobileNetworkRestriction. No se pueden configurar ambos campos al mismo tiempo.

Para ver las asignaciones, consulta Código de país móvil 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 Servicios de Google Play o una posterior.
immediateRelease

boolean

Opcional. Se requiere uno de los siguientes elementos: immediateRelease o rolloutSteps. Si la actualización debe lanzarse de inmediato. Si es así, no se debe establecer rolloutSteps.
rolloutSteps[]

object (RolloutStep)

Opcional. Se requiere uno de los siguientes elementos: rolloutSteps o immediateRelease. Los RolloutSteps deben estar en orden: los time_ms y la fracción no deben ser decrecientes. El último paso debe tener una fracción == 100.
securityUpdate

boolean

Opcional. Marca la actualización como actualización de seguridad. Esto se pasa al dispositivo para coordinar la visualización del mensaje de actualización correcto. Es decir, para mostrar el texto "aplicar la actualización de seguridad" en lugar de "aplicar la 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. Esto solo debe ser devuelto por el servidor cuando muestra la configuración.
allowEncryptedScheduledInstall

boolean

Opcional. Indica si se permite o no que se programe un paquete para su instalación en dispositivos encriptados.
reminderDialogSettings

object (ReminderDialogSettings)

Opcional. Configuración del diálogo modal que 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 descriptivo de la actualización.
title

string

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

string

Es el mensaje de diálogo de la actualización.
postSuccessMessage

string

Es el mensaje de publicación correcta de la actualización. Requiere nivel de API 14 o superior.
postFailureMessage

string

Es el mensaje de error posterior de la actualización. Requiere nivel de API 14 o superior.

LocalizedUpdateDescription

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 actualización.

Enumeradores
MODE_UNSPECIFIED No se especifica.
RECOMMENDED Se recomienda actualizar. Se le solicitará al usuario que descargue e instale la actualización.
MANDATORY Actualización obligatoria. La actualización se descargará automáticamente, pero se le solicitará al usuario que inicie la instalación.
AUTOMATIC Actualización automática La actualización se descargará e instalará automáticamente.

ScheduledInstallDelay

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

Enumeradores
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valor predeterminado Se tratará como NUNCA.
SCHEDULED_INSTALL_DELAY_NEVER Nunca derives el problema a la instalación automática.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Período 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á la conexión de red móvil durante este período después de que esté disponible la actualización.

Enumeradores
WIFI_ONLY_TIME_UNSPECIFIED No se especifica.
NONE Sin bloquear.
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 veinte días.
FOREVER Ventana permanente.

TimeWindow

Es 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)

Indica la hora de inicio del período.
stopTime

object (TimeOfDay)

Indica 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

La limitación de las actualizaciones fuera de hora pico.

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. Requiere Servicios de Google Play 6.7.72 o versiones posteriores.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opcional. Cuando el valor sea OFF_PEAK_DAYS_UNSPECIFIED, el servidor utilizará un valor predeterminado de OFF_PEAK_UPDATE_ONE_DAY. Requiere Servicios de Google Play 6.5 o versiones posteriores.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opcional. Si no se especifica el valor, el servidor utilizará un valor predeterminado de ALL_NETWORK_ALLOWED. Requiere Servicios de Google Play 6.7.72 o versiones posteriores.

UpdateOffPeakDays

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

Enumeradores
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

Configúralo en CELLULAR_OPERATOR_RESTRICTED para imponer una restricción en la ventana de baja actividad, de modo que la descarga OTA se restrinja al operador de telefonía celular en el que se recibió por primera vez. Diseñado para dispositivos con varias SIM cuando se usa en conjunto con mobileNetworkRestriction para restringir las descargas con menor demanda a un operador específico.

Enumeradores
OPERATOR_RESTRICTED_UNSPECIFIED No se especifica.
CELLULAR_OPERATOR_RESTRICTED El período de menor demanda se aplica solo al operador de telefonía celular por el que se recibió la OTA por primera vez.
ALL_NETWORK_ALLOWED El período 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. Es una regla de inclusión o exclusión. Las direcciones (include_exclude) solo pueden ser una de las siguientes opciones:
include

string

Se incluyó el patrón. Si se permiten varios valores, usa una coma para separarlos.
exclude

string

Patrón excluido. Si se permiten varios valores, usa una coma para separarlos.

SpaceNeed

El espacio requerido en bytes.

Enumeradores
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)

La marca de tiempo de lanzamiento.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 un 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)

Condiciones posteriores a la instalación de la configuración
packages[]

object (PackageConfig)

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, ganará el último paquete coincidente y se aplicará al dispositivo.
groups[]

string

Los grupos asociados de 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 del período especificado.

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)

Se muestra el botón “Recordarme más tarde”.
frequency

enum (Frequency)

Se muestra un recordatorio de frecuencia después del descarte.

Inicio

Cuándo mostrar un diálogo de recordatorio. Por ejemplo, si estableces la política 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á el valor predeterminado START_SEVEN_DAYS.

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

RemindLaterDuration

Por cuánto tiempo se muestra el botón "Recordarme más tarde" en el cuadro de diálogo. Elige ALWAYS_SHOW para mostrar el botón todo el tiempo y NEVER_SHOW para que no lo muestre nunca. Si se deja LATER_DURATION_UNSPECIFIED, se usará el valor predeterminado LATER_FOURTEEN_DAYS.

Enumeradores
LATER_DURATION_UNSPECIFIED No se especifica.
NEVER_SHOW No mostrar nunca el botón.
ALWAYS_SHOW Mostrar siempre el botón
LATER_SEVEN_DAYS Botón Quitar 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

Indica cuánto tiempo falta para que se vuelva a mostrar una vez que el usuario descarte el diálogo de recordatorio. Si se deja FREQUENCY_UNSPECIFIED, se usará el valor predeterminado FREQUENCY_SEVEN_DAYS.

Enumeradores
FREQUENCY_UNSPECIFIED No se especifica.
FREQUENCY_ONE_DAY Mostrar 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 Config nuevo.

delete

 Borra un config.

disable

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

get

 Obtiene una vista config.

list

 Enumera configs de una implementación.

update

 Actualiza un objeto config.

updatePackages

 Actualiza los paquetes en la configuración.