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

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 الجهاز ليس في وضع "فقدان الجهاز".