Method: enterprises.devices.issueCommand

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

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