Method: enterprises.devices.issueCommand

دستوری را برای دستگاه صادر می کند. منبع Operation بازگردانده شده حاوی یک Command در قسمت metadata خود است. برای بدست آوردن وضعیت دستور از روش عملیات get استفاده کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
name

string

نام دستگاه به شکل enterprises/{enterpriseId}/devices/{deviceId} .

درخواست بدن

بدنه درخواست شامل یک نمونه از Command است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

فرمان

یک دستور

نمایندگی 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 )

نوع دستور.

create Time

string ( Timestamp format)

مهر زمانی که در آن فرمان ایجاد شده است. مهر زمانی به طور خودکار توسط سرور ایجاد می شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

duration

string ( Duration format)

مدت زمانی که فرمان معتبر است. اگر در این مدت توسط دستگاه اجرا نشود، فرمان منقضی می شود. مدت زمان پیش‌فرض اگر مشخص نشده باشد ده دقیقه است. حداکثر مدت زمان وجود ندارد.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

user Name

string

نام منبع کاربری که صاحب دستگاه است به شکل enterprises/{enterpriseId}/users/{userId} . این به طور خودکار توسط سرور بر اساس دستگاهی که فرمان به آن ارسال می شود، تولید می شود.

error Code

enum ( CommandErrorCode )

اگر دستور ناموفق بود، یک کد خطایی که خرابی را توضیح می دهد. هنگامی که فرمان توسط تماس گیرنده لغو می شود، این تنظیم نمی شود.

new Password

string

برای دستورات نوع RESET_PASSWORD ، به صورت اختیاری رمز عبور جدید را مشخص می کند. نکته: رمز عبور جدید در صورت عددی بودن در دستگاه‌های اندروید 14 باید حداقل 6 کاراکتر باشد. در غیر این صورت دستور با INVALID_VALUE ناموفق خواهد بود.

reset Password Flags[]

enum ( ResetPasswordFlag )

برای دستورات نوع RESET_PASSWORD ، به صورت اختیاری پرچم ها را مشخص می کند.

params میدان اتحادیه پارامترهای مخصوص دستور توجه داشته باشید که برخی از دستورات از این مورد استفاده نمی کنند، به ویژه LOCK ، RESET_PASSWORD ، REBOOT ، و RELINQUISH_OWNERSHIP . در آینده این دستورات ممکن است از این نیز استفاده کنند.

اگر این تنظیم شده باشد، فیلدهای new_password و reset_password_flags نباید تنظیم شوند. params فقط می توانند یکی از موارد زیر باشند:

clear Apps Data Params

object ( ClearAppsDataParams )

پارامترهای دستور CLEAR_APP_DATA برای پاک کردن داده های برنامه های مشخص شده از دستگاه. به ClearAppsDataParams مراجعه کنید. اگر این تنظیم شده باشد، پیشنهاد می شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی CLEAR_APP_DATA تنظیم می کند. همچنین تنظیم صریح type بر روی CLEAR_APP_DATA قابل قبول است.

start Lost Mode Params

object ( StartLostModeParams )

پارامترهای دستور START_LOST_MODE برای قرار دادن دستگاه در حالت گمشده. StartLostModeParams ببینید. اگر این تنظیم شده باشد، پیشنهاد می شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی START_LOST_MODE تنظیم می کند. همچنین تنظیم صریح type روی START_LOST_MODE قابل قبول است.

stop Lost Mode Params

object ( StopLostModeParams )

پارامترهای دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گمشده. StopLostModeParams ببینید. اگر این تنظیم شده باشد، پیشنهاد می شود که type تنظیم نشود. در این حالت، سرور به طور خودکار آن را روی STOP_LOST_MODE تنظیم می کند. همچنین تنظیم صریح type روی STOP_LOST_MODE قابل قبول است.

status میدان اتحادیه وضعیت خاص دستور. توجه داشته باشید که برخی از دستورات از این مورد استفاده نمی کنند، به ویژه LOCK ، RESET_PASSWORD ، REBOOT ، و RELINQUISH_OWNERSHIP . در آینده این دستورات ممکن است از این نیز استفاده کنند. status فقط می تواند یکی از موارد زیر باشد:
clear Apps Data Status

object ( ClearAppsDataStatus )

فقط خروجی وضعیت فرمان CLEAR_APP_DATA برای پاک کردن داده های برنامه های مشخص شده از دستگاه. به ClearAppsDataStatus مراجعه کنید.

start Lost Mode Status

object ( StartLostModeStatus )

فقط خروجی وضعیت فرمان START_LOST_MODE برای قرار دادن دستگاه در حالت گمشده. StartLostModeStatus ببینید.

stop Lost Mode Status

object ( StopLostModeStatus )

فقط خروجی وضعیت دستور STOP_LOST_MODE برای خارج کردن دستگاه از حالت گمشده. StopLostModeStatus ببینید.

نوع فرمان

انواع دستورات

Enums
COMMAND_TYPE_UNSPECIFIED این مقدار مجاز نیست.
LOCK دستگاه را قفل کنید، گویی مهلت زمانی قفل صفحه به پایان رسیده است.
RESET_PASSWORD رمز عبور کاربر را بازنشانی کنید.
REBOOT دستگاه را راه اندازی مجدد کنید. فقط در دستگاه های کاملاً مدیریت شده دارای Android 7.0 (سطح API 24) یا بالاتر پشتیبانی می شود.
RELINQUISH_OWNERSHIP نمایه کاری و همه خط‌مشی‌ها را از دستگاه Android 8.0 و بالاتر متعلق به شرکت حذف می‌کند و دستگاه را برای استفاده شخصی واگذار می‌کند. برنامه ها و داده های مرتبط با نمایه(های) شخصی حفظ می شوند. دستگاه پس از تأیید فرمان از سرور حذف می شود.
CLEAR_APP_DATA داده های برنامه برنامه های مشخص شده را پاک می کند. این در اندروید 9 و بالاتر پشتیبانی می شود. توجه داشته باشید که یک برنامه می تواند داده ها را خارج از داده های برنامه خود ذخیره کند، به عنوان مثال در حافظه خارجی یا در فرهنگ لغت کاربر. همچنین به clearAppsDataParams مراجعه کنید.
START_LOST_MODE دستگاه را در حالت گم شده قرار می دهد. فقط در دستگاه های کاملاً مدیریت شده یا دستگاه های متعلق به سازمان با نمایه مدیریت شده پشتیبانی می شود. startLostModeParams نیز ببینید.
STOP_LOST_MODE دستگاه را از حالت گم شده خارج می کند. فقط در دستگاه های کاملاً مدیریت شده یا دستگاه های متعلق به سازمان با نمایه مدیریت شده پشتیبانی می شود. stopLostModeParams نیز ببینید.

CommandErrorCode

کد خطای دستوری این یک فیلد فقط خواندنی است که توسط سرور پر شده است.

Enums
COMMAND_ERROR_CODE_UNSPECIFIED هیچ خطایی وجود نداشت.
UNKNOWN یک خطای ناشناخته رخ داد.
API_LEVEL سطح API دستگاه از این دستور پشتیبانی نمی کند.
MANAGEMENT_MODE حالت مدیریت (مالک نمایه، صاحب دستگاه و غیره) از این فرمان پشتیبانی نمی کند.
INVALID_VALUE دستور دارای مقدار پارامتر نامعتبر است.
UNSUPPORTED دستگاه از دستور پشتیبانی نمی کند. به‌روزرسانی خط‌مشی دستگاه Android به آخرین نسخه ممکن است مشکل را حل کند.

ResetPasswordFlag

پرچم هایی که می توانند برای نوع دستور RESET_PASSWORD استفاده شوند.

Enums
RESET_PASSWORD_FLAG_UNSPECIFIED این مقدار نادیده گرفته می شود.
REQUIRE_ENTRY تا زمانی که کاربر رمز عبور را وارد نکرده، به مدیران دیگر اجازه ندهید که دوباره رمز عبور را تغییر دهند.
DO_NOT_ASK_CREDENTIALS_ON_BOOT هنگام بوت شدن دستگاه، اطلاعات کاربری را درخواست نکنید.
LOCK_NOW پس از بازنشانی رمز عبور، دستگاه را قفل کنید.

ClearAppsDataParams

پارامترهای مرتبط با دستور CLEAR_APP_DATA برای پاک کردن داده های برنامه های مشخص شده از دستگاه.

نمایندگی JSON 
{
  "packageNames": [
    string
  ]
}
فیلدها
package Names[]

string

نام بسته برنامه هایی که داده های آنها هنگام اجرای دستور پاک می شود.

StartLostModeParams

پارامترهای مرتبط با فرمان START_LOST_MODE برای قرار دادن دستگاه در حالت گمشده. حداقل یکی از پارامترها، بدون نام سازمان، باید ارائه شود تا دستگاه در حالت گم شده قرار گیرد.

نمایندگی JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
فیلدها
lost Message

object ( UserFacingMessage )

پیامی که وقتی دستگاه در حالت گم شده است به کاربر نمایش داده می شود.

lost Phone Number

object ( UserFacingMessage )

شماره تلفنی که وقتی دستگاه در حالت گم شده است و دکمه مالک تماس با آن ضربه زده می شود، با آن تماس گرفته می شود.

lost Email Address

string

آدرس ایمیلی که وقتی دستگاه در حالت گم شده است به کاربر نمایش داده می شود.

lost Street Address

object ( UserFacingMessage )

آدرس خیابانی که وقتی دستگاه در حالت گم شده است به کاربر نمایش داده می شود.

lost Organization

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)
}
فیلدها
clearing Result

enum ( ClearingResult )

نتیجه تلاش برای پاک کردن داده های یک برنامه واحد.

Clearing Result

نتیجه تلاش برای پاک کردن داده های یک برنامه واحد.

Enums
CLEARING_RESULT_UNSPECIFIED نتیجه نامشخص
SUCCESS داده های این برنامه با موفقیت پاک شد.
APP_NOT_FOUND داده‌های این برنامه پاک نشد زیرا برنامه پیدا نشد.
APP_PROTECTED داده‌های این برنامه پاک نشد زیرا برنامه محافظت شده است. برای مثال، این ممکن است برای برنامه‌هایی که برای عملکرد دستگاه حیاتی هستند، مانند فروشگاه Google Play اعمال شود.
API_LEVEL داده‌های این برنامه پاک نشد زیرا سطح API دستگاه از این دستور پشتیبانی نمی‌کند.

StartLostModeStatus

وضعیت فرمان START_LOST_MODE برای قرار دادن دستگاه در حالت گمشده.

نمایندگی JSON 
{
  "status": enum (Status)
}
فیلدها
status

enum ( Status )

وضعیت. StartLostModeStatus ببینید.

وضعیت

وضعیت. StartLostModeStatus ببینید.

Enums
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 ببینید.

Enums
STATUS_UNSPECIFIED نامشخص این مقدار استفاده نمی شود.
SUCCESS دستگاه از حالت گم شده خارج شد.
NOT_IN_LOST_MODE دستگاه در حالت گم شده نیست.