Directory API: دستگاه‌های Chrome

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

برای بازگرداندن فهرستی از همه دستگاه‌های Chrome اختصاص داده شده به یک حساب، از درخواست 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 استفاده از عملیات Retrieve a user است. از آدرس ایمیل سرپرست خود یا مقدار id کاربری منحصر به فرد مدیر خود در پارامتر مسیر userKey عملیات استفاده کنید.

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

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

این مثال با استفاده از 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 در دستگاه Chrome است. MEID معمولاً هنگام افزودن دستگاهی به طرح خدمات پس از پرداخت یک شرکت مخابراتی بی‌سیم استفاده می‌شود. برای صادر کردن لیست MEID، از درخواست GET زیر و مقادیر nextPageToken برای بازیابی لیست کامل MEIDها استفاده کنید. برای خوانایی، این نمونه کد دارای بازگشت خط است: 

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

دستگاه کروم را بازیابی کنید

برای بازیابی ویژگی‌های یک دستگاه Chrome، از درخواست 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 استفاده از عملیات Retrieve a user است. از آدرس ایمیل سرپرست خود یا مقدار id کاربری منحصر به فرد مدیر خود در پارامتر مسیر userKey عملیات استفاده کنید.
  • deviceId یک شناسه منحصر به فرد برای یک دستگاه است و در پاسخ عملیات بازیابی همه دستگاه‌های Chrome یافت می‌شود.

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

درخواست JSON

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

پاسخ JSON

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

{
  "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"
}

یک دستگاه کروم را به روز کنید

برای به‌روزرسانی یک دستگاه Chrome، از درخواست 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 استفاده از عملیات Retrieve a user است. از آدرس ایمیل سرپرست خود یا مقدار id کاربری منحصر به فرد مدیر خود در پارامتر مسیر userKey عملیات استفاده کنید.
  • deviceId یک شناسه منحصر به فرد برای یک دستگاه است و در پاسخ عملیات بازیابی همه دستگاه‌های Chrome یافت می‌شود.

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

درخواست JSON

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

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 را برمی گرداند. همراه با کد وضعیت، پاسخ ویژگی‌های دستگاه Chrome به‌روزرسانی شده را برمی‌گرداند.

حذف یا غیرفعال کردن دستگاه‌های Chrome

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

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

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

برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید.

درخواست JSON

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

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 را برمی گرداند.

دستگاه‌های Chrome را به واحد سازمان منتقل کنید

برای انتقال حداکثر 50 دستگاه Chrome به یک واحد سازمانی، از درخواست POST زیر استفاده کنید و مجوز شرح داده شده در درخواست‌های مجاز را وارد کنید. برای خوانایی، این نمونه کد دارای بازگشت خط است:

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

برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید.

درخواست JSON

درخواست JSON زیر یک درخواست نمونه برای انتقال 3 دستگاه Chrome به یک واحد سازمانی به نام /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 را برمی گرداند.