REST Resource: deployments.configs

Recurso: configuração

A 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 da configuração. 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. Descrição da configuração.
defaultUpdateDescription

object (UpdateDescription)

Obrigatório. O texto padrão da interface 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ção localizadas, que têm prioridade sobre defaultUpdateDescription quando uma delas corresponde à localidade do dispositivo.
urgencyMode

enum (UrgencyMode)

Opcional. A urgência da atualização que determina como o usuário será avisado. 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. O padrão será SEVEN_DAYS se for definido como WIFI_ONLY_TIME_UNSPECIFIED.

Observação: ele será definido como FOREVER se urgencyMode for RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Opcional. É a janela de tempo de instalação da OTA.
packageSizeAwareBatteryThreshold

boolean

Opcional. Se a atualização precisa ter diferentes limites de bateria de instalação dependendo do tamanho dela.
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 de mobileNetworkCarrierRestriction. Os dois campos não podem ser definidos ao mesmo tempo.
deviceBuildPropertyRestriction

object (IncludeExclude)

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

object (IncludeExclude)

Opcional. As possíveis operadoras de rede móvel incluídas ou excluídas. Ele precisa ser usado exclusivamente de mobileNetworkRestriction. Os dois campos não podem ser definidos ao mesmo tempo.

Para ver os mapeamentos, consulte Código de país do dispositivo móvel 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 definirá uma restrição. Requer o Google Play Services 6.1.11 ou mais recente.
immediateRelease

boolean

Opcional. É preciso especificar immediateRelease ou rolloutSteps. Se a atualização precisa ser lançada imediatamente. Se for verdadeiro, rolloutSteps não vai ser definido.
rolloutSteps[]

object (RolloutStep)

Opcional. É preciso especificar rolloutSteps ou immediateRelease. launchSteps precisa estar em ordem: time_ms e fração não podem ser decrescentes; A última etapa deve ter uma fração == 100.
securityUpdate

boolean

Opcional. Marca a atualização como uma atualização de segurança. Isso é transmitido ao dispositivo para coordenar a exibição da mensagem de atualização correta. Ou seja, para mostrar o texto "aplicando atualização de segurança", em vez de "aplicando atualização do sistema". Requer o nível da API 22 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. Ela só deve ser retornada pelo servidor ao retornar a configuração.
allowEncryptedScheduledInstall

boolean

Opcional. Se um pacote pode ou não ser programado para instalação em dispositivos criptografados.
reminderDialogSettings

object (ReminderDialogSettings)

Opcional. Configurações da caixa de diálogo modal lembrando aos usuários que uma atualização está 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 de êxito da atualização. Exige o nível da API 14 ou mais recente.
postFailureMessage

string

A mensagem de falha na publicação da atualização. Exige o nível da API 14 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 correspondentes à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 o upgrade. O usuário vai 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 vai receber uma solicitação para iniciar a instalação.
AUTOMATIC Upgrade automático. A atualização será transferida por download e instalada automaticamente.

ScheduledInstallDelay

Janela de atraso entre o momento em que a atualização está disponível e o momento em que a instalação é agendada automaticamente.

Enums
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Valor padrão. Será tratado como NUNCA.
SCHEDULED_INSTALL_DELAY_NEVER Nunca encaminhe para instalação automática.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Janela de zero dia (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 vai evitar a rede móvel para este período após a atualização estar 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 Sempre janela.

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ção fora de pico.

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

object (TimeWindow)

Janela de horário fora de pico para fazer o download da atualização. Requer 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. Requer o Google Play Services 6.5 ou mais recente.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opcional. Quando o valor não for especificado, o servidor usará um valor padrão ALL_NETWORK_ALLOWED. Requer o Google Play Services 6.7.72 ou mais recente.

UpdateOffPeakDays

Número de dias para tentar fazer o download da atualização fora da janela 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 na janela de pico, de modo que o download OTA fique restrito à operadora de celular em que foi recebido pela primeira vez. Destinado a dispositivos com vários chips, quando usado com mobileNetworkRestriction, para restringir os downloads fora de pico a uma operadora específica.

Enums
OPERATOR_RESTRICTED_UNSPECIFIED Não especificado.
CELLULAR_OPERATOR_RESTRICTED A janela de fora de pico é aplicável à operadora de celular em que o OTA foi recebido apenas pela primeira vez.
ALL_NETWORK_ALLOWED A janela de fora do pico se aplica a todas as redes.

IncludeExclude

Inclui ou exclui determinados padrões separados por vírgula.

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 de inclusões ou exclusões. include_exclude pode ser apenas de um dos tipos a seguir:
include

string

Estampa incluída. Se vários valores forem permitidos, use uma vírgula para separá-los.
exclude

string

Padrão excluído. Se vários valores forem permitidos, 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)

O carimbo de data/hora do lançamento.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 uma configuração.

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

object (Condition)

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

object (PackageConfig)

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

string

Os grupos associados dessa configuração.
versionTag

object (VersionTag)

Apenas saída. A versão da 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 o lembrete começar a ser exibido.
remindMeLaterDuration

enum (RemindLaterDuration)

A duração do botão "Lembrar mais tarde" é exibida.
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 for definida como START_TWO_DAYS, os usuários verão um lembrete dois dias depois de receber a atualização. Se deixada como START_UNSPECIFIED, um padrão de 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 Comece após dois dias.
START_SEVEN_DAYS Começar após sete dias.
START_FOURTEEN_DAYS Começar após 14 dias. PRÓXIMA TAG: 6

RemindLaterDuration

Por quanto tempo a caixa de diálogo mostra o botão "Lembrar mais tarde". Selecione ALWAYS_SHOW para mostrar o botão o tempo todo e NEVER_SHOW para nunca mostrá-lo. Se deixada como LATER_DURATION_UNSPECIFIED, um padrão de 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 Botão de remoção após 14 dias.
LATER_TWENTY_ONE_DAYS Remover botão após 21 dias.

Frequência

Quanto tempo depois que o usuário dispensa a caixa de diálogo de lembrete ela aparece novamente. Se deixada como FREQUENCY_UNSPECIFIED, um padrão de FREQUENCY_SEVEN_DAYS será usado.

Enums
FREQUENCY_UNSPECIFIED Não especificado.
FREQUENCY_ONE_DAY Mostrar o lembrete todos os dias.
FREQUENCY_THREE_DAYS Mostrar 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 têm a configuração especificada.

get

 Recebe uma visualização config.

list

 Lista configs de uma implantação.

update

 Atualiza um config.

updatePackages

 Atualizar os pacotes na configuração.