REST Resource: deployments.configs

Zasób: Config

Konfiguracja wdrożenia.

Zapis 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)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa konfiguracji. Pamiętaj, że jest to unikalny identyfikator obiektów Config i zostanie wygenerowany przez serwer po utworzeniu nowego obiektu Config.
title

string

Opcjonalnie: Tytuł konfiguracji.
description

string

Opcjonalnie: Opis konfiguracji.
defaultUpdateDescription

object (UpdateDescription)

Wymagane. Domyślny tekst interfejsu używany, gdy język urządzenia nie odpowiada żadnemu językowi określonemu w zasadzie localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Opcjonalnie: Lista zlokalizowanych opisów aktualizacji, które mają wyższy priorytet niż defaultUpdateDescription, jeśli jeden z nich jest zgodny z językiem urządzenia.
urgencyMode

enum (UrgencyMode)

Opcjonalnie: Pilna prośba o aktualizację, która określa sposób wyświetlenia użytkownikowi prośby o aktualizację. Jeśli wartość nie zostanie określona, zostanie użyta wartość domyślna MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opcjonalnie: Opóźnienie określające, kiedy aktualizacja zostanie zaplanowana do instalacji w nocy. Jeśli nie zostanie określony, domyślna wartość to NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

Opcjonalnie: Domyślna wartość to SEVEN_DAYS, jeśli pozostawisz wartość WIFI_ONLY_TIME_UNSPECIFIED.

Uwaga: jeśli urgencyMode ma wartość RECOMMENDED, ta opcja zostanie ustawiona na FOREVER.
updateMaintenanceWindow

object (TimeWindow)

Opcjonalnie: Okno czasu instalacji OTA.
packageSizeAwareBatteryThreshold

boolean

Opcjonalnie: Określa, czy aktualizacja powinna mieć różne progi baterii w zależności od jej rozmiaru.
offPeakUpdate

object (OffPeakUpdate)

Opcjonalnie: Obiekt aktualizacji poza godzinami szczytu.
countryRestriction

object (IncludeExclude)

Opcjonalnie: Lista możliwych uwzględnionych/wykluczonych krajów.
mobileNetworkRestriction

object (IncludeExclude)

Opcjonalnie: Możliwe uwzględnione/wykluczone sieci komórkowe określone za pomocą kodów mcc/mnc. Pamiętaj, że można ich używać wyłącznie w przypadku: mobileNetworkCarrierRestriction. Nie można ustawić obu pól jednocześnie.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opcjonalnie: Możliwe ograniczenie właściwości uwzględnionej lub wykluczonej kompilacji urządzenia.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opcjonalnie: Możliwe uwzględniani/wykluczeni operatorzy sieci komórkowej. Pamiętaj, że można ich używać wyłącznie w przypadku: mobileNetworkRestriction. Nie można ustawić obu pól jednocześnie.

Aby dowiedzieć się, jak to zrobić, przeczytaj artykuł Kod kraju i sieci komórkowej.
updateRequiredSetup

boolean

Opcjonalnie: Wskazuje, czy podczas kreatora konfiguracji wymagana jest aktualizacja. Wartość domyślna to fałsz.
minimalSpaceRequired

enum (SpaceNeed)

Opcjonalnie: Minimalne wymagania dotyczące miejsca. Jeśli wartością jest UNSPECIFIED, serwer nie ustawi ograniczenia. Wymaga Usług Google Play w wersji 6.1.11 lub nowszej.
immediateRelease

boolean

Opcjonalnie: Trzeba podać jedną z tych wartości: immediateRelease lub rolloutSteps. Określa, czy aktualizacja ma zostać natychmiast udostępniona. Jeśli to prawda, zasada rolloutSteps powinna być nieskonfigurowana.
rolloutSteps[]

object (RolloutStep)

Opcjonalnie: Trzeba podać jedną z tych wartości: rolloutSteps lub immediateRelease. Etapy wdrażania muszą być podane w kolejności: wartość parametru time_ms i ułamek nie może być malejąca. W ostatnim kroku należy podać ułamek równy 100.
securityUpdate

boolean

Opcjonalnie: Oznacza aktualizację jako aktualizację zabezpieczeń. Jest ona przekazywana do urządzenia, aby koordynować wyświetlanie poprawnej wiadomości o aktualizacji. Oznacza to, że aby wyświetlić tekst „stosuję aktualizację zabezpieczeń” a nie „stosowanie aktualizacji systemu”. Wymaga interfejsu API na poziomie 22 lub nowszym oraz Usług Google Play w wersji 9.4 lub nowszej.
details

object (ConfigDetails)

Tylko dane wyjściowe. Więcej informacji o konfiguracji. Ten parametr powinien być zwracany przez serwer tylko podczas zwracania konfiguracji.
allowEncryptedScheduledInstall

boolean

Opcjonalnie: Określa, czy można zaplanować instalację pakietu na zaszyfrowanych urządzeniach.
reminderDialogSettings

object (ReminderDialogSettings)

Opcjonalnie: Ustawienia okna modalnego z przypomnieniem użytkownikom o oczekującej aktualizacji.

UpdateDescription

Opis aktualizacji wysłany na urządzenie.

Zapis JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Pola
description

string

Tekst opisu aktualizacji.
title

string

Tytuł opisu aktualizacji.
dialogMessage

string

Komunikat okna aktualizacji.
postSuccessMessage

string

Komunikat o pomyślnym zakończeniu aktualizacji. Wymaga interfejsu API na poziomie 14 lub wyższym.
postFailureMessage

string

Komunikat o niepowodzeniu aktualizacji. Wymaga interfejsu API na poziomie 14 lub wyższym.

LocalizedUpdateDescription

Opis aktualizacji na podstawie języka.

Zapis JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Pola
locales[]

string

Języki zgodne z regionami urządzenia.
updateDescription

object (UpdateDescription)

Opis aktualizacji wysyłany do urządzenia.

UrgencyMode

Tryb szybkiego uaktualniania.

Wartości w polu enum
MODE_UNSPECIFIED Nie określono.
RECOMMENDED Zaleca się uaktualnienie. Użytkownik zostanie poproszony o pobranie i zainstalowanie aktualizacji.
MANDATORY Obowiązkowe uaktualnienie. Aktualizacja zostanie pobrana automatycznie, ale użytkownik zostanie poproszony o rozpoczęcie instalacji.
AUTOMATIC Automatyczne uaktualnienie. Aktualizacja zostanie pobrana i zainstalowana automatycznie.

ScheduledInstallDelay

Okres opóźnienia od momentu udostępnienia aktualizacji do automatycznego zaplanowania instalacji.

Wartości w polu enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Wartość domyślna. zostanie potraktowana jako NIGDY.
SCHEDULED_INSTALL_DELAY_NEVER Nigdy nie eskaluj do instalacji automatycznej.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Okno zero-day (natychmiast)
SCHEDULED_INSTALL_DELAY_ONE_DAY 1-dniowy okres.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Dwudniowy okres.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Okno 3-dniowe.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Okno czterodniowe.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Okno pięciodniowe.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Dziesięciodniowy okres.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Okno 15-dniowe.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Okno 30-dniowe.

WifiOnlyTime

Po udostępnieniu aktualizacji przez ten okres funkcja pobierania będzie pomijać sieć komórkową.

Wartości w polu enum
WIFI_ONLY_TIME_UNSPECIFIED Nie określono.
NONE Nie zablokowano.
TWENTY_FOUR_HOURS Okno 24-godzinne.
THREE_DAYS Okno 3-dniowe.
SEVEN_DAYS Okno 7-dniowe.
FOURTEEN_DAYS Okno 14-dniowe.
TWENTY_ONE_DAYS Okno 21-dniowe.
FOREVER Okno na niecałe okno.

TimeWindow

Przedział czasu, który określa godzinę rozpoczęcia i zakończenia dnia.

Zapis JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Pola
startTime

object (TimeOfDay)

Godzina rozpoczęcia okna.
stopTime

object (TimeOfDay)

Godzina zakończenia okna.

TimeOfDay

Przedstawia porę dnia. Data i strefa czasowa są nieistotne lub zostały określone w innym miejscu. Interfejs API może zezwolić na sekundy przestępne. Podobne typy to google.type.Date i google.protobuf.Timestamp.

Zapis JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Pola
hours

integer

Godziny dnia w formacie 24-godzinnym. Wartość powinna mieścić się w zakresie od 0 do 23. Interfejs API może zezwolić na wartość „24:00:00” w takich sytuacjach jak zamknięcie firmy.
minutes

integer

Minuty dnia. Wartość musi mieścić się w przedziale od 0 do 59.
seconds

integer

Sekundy czasu trwania. Zwykle musi mieścić się w zakresie od 0 do 59. Interfejs API może akceptować wartość 60, jeśli zezwala na użycie sekund przestępnych.
nanos

integer

Ułamki sekund w nanosekundach. Musi mieścić się w przedziale od 0 do 999 999 999.

OffPeakUpdate

Ograniczenie aktualizacji poza szczytem.

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

object (TimeWindow)

Okno poza godzinami największego zapotrzebowania na pobranie aktualizacji. Wymaga Usług Google Play w wersji 6.7.72 lub nowszej.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opcjonalnie: Jeśli wartością jest OFF_PEAK_DAYS_UNSPECIFIED, serwer użyje wartości domyślnej OFF_PEAK_UPDATE_ONE_DAY. Wymaga Usług Google Play w wersji 6.5 lub nowszej.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opcjonalnie: Jeśli wartość nie zostanie określona, serwer użyje wartości domyślnej ALL_NETWORK_ALLOWED. Wymaga Usług Google Play w wersji 6.7.72 lub nowszej.

UpdateOffPeakDays

Liczba dni, przez które należy próbować pobrać aktualizację poza godzinami szczytu.

Wartości w polu enum
OFF_PEAK_DAYS_UNSPECIFIED Nie określono.
OFF_PEAK_UPDATE_ONE_DAY 1 dzień.
OFF_PEAK_UPDATE_THREE_DAYS 3 dni.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 dni.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 dni.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 dni.

CellularOperatorRestriction

Ustaw wartość CELLULAR_OPERATOR_RESTRICTED, aby ograniczyć przedział czasu poza szczytem, tak aby pobieranie OTA było dostępne tylko dla operatora komórkowego, u którego je odebrano. Przydatny dla urządzeń z wieloma kartami SIM w połączeniu z siecią mobileNetworkRestriction, by ograniczyć pobieranie w okresie poza szczytem do określonego operatora.

Wartości w polu enum
OPERATOR_RESTRICTED_UNSPECIFIED Nie określono.
CELLULAR_OPERATOR_RESTRICTED Okres poza szczytem dotyczy operatora komórkowego, do którego po raz pierwszy odebrano OTA.
ALL_NETWORK_ALLOWED Poza sezonem obowiązuje we wszystkich sieciach.

IncludeExclude

Uwzględnia lub wyklucza określone wzorce rozdzielone przecinkami.

Zapis 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.
}
Pola
Pole sumy include_exclude. Reguła uwzględnia lub wyklucza. include_exclude może mieć tylko jedną z tych wartości:
include

string

Uwzględniony wzorzec. Jeśli dozwolonych jest kilka wartości, rozdziel je przecinkami.
exclude

string

Wykluczony wzorzec. Jeśli dozwolonych jest kilka wartości, rozdziel je przecinkami.

SpaceNeed

Wymagana ilość miejsca w bajtach.

Wartości w polu enum
SPACE_NEED_UNSPECIFIED Nie określono.
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

Komponent kroku wdrażania.

Zapis JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Pola
rolloutTime

string (Timestamp format)

Sygnatura czasowa wdrożenia.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
fraction

number

Ułamek wyrażony procentowo z zakresu od 0,00 do 100,00.

ConfigDetails

Szczegóły konfiguracji.

Zapis JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Pola
postConditions[]

object (Condition)

Warunki po instalacji konfiguracji.
packages[]

object (PackageConfig)

Zdefiniowane pakiety tej konfiguracji. Ważne: kolejność pakietów ma znaczenie. Jeśli urządzenie spełnia kilka zestawów warunków wstępnych, wygrywa ostatni pasujący pakiet, który zostanie zastosowany na urządzeniu.
groups[]

string

Powiązane grupy tej konfiguracji.
versionTag

object (VersionTag)

Tylko dane wyjściowe. Wersja konfiguracji.

ReminderDialogSettings

Ustawienia sterujące modalnym oknem przypomnienia wyświetlanym użytkownikom po upływie określonego czasu.

Zapis JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Pola
start

enum (Start)

Kiedy zacząć wyświetlać przypomnienie.
remindMeLaterDuration

enum (RemindLaterDuration)

Czas trwania „przypomnij mi później” przycisk jest widoczny.
frequency

enum (Frequency)

Przypomnienie o częstotliwości wyświetla się po zamknięciu.

Rozpocznij

Kiedy wyświetlać okno przypomnienia. Jeśli na przykład ustawisz wartość START_TWO_DAYS, użytkownicy zobaczą przypomnienie po 2 dniach od otrzymania aktualizacji. Jeśli pozostawisz START_UNSPECIFIED, zostanie użyta wartość domyślna START_SEVEN_DAYS.

Wartości w polu enum
START_UNSPECIFIED Nie określono.
NEVER_START Nigdy nie uruchamiaj przypomnienia.
START_ZERO_DAYS Rozpocznij od razu.
START_TWO_DAYS Rozpocznij po 2 dniach.
START_SEVEN_DAYS Rozpocznij po 7 dniach.
START_FOURTEEN_DAYS Rozpocznij po 14 dniach. NASTĘPNY TAG: 6

RemindLaterDuration

Jak długo w oknie dialogowym wyświetla się „Przypomnij mi później”. Przycisk Wybierz ALWAYS_SHOW, aby przycisk był wyświetlany przez cały czas, lub NEVER_SHOW, aby nigdy go nie pokazywać. Jeśli pozostawisz LATER_DURATION_UNSPECIFIED, zostanie użyta wartość domyślna LATER_FOURTEEN_DAYS.

Wartości w polu enum
LATER_DURATION_UNSPECIFIED Nie określono.
NEVER_SHOW Nigdy nie pokazuj tego przycisku.
ALWAYS_SHOW Zawsze pokazuj przycisk.
LATER_SEVEN_DAYS Usuń przycisk po 7 dniach.
LATER_FOURTEEN_DAYS Usuń przycisk po 14 dniach.
LATER_TWENTY_ONE_DAYS Usuń przycisk po 21 dniach.

Częstotliwość

Po zamknięciu okna przypomnienia przez użytkownika pojawi się ono ponownie. Jeśli pozostawisz FREQUENCY_UNSPECIFIED, zostanie użyta wartość domyślna FREQUENCY_SEVEN_DAYS.

Wartości w polu enum
FREQUENCY_UNSPECIFIED Nie określono.
FREQUENCY_ONE_DAY Pokazuj przypomnienie codziennie.
FREQUENCY_THREE_DAYS Pokazuj przypomnienie co 3 dni.
FREQUENCY_SEVEN_DAYS Pokazuj przypomnienie co 7 dni.

Metody

create

 Tworzy config i zwraca nową wartość Config.

delete

 Usuwa element config.

disable

 Wyłącza wszystkie włączone grupy o określonej konfiguracji.

get

 Otrzymuje config wyświetlenie.

list

 Wyświetla listę configs wdrożenia.

update

 Aktualizuje config.

updatePackages

 Zaktualizuj pakiety w konfiguracji.