REST Resource: deployments.configs

Recurso: Config

Uma configuração de uma implantação.

Representação 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

Apenas saída. O nome do config. Esse é o identificador exclusivo para objetos Config e será gerado pelo servidor quando um novo Config for criado.
title

string

Opcional. O título da configuração.
description

string

Opcional. A descrição da configuração.
defaultUpdateDescription

object (UpdateDescription)

Obrigatório. O texto da interface padrão usado quando a localidade do dispositivo não corresponde a nenhuma localidade especificada em localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Opcional. Uma lista de descrições de atualizações localizadas, que têm prioridade sobre defaultUpdateDescription se uma delas corresponder à localidade do dispositivo.
urgencyMode

enum (UrgencyMode)

Opcional. A urgência de atualização que dita como o usuário será solicitado. Se não for especificado, um padrão de MANDATORY será usado.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opcional. Um atraso que determina quando a atualização será programada para instalação durante a noite. Se não for especificado, o padrão será NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

Opcional. Se deixado como WIFI_ONLY_TIME_UNSPECIFIED, o padrão será SEVEN_DAYS.

Observação: esse valor vai ser definido como FOREVER se urgencyMode for RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Opcional. A janela de tempo de instalação do OTA.
packageSizeAwareBatteryThreshold

boolean

Opcional. Se a atualização deve ter limites de bateria de instalação diferentes dependendo do tamanho.
offPeakUpdate

object (OffPeakUpdate)

Opcional. O objeto de atualização fora de pico.
countryRestriction

object (IncludeExclude)

Opcional. Os possíveis países incluídos/excluídos.
mobileNetworkRestriction

object (IncludeExclude)

Opcional. As possíveis redes móveis incluídas ou excluídas identificadas por códigos mcc/mnc. Ele precisa ser usado exclusivamente em mobileNetworkCarrierRestriction. Não é possível definir os dois campos ao mesmo tempo.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opcional. A possível restrição da propriedade de build de dispositivo incluído/excluído.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opcional. As possíveis operadoras da rede móvel incluídas ou excluídas. Ele precisa ser usado exclusivamente em mobileNetworkRestriction. Não é possível definir os dois campos ao mesmo tempo.

Para ver os mapeamentos, consulte Código de país para dispositivos móveis e código de rede móvel.
updateRequiredSetup

boolean

Opcional. Indica se a atualização é necessária durante o assistente de configuração. O padrão é "false".
minimalSpaceRequired

enum (SpaceNeed)

Opcional. O requisito de espaço mínimo. Quando o valor for UNSPECIFIED, o servidor não vai definir uma restrição. É necessário ter o Google Play Services 6.1.11 ou mais recente.
immediateRelease

boolean

Opcional. É preciso especificar immediateRelease ou rolloutSteps. Se a atualização deve ser lançada imediatamente. Se esse for o caso, rolloutSteps não deverá ser definido.
rolloutSteps[]

object (RolloutStep)

Opcional. É preciso especificar rolloutSteps ou immediateRelease. RolloutSteps precisa estar em ordem: time_ms e Aplicativos não devem diminuir. A última etapa deve ter fração == 100.
securityUpdate

boolean

Opcional. Marca a atualização como uma atualização de segurança. Ela é transmitida ao dispositivo para coordenar a exibição da mensagem de atualização correta. Ou seja, para exibir o texto "aplicando atualização de segurança" em vez de "aplicar uma atualização do sistema". Exige o nível 22 da API ou mais recente e o Google Play Services 9.4 ou mais recente.
details

object (ConfigDetails)

Apenas saída. Mais detalhes de uma configuração. Ele só deve ser retornado pelo servidor ao retornar a configuração.
allowEncryptedScheduledInstall

boolean

Opcional. Se a instalação de um pacote tem permissão ou não em dispositivos criptografados.
reminderDialogSettings

object (ReminderDialogSettings)

Opcional. Configurações da caixa de diálogo modal que lembra os usuários de que há uma atualização pendente.

UpdateDescription

A descrição da atualização enviada ao dispositivo.

Representação JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Campos
description

string

O texto de descrição da atualização.
title

string

O título da descrição da atualização.
dialogMessage

string

A mensagem da caixa de diálogo da atualização.
postSuccessMessage

string

A mensagem pós-sucesso da atualização. Exige o nível 14 da API ou mais recente.
postFailureMessage

string

A mensagem de falha após a atualização da atualização. Exige o nível 14 da API ou mais recente.

LocalizedUpdateDescription

A descrição da atualização com base na localidade.

Representação JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Campos
locales[]

string

As localidades que correspondem às do dispositivo.
updateDescription

object (UpdateDescription)

A descrição da atualização enviada ao dispositivo.

UrgencyMode

O modo de urgência do upgrade.

Enums
MODE_UNSPECIFIED Não especificado.
RECOMMENDED Recomende um upgrade. O usuário receberá uma solicitação para fazer o download e instalar a atualização.
MANDATORY Upgrade obrigatório. O download da atualização será feito automaticamente, mas o usuário receberá uma solicitação para iniciar a instalação.
AUTOMATIC Upgrade automático. A atualização será baixada e instalada automaticamente.

ScheduledInstallDelay

Janela de atraso entre a disponibilização da atualização e o agendamento automático da instalação.

Enums
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valor padrão. Serão tratados como NUNCA.
SCHEDULED_INSTALL_DELAY_NEVER Nunca encaminhe para uma instalação automática.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Janela de dia zero (imediatamente)
SCHEDULED_INSTALL_DELAY_ONE_DAY Janela de um dia.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Janela de dois dias.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Janela de três dias.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Janela de quatro dias.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Janela de cinco dias.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Janela de 10 dias.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Janela de 15 dias.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Janela de 30 dias.

WifiOnlyTime

O download evitará a rede móvel durante este período depois que a atualização estiver disponível.

Enums
WIFI_ONLY_TIME_UNSPECIFIED Não especificado.
NONE Não bloqueado.
TWENTY_FOUR_HOURS Janela de 24 horas.
THREE_DAYS Janela de três dias.
SEVEN_DAYS Janela de sete dias.
FOURTEEN_DAYS Janela de 14 dias.
TWENTY_ONE_DAYS Janela de 21 dias.
FOREVER Janela contínua.

TimeWindow

Uma janela de tempo que define o horário de início e de término de um dia.

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

O horário de início da janela.
stopTime

object (TimeOfDay)

O horário de término da janela.

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Representação JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas do dia no formato de 24 horas. Precisa ser de 0 a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

integer

Minutos da hora do dia. Precisa ser de 0 a 59.
seconds

integer

Segundos do minutos do horário. Normalmente precisa ser de 0 a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

integer

Frações de segundos em nanossegundos. Precisa ser de 0 a 999.999.999.

OffPeakUpdate

A limitação de atualizações fora de pico.

Representação JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Campos
updateOffPeakWindow

object (TimeWindow)

Janela de tempo fora de pico para fazer o download da atualização. É necessário ter o Google Play Services 6.7.72 ou mais recente.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opcional. Quando o valor for OFF_PEAK_DAYS_UNSPECIFIED, o servidor usará um valor padrão de OFF_PEAK_UPDATE_ONE_DAY. É necessário ter o Google Play Services 6.5 ou mais recente.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opcional. Quando o valor não é especificado, o servidor usa um valor padrão de ALL_NETWORK_ALLOWED. É necessário ter o Google Play Services 6.7.72 ou mais recente.

UpdateOffPeakDays

Número de dias para tentar fazer o download da atualização em uma janela fora de pico.

Enums
OFF_PEAK_DAYS_UNSPECIFIED Não especificado.
OFF_PEAK_UPDATE_ONE_DAY 1 dia.
OFF_PEAK_UPDATE_THREE_DAYS 3 dias.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 dias.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 dias.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 dias.

CellularOperatorRestriction

Defina como CELLULAR_OPERATOR_RESTRICTED para impor uma restrição à janela fora de pico de modo que o download OTA fique restrito à operadora de celular em que foi recebido. Projetado para dispositivos com vários chips quando usado com mobileNetworkRestriction para restringir downloads fora de alta demanda a uma operadora específica.

Enums
OPERATOR_RESTRICTED_UNSPECIFIED Não especificado.
CELLULAR_OPERATOR_RESTRICTED Essa janela só é aplicável à operadora de celular em que a OTA foi recebida pela primeira vez.
ALL_NETWORK_ALLOWED A janela fora de pico é aplicável a todas as redes.

IncludeExclude

Inclui ou exclui certos padrões separados por vírgulas.

Representação 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ão include_exclude. Uma regra inclui ou exclui. include_exclude pode ser apenas de um dos tipos a seguir:
include

string

Padrão incluído. Se forem permitidos vários valores, use uma vírgula para separá-los.
exclude

string

Padrão excluído. Se forem permitidos vários valores, use uma vírgula para separá-los.

SpaceNeed

O requisito de espaço em bytes.

Enums
SPACE_NEED_UNSPECIFIED Não especificado.
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

O componente da etapa de lançamento.

Representação JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Campos
rolloutTime

string (Timestamp format)

Carimbo de data/hora do lançamento.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
fraction

number

Fração denominada por porcentagem entre 0,00 e 100,00.

ConfigDetails

Detalhes de um config.

Representação JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Campos
postConditions[]

object (Condition)

As condições pós-instalação da instalação da configuração.
packages[]

object (PackageConfig)

Os pacotes definidos desta configuração. Importante: a ordem dos pacotes é importante. Se um dispositivo corresponder a vários conjuntos de pré-condições, o último pacote correspondente vai ganhar e ser aplicado ao dispositivo.
groups[]

string

Os grupos associados da configuração.
versionTag

object (VersionTag)

Apenas saída. A versão de configuração.

ReminderDialogSettings

Configurações que controlam uma caixa de diálogo modal de lembrete mostrada aos usuários após o período especificado.

Representação JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Campos
start

enum (Start)

Quando começar a mostrar o lembrete.
remindMeLaterDuration

enum (RemindLaterDuration)

Duração "lembre-me mais tarde" é exibido.
frequency

enum (Frequency)

O lembrete de frequência é exibido após a dispensa.

Iniciar

Quando mostrar uma caixa de diálogo de lembrete. Por exemplo, se definida como START_TWO_DAYS, os usuários verão um lembrete dois dias depois de receber a atualização. Se for deixado START_UNSPECIFIED, o padrão START_SEVEN_DAYS será usado.

Enums
START_UNSPECIFIED Não especificado.
NEVER_START Nunca iniciar o lembrete.
START_ZERO_DAYS Comece imediatamente.
START_TWO_DAYS Começar após dois dias.
START_SEVEN_DAYS Começar depois de sete dias.
START_FOURTEEN_DAYS Começar depois de 14 dias. PRÓXIMA TAG: 6

RemindLaterDuration

Por quanto tempo a caixa de diálogo mostra o "Lembrar mais tarde" . Selecione ALWAYS_SHOW para mostrar o botão o tempo todo e NEVER_SHOW para nunca mostrá-lo. Se for deixado LATER_DURATION_UNSPECIFIED, o padrão LATER_FOURTEEN_DAYS será usado.

Enums
LATER_DURATION_UNSPECIFIED Não especificado.
NEVER_SHOW Nunca mostrar o botão.
ALWAYS_SHOW Sempre mostrar o botão.
LATER_SEVEN_DAYS Botão "Remover" após sete dias.
LATER_FOURTEEN_DAYS Remover botão após 14 dias.
LATER_TWENTY_ONE_DAYS Remover botão após 21 dias.

Frequência

Depois que o usuário dispensa a caixa de diálogo do lembrete, informa quanto tempo leva para ela aparecer novamente. Se for deixado FREQUENCY_UNSPECIFIED, o padrão FREQUENCY_SEVEN_DAYS será usado.

Enums
FREQUENCY_UNSPECIFIED Não especificado.
FREQUENCY_ONE_DAY Mostrar o lembrete todos os dias.
FREQUENCY_THREE_DAYS Exibir o lembrete a cada três dias.
FREQUENCY_SEVEN_DAYS Mostrar o lembrete a cada sete dias.

Métodos

create

 Cria um config e retorna o novo Config.

delete

 Exclui um config.

disable

 Desativa todos os grupos ativados que tenham a configuração especificada.

get

 Recebe uma visualização config.

list

 Lista configs de uma implantação.

update

 Atualiza um config.

updatePackages

 Atualize os pacotes na configuração.