REST Resource: deployments.configs

Resource: Konfigurasi

Konfigurasi deployment.

Representasi 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)
  }
}
Kolom
name

string

Hanya output. Nama konfigurasi. Perhatikan bahwa ini adalah ID unik untuk objek Config dan akan dihasilkan oleh server saat Config baru dibuat.
title

string

Opsional. Judul konfigurasi.
description

string

Opsional. Deskripsi konfigurasi.
defaultUpdateDescription

object (UpdateDescription)

Wajib. Teks UI default yang digunakan saat lokalitas perangkat tidak cocok dengan lokal apa pun yang ditentukan di localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Opsional. Daftar deskripsi update yang dilokalkan, yang akan lebih diprioritaskan daripada defaultUpdateDescription jika salah satunya cocok dengan lokalitas perangkat.
urgencyMode

enum (UrgencyMode)

Opsional. Urgensi pembaruan yang menentukan bagaimana pengguna akan diminta melakukannya. Jika tidak ditentukan, default MANDATORY akan digunakan.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Opsional. Penundaan yang menentukan kapan update akan dijadwalkan untuk penginstalan semalam. Default-nya adalah NEVER jika tidak ditentukan.
wifiOnlyTime

enum (WifiOnlyTime)

Opsional. Default-nya adalah SEVEN_DAYS jika dibiarkan sebagai WIFI_ONLY_TIME_UNSPECIFIED.

Catatan: ini akan ditetapkan ke FOREVER jika urgencyMode adalah RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Opsional. Periode waktu penginstalan untuk OTA.
packageSizeAwareBatteryThreshold

boolean

Opsional. Apakah update harus memiliki batas baterai penginstalan yang berbeda, bergantung pada ukurannya.
offPeakUpdate

object (OffPeakUpdate)

Opsional. Objek update tidak sibuk.
countryRestriction

object (IncludeExclude)

Opsional. Negara yang mungkin disertakan/dikecualikan.
mobileNetworkRestriction

object (IncludeExclude)

Opsional. Kemungkinan jaringan seluler yang disertakan/dikecualikan yang diidentifikasi oleh kode MCC/mnc. Perhatikan bahwa ini harus digunakan secara eksklusif dari mobileNetworkCarrierRestriction. Kedua kolom tidak dapat ditetapkan bersamaan.
deviceBuildPropertyRestriction

object (IncludeExclude)

Opsional. Kemungkinan batasan properti build perangkat yang disertakan/dikecualikan.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Opsional. Operator jaringan seluler yang mungkin disertakan/dikecualikan. Perhatikan bahwa ini harus digunakan secara eksklusif dari mobileNetworkRestriction. Kedua kolom tidak dapat ditetapkan bersamaan.

Untuk melihat pemetaan, lihat Kode Negara Seluler dan Kode Jaringan Seluler.
updateRequiredSetup

boolean

Opsional. Menunjukkan apakah pembaruan diperlukan selama wizard penyiapan. Nilai defaultnya adalah false (salah).
minimalSpaceRequired

enum (SpaceNeed)

Opsional. Persyaratan ruang minimal. Jika nilainya UNSPECIFIED, server tidak akan menetapkan batasan. Memerlukan Layanan Google Play 6.1.11 atau yang lebih baru.
immediateRelease

boolean

Opsional. Salah satu dari immediateRelease atau rolloutSteps harus ada. Apakah update harus segera dirilis. Jika ini benar, rolloutSteps harus dibatalkan penetapannya.
rolloutSteps[]

object (RolloutStep)

Opsional. Salah satu dari rolloutSteps atau immediateRelease harus ada. launchSteps harus berurutan: time_ms dan pecahan tidak boleh menurun. Langkah terakhir harus memiliki pecahan == 100.
securityUpdate

boolean

Opsional. Menandai update sebagai update keamanan. Ini diteruskan ke perangkat untuk mengoordinasikan tampilan pesan update yang benar. Artinya, untuk menampilkan teks "menerapkan update keamanan" bukan "menerapkan update sistem". Memerlukan API level 22 atau yang lebih baru dan Layanan Google Play 9.4 atau yang lebih baru.
details

object (ConfigDetails)

Hanya output. Detail lebih lanjut tentang konfigurasi. Kolom ini hanya boleh ditampilkan oleh server saat menampilkan konfigurasi.
allowEncryptedScheduledInstall

boolean

Opsional. Apakah paket diizinkan untuk dijadwalkan untuk diinstal pada perangkat terenkripsi atau tidak.
reminderDialogSettings

object (ReminderDialogSettings)

Opsional. Setelan untuk dialog modal mengingatkan pengguna bahwa mereka memiliki update yang tertunda.

UpdateDescription

Deskripsi update dikirim ke perangkat.

Representasi JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Kolom
description

string

Teks deskripsi update.
title

string

Judul deskripsi update.
dialogMessage

string

Pesan dialog update.
postSuccessMessage

string

Pesan update berhasil. Memerlukan API level 14 atau yang lebih tinggi.
postFailureMessage

string

Pesan kegagalan postingan update. Memerlukan API level 14 atau yang lebih tinggi.

LocalizedUpdateDescription

Deskripsi update berdasarkan lokalitas.

Representasi JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Kolom
locales[]

string

Lokal yang sesuai dengan lokal perangkat.
updateDescription

object (UpdateDescription)

Deskripsi update yang dikirim ke perangkat.

UrgencyMode

Mode urgensi upgrade.

Enum
MODE_UNSPECIFIED Tidak ditentukan.
RECOMMENDED Sarankan upgrade. Pengguna akan diminta untuk mendownload dan menginstal update.
MANDATORY Upgrade wajib. Update akan didownload secara otomatis tetapi pengguna akan diminta untuk memulai penginstalan.
AUTOMATIC Upgrade otomatis. Update akan didownload dan diinstal secara otomatis.

ScheduledInstallDelay

Periode penundaan dari saat update tersedia hingga saat penginstalan dijadwalkan secara otomatis.

Enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Nilai default. Akan diperlakukan sebagai TIDAK PERNAH.
SCHEDULED_INSTALL_DELAY_NEVER Jangan pernah melakukan eskalasi ke penginstalan otomatis.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Periode nol hari (segera)
SCHEDULED_INSTALL_DELAY_ONE_DAY Periode satu hari.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Jendela dua hari.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Jendela tiga hari.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Periode empat hari.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Jendela lima hari.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Jendela sepuluh hari.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Jendela lima belas hari.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Jendela tiga puluh hari.

WifiOnlyTime

Download akan menghindari jaringan seluler selama periode ini setelah update tersedia.

Enum
WIFI_ONLY_TIME_UNSPECIFIED Tidak ditentukan.
NONE Tidak diblokir.
TWENTY_FOUR_HOURS Jendela dua puluh empat jam.
THREE_DAYS Jendela tiga hari.
SEVEN_DAYS Periode tujuh hari.
FOURTEEN_DAYS Jendela empat belas hari.
TWENTY_ONE_DAYS Jendela dua puluh satu hari.
FOREVER Jendela selamanya.

TimeWindow

Jendela waktu yang menentukan waktu mulai dalam sehari dan waktu berhenti dalam sehari.

Representasi JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Kolom
startTime

object (TimeOfDay)

Waktu mulai jendela.
stopTime

object (TimeOfDay)

Waktu berhenti jendela.

TimeOfDay

Mewakili waktu. Tanggal dan zona waktu tidak signifikan atau ditentukan di tempat lain. API dapat memilih untuk mengizinkan detik kabisat. Jenis terkait adalah google.type.Date dan google.protobuf.Timestamp.

Representasi JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Kolom
hours

integer

Jam dalam format 24 jam. Harus dari 0 hingga 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti jam tutup bisnis.
minutes

integer

Menit dalam jam. Harus dari 0 hingga 59.
seconds

integer

Detik menit dari waktu. Biasanya harus antara 0 hingga 59. API dapat mengizinkan nilai 60 jika memungkinkan kabisat-detik.
nanos

integer

Pecahan detik dalam nanodetik. Harus dari 0 hingga 999.999.999.

OffPeakUpdate

Batasan update di luar puncak.

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

object (TimeWindow)

Periode di luar jam sibuk untuk mendownload update. Memerlukan Layanan Google Play 6.7.72 atau yang lebih baru.
updateOffPeakDays

enum (UpdateOffPeakDays)

Opsional. Jika nilainya OFF_PEAK_DAYS_UNSPECIFIED, server akan menggunakan nilai default OFF_PEAK_UPDATE_ONE_DAY. Memerlukan Layanan Google Play 6.5 atau yang lebih baru.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Opsional. Jika nilai tidak ditentukan, server akan menggunakan nilai default ALL_NETWORK_ALLOWED. Memerlukan Layanan Google Play 6.7.72 atau yang lebih baru.

UpdateOffPeakDays

Jumlah hari untuk mencoba mendownload update pada periode tidak sibuk.

Enum
OFF_PEAK_DAYS_UNSPECIFIED Tidak ditentukan.
OFF_PEAK_UPDATE_ONE_DAY 1 hari.
OFF_PEAK_UPDATE_THREE_DAYS 3 hari.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 hari.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 hari.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 hari.

CellularOperatorRestriction

Setel ke CELLULAR_OPERATOR_RESTRICTED untuk menerapkan pembatasan pada jendela tidak sibuk sehingga download OTA dibatasi hanya untuk operator seluler tempat download OTA pertama kali diterima. Ditujukan untuk perangkat multi-SIM saat digunakan bersama dengan mobileNetworkRestriction untuk membatasi download di luar jam sibuk untuk operator tertentu.

Enum
OPERATOR_RESTRICTED_UNSPECIFIED Tidak ditentukan.
CELLULAR_OPERATOR_RESTRICTED Jendela {i>off-peak<i} berlaku untuk operator seluler tempat OTA pertama kali diterima hanya.
ALL_NETWORK_ALLOWED Periode tidak sibuk ini berlaku untuk semua jaringan.

IncludeExclude

Menyertakan atau mengecualikan pola tertentu yang dipisahkan koma.

Representasi 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.
}
Kolom
Kolom union include_exclude. Aturan menyertakan atau mengecualikan. include_exclude hanya ada berupa salah satu diantara berikut:
include

string

Pola yang disertakan. Jika beberapa nilai diperbolehkan, gunakan koma untuk memisahkannya.
exclude

string

Pola yang dikecualikan. Jika beberapa nilai diperbolehkan, gunakan koma untuk memisahkannya.

SpaceNeed

Persyaratan ruang dalam byte.

Enum
SPACE_NEED_UNSPECIFIED Tidak ditentukan.
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

Komponen langkah peluncuran.

Representasi JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Kolom
rolloutTime

string (Timestamp format)

Stempel waktu peluncuran.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
fraction

number

Pecahan dinyatakan dengan persentase antara 0,00 dan 100,00.

ConfigDetails

Detail konfigurasi.

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

object (Condition)

Kondisi pasca-penginstalan konfigurasi.
packages[]

object (PackageConfig)

Paket yang ditentukan dari konfigurasi ini. Penting: urutan paket itu penting. Jika perangkat cocok dengan beberapa kumpulan prakondisi, paket terakhir yang cocok akan menang dan akan diterapkan ke perangkat.
groups[]

string

Grup terkait dari konfigurasi ini.
versionTag

object (VersionTag)

Hanya output. Versi konfigurasi.

ReminderDialogSettings

Setelan yang mengontrol dialog pengingat modal yang ditampilkan kepada pengguna setelah jangka waktu yang ditentukan.

Representasi JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Kolom
start

enum (Start)

Waktu mulai menampilkan pengingat.
remindMeLaterDuration

enum (RemindLaterDuration)

Tombol durasi "ingatkan saya nanti" ditampilkan.
frequency

enum (Frequency)

Pengingat frekuensi ditampilkan setelah penutupan.

Mulai

Waktu untuk menampilkan dialog pengingat. Misalnya, jika disetel ke START_TWO_DAYS, pengguna akan melihat pengingat 2 hari setelah menerima update. Jika dibiarkan START_UNSPECIFIED, default START_SEVEN_DAYS akan digunakan.

Enum
START_UNSPECIFIED Tidak ditentukan.
NEVER_START Jangan pernah memulai pengingat.
START_ZERO_DAYS Segera mulai.
START_TWO_DAYS Mulai setelah dua hari.
START_SEVEN_DAYS Mulai setelah tujuh hari.
START_FOURTEEN_DAYS Mulai setelah empat belas hari. TAG BERIKUTNYA: 6

RemindLaterDuration

Berapa lama dialog menampilkan tombol "Ingatkan saya nanti". Pilih ALWAYS_SHOW untuk selalu menampilkan tombol dan NEVER_SHOW untuk tidak pernah menampilkannya. Jika dibiarkan LATER_DURATION_UNSPECIFIED, default LATER_FOURTEEN_DAYS akan digunakan.

Enum
LATER_DURATION_UNSPECIFIED Tidak ditentukan.
NEVER_SHOW Jangan pernah menampilkan tombol.
ALWAYS_SHOW Selalu tampilkan tombol.
LATER_SEVEN_DAYS Hapus tombol setelah tujuh hari.
LATER_FOURTEEN_DAYS Hapus tombol setelah empat belas hari.
LATER_TWENTY_ONE_DAYS Hapus tombol setelah dua puluh satu hari.

Frekuensi

Setelah pengguna menutup dialog pengingat, berapa lama waktu yang diperlukan hingga dialog pengingat ditampilkan lagi. Jika dibiarkan FREQUENCY_UNSPECIFIED, default FREQUENCY_SEVEN_DAYS akan digunakan.

Enum
FREQUENCY_UNSPECIFIED Tidak ditentukan.
FREQUENCY_ONE_DAY Tampilkan pengingat setiap hari.
FREQUENCY_THREE_DAYS Tampilkan pengingat setiap tiga hari.
FREQUENCY_SEVEN_DAYS Tampilkan pengingat setiap tujuh hari.

Metode

create

 Membuat config, dan menampilkan Config baru.

delete

 Menghapus config.

disable

 Menonaktifkan semua grup yang diaktifkan yang memiliki konfigurasi yang ditentukan.

get

 Mendapatkan tampilan config.

list

 Mencantumkan configs deployment.

update

 Memperbarui config.

updatePackages

 Update paket di bagian konfigurasi.