REST Resource: deployments.configs

Zasób: konfiguracja

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. Jest to unikalny identyfikator obiektów Config, który jest generowany przez serwer po utworzeniu nowego obiektu Config.
title

string

Opcjonalnie. Tytuł konfiguracji.
description

string

Opcjonalnie. Opis konfiguracji.
defaultUpdateDescription

object (UpdateDescription)

To pole jest wymagane. Domyślny tekst interfejsu używany, gdy język urządzenia nie jest zgodny z żadnym językiem określonym 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. Częstotliwość aktualizacji, która określa, w jaki sposób użytkownik zobaczy prośbę o aktualizację. Jeśli wartość nie zostanie określona, używana będzie wartość domyślna MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opcjonalnie. Opóźnienie, które określa, kiedy aktualizacja zostanie zaplanowana na noc. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

Opcjonalnie. Jeśli pozostawiono wartość WIFI_ONLY_TIME_UNSPECIFIED, domyślna wartość to SEVEN_DAYS.

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

object (TimeWindow)

Opcjonalnie. Okno czasowe instalacji aktualizacji OTA.
packageSizeAwareBatteryThreshold

boolean

Opcjonalnie. Określa, czy w zależności od rozmiaru aktualizacji należy ustawić inne progi instalacji baterii.
offPeakUpdate

object (OffPeakUpdate)

Opcjonalnie. Obiekt aktualizacji poza szczytem sezonu.
countryRestriction

object (IncludeExclude)

Opcjonalnie. Kraje, które można uwzględnić lub wykluczyć.
mobileNetworkRestriction

object (IncludeExclude)

Opcjonalnie. Możliwe uwzględnione/wykluczone sieci komórkowe zidentyfikowane za pomocą kodów mcc/mnc. Należy go używać wyłącznie w przypadku mobileNetworkCarrierRestriction. Nie można ustawić obu pól jednocześnie.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opcjonalnie. Możliwe ograniczenie dotyczące uwzględnionych/wykluczonych usług kompilacji urządzenia.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opcjonalnie. Możliwi uwzględniani/wykluczeni operatorzy sieci komórkowej. Należy go używać wyłącznie w przypadku mobileNetworkRestriction. Nie można ustawić obu pól jednocześnie.

Informacje o mapowaniach znajdziesz w tym artykule.
updateRequiredSetup

boolean

Opcjonalnie. Wskazuje, czy w kreatorze konfiguracji wymagana jest aktualizacja. Wartość domyślna to fałsz.
minimalSpaceRequired

enum (SpaceNeed)

Opcjonalnie. Minimalna wymagana ilość miejsca. Gdy wartość to UNSPECIFIED, serwer nie ustawi ograniczenia. Wymaga Usług Google Play w wersji 6.1.11 lub nowszej.
immediateRelease

boolean

Opcjonalnie. Wymagana jest wartość immediateRelease lub rolloutSteps. Określa, czy aktualizacja powinna zostać natychmiast opublikowana. Jeśli ta zasada ma wartość prawda, zasada rolloutSteps powinna być nieskonfigurowana.
rolloutSteps[]

object (RolloutStep)

Opcjonalnie. Wymagana jest wartość rolloutSteps lub immediateRelease. Parametry RolloutStep muszą być w kolejności: czas_ms i ułamek nie mogą się zmniejszać. W ostatnim kroku należy podać ułamek == 100.
securityUpdate

boolean

Opcjonalnie. Oznacza aktualizację jako aktualizację zabezpieczeń. Jest ona przekazywana do urządzenia w celu koordynacji wyświetlenia prawidłowego komunikatu o aktualizacji. Oznacza to, że wyświetla się tekst „Stosuję aktualizację zabezpieczeń”, a nie „Stosuję aktualizację systemu”. Wymaga interfejsu API na poziomie 22 lub nowszym i Usług Google Play w wersji 9.4 lub nowszej.
details

object (ConfigDetails)

Tylko dane wyjściowe. Więcej szczegółów konfiguracji. Powinien on 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 przypominającego użytkownikom, że mają oczekującą aktualizację.

UpdateDescription

Opis aktualizacji został 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 w oknie aktualizacji.
postSuccessMessage

string

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

string

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

LocalizedUpdateDescription

Opis aktualizacji na podstawie regionu.

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

string

Ustawienia regionalne zgodne z ustawieniami regionalnymi urządzenia.
updateDescription

object (UpdateDescription)

Opis aktualizacji wysyłany na urządzenie.

UrgencyMode

Tryb pilnego uaktualnienia.

Wartości w polu enum
MODE_UNSPECIFIED Nie określono.
RECOMMENDED Zaproponuj uaktualnienie. Użytkownik zostanie poproszony o pobranie i zainstalowanie aktualizacji.
MANDATORY Uaktualnienie obowiązkowe. 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 udostępnienia aktualizacji do automatycznego zaplanowania instalacji.

Wartości w polu enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Wartość domyślna. Środki będą traktowane jako NIGDY.
SCHEDULED_INSTALL_DELAY_NEVER Nigdy nie przekazuj do instalacji automatycznej.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Okno zerowe (natychmiastowe)
SCHEDULED_INSTALL_DELAY_ONE_DAY Okno jednego dnia.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Okno 2-dniowe.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Okres 3-dniowy.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Okno czterodniowe.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Okno pięciodniowe.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Okno 10 dni.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Okno 15-dniowe.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Okno 30 dni.

WifiOnlyTime

Po udostępnieniu aktualizacji pobieranie będzie omijać sieć komórkową w tym okresie.

Wartości w polu enum
WIFI_ONLY_TIME_UNSPECIFIED Nie określono.
NONE Nie zablokowano.
TWENTY_FOUR_HOURS 24-godzinne okno.
THREE_DAYS Okres 3-dniowy.
SEVEN_DAYS Okno 7-dniowe.
FOURTEEN_DAYS Okno 14-dniowe.
TWENTY_ONE_DAYS Okno 21 dni.
FOREVER Bezterminowe 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 zatrzymania okna.

TimeOfDay

Reprezentuje 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. Pokrewne rodzaje treści: 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. W przypadku takich sytuacji jak godzina zamknięcia firmy interfejs API może zezwolić na wartość „24:00:00”.
minutes

integer

Minuty w ciągu dnia. Wymagana wartość z zakresu od 0 do 59.
seconds

integer

Sekundy minut czasu. Zwykle musi mieścić się w zakresie od 0 do 59. Interfejs API może zezwolić na wartość 60, jeśli zezwala na sekundy przestępne.
nanos

integer

Ułamki sekund w nanosekundach. Wartość musi mieścić się w zakresie od 0 do 999 999 999.

OffPeakUpdate

Ograniczenie dotyczące aktualizacji poza szczytem sezonu.

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

object (TimeWindow)

Poza godzinami szczytu możesz pobrać aktualizację. Wymaga Usług Google Play w wersji 6.7.72 lub nowszej.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opcjonalnie. Gdy 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 aktualizacje są pobierane 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 jako CELLULAR_OPERATOR_RESTRICTED, aby nakładać ograniczenie poza godzinami szczytu, tak aby pobieranie OTA było ograniczone do operatora komórkowego, u którego zostało ono po raz pierwszy odebrane. Przeznaczona dla urządzeń z wieloma kartami SIM w połączeniu z mobileNetworkRestriction, aby ograniczyć pobieranie poza godzinami szczytu do określonego operatora.

Wartości w polu enum
OPERATOR_RESTRICTED_UNSPECIFIED Nie określono.
CELLULAR_OPERATOR_RESTRICTED Czas poza szczytem obowiązuje tylko w przypadku operatora komórkowego, przez który odebrano OTA jako pierwszy.
ALL_NETWORK_ALLOWED Okres poza szczytem sezonu obowiązuje we wszystkich sieciach.

IncludeExclude

Uwzględnia lub wyklucza określone wzorce rozdzielane 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ędniania lub wykluczania. include_exclude może mieć tylko jedną z tych wartości:
include

string

Wzór uwzględniony. Jeśli dozwolonych jest wiele wartości, rozdziel je przecinkami.
exclude

string

Wykluczony wzorzec. Jeśli dozwolonych jest wiele 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 formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
fraction

number

Ułamek procentowy z przedziału 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 instalacji konfiguracji.
packages[]

object (PackageConfig)

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

string

Powiązane grupy związane z tą konfiguracją.
versionTag

object (VersionTag)

Tylko dane wyjściowe. Wersja konfiguracji.

ReminderDialogSettings

Ustawienia kontrolujące okno modalne przypomnienia wyświetlane 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 to przycisk „Przypomnij mi później”.
frequency

enum (Frequency)

Po odrzuceniu aplikacji wyświetla się przypomnienie o częstotliwości.

Początek

Kiedy wyświetlać okno przypomnienia. Jeśli na przykład ustawisz wartość START_TWO_DAYS, użytkownicy zobaczą przypomnienie 2 dni po otrzymaniu aktualizacji. Jeśli pozostawisz ustawienie 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 rozpoczynaj przypomnienia.
START_ZERO_DAYS Rozpocznij natychmiast.
START_TWO_DAYS Rozpocznij po upływie 2 dni.
START_SEVEN_DAYS Rozpocznij po 7 dniach.
START_FOURTEEN_DAYS Rozpocznij po 14 dniach. NASTĘPNY TAG: 6

RemindLaterDuration

Czas, przez jaki w oknie jest wyświetlany przycisk „Przypomnij mi później”. Wybierz ustawienie ALWAYS_SHOW, aby przycisk był cały czas wyświetlany, lub NEVER_SHOW, aby nigdy nie był wyświetlany. Jeśli pozostawisz ustawienie 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 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 jakim czasie od zamknięcia przez użytkownika okna przypomnienia pojawi się ono ponownie. Jeśli pozostawisz ustawienie 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 Wyświetlaj przypomnienie co 3 dni.
FREQUENCY_SEVEN_DAYS Wyświetlaj przypomnienie co 7 dni.

Metody

create

 Tworzy element config i zwraca nową wartość Config.

delete

 Usuwa config.

disable

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

get

 Uzyskuje wyświetlenie config.

list

 Wyświetla listę configs wdrożenia.

update

 Aktualizuje: config.

updatePackages

 Zaktualizuj pakiety w konfiguracji.