Method: enterprises.devices.issueCommand

إصدار أمر إلى جهاز يحتوي مورد Operation المعروض على الحقل Command في حقل metadata. استخدِم طريقة التشغيل للاطّلاع على حالة الأمر.

طلب HTTP

POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المَعلمات
name

string

يعرض هذا الحقل اسم الجهاز في النموذج enterprises/{enterpriseId}/devices/{deviceId}.

نص الطلب

يحتوي نص الطلب على مثال Command.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/androidmanagement

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

Command

أمر.

تمثيل JSON 
{
  "type": enum (CommandType),
  "createTime": string,
  "duration": string,
  "userName": string,
  "errorCode": enum (CommandErrorCode),
  "newPassword": string,
  "resetPasswordFlags": [
    enum (ResetPasswordFlag)
  ],

  // Union field params can be only one of the following:
  "clearAppsDataParams": {
    object (ClearAppsDataParams)
  },
  "startLostModeParams": {
    object (StartLostModeParams)
  },
  "stopLostModeParams": {
    object (StopLostModeParams)
  }
  // End of list of possible types for union field params.

  // Union field status can be only one of the following:
  "clearAppsDataStatus": {
    object (ClearAppsDataStatus)
  },
  "startLostModeStatus": {
    object (StartLostModeStatus)
  },
  "stopLostModeStatus": {
    object (StopLostModeStatus)
  }
  // End of list of possible types for union field status.
}
الحقول
type

enum (CommandType)

تمثّل هذه السمة نوع الأمر.
createTime

string (Timestamp format)

الطابع الزمني الذي تم فيه إنشاء الأمر يُنشئ الخادم الطابع الزمني تلقائيًا.

طابع زمني بتنسيق RFC3339 UTC "Zulu"، بدقة تصل إلى نانو ثانية وما يصل إلى تسعة أرقام كسور أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

المدة التي يكون فيها الأمر صالحًا. ستنتهي صلاحية الأمر في حال عدم تنفيذه من قِبل الجهاز خلال هذه الفترة. المدة التلقائية في حال عدم تحديدها هي عشر دقائق. وليس هناك حد أقصى للمدة.

مدة بالثواني بعدد يصل إلى تسعة أرقام كسور، تنتهي بالأرقام "s". مثال: "3.5s".
userName

string

اسم المورد للمستخدم الذي يملك الجهاز في النموذج enterprises/{enterpriseId}/users/{userId}. ينشئ الخادم هذا الإعداد تلقائيًا استنادًا إلى الجهاز الذي يتم إرسال الأمر إليه.
errorCode

enum (CommandErrorCode)

إذا تعذّر تنفيذ الأمر، سيظهر رمز خطأ يوضّح عدم اكتمال العملية. لا يتم ضبط هذا الإعداد عند إلغاء الطلب من قِبل المتصل.
newPassword

string

بالنسبة إلى الأوامر من النوع RESET_PASSWORD، يمكنك تحديد كلمة المرور الجديدة اختياريًا.
resetPasswordFlags[]

enum (ResetPasswordFlag)

بالنسبة إلى الأوامر من النوع RESET_PASSWORD، يمكن اختياريًا تحديد العلامات.

حقل الاتحاد params. المعلّمات الخاصة بالأمر. يُرجى العِلم أنّ بعض الأوامر لا تستخدم ذلك الأمر على وجه الخصوص LOCK وRESET_PASSWORD وREBOOT وRELINQUISH_OWNERSHIP. وقد تستخدم هذه الأوامر في المستقبل أيضًا.

وفي حال تم ضبطها، يجب عدم ضبط الحقلين new_password وreset_password_flags. لا يمكن أن يكون params سوى واحد مما يلي:
clearAppsDataParams

object (ClearAppsDataParams)

معلّمات الأمر CLEAR_APP_DATA لمحو بيانات تطبيقات محدّدة من الجهاز. يمكنك الاطّلاع على ClearAppsDataParams. في حال ضبط السياسة، يجب عدم ضبط type. وفي هذه الحالة، يضبط الخادم تلقائيًا على CLEAR_APP_DATA. ويمكن أيضًا ضبط السمة type على CLEAR_APP_DATA صراحةً.
startLostModeParams

object (StartLostModeParams)

معلَمات الأمر START_LOST_MODE لوضع الجهاز في وضع فقدان الجهاز يمكنك الاطّلاع على StartLostModeParams. في حال ضبط السياسة، يجب عدم ضبط type. وفي هذه الحالة، يضبط الخادم تلقائيًا على START_LOST_MODE. ويمكن أيضًا ضبط السمة type على START_LOST_MODE صراحةً.
stopLostModeParams

object (StopLostModeParams)

معلّمات الأمر STOP_LOST_MODE لإخراج الجهاز من الوضع المفقود يمكنك الاطّلاع على StopLostModeParams. في حال ضبط السياسة، يجب عدم ضبط type. وفي هذه الحالة، يضبط الخادم تلقائيًا على STOP_LOST_MODE. ويمكن أيضًا ضبط السمة type على STOP_LOST_MODE صراحةً.
حقل الاتحاد status. حالة خاصة بالأمر يُرجى العِلم أنّ بعض الأوامر لا تستخدم ذلك الأمر على وجه الخصوص LOCK وRESET_PASSWORD وREBOOT وRELINQUISH_OWNERSHIP. وقد تستخدم هذه الأوامر في المستقبل أيضًا. لا يمكن أن يكون status سوى واحد مما يلي:
clearAppsDataStatus

object (ClearAppsDataStatus)

الإخراج فقط. حالة الأمر CLEAR_APP_DATA لمحو بيانات تطبيقات مُحدَّدة من الجهاز. يمكنك الاطّلاع على ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

الإخراج فقط. حالة الأمر START_LOST_MODE لوضع الجهاز في وضع فقدان الهاتف يمكنك الاطّلاع على StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

الإخراج فقط. حالة الأمر STOP_LOST_MODE لإخراج الجهاز من "الوضع المفقود". يمكنك الاطّلاع على StopLostModeStatus.

نوع الأوامر

أنواع الأوامر

عمليات التعداد
COMMAND_TYPE_UNSPECIFIED هذه القيمة غير مسموح بها.
LOCK يمكنك قفل الجهاز، كما لو كان قد انتهت مهلة مهلة شاشة القفل.
RESET_PASSWORD إعادة ضبط كلمة مرور المستخدم
REBOOT إعادة تشغيل الجهاز لا تتوافق هذه الميزة إلا مع الأجهزة المُدارة بالكامل والتي تعمل بالإصدار 7.0 من نظام التشغيل Android (المستوى 24 من واجهة برمجة التطبيقات) أو الإصدارات الأحدث.
RELINQUISH_OWNERSHIP يؤدي هذا الخيار إلى إزالة الملف الشخصي للعمل وجميع السياسات من جهاز يعمل بنظام التشغيل Android 8.0 والإصدارات المملوكة للشركة، مع التخلي عن الجهاز للاستخدام الشخصي. يتم الاحتفاظ بالتطبيقات والبيانات المرتبطة بالملفات الشخصية. سيتم حذف الجهاز من الخادم بعد أن يتعرّف على الأمر.
CLEAR_APP_DATA يؤدي إلى محو بيانات التطبيق لتطبيقات محددة. يتوفّر هذا الخيار على نظام التشغيل Android 9 والإصدارات الأحدث. يُرجى ملاحظة أن التطبيق يمكنه تخزين البيانات خارج بياناته، مثل مساحة التخزين الخارجية أو قاموس المستخدم. يمكنك أيضًا الاطّلاع على clearAppsDataParams.
START_LOST_MODE لضبط الجهاز على وضع فقدان الهاتف هذه الميزة غير متاحة إلا على الأجهزة المُدارة بالكامل أو الأجهزة المملوكة للمؤسسة والتي تتضمّن ملفًا شخصيًا مُدارًا. يمكنك أيضًا الاطّلاع على startLostModeParams.
STOP_LOST_MODE يؤدي هذا الإجراء إلى إيقاف الجهاز من وضع "فقدان الجهاز". هذه الميزة غير متاحة إلا على الأجهزة المُدارة بالكامل أو الأجهزة المملوكة للمؤسسة والتي تتضمّن ملفًا شخصيًا مُدارًا. يمكنك أيضًا الاطّلاع على stopLostModeParams.

رمز الأوامر

رمز خطأ في الأمر وهو حقل للقراءة فقط تتم تعبئته من خلال الخادم.

عمليات التعداد
COMMAND_ERROR_CODE_UNSPECIFIED لم يحدث أي خطأ.
UNKNOWN حدث خطأ غير معروف.
API_LEVEL لا يتيح مستوى واجهة برمجة التطبيقات للجهاز هذا الأمر.
MANAGEMENT_MODE لا يتوفّر الأمر "وضع الإدارة" (مالك الملف الشخصي أو مالك الجهاز أو غير ذلك)
INVALID_VALUE يحتوي الأمر على قيمة مَعلمة غير صالحة.
UNSUPPORTED الْجِهَازْ مَبْيِدْعَمْشِ الْأَمْرْ. قد يؤدي تحديث تطبيق Android Device Policy إلى أحدث إصدار إلى حل المشكلة.

إعادة ضبط كلمة المرور

العلامات التي يمكن استخدامها لنوع الأمر RESET_PASSWORD.

عمليات التعداد
RESET_PASSWORD_FLAG_UNSPECIFIED تم تجاهل هذه القيمة.
REQUIRE_ENTRY عدم السماح للمشرفين الآخرين بتغيير كلمة المرور مرة أخرى إلى أن يُدخِلها المستخدم.
DO_NOT_ASK_CREDENTIALS_ON_BOOT عدم طلب بيانات اعتماد المستخدم عند تشغيل الجهاز
LOCK_NOW اقفل الجهاز بعد إعادة ضبط كلمة المرور.

محو بيانات تطبيقات

المعلّمات المرتبطة بالأمر CLEAR_APP_DATA لمحو بيانات تطبيقات محدّدة من الجهاز.

تمثيل JSON 
{
  "packageNames": [
    string
  ]
}
الحقول
packageNames[]

string

أسماء حزم التطبيقات التي سيتم محو بياناتها عند تنفيذ الأمر.

بداية وضع التشغيل المفقود

المعلّمات المرتبطة بالأمر START_LOST_MODE لوضع الجهاز في وضع فقدان الجهاز. يجب تقديم معلّمة واحدة على الأقل، لا تتضمّن اسم المؤسسة، حتى يتم وضع الجهاز في الوضع المفقود.

تمثيل JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
الحقول
lostMessage

object (UserFacingMessage)

الرسالة التي يتم عرضها للمستخدم في حال فقدان الجهاز.
lostPhoneNumber

object (UserFacingMessage)

رقم الهاتف المعروض للمستخدم عندما يكون الجهاز في وضع فقدان الجهاز.
lostEmailAddress

string

عنوان البريد الإلكتروني الذي يظهر للمستخدم عندما يكون الجهاز في وضع فقدان الجهاز.
lostStreetAddress

object (UserFacingMessage)

عنوان الشارع الذي يظهر للمستخدم عندما يكون الجهاز في وضع "فقدان الجهاز".
lostOrganization

object (UserFacingMessage)

اسم المؤسسة الذي يظهر للمستخدم عندما يكون الجهاز في وضع فقدان الجهاز

إيقاف وضع الإيقاف المفقود

لا يحتوي هذا النوع على أي حقول.

المعلّمات المرتبطة بالأمر STOP_LOST_MODE لإخراج الجهاز من الوضع المفقود.

محو بيانات التطبيقات

حالة الأمر CLEAR_APP_DATA لمحو بيانات تطبيقات مُحدَّدة من الجهاز.

تمثيل JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
الحقول
results

map (key: string, value: object (PerAppResult))

النتائج لكل تطبيق، التعيين من أسماء الحِزم إلى نتيجة المقاصة ذات الصلة

عنصر يحتوي على قائمة بأزواج من "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

نتيجة التطبيق

نتيجة محاولة محو بيانات تطبيق واحد.

تمثيل JSON 
{
  "clearingResult": enum (ClearingResult)
}
الحقول
clearingResult

enum (ClearingResult)

نتيجة محاولة محو بيانات تطبيق واحد.

جارٍ محو نتيجة البحث

نتيجة محاولة محو بيانات تطبيق واحد.

عمليات التعداد
CLEARING_RESULT_UNSPECIFIED نتيجة غير محدّدة.
SUCCESS تم محو بيانات هذا التطبيق بنجاح.
APP_NOT_FOUND تعذّر محو بيانات هذا التطبيق بسبب عدم العثور على التطبيق.
APP_PROTECTED تعذّر محو بيانات هذا التطبيق لأنّه محمي. على سبيل المثال، قد ينطبق ذلك على التطبيقات الحيوية التي تعمل على أداء الجهاز، مثل "متجر Google Play".
API_LEVEL تعذّر محو بيانات هذا التطبيق لأنّ مستوى واجهة برمجة تطبيقات الجهاز لا يتيح استخدام هذا الأمر.

بداية وضع التشغيل

حالة الأمر START_LOST_MODE لوضع الجهاز في وضع فقدان الهاتف

تمثيل JSON 
{
  "status": enum (Status)
}
الحقول
status

enum (Status)

الحالة. يمكنك الاطّلاع على StartLostModeStatus.

الحالة

الحالة. يمكنك الاطّلاع على StartLostModeStatus.

عمليات التعداد
STATUS_UNSPECIFIED غير محدد لم يتم استخدام هذه القيمة.
SUCCESS تم وضع الجهاز في وضع فقدان.
RESET_PASSWORD_RECENTLY تعذّر وضع الجهاز في وضع فقدان الجهاز لأنّ المشرف أعاد ضبط كلمة مرور الجهاز مؤخرًا.
USER_EXIT_LOST_MODE_RECENTLY تعذّر وضع الجهاز في وضع فقدان الجهاز لأنّ المستخدم خرج من الوضع المفقود مؤخرًا.
ALREADY_IN_LOST_MODE الجهاز في وضع الخطأ حاليًا.

وضع الإيقاف المفقود

حالة الأمر STOP_LOST_MODE لإخراج الجهاز من "الوضع المفقود".

تمثيل JSON 
{
  "status": enum (Status)
}
الحقول
status

enum (Status)

الحالة. يمكنك الاطّلاع على StopLostModeStatus.

الحالة

الحالة. يمكنك الاطّلاع على StopLostModeStatus.

عمليات التعداد
STATUS_UNSPECIFIED غير محدد لم يتم استخدام هذه القيمة.
SUCCESS تم إخراج الجهاز من وضع فقدان الهاتف.
NOT_IN_LOST_MODE الجهاز ليس في وضع "فقدان الجهاز".