REST Resource: deployments.configs

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

Cấu hình 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)
  }
}
Các trường
name

string

Chỉ có đầu ra. Tên của cấu hình. Lưu ý rằng đây là giá trị nhận dạng duy nhất cho các đối tượng Config và sẽ được máy chủ tạo khi tạo Config mới.
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ả 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ả bản cập nhật đã bản địa hoá, sẽ đượ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. Mức độ khẩn cấp trong việc cập nhật thể hiện cách hệ thống sẽ nhắc người dùng. Nếu bạn không chỉ định thì giá trị mặc định là MANDATORY sẽ được sử dụng.
scheduledInstallDelay

enum (ScheduledInstallDelay)

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

enum (WifiOnlyTime)

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

Lưu ý: thuộc tính 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. Cửa sổ thời gian cài đặt OTA.
packageSizeAwareBatteryThreshold

boolean

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

object (OffPeakUpdate)

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

object (IncludeExclude)

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

object (IncludeExclude)

Không bắt buộc. Các mạng di động có thể bao gồm/bị loại trừ được xác định bằng mã MCC/mnc. Xin lưu ý rằng thuộc tính này chỉ được sử dụng cho 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ế về thuộc tính bản dựng thiết bị có thể được bao gồm/bị loại trừ.
mobileNetworkCarrierRestriction

object (IncludeExclude)

Không bắt buộc. Nhà mạng di động có thể được bao gồm/không bao gồm. Xin lưu ý rằng thuộc tính này chỉ được sử dụng cho mobileNetworkRestriction. Bạn không thể đặt cả hai trường cùng một lúc.

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

boolean

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

enum (SpaceNeed)

Không bắt buộc. Yêu cầu dung lượng tối thiểu. 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. Bạn phải nhập một trong hai giá trị immediateRelease hoặc rolloutSteps. Liệu có nên phát hành bản cập nhật ngay lập tức hay không. Nếu đúng là như vậy thì bạn không nên đặt rolloutSteps.
rolloutSteps[]

object (RolloutStep)

Không bắt buộc. Bạn phải nhập một trong hai giá trị rolloutSteps hoặc immediateRelease. ReleaseSteps phải theo thứ tự: cả time_ms và phân số đều 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. Thông tin này được truyền đến thiết bị để hiển thị đúng thông báo cập nhật. Tức là văn bản "đang áp dụng bản cập nhật bảo mật" thay vì "đang á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ề cấu hình. Chỉ máy chủ trả về mã này khi trả về cấu hình.
allowEncryptedScheduledInstall

boolean

Không bắt buộc. Cho biết 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. Chế độ cài đặt cho 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 tới thiết bị.

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

string

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

string

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

string

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

string

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

string

Thông báo lỗi đăng trong bản cập nhật. Yêu cầu API cấp 14 trở lên.

LocalizedUpdateDescription

Nội dung mô tả 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)
  }
}
Các trường
locales[]

string

Ngôn ngữ phù hợ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 nâng cấp.

Enum
MODE_UNSPECIFIED Chưa xác đị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 Tự động nâng cấp. Bản cập nhật sẽ tự động được tải xuống và cài đặt.

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 BAO GIỜ.
SCHEDULED_INSTALL_DELAY_NEVER Không bao giờ chuyển lên chế độ 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 Khoảng thời gian một ngày.
SCHEDULED_INSTALL_DELAY_TWO_DAYS Khoảng thời gian là 2 ngày.
SCHEDULED_INSTALL_DELAY_THREE_DAYS Khung thời gian 3 ngày.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS Khung thời gian 4 ngày.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS Khoảng thời gian 5 ngày.
SCHEDULED_INSTALL_DELAY_TEN_DAYS Khung thời gian 10 ngày.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS Khung thời gian 15 ngày.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS Khung thời gian 30 ngày.

WifiOnlyTime

Tính năng tải xuống sẽ tránh dùng mạng di động trong khoảng thời gian này sau khi có bản cập nhật.

Enum
WIFI_ONLY_TIME_UNSPECIFIED Chưa xác định.
NONE Không bị chặn.
TWENTY_FOUR_HOURS Khoảng thời gian 24 giờ.
THREE_DAYS Khung thời gian 3 ngày.
SEVEN_DAYS Khung thời gian 7 ngày.
FOURTEEN_DAYS Khung thời gian 14 ngày.
TWENTY_ONE_DAYS Khoảng thời gian 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 ngừng của một ngày.

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

object (TimeOfDay)

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

object (TimeOfDay)

Thời lượng kết thúc.

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
}
Các trường
hours

integer

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

integer

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

integer

Số giây trong phút. Thông thường phải từ 0 đến 59. API có thể cho phép giá trị 60 nếu cho phép giây nhuận.
nanos

integer

Phân số giây tính bằng nano giây. Phải từ 0 đến 999.999.999.

OffPeakUpdate

Giới hạn cập nhật ngoài đỉnh điểm.

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

object (TimeWindow)

Khoảng thời gian cao đ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 phải có Dịch vụ Google Play 6.5 trở lên.
updateOperatorRestriction

enum (CellularOperatorRestriction)

Không bắt buộc. Khi giá trị này không được chỉ định, 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ờ cao điểm.

Enum
OFF_PEAK_DAYS_UNSPECIFIED Chưa xác định.
OFF_PEAK_UPDATE_ONE_DAY 1 ngày.
OFF_PEAK_UPDATE_THREE_DAYS 3 ngày nữa.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 ngày qua.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 ngày.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 ngày.

CellularOperatorRestriction

Hãy thiết lập thành CELLULAR_OPERATOR_RESTRICTED để áp dụng hạn chế đối với thời lượng không cao điểm sao cho việc tải xuống qua mạng không dây chỉ áp dụng cho nhà cung cấp dịch vụ di động mà dịch vụ đó nhận lần đầu. Dành cho các thiết bị nhiều SIM, khi được dùng cùng với mobileNetworkRestriction để chỉ cho phép một nhà cung cấp dịch vụ cụ thể tải xuống ở mức cao nhất.

Enum
OPERATOR_RESTRICTED_UNSPECIFIED Chưa xác định.
CELLULAR_OPERATOR_RESTRICTED Thời hạn thấp điểm chỉ áp dụng cho nhà cung cấp dịch vụ di động mà OTA được nhận lần đầu.
ALL_NETWORK_ALLOWED Khung giờ cao điểm áp dụng 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.
}
Các trường
Trường nhóm 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 dung lượng tính bằng byte.

Enum
SPACE_NEED_UNSPECIFIED Chưa xác đị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 trong bước ra mắt.

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

string (Timestamp format)

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

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
fraction

number

Phần có giá trị phần trăm từ 0,00 đến 100,00.

ConfigDetails

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

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

object (Condition)

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

object (PackageConfig)

Các gói đã xác định của cấu hình này. Quan trọng: thứ tự của các gói 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 gần đây nhất sẽ thắng và được áp dụng cho thiết bị.
groups[]

string

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

object (VersionTag)

Chỉ có đầu ra. Phiên bản cấu hình.

ReminderDialogSettings

Chế độ cài đặt kiểm soát hộp thoại lời nhắc dạng 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)
}
Các trường
start

enum (Start)

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

enum (RemindLaterDuration)

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

enum (Frequency)

Lời nhắc về tần suất hiển thị sau khi người dùng tắt thông báo.

Bắt đầu

Thời điểm hiển thị 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 sau 2 ngày kể từ khi nhận được bản cập nhật. Nếu bạn rời khỏi START_UNSPECIFIED, giá trị mặc định sẽ là START_SEVEN_DAYS.

Enum
START_UNSPECIFIED Chưa xác đị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ị nút "Nhắc tôi sau". Chọn ALWAYS_SHOW để luôn hiện nút này và NEVER_SHOW để không bao giờ hiện nút này. Nếu bạn rời khỏi LATER_DURATION_UNSPECIFIED, giá trị mặc định sẽ là LATER_FOURTEEN_DAYS.

Enum
LATER_DURATION_UNSPECIFIED Chưa xác đị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

Sau khi người dùng đóng hộp thoại lời nhắc, khoảng thời gian cho đến khi hộp thoại hiển thị lại. Nếu bạn rời khỏi FREQUENCY_UNSPECIFIED, giá trị mặc định sẽ là FREQUENCY_SEVEN_DAYS.

Enum
FREQUENCY_UNSPECIFIED Chưa xác định.
FREQUENCY_ONE_DAY Hiển thị lời nhắc mỗi 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á config.

disable

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

get

 Nhận được lượt xem config.

list

 Liệt kê configs của một lần triển khai.

update

 Cập nhật một config.

updatePackages

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