Directory API: ChromeOS devices

بازیابی همه دستگاه‌های ChromeOS برای یک حساب

برای برگرداندن فهرستی از همه دستگاه‌های ChromeOS اختصاص‌داده‌شده به یک حساب، از درخواست GET زیر استفاده کنید و مجوز شرح‌داده‌شده در درخواست‌های مجوز را اضافه کنید. برای خوانایی، این نمونه کد دارای خطوط برگشتی است: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?projection={BASIC|FULL}&query=query
&orderBy=orderBy category&sortOrder={ASCENDING|DESCENDING}
&pageToken=token for next results page, if applicable
&maxResults=max number of results per page

  • customerId شناسه یکتای حساب Google مشتری است.
  • به‌عنوان سرپرست حساب، می‌توانید از رشته my_customer نیز استفاده کنید که customerId حسابتان را نشان می‌دهد. راه دیگر برای دریافت مقدار customerId استفاده از عملیات بازیابی کاربر است. از نشانی ایمیل سرپرست یا مقدار id کاربر یکتای سرپرست در پارامتر مسیر userKey عملیات استفاده کنید.

برای رشته‌های پُرسمان، درخواست، و ویژگی‌های پاسخ، مرجع میانای برنامه‌سازی کاربردی را ببینید.

مثال: فیلتر کردن دستگاه‌ها براساس کاربر

این مثال بااستفاده از query=user:help desk کاربر خاصی را جستجو می‌کند. پاسخ حاوی یک منبع chromeosdevice است، که در آن annotatedUser برابر با help desk است:

درخواست JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=user:help desk&orderBy=status
&sortOrder=ASCENDING&maxResults=100

پاسخ JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "etag": "1234567890"
       "deviceId": "def456",
       "serialNumber": "234567",
       "status": "ACTIVE",
       "lastSync": "2013-03-05T17:30:04.325Z",
       "supportEndDate": "2014-04-05T17:30:04.325Z",
       "annotatedUser": "help desk",
       "annotatedLocation": "Mountain View help desk Chromebook",
       "annotatedAssetId": "1234567890",
       "notes": "Loaned from support",
       "orderNumber": "1234",
       "willAutoRenew": true,
       "osVersion": "Browser Version 18.0",
       "platformVersion": "Platform Version 1415.2.0",
       "firmwareVersion": "Firmware Version 1.2.3.4",
       "bootMode": "validated",
       "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
       "orgUnitPath": "corp/engineering",
       "recentUsers": [
         {
           "type": "USER_TYPE_MANAGED",
           "email": "user@customer.com"
         }
       ],
       "activeTimeRanges": [
         {
           "date": "2012-04-05",
           "activeTime": "3600000"
         }
       ],
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

مثال: فیلتر کردن دستگاه‌ها براساس شماره سریال

این مثال شماره سریال خاصی را بااستفاده از query=id:123456 جستجو می‌کند، که در آن 123456 شماره سریال دستگاه است. پاسخ نشان‌داده‌شده در زیر حاوی یک پاسخ منطبق است که در آن ویژگی serialNumber با مقدار جستجو مطابقت دارد.

درخواست JSON

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos?projection=FULL&query=id:123456&orderBy=status
&sortOrder=ASCENDING&maxResults=100

پاسخ JSON

{
  "kind": "directory#chromeosdevices",
  "chromeosdevices": [
     {
       "kind": "directory#chromeosdevice",
       "deviceId": "abc123",
       "serialNumber": "123456",
       "status": "SHIPPED",
       "supportEndDate": "1404457200000",
       "model": "model_value",
       "meid": "meid_value",
       "macAddress": "mac_address_value",
       "orderNumber": "1234",
       "willAutoRenew": true
     }
  ],
  "nextPageToken": "abcdefghijkl123"
}

این نمونه پاسخ شامل ویژگی‌های model،‏ meid، و macAddress است. اگر دستگاهی این ویژگی‌ها را نداشته باشد، در پاسخ گنجانده نمی‌شود. برای جزئیات کامل، نمایش منبع Chromeosdevices را ببینید.

صادر کردن فهرست MEID

meid «شناسه تجهیزات سیار» (MEID) برای کارت تلفن همراه 3G در دستگاه ChromeOS است. معمولاً وقتی دستگاهی به طرح خدمات پس‌پرداخت شرکت مخابراتی بی‌سیم اضافه می‌شود، از MEID استفاده می‌شود. برای صادر کردن فهرست MEID، از درخواست GET زیر و مقادیر nextPageToken برای بازیابی فهرست کامل MEID استفاده کنید. برای خوانایی، این نمونه کد دارای خطوط بازگشتی است: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos?fields=nextPageToken,chromeosdevices(meid)

بازیابی دستگاه ChromeOS

برای بازیابی ویژگی‌های دستگاه ChromeOS، از درخواست GET زیر استفاده کنید و مجوز شرح‌داده‌شده در درخواست‌های صدور مجوز را اضافه کنید. برای خوانایی، این نمونه کد دارای خطوط برگشتی است: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId شناسه یکتای حساب Google مشتری است.
  • به‌عنوان سرپرست حساب، می‌توانید از رشته my_customer نیز استفاده کنید که customerId حسابتان را نشان می‌دهد. راه دیگر برای دریافت مقدار customerId استفاده از عملیات بازیابی کاربر است. از نشانی ایمیل سرپرست یا مقدار id کاربر یکتای سرپرست در پارامتر مسیر userKey عملیات استفاده کنید.
  • ‫deviceId شناسه یکتایی برای دستگاه است و در پاسخ عملیات بازیابی همه دستگاه‌های ChromeOS یافت می‌شود.

برای رشته‌های پُرسمان، درخواست، و ویژگی‌های پاسخ، مرجع میانای برنامه‌سازی کاربردی را ببینید.

درخواست JSON

درخواست نمونه. برای خوانایی، این نمونه کد دارای خطوط بازگشتی است: 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

پاسخ JSON

درخواست موفق رمز وضعیت HTTP 200 را برمی‌گرداند. همراه با کد وضعیت، پاسخ ویژگی‌های دستگاه ChromeOS را برمی‌گرداند: 

{
  "kind": "directory#chromeosdevice",
  "deviceId": "device_id_value",
  "serialNumber": "device_serial_number",
  "status": "ACTIVE",
  "lastSync": "2012-04-05T17:30:04.325Z",
  "supportEndDate": "2014-04-05T17:30:04.325Z",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "12345667890",
  "notes": "Loaned from support",
  "orderNumber": "123456",
  "willAutoRenew": true,
  "osVersion": "Browser Version 18.0",
  "platformVersion": "Platform Version 1415.2.0",
  "firmwareVersion": "Firmware Version 1.2.3.4",
  "bootMode": "validated"
  "lastEnrollmentTime": "2012-04-05T17:30:04.325Z",
  "orgUnitPath": "corp/engineering"
}

به‌روزرسانی دستگاه ChromeOS

برای به‌روزرسانی دستگاه ChromeOS، از درخواست PUT زیر استفاده کنید و مجوز شرح‌داده‌شده در مجوز دادن به درخواست‌ها را اضافه کنید. برای خوانایی، این نمونه کد دارای خطوط برگشتی است: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId شناسه یکتای حساب Google مشتری است.
  • به‌عنوان سرپرست حساب، می‌توانید از رشته my_customer نیز استفاده کنید که customerId حسابتان را نشان می‌دهد. راه دیگر برای دریافت مقدار customerId استفاده از عملیات بازیابی کاربر است. از نشانی ایمیل سرپرست یا مقدار id کاربر یکتای سرپرست در پارامتر مسیر userKey عملیات استفاده کنید.
  • ‫deviceId شناسه یکتایی برای دستگاه است و در پاسخ عملیات بازیابی همه دستگاه‌های ChromeOS یافت می‌شود.

برای رشته‌های پُرسمان، درخواست، و ویژگی‌های پاسخ، مرجع میانای برنامه‌سازی کاربردی را ببینید.

درخواست JSON

نمونه درخواست JSON زیر ویژگی‌های annotatedUser، annotatedLocation، annotatedAssetId، notes، و orgUnitPath دستگاه ChromeOS را به‌روز می‌کند. برای خوانایی، این نمونه کد دارای خطوط بازگشتی است: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 نمونه متن درخواست: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

برای درخواست به‌روزرسانی، فقط ویژگی‌های دارای مقادیر به‌روزشده را در درخواستتان بگنجانید.

درخواست موفق رمز وضعیت HTTP 200 را برمی‌گرداند. همراه با رمز وضعیت، پاسخ ویژگی‌های دستگاه ChromeOS به‌روزشده را برمی‌گرداند.

لغو تأمین یا غیرفعال کردن دستگاه‌های ChromeOS

برای لغو تأمین یا غیرفعال کردن دستگاه‌های ChromeOS، از درخواست POST زیر استفاده کنید و مجوز شرح‌داده‌شده در مجوز دادن به درخواست‌ها را اضافه کنید. برای خوانایی، این نمونه کد دارای خطوط برگشتی است: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer or customerId/
devices/chromeos:batchChangeStatus

  • customerId شناسه یکتای حساب Google مشتری است.
  • به‌عنوان سرپرست حساب، می‌توانید از رشته my_customer نیز استفاده کنید که customerId حسابتان را نشان می‌دهد. راه دیگر برای دریافت مقدار customerId استفاده از عملیات بازیابی کاربر است. از نشانی ایمیل سرپرست یا مقدار id کاربر یکتای سرپرست در پارامتر مسیر userKey عملیات استفاده کنید.

برای ویژگی‌های درخواست و پاسخ، مرجع میانای برنامه‌سازی کاربردی را ببینید.

درخواست JSON

درخواست JSON زیر نمونه درخواستی را برای لغو تأمین و غیرفعال کردن دستگاه‌های ChromeOS نشان می‌دهد: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 بدنه درخواست برای لغو تأمین نمونه عبارت است از: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 متن درخواست غیرفعال کردن: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

درخواست موفق رمز وضعیت HTTP 200 را برمی‌گرداند.

انتقال دستگاه‌های ChromeOS به «واحد سازمانی»

برای انتقال حداکثر ۵۰ دستگاه ChromeOS به «واحد سازمانی»، از درخواست POST زیر استفاده کنید و مجوز شرح‌داده‌شده در مجوز دادن به درخواست‌ها را اضافه کنید. برای خوانایی، این نمونه کد دارای خطوط برگشتی است: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId شناسه یکتای حساب Google مشتری است.
  • به‌عنوان سرپرست حساب، می‌توانید از رشته my_customer نیز استفاده کنید که customerId حسابتان را نشان می‌دهد. راه دیگر برای دریافت مقدار customerId استفاده از عملیات بازیابی کاربر است. از نشانی ایمیل سرپرست یا مقدار کاربر یکتای سرپرست id در پارامتر مسیر userKey عملیات استفاده کنید.

برای ویژگی‌های درخواست و پاسخ، مرجع میانای برنامه‌سازی کاربردی را ببینید.

درخواست JSON

درخواست JSON زیر نمونه درخواستی را برای انتقال ۳ دستگاه ChromeOS به «واحد سازمانی» به‌نام /Marketing نشان می‌دهد: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/chromeos/moveDevicesToOu?orgUnitPath=/Marketing

متن درخواست برای انتقال دستگاه:

{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"]
}

درخواست موفق رمز وضعیت HTTP 200 را برمی‌گرداند.