REST Resource: deployments.configs

Kaynak: Yapılandırma

Bir dağıtım 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 nesnelerinin benzersiz tanımlayıcısı olduğunu ve yeni bir Config oluşturulduğunda sunucu tarafından oluşturulacağını 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 yerel ayarlarla eşleşmediğinde kullanılan varsayılan kullanıcı arayüzü metni.

localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

İsteğe bağlı. Yerelleştirilmiş güncelleme açıklamalarının listesi. Bunlardan biri cihazın yerel ayarıyla eşleşiyorsa defaultUpdateDescription özelliğine göre önceliklidir.

urgencyMode

enum (UrgencyMode)

İsteğe bağlı. Kullanıcının nasıl isteneceğini belirleyen güncelleme aciliyeti. Belirtilmezse varsayılan olarak MANDATORY kullanılır.

scheduledInstallDelay

enum (ScheduledInstallDelay)

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

wifiOnlyTime

enum (WifiOnlyTime)

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

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

updateMaintenanceWindow

object (TimeWindow)

İsteğe bağlı. OTA için yükleme süresi 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ı. Dahil edilen/hariç tutulan ülkeler.

mobileNetworkRestriction

object (IncludeExclude)

İsteğe bağlı. mcc/mnc kodlarıyla tanımlanan olası dahil edilen/hariç tutulan mobil ağlar. Bunun yalnızca mobileNetworkCarrierRestriction için kullanılması gerektiğini unutmayın. İki alan da aynı anda ayarlanamaz.

deviceBuildPropertyRestriction

object (IncludeExclude)

İsteğe bağlı. Dahil edilen/hariç tutulan cihaz derleme özelliği kısıtlaması.

mobileNetworkCarrierRestriction

object (IncludeExclude)

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

Eşlemeleri görüntülemek için lütfen Mobil Ülke Kodu ve Mobil Ağ Kodu başlıklı makaleyi inceleyin.

updateRequiredSetup

boolean

İsteğe bağlı. Kurulum sihirbazında güncelleme gerekip gerekmediğini belirtir. Varsayılan olarak "false" (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 sonraki bir sürümü gerekir.

immediateRelease

boolean

İsteğe bağlı. Bir immediateRelease veya rolloutSteps zorunludur. Güncellemenin hemen yayınlanıp yayınlanmayacağı. Bu doğruysa rolloutSteps politikası ayarlanmamalıdır.

rolloutSteps[]

object (RolloutStep)

İsteğe bağlı. Bir rolloutSteps veya immediateRelease zorunludur. RolloutSteps sıralı olmalıdır: hem time_ms hem de ondalık değer azaltılmamalıdır. Son adım kesir == 100 olmalıdır.

securityUpdate

boolean

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

details

object (ConfigDetails)

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

allowEncryptedScheduledInstall

boolean

İsteğe bağlı. Bir paketin şifrelenmiş cihazlara yüklenmek üzere planlanmasına izin verilip verilmediği.

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

Açıklamayı güncelleme başlığı.

dialogMessage

string

Güncellemenin iletişim mesajı.

postSuccessMessage

string

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

postFailureMessage

string

Güncellemenin yayın başarısız 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 Yükseltmeyi ö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 otomatik olarak indirilip yüklenecek.

ScheduledInstallDelay

Güncellemenin kullanıma sunulmasından yüklemenin otomatik olarak planlanmasına kadar geçen gecikme aralığı.

Sıralamalar
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Varsayılan değer. HİÇBİR ZAMAN olarak ele alınacaktır.
SCHEDULED_INSTALL_DELAY_NEVER Hiçbir zaman otomatik yüklemeye yükseltme.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Sıfır gün aralığı (hemen)
SCHEDULED_INSTALL_DELAY_ONE_DAY Bir günlük aralık.
SCHEDULED_INSTALL_DELAY_TWO_DAYS İki günlük pencere.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Üç günlük aralık.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Dört günlük pencere.
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 zaman aralığı.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Otuz günlük zaman aralığı.

WifiOnlyTime

İndirme işlemi, güncelleme kullanıma sunulduktan sonra bu süre boyunca mobil ağdan kaçınır.

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

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)

Aralık başlangıç zamanı.

stopTime

object (TimeOfDay)

Aralık durdurma zamanı.

TimeOfDay

Günün saatini temsil eder. Tarih ve saat dilimi önemli değil veya başka bir yerde belirtilmiş. API'ler artık saniyelere izin vermeyi tercih edebilir. İlgili türler şunlardır: 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. API'ler, işletmenin kapanış saati gibi senaryolar için "24:00:00" değerine izin vermeyi tercih edebilir.

minutes

integer

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

seconds

integer

Dakikanın saniye cinsinden saniyeleri. Normalde 0 ile 59 arasında olmalıdır. Artık saniyelere izin veren API'ler 60 değerine izin verebilir.

nanos

integer

Saniyenin nanosaniye cinsinden kısmı. 0 ile 999.999.999 arasında olmalıdır.

OffPeakUpdate

Zirve dışı güncelleme sınırlaması.

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

object (TimeWindow)

Güncellemeyi indirmek için yoğun olmayan zaman aralığı. Google Play Hizmetleri 6.7.72 veya üzeri bir sürümü gerektirir.

updateOffPeakDays

enum (UpdateOffPeakDays)

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

updateOperatorRestriction

enum (CellularOperatorRestriction)

İsteğe bağlı. Değer belirtilmezse sunucu, ALL_NETWORK_ALLOWED değerini varsayılan olarak kullanır. Google Play Hizmetleri 6.7.72 veya üzeri bir sürümü gerektirir.

UpdateOffPeakDays

Güncellemeyi yoğun olmayan zaman aralığında indirmek için beklenecek 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

OTA indirme işleminin, ilk alındığı hücresel operatörle sınırlı olması için yoğun kullanım dışı zaman aralığında bir kısıtlama uygulamak üzere CELLULAR_OPERATOR_RESTRICTED değerine ayarlayın. Yoğun olmayan indirme işlemlerini belirli bir operatörle kısıtlamak için mobileNetworkRestriction ile birlikte kullanıldığında çoklu SIM kartlı cihazlar için tasarlanmıştır.

Sıralamalar
OPERATOR_RESTRICTED_UNSPECIFIED Belirtilmedi.
CELLULAR_OPERATOR_RESTRICTED Yoğun olmayan zaman aralığı, yalnızca OTA'nın ilk 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

Virgülle ayrılmış belirli 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
include_exclude alanı. Dahil etme veya hariç tutma kuralı. include_exclude şunlardan yalnızca biri olabilir:
include

string

Desen eklendi. Birden çok değere izin veriliyorsa bunları virgülle ayırın.

exclude

string

Hariç tutulan kalıp. Birden çok değere izin veriliyorsa bunları 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ı.

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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 ifade edilen 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üklemesi sonrası koşulları.

packages[]

object (PackageConfig)

Bu yapılandırmanın tanımlanmış 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 ne zaman gösterilmeye başlayacağı.

remindMeLaterDuration

enum (RemindLaterDuration)

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

frequency

enum (Frequency)

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

Başlat

Hatırlatıcı iletişim kutusunun gösterilme zamanı. Örneğin, START_TWO_DAYS olarak ayarlanırsa kullanıcılara güncellemeyi almalarından 2 gün sonra bir hatırlatıcı gösterilir. START_UNSPECIFIED bölümünden ayrılırsanız varsayılan olarak 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şlayın.
START_FOURTEEN_DAYS On dört gün sonra başlayın. SONRAKİ ETİKET: 6

RemindLaterDuration

İletişim kutusunda "Daha sonra hatırlat" düğmesinin gösterilme süresi. Düğmenin her zaman gösterilmesi için ALWAYS_SHOW, hiçbir zaman gösterilmemesi için NEVER_SHOW öğesini seçin. LATER_DURATION_UNSPECIFIED bölümünden ayrılırsanız varsayılan olarak 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öster.
LATER_SEVEN_DAYS Yedi gün sonra kaldır düğmesi.
LATER_FOURTEEN_DAYS Düğmeyi on dört gün sonra kaldır.
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österileceği süre. FREQUENCY_UNSPECIFIED bölümünden ayrılırsanız varsayılan olarak 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

Bir config dosyasını siler.

disable

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

get

config görüntüleme alır.

list

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

update

config öğesini günceller.

updatePackages

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