Method: enterprises.devices.issueCommand

يصدر أمرًا إلى جهاز. يحتوي مورد Operation المعروض على Command في الحقل metadata الخاص به. استخدم إجراء العملية get لمعرفة حالة الأمر.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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، يتم تحديد كلمة المرور الجديدة اختياريًا. ملاحظة: يجب ألا يقل طول كلمة المرور الجديدة عن 6 أحرف إذا كانت رقمية في حال استخدام أجهزة Android 14. إذا لم يتم تنفيذ الأمر، لن ينجح الأمر مع INVALID_VALUE.
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.

CommandType

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

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

CommandErrorCode

رمز خطأ في الأمر. هذا حقل للقراءة فقط ملأه الخادم.

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

ResetPasswordFlag

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

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

ClearAppsDataParams

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

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

string

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

StartLostModeParams

المعلَمات المرتبطة بالأمر 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)

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

StopLostModeParams

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

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

ClearAppsDataStatus

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

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

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

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

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

PerAppResult

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

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

enum (ClearingResult)

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

ClearingResult

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

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

StartLostModeStatus

حالة الأمر 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 الجهاز في وضع "فقدان الجهاز" حاليًا.

StopLostModeStatus

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

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

enum (Status)

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

الحالة

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

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