REST Resource: deployments.configs

Tài nguyên: Cấu hình

Cấu hình của một đợt triển khai.

Biểu diễn dưới dạng 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)
  }
}
Trường
name

string

Chỉ có đầu ra. Tên của cấu hình. Xin lưu ý rằng đây là giá trị nhận dạng duy nhất của các đối tượng Config và sẽ do máy chủ tạo khi Config mới được tạo.
title

string

Không bắt buộc. Tiêu đề của cấu hình.
description

string

Không bắt buộc. Nội dung mô tả về cấu hình.
defaultUpdateDescription

object (UpdateDescription)

Bắt buộc. Văn bản giao diện người dùng mặc định được dùng khi ngôn ngữ của thiết bị không khớp với bất kỳ ngôn ngữ nào được chỉ định trong localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

Không bắt buộc. Danh sách nội dung mô tả về bản cập nhật đã bản địa hoá và được ưu tiên hơn defaultUpdateDescription nếu một trong số đó khớp với ngôn ngữ của thiết bị.
urgencyMode

enum (UrgencyMode)

Không bắt buộc. Tính cấp bách của việc cập nhật cho biết cách hệ thống sẽ nhắc người dùng. Nếu bạn không chỉ định, giá trị mặc định là MANDATORY sẽ được sử dụng.
scheduledInstallDelay

enum (ScheduledInstallDelay)

Không bắt buộc. Độ trễ xác định thời điểm lên lịch cài đặt qua đêm cho bản cập nhật. Giá trị mặc định là NEVER nếu bạn không chỉ định.
wifiOnlyTime

enum (WifiOnlyTime)

Không bắt buộc. Giá trị mặc định là SEVEN_DAYS nếu để là WIFI_ONLY_TIME_UNSPECIFIED.

Lưu ý: giá trị này sẽ được thiết lập thành FOREVER nếu urgencyMode là RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

Không bắt buộc. Khoảng thời gian cài đặt OTA.
packageSizeAwareBatteryThreshold

boolean

Không bắt buộc. Việc bản cập nhật có cần ngưỡng pin cài đặt khác nhau hay không tuỳ thuộc vào kích thước của bản cập nhật.
offPeakUpdate

object (OffPeakUpdate)

Không bắt buộc. Đối tượng cập nhật ngoài giờ cao điểm.
countryRestriction

object (IncludeExclude)

Không bắt buộc. Các quốc gia có thể được thêm vào/bị loại trừ.
mobileNetworkRestriction

object (IncludeExclude)

Không bắt buộc. Các mạng di động có thể được bao gồm/bị loại trừ được xác định bằng mã mcc/mnc. Lưu ý rằng chỉ được sử dụng mobileNetworkCarrierRestriction. Bạn không thể đặt cả hai trường cùng một lúc.
deviceBuildPropertyRestriction

object (IncludeExclude)

Không bắt buộc. Quy định hạn chế có thể áp dụng cho thuộc tính bản dựng thiết bị được thêm vào/bị loại trừ.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Không bắt buộc. Các nhà mạng có thể được bao gồm/bị loại trừ. Lưu ý rằng chỉ được sử dụng mobileNetworkRestriction. Bạn không thể đặt cả hai trường cùng một lúc.

Để xem các mục liên kết, vui lòng tham khảo bài viết Mã quốc gia di động và Mã mạng di động.
updateRequiredSetup

boolean

Không bắt buộc. Cho biết liệu trình hướng dẫn thiết lập có cần cập nhật hay không. Giá trị mặc định là false.
minimalSpaceRequired

enum (SpaceNeed)

Không bắt buộc. Yêu cầu tối thiểu về không gian. Khi giá trị là UNSPECIFIED, máy chủ sẽ không đặt giới hạn. Yêu cầu Dịch vụ Google Play 6.1.11 trở lên.
immediateRelease

boolean

Không bắt buộc. Một trong số immediateRelease hoặc rolloutSteps là trường bắt buộc. Liệu bản cập nhật có được phát hành ngay lập tức hay không. Nếu đúng như vậy, bạn không nên đặt rolloutSteps.
rolloutSteps[]

object (RolloutStep)

Không bắt buộc. Một trong số rolloutSteps hoặc immediateRelease là trường bắt buộc. ReleaseStep phải theo thứ tự: cả time_mili giây và phân đoạn đều phải không giảm. Bước cuối cùng phải có phân số == 100.
securityUpdate

boolean

Không bắt buộc. Đánh dấu bản cập nhật đó là bản cập nhật bảo mật. Giá trị này được truyền đến thiết bị để điều phối việc hiển thị thông báo cập nhật chính xác. Tức là để hiện văn bản "đang áp dụng bản cập nhật bảo mật" thay vì "áp dụng bản cập nhật hệ thống". Yêu cầu API cấp 22 trở lên và Dịch vụ Google Play 9.4 trở lên.
details

object (ConfigDetails)

Chỉ có đầu ra. Thông tin chi tiết khác về một cấu hình. Chỉ máy chủ mới trả về giá trị này khi trả về cấu hình.
allowEncryptedScheduledInstall

boolean

Không bắt buộc. Liệu một gói có được phép lên lịch cài đặt trên thiết bị đã mã hoá hay không.
reminderDialogSettings

object (ReminderDialogSettings)

Không bắt buộc. Các chế độ cài đặt của hộp thoại phương thức nhắc người dùng rằng họ có một bản cập nhật đang chờ xử lý.

UpdateDescription

Nội dung mô tả về bản cập nhật được gửi đến thiết bị.

Biểu diễn dưới dạng JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
Trường
description

string

Văn bản mô tả bản cập nhật.
title

string

Tiêu đề nội dung mô tả của bản cập nhật.
dialogMessage

string

Thông báo hộp thoại về việc cập nhật.
postSuccessMessage

string

Thông báo cập nhật thành công khi đăng thành công. Yêu cầu API cấp 14 trở lên.
postFailureMessage

string

Thông báo cập nhật không thành công khi đăng. Yêu cầu API cấp 14 trở lên.

LocalizedUpdateDescription

Nội dung mô tả về bản cập nhật dựa trên ngôn ngữ.

Biểu diễn dưới dạng JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
Trường
locales[]

string

Ngôn ngữ để khớp với ngôn ngữ của thiết bị.
updateDescription

object (UpdateDescription)

Nội dung mô tả về bản cập nhật được gửi đến thiết bị.

UrgencyMode

Chế độ khẩn cấp về việc nâng cấp.

Enum
MODE_UNSPECIFIED Chưa chỉ định.
RECOMMENDED Đề xuất nâng cấp. Người dùng sẽ được nhắc tải xuống và cài đặt bản cập nhật.
MANDATORY Nâng cấp bắt buộc. Bản cập nhật sẽ tự động tải xuống nhưng người dùng sẽ được nhắc bắt đầu cài đặt.
AUTOMATIC Nâng cấp tự động. Bản cập nhật sẽ được tải xuống và cài đặt tự động.

ScheduledInstallDelay

Khoảng thời gian trì hoãn từ khi có bản cập nhật đến khi quá trình cài đặt được lên lịch tự động.

Enum
SCHEDULED_INSTALL_DELAY_UNSPECIFIED Giá trị mặc định. Sẽ được coi là KHÔNG CÓ.
SCHEDULED_INSTALL_DELAY_NEVER Không bao giờ chuyển lên quy trình cài đặt tự động.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS Khoảng thời gian 0 ngày (ngay lập tức)
SCHEDULED_INSTALL_DELAY_ONE_DAY Thời hạn một ngày.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Thời hạn hai ngày.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Thời hạn 3 ngày.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Thời hạn 4 ngày.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Thời hạn 5 ngày.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Thời hạn 10 ngày.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Khoảng thời gian là 15 ngày.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Thời hạn 30 ngày.

WifiOnlyTime

Trong khoảng thời gian này, sau khi có bản cập nhật, quá trình tải xuống sẽ tránh được mạng di động.

Enum
WIFI_ONLY_TIME_UNSPECIFIED Chưa chỉ định.
NONE Không bị chặn.
TWENTY_FOUR_HOURS Khoảng thời gian 24 giờ.
THREE_DAYS Thời hạn 3 ngày.
SEVEN_DAYS Thời hạn 7 ngày.
FOURTEEN_DAYS Khoảng thời gian 14 ngày.
TWENTY_ONE_DAYS Thời hạn 21 ngày.
FOREVER Cửa sổ vĩnh viễn.

TimeWindow

Khoảng thời gian xác định thời gian bắt đầu của một ngày và thời gian kết thúc trong ngày.

Biểu diễn dưới dạng JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
Trường
startTime

object (TimeOfDay)

Thời gian bắt đầu khung thời gian.
stopTime

object (TimeOfDay)

Thời gian ngừng của khoảng thời gian.

TimeOfDay

Đại diện cho thời gian trong ngày. Ngày và múi giờ không quan trọng hoặc được chỉ định ở nơi khác. API có thể chọn cho phép giây nhuận. Các loại có liên quan là google.type.Date và google.protobuf.Timestamp.

Biểu diễn dưới dạng JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Trường
hours

integer

Giờ trong ngày ở định dạng 24 giờ. Nên ở từ 0 đến 23. Một API có thể chọn cho phép giá trị "24:00:00" cho các tình huống như thời gian đóng cửa doanh nghiệp.
minutes

integer

Số phút trong ngày. Phải từ 0 đến 59.
seconds

integer

Số giây của thời gian. Giá trị thường phải từ 0 đến 59. Một API có thể cho phép giá trị 60 nếu cho phép bật-giây.
nanos

integer

Các phân số của giây tính bằng nano giây. Giá trị phải nằm trong khoảng từ 0 đến 999.999.999.

OffPeakUpdate

Giới hạn cập nhật thấp điểm.

Biểu diễn dưới dạng JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
Trường
updateOffPeakWindow

object (TimeWindow)

Khoảng thời gian thấp điểm để tải bản cập nhật xuống. Yêu cầu Dịch vụ Google Play 6.7.72 trở lên.
updateOffPeakDays

enum (UpdateOffPeakDays)

Không bắt buộc. Khi giá trị là OFF_PEAK_DAYS_UNSPECIFIED, máy chủ sẽ sử dụng giá trị mặc định là OFF_PEAK_UPDATE_ONE_DAY. Yêu cầu Dịch vụ Google Play 6.5 trở lên.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Không bắt buộc. Khi bạn không chỉ định giá trị này, máy chủ sẽ sử dụng giá trị mặc định là ALL_NETWORK_ALLOWED. Yêu cầu Dịch vụ Google Play 6.7.72 trở lên.

UpdateOffPeakDays

Số ngày cố gắng tải bản cập nhật xuống trong khung giờ thấp điểm.

Enum
OFF_PEAK_DAYS_UNSPECIFIED Chưa chỉ định.
OFF_PEAK_UPDATE_ONE_DAY 1 ngày.
OFF_PEAK_UPDATE_THREE_DAYS 3 ngày.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 ngày.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 ngày.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 ngày.

CellularOperatorRestriction

Bạn có thể đặt thành CELLULAR_OPERATOR_RESTRICTED để hạn chế hoạt động trong thời gian thấp điểm, nhằm hạn chế việc tải xuống qua mạng di động qua mạng di động lần đầu. Dành cho các thiết bị nhiều SIM khi được dùng cùng với mobileNetworkRestriction để hạn chế tải xuống ngoài giờ cao điểm cho một nhà cung cấp dịch vụ cụ thể.

Enum
OPERATOR_RESTRICTED_UNSPECIFIED Chưa chỉ định.
CELLULAR_OPERATOR_RESTRICTED Thời gian ngoài giờ cao điểm có thể áp dụng cho nhà cung cấp dịch vụ di động mà OTA nhận được lần đầu tiên.
ALL_NETWORK_ALLOWED Áp dụng khung giờ thấp điểm cho tất cả các mạng.

IncludeExclude

Bao gồm hoặc loại trừ một số mẫu được phân tách bằng dấu phẩy.

Biểu diễn dưới dạng 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.
}
Trường
Trường kết hợp include_exclude. Quy tắc bao gồm hoặc loại trừ. include_exclude chỉ có thể là một trong những trạng thái sau đây:
include

string

Hoa văn đi kèm. Nếu bạn cho phép nhiều giá trị, hãy sử dụng dấu phẩy để phân tách các giá trị.
exclude

string

Mẫu bị loại trừ. Nếu bạn cho phép nhiều giá trị, hãy sử dụng dấu phẩy để phân tách các giá trị.

SpaceNeed

Yêu cầu về dung lượng tính bằng byte.

Enum
SPACE_NEED_UNSPECIFIED Chưa chỉ định.
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

Thành phần bước ra mắt.

Biểu diễn dưới dạng JSON 
{
  "rolloutTime": string,
  "fraction": number
}
Trường
rolloutTime

string (Timestamp format)

Dấu thời gian ra mắt.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
fraction

number

Tỷ lệ được viết theo tỷ lệ phần trăm từ 0,00 đến 100,00.

ConfigDetails

Thông tin chi tiết về một cấu hình.

Biểu diễn dưới dạng JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
Trường
postConditions[]

object (Condition)

Cấu hình cài đặt sau điều kiện.
packages[]

object (PackageConfig)

Các gói đã xác định của cấu hình này. Lưu ý quan trọng: thứ tự của các gói hàng rất quan trọng. Nếu một thiết bị khớp với nhiều nhóm điều kiện tiên quyết, thì gói phù hợp cuối cùng sẽ chiến thắng và sẽ được áp dụng cho thiết bị đó.
groups[]

string

Các nhóm được liên kết với cấu hình này.
versionTag

object (VersionTag)

Chỉ có đầu ra. Phiên bản config.

ReminderDialogSettings

Chế độ cài đặt kiểm soát hộp thoại lời nhắc theo phương thức hiển thị cho người dùng sau khoảng thời gian đã chỉ định.

Biểu diễn dưới dạng JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
Trường
start

enum (Start)

Thời điểm bắt đầu hiển thị lời nhắc.
remindMeLaterDuration

enum (RemindLaterDuration)

Thời lượng "nhắc tôi sau" sẽ hiển thị.
frequency

enum (Frequency)

Lời nhắc tần suất sẽ xuất hiện sau khi người dùng đóng.

Bắt đầu

Thời điểm hiện hộp thoại lời nhắc. Ví dụ: Nếu bạn đặt thành START_TWO_DAYS, người dùng sẽ thấy lời nhắc 2 ngày sau khi nhận bản cập nhật. Nếu bạn để START_UNSPECIFIED, giá trị mặc định là START_SEVEN_DAYS sẽ được sử dụng.

Enum
START_UNSPECIFIED Chưa chỉ định.
NEVER_START Không bao giờ bắt đầu lời nhắc.
START_ZERO_DAYS Bắt đầu ngay.
START_TWO_DAYS Bắt đầu sau 2 ngày.
START_SEVEN_DAYS Bắt đầu sau 7 ngày.
START_FOURTEEN_DAYS Bắt đầu sau 14 ngày. THẺ TIẾP THEO: 6

RemindLaterDuration

Khoảng thời gian hộp thoại hiện thông báo "Nhắc tôi sau" . Chọn ALWAYS_SHOW để nút này luôn hiện và NEVER_SHOW để không bao giờ hiển thị nút này. Nếu bạn để LATER_DURATION_UNSPECIFIED, giá trị mặc định là LATER_FOURTEEN_DAYS sẽ được sử dụng.

Enum
LATER_DURATION_UNSPECIFIED Chưa chỉ định.
NEVER_SHOW Không bao giờ hiện nút này.
ALWAYS_SHOW Luôn hiện nút này.
LATER_SEVEN_DAYS Nút xoá sau 7 ngày.
LATER_FOURTEEN_DAYS Nút xoá sau 14 ngày.
LATER_TWENTY_ONE_DAYS Nút Xoá sau 21 ngày.

Tần suất

Thời gian cho đến khi lời nhắc xuất hiện lại sau khi người dùng đóng hộp thoại. Nếu bạn để FREQUENCY_UNSPECIFIED, giá trị mặc định là FREQUENCY_SEVEN_DAYS sẽ được sử dụng.

Enum
FREQUENCY_UNSPECIFIED Chưa chỉ định.
FREQUENCY_ONE_DAY Hiện lời nhắc hằng ngày.
FREQUENCY_THREE_DAYS Hiển thị lời nhắc 3 ngày một lần.
FREQUENCY_SEVEN_DAYS Hiển thị lời nhắc 7 ngày một lần.

Phương thức

create

 Tạo config và trả về Config mới.

delete

 Xoá một config.

disable

 Tắt tất cả các nhóm đã bật có cấu hình được chỉ định.

get

 Nhận chế độ xem config.

list

 Liệt kê configs một đợt triển khai.

update

 Cập nhật một config.

updatePackages

 Cập nhật các gói trong cấu hình.