REST Resource: deployments.configs

Kaynak: Yapılandırma

Dağıtımın yapılandırması.

JSON gösterimi
{
  "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)
  }
}
Alanlar
name

string

Yalnızca çıkış. Yapılandırmanın adı. Bunun, Config nesneleri için benzersiz tanımlayıcı olduğunu ve yeni bir Config oluşturulduğunda sunucu tarafından üretileceğini unutmayın.

title

string

İsteğe bağlı. Yapılandırmanın başlığı.

description

string

İsteğe bağlı. Yapılandırmanın açıklaması.

defaultUpdateDescription

object (UpdateDescription)

Zorunlu. Cihaz yerel ayarı localizedUpdateDescriptions içinde belirtilen hiçbir yerel ayarla eşleşmediğinde kullanılan varsayılan kullanıcı arayüzü metni.

localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

İsteğe bağlı. İçlerinden biri cihazın yerel ayarıyla eşleşirse defaultUpdateDescription açıklamalarından daha öncelikli olan yerelleştirilmiş güncelleme açıklamalarının listesi.

urgencyMode

enum (UrgencyMode)

İsteğe bağlı. Kullanıcıya nasıl istem gösterileceğini belirten güncelleme aciliyeti. Belirtilmemesi durumunda varsayılan MANDATORY kullanılır.

scheduledInstallDelay

enum (ScheduledInstallDelay)

İsteğe bağlı. Güncellemenin gecelik olarak yüklenmek üzere ne zaman planlanacağını belirleyen gecikme. Belirtilmezse varsayılan olarak NEVER değerine ayarlanır.

wifiOnlyTime

enum (WifiOnlyTime)

İsteğe bağlı. WIFI_ONLY_TIME_UNSPECIFIED olarak bırakıldıysa varsayılan olarak SEVEN_DAYS değerine ayarlanır.

Not: urgencyMode değeri RECOMMENDED ise bu ayar FOREVER olarak ayarlanır.

updateMaintenanceWindow

object (TimeWindow)

İsteğe bağlı. OTA'nın kurulum zaman aralığı.

packageSizeAwareBatteryThreshold

boolean

İsteğe bağlı. Güncellemenin, boyutuna bağlı olarak farklı yükleme pil eşiklerine sahip olup olmayacağı.

offPeakUpdate

object (OffPeakUpdate)

İsteğe bağlı. Yoğun olmayan güncelleme nesnesi.

countryRestriction

object (IncludeExclude)

İsteğe bağlı. Olası dahil edilen/hariç tutulan ülkeler.

mobileNetworkRestriction

object (IncludeExclude)

İsteğe bağlı. mm/mnc kodlarıyla tanımlanan dahil edilmiş/hariç tutulmuş olası mobil ağlar. Bunun yalnızca mobileNetworkCarrierRestriction için kullanılması gerektiğini unutmayın. Her iki alan da aynı anda ayarlanamaz.

deviceBuildPropertyRestriction

object (IncludeExclude)

İsteğe bağlı. Dahil edilmiş/hariç tutulmuş olası cihaz derleme özelliği kısıtlaması.

mobileNetworkCarrierRestriction

object (IncludeExclude)

İsteğe bağlı. Dahil edilen/hariç tutulan olası mobil ağ operatörleri. Bunun yalnızca mobileNetworkRestriction için kullanılması gerektiğini unutmayın. Her iki alan da aynı anda ayarlanamaz.

Eşlemeleri görüntülemek için lütfen Mobil Ülke Kodu ve Mobil Ağ Kodu bölümüne bakın.

updateRequiredSetup

boolean

İsteğe bağlı. Kurulum sihirbazında güncelleme gerekip gerekmediğini gösterir. Varsayılan olarak yanlış değerine ayarlanır.

minimalSpaceRequired

enum (SpaceNeed)

İsteğe bağlı. Minimum alan gereksinimi. Değer UNSPECIFIED olduğunda sunucu bir kısıtlama ayarlamaz. Google Play Hizmetleri 6.1.11 veya daha yeni bir sürüm gerektirir.

immediateRelease

boolean

İsteğe bağlı. immediateRelease veya rolloutSteps özelliklerinden biri gerekli. Güncellemenin hemen yayınlanıp yayınlanmayacağı. Bu doğruysa rolloutSteps ayarlanmamış olmalıdır.

rolloutSteps[]

object (RolloutStep)

İsteğe bağlı. rolloutSteps veya immediateRelease özelliklerinden biri gerekli. RolloutSteps sıralı olmalıdır: Hem time_ms hem de kesirde azalma olmamalıdır. Son adımın değeri 100 ile aynı olmalıdır.

securityUpdate

boolean

İsteğe bağlı. Güncellemeyi güvenlik güncellemesi olarak işaretler. Bu bilgi, doğru güncelleme mesajının gösterilmesini koordine etmek için cihaza iletilir. Yani, "güvenlik güncellemesi uygulanıyor" metnini görüntülemek için "sistem güncellemesi uygulayın". API düzeyi 22 veya sonraki sürümleri ve Google Play Hizmetleri 9.4 veya sonraki sürümleri gerekir.

details

object (ConfigDetails)

Yalnızca çıkış. Yapılandırmayla ilgili daha fazla ayrıntı. Bu, yalnızca yapılandırma döndürülürken sunucu tarafından döndürülmelidir.

allowEncryptedScheduledInstall

boolean

İsteğe bağlı. Bir paketin şifrelenmiş cihazlara yüklenmesinin planlanıp programlanmadığı.

reminderDialogSettings

object (ReminderDialogSettings)

İsteğe bağlı. Kullanıcılara bekleyen güncellemeleri olduğunu hatırlatan kalıcı iletişim kutusunun ayarları.

UpdateDescription

Cihaza gönderilen güncelleme açıklaması.

JSON gösterimi
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Alanlar
description

string

Güncelleme açıklama metni.

title

string

Güncelleme açıklaması başlığı.

dialogMessage

string

Güncellemeyle ilgili iletişim kutusu mesajı.

postSuccessMessage

string

Güncellemenin yayın başarılı mesajı. API düzeyi 14 veya üstünü gerektirir.

postFailureMessage

string

Güncellemenin yayın hatası mesajı. API düzeyi 14 veya üstünü gerektirir.

LocalizedUpdateDescription

Yerel ayara göre güncelleme açıklaması.

JSON gösterimi
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Alanlar
locales[]

string

Cihazın yerel ayarlarıyla eşleşecek yerel ayarlar.

updateDescription

object (UpdateDescription)

Cihaza gönderilen güncelleme açıklaması.

UrgencyMode

Yükseltme aciliyet modu.

Sıralamalar
MODE_UNSPECIFIED Belirtilmedi.
RECOMMENDED Yeni sürüme geçmeyi önerin. Kullanıcıdan güncellemeyi indirip yüklemesi istenir.
MANDATORY Zorunlu yükseltme. Güncelleme otomatik olarak indirilir ancak kullanıcıdan yüklemeyi başlatması istenir.
AUTOMATIC Otomatik yükseltme. Güncelleme indirilip otomatik olarak yüklenir.

ScheduledInstallDelay

Güncellemenin kullanılabilir olduğu andan kurulumun otomatik olarak planlandığı ana kadar geçen gecikme aralığı.

Sıralamalar
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Varsayılan değer. HİÇBİR ZAMAN olarak ele alınır.
SCHEDULED_INSTALL_DELAY_NEVER Hiçbir zaman otomatik yüklemeye iletme.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Sıfır günlük zaman aralığı (hemen)
SCHEDULED_INSTALL_DELAY_ONE_DAY Bir günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_TWO_DAYS İki günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Üç günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Dört günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Beş günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_TEN_DAYS On günlük zaman aralığı.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS On beş günlük aralık.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Otuz günlük aralık.

WifiOnlyTime

İndirme işleminde, güncelleme kullanıma sunulduktan sonra bu süre boyunca mobil ağ kullanılmayacak.

Sıralamalar
WIFI_ONLY_TIME_UNSPECIFIED Belirtilmedi.
NONE Engellenmedi.
TWENTY_FOUR_HOURS Yirmi dört saatlik zaman aralığı.
THREE_DAYS Üç günlük zaman aralığı.
SEVEN_DAYS Yedi günlük aralık.
FOURTEEN_DAYS On dört günlük aralık.
TWENTY_ONE_DAYS Yirmi bir günlük zaman aralığı.
FOREVER Sonsuza kadar sürecek pencere.

TimeWindow

Bir günün başlangıç ve bitiş zamanını tanımlayan zaman aralığıdır.

JSON gösterimi
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Alanlar
startTime

object (TimeOfDay)

Pencere başlangıç zamanı.

stopTime

object (TimeOfDay)

Pencerenin durma süresi.

TimeOfDay

Günün saatini temsil eder. Tarih ve saat dilimi önemli değil veya başka bir yerde belirtilmiş. Bir API, artık saniyeye izin vermeyi seçebilir. İlgili türler: google.type.Date ve google.protobuf.Timestamp.

JSON gösterimi
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Alanlar
hours

integer

24 saat biçiminde günün saatleri. 0 ile 23 arasında olmalıdır. Bir API, "24:00:00" değerine izin vermeyi seçebilir. gibi senaryolar için oldukça yararlı olabilir.

minutes

integer

Günün saatindeki dakikalar. 0 ile 59 arasında olmalıdır.

seconds

integer

Saniye cinsinden dakika. Normalde 0 ile 59 arasında olmalıdır. Bir API, artık saniyeye izin veriyorsa 60 değerine izin verebilir.

nanos

integer

Nanosaniye cinsinden saniyenin kesirleri. 0 ile 999.999.999 arasında olmalıdır.

OffPeakUpdate

Yoğun olmayan zamanlarda güncelleme sınırlaması.

JSON gösterimi
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Alanlar
updateOffPeakWindow

object (TimeWindow)

Güncellemenin indirileceği yoğun olmayan zaman aralığı. Google Play Hizmetleri 6.7.72 veya daha yeni bir sürüm gerektirir.

updateOffPeakDays

enum (UpdateOffPeakDays)

İsteğe bağlı. Değer OFF_PEAK_DAYS_UNSPECIFIED olduğunda sunucu, varsayılan OFF_PEAK_UPDATE_ONE_DAY değerini kullanır. Google Play Hizmetleri 6.5 veya sonraki bir sürümü gerekir.

updateOperatorRestriction

enum (CellularOperatorRestriction)

İsteğe bağlı. Değer belirtilmediğinde sunucu varsayılan ALL_NETWORK_ALLOWED değerini kullanır. Google Play Hizmetleri 6.7.72 veya daha yeni bir sürüm gerektirir.

UpdateOffPeakDays

Güncellemenin yoğun olmayan zaman aralığında indirilmeye çalışılacağı gün sayısı.

Sıralamalar
OFF_PEAK_DAYS_UNSPECIFIED Belirtilmedi.
OFF_PEAK_UPDATE_ONE_DAY 1 gün.
OFF_PEAK_UPDATE_THREE_DAYS 3 gün.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 gün.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 gün.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 gün.

CellularOperatorRestriction

Yoğun olmayan zaman aralığında OTA indirme işleminin, ilk alındığı hücresel operatörle sınırlandırılması için CELLULAR_OPERATOR_RESTRICTED olarak ayarlayın. Yoğun olmayan saatlerin dışında indirmeleri belirli bir operatörle kısıtlamak için mobileNetworkRestriction ile birlikte kullanıldığında çoklu SIM kart kullanılan cihazlar için tasarlanmıştır.

Sıralamalar
OPERATOR_RESTRICTED_UNSPECIFIED Belirtilmedi.
CELLULAR_OPERATOR_RESTRICTED Yoğun olmayan zaman aralığı, OTA'nın yalnızca ilk kez alındığı hücresel operatör için geçerlidir.
ALL_NETWORK_ALLOWED Yoğun olmayan zaman aralığı tüm ağlar için geçerlidir.

IncludeExclude

Belirli virgülle ayrılmış kalıpları içerir veya hariç tutar.

JSON gösterimi
{

  // 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.
}
Alanlar
Birleştirme alanı include_exclude. Dahil etme veya hariç tutma kuralı. include_exclude şunlardan yalnızca biri olabilir:
include

string

Eklenen desen. Birden çok değere izin veriliyorsa değerleri virgülle ayırın.

exclude

string

Hariç tutulan kalıp. Birden çok değere izin veriliyorsa değerleri virgülle ayırın.

SpaceNeed

Bayt cinsinden alan gereksinimi.

Sıralamalar
SPACE_NEED_UNSPECIFIED Belirtilmedi.
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

Kullanıma sunma adımı bileşeni.

JSON gösterimi
{
  "rolloutTime": string,
  "fraction": number
}
Alanlar
rolloutTime

string (Timestamp format)

Kullanıma sunma zaman damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

fraction

number

0,00 ile 100,00 arasında yüzde cinsinden hesaplanan oran.

ConfigDetails

Bir yapılandırmanın ayrıntıları.

JSON gösterimi
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Alanlar
postConditions[]

object (Condition)

Yapılandırma yükleme sonrası koşullar.

packages[]

object (PackageConfig)

Bu yapılandırmanın tanımlanan paketleri. Önemli: Paketlerin sırası önemlidir. Bir cihaz birden fazla ön koşul grubuyla eşleşirse son eşleşen paket kazanır ve cihaza uygulanır.

groups[]

string

Bu yapılandırmanın ilişkili grupları.

versionTag

object (VersionTag)

Yalnızca çıkış. Yapılandırma sürümü.

ReminderDialogSettings

Belirtilen süre sonunda kullanıcılara gösterilen kalıcı hatırlatıcı iletişim kutusunu kontrol eden ayarlar.

JSON gösterimi
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Alanlar
start

enum (Start)

Hatırlatıcının gösterilmeye başlayacağı zaman.

remindMeLaterDuration

enum (RemindLaterDuration)

Süre "daha sonra hatırlat" düğmesi gösterilir.

frequency

enum (Frequency)

Sıklık hatırlatıcı kapatıldıktan sonra gösterilir.

Başlangıç

Hatırlatıcı iletişim kutusu ne zaman gösterilir? Örneğin, START_TWO_DAYS olarak ayarlanırsa kullanıcılar güncellemeyi aldıktan 2 gün sonra bir hatırlatıcı görür. START_UNSPECIFIED olarak bırakılırsa varsayılan START_SEVEN_DAYS kullanılır.

Sıralamalar
START_UNSPECIFIED Belirtilmedi.
NEVER_START Hatırlatıcıyı hiçbir zaman başlatma.
START_ZERO_DAYS Hemen başlayın.
START_TWO_DAYS İki gün sonra başlayın.
START_SEVEN_DAYS Yedi gün sonra başlayabilirsiniz.
START_FOURTEEN_DAYS On dört gün sonra başlamalıdır. SONRAKİ ETİKET: 6

RemindLaterDuration

İletişim kutusunda "Daha sonra hatırlat" seçeneği ne kadar süre boyunca gösterilir? düğmesini tıklayın. Düğmeyi her zaman göstermek için ALWAYS_SHOW düğmesini, asla göstermemek için NEVER_SHOW simgesini seçin. LATER_DURATION_UNSPECIFIED olarak bırakılırsa varsayılan LATER_FOURTEEN_DAYS kullanılır.

Sıralamalar
LATER_DURATION_UNSPECIFIED Belirtilmedi.
NEVER_SHOW Düğmeyi hiçbir zaman gösterme.
ALWAYS_SHOW Düğmeyi her zaman gösterin.
LATER_SEVEN_DAYS Düğmeyi yedi gün sonra kaldır.
LATER_FOURTEEN_DAYS Kaldır düğmesi on dört gün sonra.
LATER_TWENTY_ONE_DAYS Yirmi bir gün sonra kaldır düğmesi.

Sıklık

Kullanıcı hatırlatıcı iletişim kutusunu kapattıktan sonra, iletişim kutusunun tekrar gösterilmesi için ne kadar süre geçmesi gerekir? FREQUENCY_UNSPECIFIED olarak bırakılırsa varsayılan FREQUENCY_SEVEN_DAYS kullanılır.

Sıralamalar
FREQUENCY_UNSPECIFIED Belirtilmedi.
FREQUENCY_ONE_DAY Hatırlatıcıyı her gün göster.
FREQUENCY_THREE_DAYS Hatırlatıcıyı üç günde bir göster.
FREQUENCY_SEVEN_DAYS Hatırlatıcıyı yedi günde bir göster.

Yöntemler

create

Bir config oluşturur ve yeni Config değerini döndürür.

delete

config öğesini siler.

disable

Belirtilen yapılandırmaya sahip tüm etkin grupları devre dışı bırakır.

get

config görünümü alır.

list

Bir dağıtımın configs kadarını listeler.

update

config günceller.

updatePackages

Yapılandırma altındaki paketleri güncelleyin.