REST Resource: deployments.configs

ทรัพยากร: การกำหนดค่า

การกำหนดค่าของการทำให้ใช้งานได้

การแสดง 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)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อของการกำหนดค่า โปรดทราบว่านี่เป็นตัวระบุที่ไม่ซ้ำกันสำหรับออบเจ็กต์ Config และเซิร์ฟเวอร์จะสร้างข้อมูลดังกล่าวเมื่อมีการสร้าง Config ใหม่
title

string

ไม่บังคับ ชื่อของการกำหนดค่า
description

string

ไม่บังคับ คำอธิบายของการกำหนดค่า
defaultUpdateDescription

object (UpdateDescription)

ต้องระบุ ข้อความ UI เริ่มต้นที่ใช้เมื่อภาษาของอุปกรณ์ไม่ตรงกับภาษาที่ระบุไว้ใน localizedUpdateDescriptions
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

ไม่บังคับ รายการคำอธิบายการอัปเดตที่แปลแล้ว ซึ่งมีลำดับความสำคัญสูงกว่า defaultUpdateDescription หากรายการใดรายการหนึ่งตรงกับภาษาของอุปกรณ์
urgencyMode

enum (UrgencyMode)

ไม่บังคับ ความเร่งด่วนของการอัปเดตซึ่งจะกำหนดวิธีการแจ้งให้ผู้ใช้ทราบ หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้น MANDATORY
scheduledInstallDelay

enum (ScheduledInstallDelay)

ไม่บังคับ การหน่วงเวลาซึ่งกำหนดเวลาที่จะตั้งเวลาการอัปเดตสำหรับการติดตั้งข้ามคืน ค่าเริ่มต้นจะเป็น NEVER หากไม่ได้ระบุไว้
wifiOnlyTime

enum (WifiOnlyTime)

ไม่บังคับ ค่าเริ่มต้นคือ SEVEN_DAYS หากปล่อยไว้เป็น WIFI_ONLY_TIME_UNSPECIFIED

หมายเหตุ: ตัวแปรนี้จะตั้งค่าเป็น FOREVER หาก urgencyMode คือ RECOMMENDED
updateMaintenanceWindow

object (TimeWindow)

ไม่บังคับ กรอบเวลาในการติดตั้ง OTA
packageSizeAwareBatteryThreshold

boolean

ไม่บังคับ การอัปเดตควรมีเกณฑ์แบตเตอรี่สำหรับการติดตั้งที่แตกต่างกันตามขนาดหรือไม่
offPeakUpdate

object (OffPeakUpdate)

ไม่บังคับ ออบเจ็กต์การอัปเดตนอกช่วง
countryRestriction

object (IncludeExclude)

ไม่บังคับ ประเทศที่รวม/ยกเว้นที่เป็นไปได้
mobileNetworkRestriction

object (IncludeExclude)

ไม่บังคับ เครือข่ายมือถือที่รวมไว้/ยกเว้นที่เป็นไปได้ซึ่งระบุด้วยรหัส mcc/mnc โปรดทราบว่าต้องใช้ mobileNetworkCarrierRestriction เท่านั้น ตั้งค่าทั้ง 2 ช่องพร้อมกันไม่ได้
deviceBuildPropertyRestriction

object (IncludeExclude)

ไม่บังคับ การจำกัดพร็อพเพอร์ตี้บิลด์ของอุปกรณ์ที่รวมอยู่/ยกเว้นที่เป็นไปได้
mobileNetworkCarrierRestriction

object (IncludeExclude)

ไม่บังคับ ผู้ให้บริการเครือข่ายมือถือที่รวม/ยกเว้นที่เป็นไปได้ โปรดทราบว่าต้องใช้ mobileNetworkRestriction เท่านั้น ตั้งค่าทั้ง 2 ช่องพร้อมกันไม่ได้

หากต้องการดูการแมป โปรดอ้างอิงรหัสประเทศของอุปกรณ์เคลื่อนที่และรหัสเครือข่ายมือถือ
updateRequiredSetup

boolean

ไม่บังคับ ระบุว่าต้องอัปเดตหรือไม่ในระหว่างวิซาร์ดการตั้งค่า ค่าเริ่มต้นคือ "เท็จ"
minimalSpaceRequired

enum (SpaceNeed)

ไม่บังคับ พื้นที่ขั้นต่ำที่ต้องการ เมื่อค่านี้เป็น UNSPECIFIED เซิร์ฟเวอร์จะไม่ตั้งค่าข้อจำกัด ต้องใช้บริการ Google Play 6.1.11 ขึ้นไป
immediateRelease

boolean

ไม่บังคับ ต้องระบุ immediateRelease หรือ rolloutSteps อย่างน้อย 1 รายการ ควรเผยแพร่การอัปเดตทันทีหรือไม่ หากเป็นเช่นนี้ ควรยกเลิกการตั้งค่า rolloutSteps
rolloutSteps[]

object (RolloutStep)

ไม่บังคับ ต้องระบุ rolloutSteps หรือ immediateRelease อย่างน้อย 1 รายการ RolloutSteps ต้องเป็นไปตามลำดับ: ทั้ง time_ms และเศษส่วนไม่ควรลดลง ขั้นตอนสุดท้ายควรมีเศษ == 100
securityUpdate

boolean

ไม่บังคับ ทำเครื่องหมายการอัปเดตนี้เป็นการอัปเดตความปลอดภัย ซึ่งจะส่งข้อมูลนี้ไปยังอุปกรณ์เพื่อประสานงานการแสดงข้อความอัปเดตที่ถูกต้อง ซึ่งหมายถึงการแสดงข้อความ "กำลังใช้การอัปเดตความปลอดภัย" แทนที่จะใช้ "ใช้การอัปเดตระบบ" ต้องใช้ API ระดับ 22 ขึ้นไปและบริการ Google Play 9.4 ขึ้นไป
details

object (ConfigDetails)

เอาต์พุตเท่านั้น รายละเอียดเพิ่มเติมเกี่ยวกับการกำหนดค่า ซึ่งเซิร์ฟเวอร์ควรส่งคืนเมื่อแสดงการกำหนดค่าเท่านั้น
allowEncryptedScheduledInstall

boolean

ไม่บังคับ ระบุว่าอนุญาตให้กำหนดเวลาติดตั้งแพ็กเกจในอุปกรณ์ที่เข้ารหัสหรือไม่
reminderDialogSettings

object (ReminderDialogSettings)

ไม่บังคับ การตั้งค่าสำหรับกล่องโต้ตอบโมดัลที่แจ้งเตือนผู้ใช้ว่ามีการอัปเดตที่รอดำเนินการ

UpdateDescription

คําอธิบายการอัปเดตที่ส่งไปยังอุปกรณ์

การแสดง JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
ช่อง
description

string

ข้อความอธิบายการอัปเดต
title

string

ชื่อคำอธิบายการอัปเดต
dialogMessage

string

ข้อความในกล่องโต้ตอบของการอัปเดต
postSuccessMessage

string

ข้อความอัปเดตหลังโพสต์สำเร็จ ต้องมี API ระดับ 14 ขึ้นไป
postFailureMessage

string

ข้อความอัปเดตล้มเหลวในโพสต์ ต้องมี API ระดับ 14 ขึ้นไป

LocalizedUpdateDescription

คำอธิบายการอัปเดตตามภาษา

การแสดง JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
ช่อง
locales[]

string

ภาษาที่ตรงกับภาษาของอุปกรณ์
updateDescription

object (UpdateDescription)

คำอธิบายการอัปเดตที่ส่งไปยังอุปกรณ์

UrgencyMode

โหมดเร่งด่วนในการอัปเกรด

Enum
MODE_UNSPECIFIED ไม่ได้ระบุ
RECOMMENDED แนะนำให้อัปเกรด ผู้ใช้จะได้รับแจ้งให้ดาวน์โหลดและติดตั้งอัปเดต
MANDATORY การอัปเกรดภาคบังคับ การอัปเดตจะดาวน์โหลดโดยอัตโนมัติ แต่ผู้ใช้จะได้รับข้อความแจ้งให้เริ่มการติดตั้ง
AUTOMATIC การอัปเกรดอัตโนมัติ ระบบจะดาวน์โหลดและติดตั้งอัปเดตโดยอัตโนมัติ

ScheduledInstallDelay

กรอบเวลาความล่าช้าตั้งแต่เวลาที่อัปเดตพร้อมใช้งานจนถึงกำหนดเวลาการติดตั้งโดยอัตโนมัติ

Enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED ค่าเริ่มต้น จะถือว่าเป็น "ไม่มี"
SCHEDULED_INSTALL_DELAY_NEVER ไม่ต้องส่งต่อไปยังการติดตั้งอัตโนมัติ
SCHEDULED_INSTALL_DELAY_ZERO_DAYS กรอบเวลา Zero Day (ทันที)
SCHEDULED_INSTALL_DELAY_ONE_DAY กรอบเวลาหนึ่งวัน
SCHEDULED_INSTALL_DELAY_TWO_DAYS กรอบเวลา 2 วัน
SCHEDULED_INSTALL_DELAY_THREE_DAYS กรอบเวลา 3 วัน
SCHEDULED_INSTALL_DELAY_FOUR_DAYS กรอบเวลา 4 วัน
SCHEDULED_INSTALL_DELAY_FIVE_DAYS กรอบเวลา 5 วัน
SCHEDULED_INSTALL_DELAY_TEN_DAYS กรอบเวลา 10 วัน
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS กรอบเวลา 15 วัน
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS กรอบเวลา 30 วัน

WifiOnlyTime

การดาวน์โหลดจะเลี่ยงเครือข่ายมือถือในช่วงนี้หลังจากอัปเดตที่พร้อมใช้งาน

Enum
WIFI_ONLY_TIME_UNSPECIFIED ไม่ได้ระบุ
NONE ไม่ได้บล็อก
TWENTY_FOUR_HOURS กรอบเวลา 24 ชั่วโมง
THREE_DAYS กรอบเวลา 3 วัน
SEVEN_DAYS กรอบเวลา 7 วัน
FOURTEEN_DAYS กรอบเวลา 14 วัน
TWENTY_ONE_DAYS กรอบเวลา 20 วัน
FOREVER กรอบเวลาถาวร

TimeWindow

กรอบเวลาที่กำหนดเวลาเริ่มต้นของวันและเวลาหยุดของวัน

การแสดง JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
ช่อง
startTime

object (TimeOfDay)

เวลาเริ่มต้นของกรอบเวลา
stopTime

object (TimeOfDay)

เวลาสิ้นสุดของกรอบเวลา

TimeOfDay

แสดงช่วงเวลาของวัน วันที่และเขตเวลาไม่มีความสำคัญหรือมีการระบุไว้ที่อื่น API อาจเลือกอนุญาตการใช้เวลาไม่กี่วินาที ประเภทที่เกี่ยวข้องคือ google.type.Date และ google.protobuf.Timestamp

การแสดง JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
ช่อง
hours

integer

ชั่วโมงของวันในรูปแบบ 24 ชั่วโมง ควรอยู่ในช่วง 0 ถึง 23 API อาจเลือกอนุญาตค่า "24:00:00" สำหรับสถานการณ์ต่างๆ เช่น เวลาปิดทำการ
minutes

integer

นาทีต่อชั่วโมง ต้องอยู่ระหว่าง 0 ถึง 59
seconds

integer

เวลาเป็นวินาที โดยปกติต้องอยู่ระหว่าง 0 ถึง 59 API อาจอนุญาตให้ใช้ค่า 60 หากอนุญาตให้มีวินาทีอธิกวาร
nanos

integer

เศษส่วนของวินาทีในหน่วยนาโนวินาที ต้องมีค่าตั้งแต่ 0 ถึง 999,999,999

OffPeakUpdate

ข้อจำกัดในการอัปเดตช่วงโลว์ซีซัน

การแสดง JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
ช่อง
updateOffPeakWindow

object (TimeWindow)

กรอบเวลาช่วงโลว์ซีซันในการดาวน์โหลดอัปเดต ต้องใช้บริการ Google Play เวอร์ชัน 6.7.72 ขึ้นไป
updateOffPeakDays

enum (UpdateOffPeakDays)

ไม่บังคับ เมื่อค่านี้เป็น OFF_PEAK_DAYS_UNSPECIFIED เซิร์ฟเวอร์จะใช้ค่าเริ่มต้นเป็น OFF_PEAK_UPDATE_ONE_DAY ต้องใช้บริการ Google Play 6.5 ขึ้นไป
updateOperatorRestriction

enum (CellularOperatorRestriction)

ไม่บังคับ เมื่อไม่มีการระบุค่า เซิร์ฟเวอร์จะใช้ค่าเริ่มต้น ALL_NETWORK_ALLOWED ต้องใช้บริการ Google Play เวอร์ชัน 6.7.72 ขึ้นไป

UpdateOffPeakDays

จำนวนวันที่จะลองดาวน์โหลดการอัปเดตในช่วงที่มีการใช้งานต่ำ

Enum
OFF_PEAK_DAYS_UNSPECIFIED ไม่ได้ระบุ
OFF_PEAK_UPDATE_ONE_DAY 1 วัน
OFF_PEAK_UPDATE_THREE_DAYS 3 วัน
OFF_PEAK_UPDATE_SEVEN_DAYS 7 วัน
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 วัน
OFF_PEAK_UPDATE_THIRTY_DAYS 30 วัน

CellularOperatorRestriction

ตั้งค่าเป็น CELLULAR_OPERATOR_RESTRICTED เพื่อกำหนดข้อจำกัดสำหรับช่วงที่มีการใช้งานสูงสุด เพื่อจำกัดการดาวน์โหลด OTA ให้กับผู้ให้บริการเครือข่ายมือถือที่ได้รับอุปกรณ์ครั้งแรก มีไว้สำหรับอุปกรณ์แบบหลายซิมเมื่อใช้ร่วมกับ mobileNetworkRestriction เพื่อจำกัดการดาวน์โหลดในช่วงที่มีการใช้งานสูงให้กับโอเปอเรเตอร์บางราย

Enum
OPERATOR_RESTRICTED_UNSPECIFIED ไม่ได้ระบุ
CELLULAR_OPERATOR_RESTRICTED กรอบเวลาช่วงโลว์ซีซันใช้ได้กับผู้ให้บริการเครือข่ายมือถือที่ได้รับ OTA ครั้งแรกผ่านเท่านั้น
ALL_NETWORK_ALLOWED กรอบเวลาช่วงโลว์ซีซันใช้ได้กับทุกเครือข่าย

IncludeExclude

รวมหรือยกเว้นรูปแบบที่คั่นด้วยคอมมาบางรูปแบบ

การแสดง 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.
}
ช่อง
ช่องการรวม include_exclude กฎของการรวมหรือยกเว้น include_exclude ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
include

string

รูปแบบที่รวม หากมีหลายค่า ให้ใช้เครื่องหมายจุลภาคเพื่อคั่นค่าแต่ละรายการ
exclude

string

รูปแบบที่ยกเว้น หากอนุญาตให้มีได้หลายค่า ให้ใช้คอมมาคั่นระหว่างค่า

SpaceNeed

ความต้องการพื้นที่ในหน่วยไบต์

Enum
SPACE_NEED_UNSPECIFIED ไม่ได้ระบุ
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

คอมโพเนนต์ขั้นตอนการเปิดตัว

การแสดง JSON 
{
  "rolloutTime": string,
  "fraction": number
}
ช่อง
rolloutTime

string (Timestamp format)

การประทับเวลาการเปิดตัว

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
fraction

number

เศษส่วนที่กำหนดด้วยเปอร์เซ็นต์ระหว่าง 0.00 ถึง 100.00

ConfigDetails

รายละเอียดของการกำหนดค่า

การแสดง JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
ช่อง
postConditions[]

object (Condition)

เงื่อนไขหลังการติดตั้งการกำหนดค่า
packages[]

object (PackageConfig)

แพ็กเกจที่กำหนดไว้ของการกำหนดค่านี้ สำคัญ: ลำดับพัสดุเป็นสิ่งสำคัญ หากอุปกรณ์ตรงกับเงื่อนไขล่วงหน้าหลายชุด แพ็กเกจที่ตรงกันล่าสุดจะเป็นผู้ชนะและจะนำไปใช้กับอุปกรณ์
groups[]

string

กลุ่มที่เกี่ยวข้องของการกำหนดค่านี้
versionTag

object (VersionTag)

เอาต์พุตเท่านั้น เวอร์ชันการกำหนดค่า

ReminderDialogSettings

การตั้งค่าการควบคุมกล่องโต้ตอบการช่วยเตือนแบบโมดัลที่แสดงต่อผู้ใช้หลังจากผ่านระยะเวลาที่ระบุ

การแสดง JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
ช่อง
start

enum (Start)

เวลาที่ควรเริ่มแสดงการช่วยเตือน
remindMeLaterDuration

enum (RemindLaterDuration)

ระยะเวลา "เตือนฉันทีหลัง" อยู่
frequency

enum (Frequency)

การช่วยเตือนความถี่จะแสดงหลังจากการปิด

เริ่ม

เมื่อใดที่ควรแสดงกล่องโต้ตอบการช่วยเตือน เช่น หากตั้งค่าเป็น START_TWO_DAYS ผู้ใช้จะเห็นการช่วยเตือน 2 วันหลังจากได้รับการอัปเดต หากออกจาก START_UNSPECIFIED ระบบจะใช้ค่าเริ่มต้น START_SEVEN_DAYS

Enum
START_UNSPECIFIED ไม่ได้ระบุ
NEVER_START ไม่ต้องเริ่มการช่วยเตือน
START_ZERO_DAYS เริ่มตอนนี้เลย
START_TWO_DAYS เริ่มหลังจาก 2 วัน
START_SEVEN_DAYS เริ่มหลังจาก 7 วัน
START_FOURTEEN_DAYS เริ่มหลังจาก 14 วัน แท็กถัดไป: 6

RemindLaterDuration

ระยะเวลาที่กล่องโต้ตอบจะแสดงข้อความ "เตือนฉันในภายหลัง" เลือก ALWAYS_SHOW เพื่อแสดงปุ่มตลอดเวลา และเลือก NEVER_SHOW ไม่ให้แสดงปุ่มเลย หากออกจาก LATER_DURATION_UNSPECIFIED ระบบจะใช้ค่าเริ่มต้น LATER_FOURTEEN_DAYS

Enum
LATER_DURATION_UNSPECIFIED ไม่ได้ระบุ
NEVER_SHOW ไม่ต้องแสดงปุ่ม
ALWAYS_SHOW แสดงปุ่มเสมอ
LATER_SEVEN_DAYS ปุ่มนำออกหลังจากผ่านไป 7 วัน
LATER_FOURTEEN_DAYS นำออกปุ่มหลังจาก 14 วัน
LATER_TWENTY_ONE_DAYS นำออกปุ่มหลังจาก 21 วัน

ความถี่

หลังจากผู้ใช้ปิดกล่องโต้ตอบการช่วยเตือน จะใช้เวลานานเท่าใดก่อนที่จะแสดงกล่องโต้ตอบอีกครั้ง หากออกจาก FREQUENCY_UNSPECIFIED ระบบจะใช้ค่าเริ่มต้น FREQUENCY_SEVEN_DAYS

Enum
FREQUENCY_UNSPECIFIED ไม่ได้ระบุ
FREQUENCY_ONE_DAY แสดงการช่วยเตือนทุกวัน
FREQUENCY_THREE_DAYS แสดงการช่วยเตือนทุก 3 วัน
FREQUENCY_SEVEN_DAYS แสดงการช่วยเตือนทุก 7 วัน

เมธอด

create

 สร้าง config และแสดงผล Config ใหม่

delete

 ลบ config

disable

 ปิดใช้กลุ่มที่เปิดใช้ทั้งหมดที่มีการกำหนดค่าที่ระบุ

get

 มียอดดู config

list

 แสดงรายการ configs ของการทำให้ใช้งานได้

update

 อัปเดต config

updatePackages

 อัปเดตแพ็กเกจภายใต้การกำหนดค่า