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)

اختياريّ. تم ضبط السياسة تلقائيًا على SEVEN_DAYS إذا تم تركها WIFI_ONLY_TIME_UNSPECIFIED.

ملاحظة: سيتم ضبط هذه السياسة على FOREVER إذا كانت قيمة urgencyMode هي RECOMMENDED.

updateMaintenanceWindow

object (TimeWindow)

اختياريّ. نافذة وقت التثبيت للتحديث عبر الهواء.

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. يجب أن تكون خطوات التنفيذ بالترتيب: يجب ألا يؤدي ذلك إلى خفض كلٍ من time_ms والكسر. يجب أن تحتوي الخطوة الأخيرة على الكسر == 100.

securityUpdate

boolean

اختياريّ. وضع علامة على التحديث كتحديث أمان ويتم تمريره إلى الجهاز لتنسيق عرض رسالة التحديث الصحيحة. وهذا يعني عرض النص "تطبيق تحديث الأمان" بدلاً من "تطبيق تحديث النظام". يتطلب ذلك مستوى واجهة برمجة التطبيقات 22 أو إصدار أحدث والإصدار 9.4 من "خدمات Google Play" أو إصدار أحدث.

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

رسالة نجاح المشاركة الخاصة بالتعديل. يجب استخدام المستوى 14 من واجهة برمجة التطبيقات أو مستوى أعلى.

postFailureMessage

string

رسالة تعذُّر النشر الخاصة بالتعديل يجب استخدام المستوى 14 من واجهة برمجة التطبيقات أو مستوى أعلى.

LocalizedUpdateDescription

وصف التحديث استنادًا إلى اللغة.

تمثيل JSON
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
الحقول
locales[]

string

اللغات التي تتطابق مع لغات الجهاز.

updateDescription

object (UpdateDescription)

وصف التحديث الذي يتم إرساله إلى الجهاز.

UrgencyMode

وضع الترقية العاجلة.

عمليات التعداد
MODE_UNSPECIFIED غير محدَّد.
RECOMMENDED ننصحك بالترقية. سيُطلب من المستخدم تنزيل التحديث وتثبيته.
MANDATORY الترقية الإلزامية. سيتم تنزيل التحديث تلقائيًا، ولكن سيُطلب من المستخدم بدء التثبيت.
AUTOMATIC الترقية التلقائية. سيتم تنزيل التحديث وتثبيته تلقائيًا.

ScheduledInstallDelay

فترة تأخير من وقت توفُّر التحديث إلى وقت جدولة التثبيت تلقائيًا.

عمليات التعداد
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 نافذة لمدة 15 يومًا
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS فترة ثلاثين يومًا

WifiOnlyTime

سيؤدي التنزيل إلى تجنُّب استخدام شبكة الجوّال في هذه الفترة بعد توفُّر التحديث.

عمليات التعداد
WIFI_ONLY_TIME_UNSPECIFIED غير محدَّد.
NONE غير محظور.
TWENTY_FOUR_HOURS نافذة مدتها أربع وعشرون ساعة.
THREE_DAYS فترة تبلغ ثلاثة أيام.
SEVEN_DAYS فترة 7 أيام
FOURTEEN_DAYS فترة لأربعة عشر يومًا
TWENTY_ONE_DAYS نافذة واحدة وعشرون يومًا
FOREVER نافذة للأبد.

TimeWindow

فترة زمنية تحدِّد وقت بدء اليوم ووقت إيقافه.

تمثيل JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
الحقول
startTime

object (TimeOfDay)

وقت بدء النافذة

stopTime

object (TimeOfDay)

وقت توقف النافذة.

TimeOfDay

يشير إلى وقت من اليوم. إما أن التاريخ والمنطقة الزمنية ليسا مهمين أو تم تحديدهما في مكان آخر. وقد تختار واجهة برمجة التطبيقات السماح بالثانية. النوعان ذوا الصلة هما google.type.Date وgoogle.protobuf.Timestamp.

تمثيل JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
الحقول
hours

integer

ساعات اليوم بتنسيق 24 ساعة. يجب أن تتراوح القيمة بين 0 و23. قد تختار واجهة برمجة التطبيقات السماح بالقيمة "24:00:00" لسيناريوهات مثل وقت إغلاق النشاط التجاري.

minutes

integer

دقائق من اليوم. يجب أن تتراوح القيمة بين 0 و59.

seconds

integer

ثوانٍ من الوقت. يجب أن تتراوح القيمة عادةً بين 0 و59. قد تسمح واجهة برمجة التطبيقات بالقيمة 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. يتطلب الإصدار 6.5 من خدمات Google Play أو إصدارًا أحدث.

updateOperatorRestriction

enum (CellularOperatorRestriction)

اختياريّ. عندما لا يتم تحديد القيمة، سيستخدم الخادم قيمة تلقائية ALL_NETWORK_ALLOWED. يتطلب استخدام "خدمات Google Play" الإصدار 6.7.72 أو إصدار أحدث.

UpdateOffPeakDays

عدد الأيام التي يمكن خلالها تنزيل التحديث في الفترة التي تكون خارج وقت الذروة.

عمليات التعداد
OFF_PEAK_DAYS_UNSPECIFIED غير محدَّد.
OFF_PEAK_UPDATE_ONE_DAY يوم واحد.
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 لفرض قيود على النافذة خارج وقت الذروة بحيث يتم حصر تنزيل البيانات عبر الهواء على مشغّل شبكة الجوّال الذي تم تلقّيه من خلاله لأول مرة. هذا الجهاز مخصّص للأجهزة التي تتضمّن شرائح SIM متعددة عند استخدامه مع mobileNetworkRestriction لحصر عمليات التنزيل في وقت غير محدود على مشغّل معيّن.

عمليات التعداد
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

متطلبات المساحة بالبايت.

عمليات التعداد
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.

عمليات التعداد
START_UNSPECIFIED غير محدَّد.
NEVER_START عدم بدء التذكير مطلقًا.
START_ZERO_DAYS البدء فورًا.
START_TWO_DAYS البدء بعد يومين.
START_SEVEN_DAYS البدء بعد سبعة أيام.
START_FOURTEEN_DAYS البدء بعد أربعة عشر يومًا. العلامة التالية: 6

RemindLaterDuration

المدة التي يعرض فيها مربع الحوار الزر "تذكيري لاحقًا". اختَر ALWAYS_SHOW لعرض الزر طوال الوقت وNEVER_SHOW لعدم عرضه مطلقًا. في حال ترك هذه الدالة LATER_DURATION_UNSPECIFIED، سيتم استخدام القيمة التلقائية LATER_FOURTEEN_DAYS.

عمليات التعداد
LATER_DURATION_UNSPECIFIED غير محدَّد.
NEVER_SHOW عدم عرض الزر مطلقًا.
ALWAYS_SHOW عرض الزر دائمًا.
LATER_SEVEN_DAYS زر الإزالة بعد سبعة أيام
LATER_FOURTEEN_DAYS زر الإزالة بعد أربعة عشر يومًا.
LATER_TWENTY_ONE_DAYS زرّ الإزالة بعد واحد وعشرين يومًا

معدّل التكرار

بعد أن يغلق المستخدم مربّع حوار التذكير، المدة المتبقية ليتم عرضه مرة أخرى في حال ترك هذه الدالة FREQUENCY_UNSPECIFIED، سيتم استخدام القيمة التلقائية FREQUENCY_SEVEN_DAYS.

عمليات التعداد
FREQUENCY_UNSPECIFIED غير محدَّد.
FREQUENCY_ONE_DAY عرض التذكير كل يوم.
FREQUENCY_THREE_DAYS عرض التذكير كل ثلاثة أيام.
FREQUENCY_SEVEN_DAYS عرض التذكير كل سبعة أيام.

الطُرق

create

تنشئ config، وتعرض Config الجديد.

delete

حذف config

disable

لإيقاف جميع المجموعات المفعّلة التي تم ضبط الإعدادات المحدّدة لها.

get

للحصول على مشاهَدة config.

list

يسرد configs لعملية نشر.

update

لتعديل config

updatePackages

يمكنك تعديل الحِزم ضِمن الإعدادات.