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 )

ضروری. متن پیش‌فرض رابط کاربری زمانی استفاده می‌شود که زبان دستگاه با هیچ یک از زبان‌های مشخص‌شده در localizedUpdateDescriptions مطابقت ندارد.

localizedUpdateDescriptions[]

object ( LocalizedUpdateDescription )

اختیاری. فهرستی از توضیحات به‌روزرسانی محلی، که اگر یکی از آنها با منطقه دستگاه مطابقت داشته باشد، بر defaultUpdateDescription اولویت دارد.

urgencyMode

enum ( UrgencyMode )

اختیاری. فوریت به‌روزرسانی که نحوه درخواست کاربر را دیکته می‌کند. اگر نامشخص باقی بماند، پیش‌فرض MANDATORY استفاده می‌شود.

scheduledInstallDelay

enum ( ScheduledInstallDelay )

اختیاری. تاخیری که تعیین می‌کند به‌روزرسانی چه زمانی برای نصب یک شبه برنامه‌ریزی می‌شود. اگر نامشخص باقی بماند به طور پیش‌فرض روی NEVER تنظیم می‌شود.

wifiOnlyTime

enum ( WifiOnlyTime )

اختیاری. اگر WIFI_ONLY_TIME_UNSPECIFIED باقی بماند SEVEN_DAYS پیش‌فرض است.

توجه : اگر urgencyMode RECOMMENDED ، این روی برای FOREVER تنظیم می شود.

updateMaintenanceWindow

object ( TimeWindow )

اختیاری. پنجره زمان نصب برای OTA.

packageSizeAwareBatteryThreshold

boolean

اختیاری. آیا به‌روزرسانی بسته به اندازه آن باید آستانه باتری نصب متفاوتی داشته باشد یا خیر.

offPeakUpdate

object ( OffPeakUpdate )

اختیاری. شیء به روز رسانی خارج از پیک.

countryRestriction

object ( IncludeExclude )

اختیاری. کشورهای ممکن شامل / مستثنی شده.

mobileNetworkRestriction

object ( IncludeExclude )

اختیاری. شبکه‌های تلفن همراه ممکن شامل/مستثنی شده با کدهای mcc/mnc شناسایی شده‌اند. توجه داشته باشید که این باید منحصراً برای mobileNetworkCarrierRestriction استفاده شود. هر دو فیلد را نمی توان همزمان تنظیم کرد.

deviceBuildPropertyRestriction

object ( IncludeExclude )

اختیاری. محدودیت اموال ساخت دستگاه ممکن شامل/استثنا شده است.

mobileNetworkCarrierRestriction

object ( IncludeExclude )

اختیاری. حامل های شبکه تلفن همراه ممکن شامل/استثنا شده است. توجه داشته باشید که این باید منحصراً برای mobileNetworkRestriction استفاده شود. هر دو فیلد را نمی توان همزمان تنظیم کرد.

برای مشاهده نقشه‌ها، لطفاً به کد کشور تلفن همراه و کد شبکه تلفن همراه مراجعه کنید.

updateRequiredSetup

boolean

اختیاری. نشان می دهد که آیا به روز رسانی در طول جادوگر راه اندازی مورد نیاز است یا خیر. پیش فرض به نادرست.

minimalSpaceRequired

enum ( SpaceNeed )

اختیاری. حداقل فضای مورد نیاز وقتی مقدار UNSPECIFIED باشد، سرور محدودیتی تعیین نمی کند. به خدمات Google Play 6.1.11 یا جدیدتر نیاز دارد.

immediateRelease

boolean

اختیاری. یکی از immediateRelease یا rolloutSteps مورد نیاز است. آیا به‌روزرسانی باید فوراً منتشر شود یا خیر. اگر این درست است، rolloutSteps باید تنظیم نشود.

rolloutSteps[]

object ( RolloutStep )

اختیاری. یکی از rolloutSteps یا immediateRelease مورد نیاز است. RolloutSteps باید به ترتیب باشد: هم time_ms و هم fraction باید بدون کاهش باشند. مرحله آخر باید کسری == 100 داشته باشد.

securityUpdate

boolean

اختیاری. به روز رسانی را به عنوان یک به روز رسانی امنیتی علامت گذاری می کند. این به دستگاه ارسال می شود تا نمایش پیام به روز رسانی صحیح را هماهنگ کند. یعنی به جای «اعمال به‌روزرسانی سیستم»، متن «اعمال به‌روزرسانی امنیتی» را نمایش دهید. به API سطح 22 یا بالاتر و Google Play Services 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 )

توضیحات به روز رسانی که به دستگاه ارسال می شود.

حالت فوریت

حالت اضطراری ارتقا.

Enums
MODE_UNSPECIFIED مشخص نشده است.
RECOMMENDED پیشنهاد ارتقا از کاربر خواسته می شود که آپدیت را دانلود و نصب کند.
MANDATORY ارتقاء اجباری به روز رسانی به طور خودکار دانلود می شود اما از کاربر خواسته می شود تا نصب را شروع کند.
AUTOMATIC ارتقاء خودکار. به روز رسانی به صورت خودکار دانلود و نصب می شود.

ScheduledInstallDelay

پنجره تاخیر از زمانی که به روز رسانی در دسترس است تا زمانی که نصب به طور خودکار برنامه ریزی شود.

Enums
SCHEDULED_INSTALL_DELAY_UNSPECIFIED مقدار پیش فرض. به عنوان هرگز رفتار خواهد شد.
SCHEDULED_INSTALL_DELAY_NEVER هرگز به نصب خودکار تبدیل نشوید.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS پنجره روز صفر (فورا)
SCHEDULED_INSTALL_DELAY_ONE_DAY پنجره یک روزه
SCHEDULED_INSTALL_DELAY_TWO_DAYS پنجره دو روزه
SCHEDULED_INSTALL_DELAY_THREE_DAYS پنجره سه روزه
SCHEDULED_INSTALL_DELAY_FOUR_DAYS پنجره چهار روزه
SCHEDULED_INSTALL_DELAY_FIVE_DAYS پنجره پنج روزه
SCHEDULED_INSTALL_DELAY_TEN_DAYS پنجره ده روزه
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS پنجره پانزده روزه
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS پنجره سی روزه

WifiOnlyTime

دانلود از شبکه تلفن همراه برای این مدت پس از در دسترس بودن به‌روزرسانی جلوگیری می‌کند.

Enums
WIFI_ONLY_TIME_UNSPECIFIED مشخص نشده است.
NONE مسدود نشده است.
TWENTY_FOUR_HOURS پنجره بیست و چهار ساعته
THREE_DAYS پنجره سه روزه
SEVEN_DAYS پنجره هفت روزه
FOURTEEN_DAYS پنجره چهارده روزه
TWENTY_ONE_DAYS پنجره بیست و یک روزه
FOREVER پنجره برای همیشه.

پنجره زمان

یک پنجره زمانی که زمان شروع یک روز و زمان توقف یک روز را مشخص می کند.

نمایندگی 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

تعداد روزهایی که باید سعی کنید به‌روزرسانی را در پنجره خارج از پیک دانلود کنید.

Enums
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 روز.

محدودیت اپراتور سلولی

روی CELLULAR_OPERATOR_RESTRICTED تنظیم کنید تا محدودیتی در پنجره خارج از پیک اعمال شود تا بارگیری OTA به اپراتور تلفن همراهی که برای اولین بار در آن دریافت شده است محدود شود. زمانی که همراه با mobileNetworkRestriction برای محدود کردن دانلودهای خارج از پیک به یک اپراتور خاص استفاده می شود، برای دستگاه های چند سیم کارته در نظر گرفته شده است.

Enums
OPERATOR_RESTRICTED_UNSPECIFIED مشخص نشده است.
CELLULAR_OPERATOR_RESTRICTED پنجره خارج از پیک فقط برای اپراتور تلفن همراهی که OTA برای اولین بار فقط از طریق آن دریافت شد، قابل اجرا است.
ALL_NETWORK_ALLOWED پنجره خارج از پیک برای همه شبکه ها قابل اجرا است.

شامل حذف

شامل یا حذف برخی از الگوهای جدا شده با کاما است.

نمایندگی 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

فضای مورد نیاز بر حسب بایت

Enums
SPACE_NEED_UNSPECIFIED مشخص نشده است.
ONE_HUNDRED_MB 100 مگابایت
ONE_HUNDRED_AND_FIFTY_MB 150 مگابایت
TWO_HUNDRED_AND_FIFTY_MB 250 مگابایت
FIVE_HUNDRED_MB 500 مگابایت

RolloutStep

جزء مرحله رول کردن.

نمایندگی JSON
{
  "rolloutTime": string,
  "fraction": number
}
زمینه های
rolloutTime

string ( Timestamp format)

مهر زمانی عرضه

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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 تنظیم شود، کاربران ۲ روز پس از دریافت به‌روزرسانی، یادآوری را مشاهده می‌کنند. اگر START_UNSPECIFIED باقی بماند، پیش‌فرض START_SEVEN_DAYS استفاده خواهد شد.

Enums
START_UNSPECIFIED مشخص نشده است.
NEVER_START هرگز یادآوری را شروع نکنید.
START_ZERO_DAYS بلافاصله شروع کنید.
START_TWO_DAYS بعد از دو روز شروع کنید.
START_SEVEN_DAYS بعد از هفت روز شروع کنید.
START_FOURTEEN_DAYS بعد از چهارده روز شروع کنید. تگ بعدی: 6

RemindLaterDuration

چه مدت در گفتگو دکمه "Remind me later" را نشان می دهد. ALWAYS_SHOW برای نمایش همیشه دکمه و NEVER_SHOW برای هرگز نشان دادن آن انتخاب کنید. اگر LATER_DURATION_UNSPECIFIED باقی بماند، پیش‌فرض LATER_FOURTEEN_DAYS استفاده خواهد شد.

Enums
LATER_DURATION_UNSPECIFIED مشخص نشده است.
NEVER_SHOW هرگز دکمه را نشان ندهید.
ALWAYS_SHOW همیشه دکمه را نشان دهید.
LATER_SEVEN_DAYS حذف دکمه بعد از هفت روز.
LATER_FOURTEEN_DAYS حذف دکمه بعد از چهارده روز.
LATER_TWENTY_ONE_DAYS بعد از بیست و یک روز دکمه را حذف کنید.

فرکانس

پس از اینکه کاربر کادر گفتگوی یادآوری را رد کرد، چقدر طول می کشد تا دوباره نمایش داده شود. اگر FREQUENCY_UNSPECIFIED باقی بماند، یک پیش‌فرض FREQUENCY_SEVEN_DAYS استفاده خواهد شد.

Enums
FREQUENCY_UNSPECIFIED مشخص نشده است.
FREQUENCY_ONE_DAY یادآوری را هر روز نشان دهید.
FREQUENCY_THREE_DAYS هر سه روز یک بار یادآوری را نشان دهید.
FREQUENCY_SEVEN_DAYS یادآوری را هر هفت روز یکبار نمایش دهید.

مواد و روش ها

create

 یک config ایجاد می کند و Config جدید را برمی گرداند.

delete

 یک config را حذف می کند.

disable

 همه گروه های فعال را که دارای تنظیمات مشخص شده هستند غیرفعال می کند.

get

 نمای config را دریافت می کند.

list

 configs یک استقرار را فهرست می کند.

update

 یک config را به روز می کند.

updatePackages

 بسته های زیر پیکربندی را به روز کنید.