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)

اختياريّ. كائن Update-peak.

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 والكسر. يجب أن تحتوي الخطوة الأخيرة على الكسر == 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 فترة خمسة عشر يومًا
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS نافذة ثلاثين يومًا.

WifiOnlyTime

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

عمليات التعداد
WIFI_ONLY_TIME_UNSPECIFIED لم يتم تحديده.
NONE غير محظور.
TWENTY_FOUR_HOURS نافذة أربع وعشرين ساعة.
THREE_DAYS فترة ثلاثة أيام.
SEVEN_DAYS نافذة سبعة أيام.
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. تتطلب خدمات Google Play الإصدار 6.5 أو إصدار أحدث.

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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

حصد فيديو Shorts مشاهدة واحدة (config).

list

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

update

يعدِّل config.

updatePackages

حدِّث الحزم ضمن الإعداد.