واجهة برمجة التطبيقات للدليل: أجهزة 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 التي representcustomerId لحسابك. هناك طريقة أخرى للحصول على قيمة 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) لبطاقة شبكة الجيل الثالث في جهاز 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

لاسترداد سمات جهاز Chrome، استخدِم طلب GET التالي وأضِف التفويض الموضّح في طلبات التفويض. بغرض سهولة القراءة، تحتوي عينة التعليمات البرمجية التالية على أحرف الرجوع إلى أول السطر:

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId هو معرّف فريد لحساب العميل على Google.
  • بصفتك مشرف حساب، يمكنك أيضًا استخدام السلسلة my_customer التي representcustomerId لحسابك. هناك طريقة أخرى للحصول على قيمة customerId وهي استخدام عملية استرداد مستخدم. ويمكنك استخدام عنوان البريد الإلكتروني للمشرف أو قيمة id المميزة للمشرف في مَعلمة مسار userKey في العملية.
  • deviceId هو معرّف فريد للجهاز ويمكن العثور عليه في استجابة عملية استرداد جميع أجهزة Chrome.

للاطّلاع على سمات سلاسل طلبات البحث وطلبات البيانات والاستجابة، يرجى مراجعة مرجع واجهة برمجة التطبيقات.

طلب 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

لتعديل جهاز Chrome، استخدِم طلب PUT التالي وأضِف التفويض الموضّح في طلبات التفويض. بغرض سهولة القراءة، تحتوي عينة التعليمات البرمجية التالية على أحرف الرجوع إلى أول السطر:

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId هو معرّف فريد لحساب العميل على Google.
  • بصفتك مشرف حساب، يمكنك أيضًا استخدام السلسلة my_customer التي representcustomerId لحسابك. هناك طريقة أخرى للحصول على قيمة customerId وهي استخدام عملية استرداد مستخدم. ويمكنك استخدام عنوان البريد الإلكتروني للمشرف أو قيمة id المميزة للمشرف في مَعلمة مسار userKey في العملية.
  • deviceId هو معرّف فريد للجهاز ويمكن العثور عليه في استجابة عملية استرداد جميع أجهزة Chrome.

للاطّلاع على سمات سلاسل طلبات البحث وطلبات البيانات والاستجابة، يرجى مراجعة مرجع واجهة برمجة التطبيقات.

طلب 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 التي representcustomerId لحسابك. هناك طريقة أخرى للحصول على قيمة customerId وهي استخدام عملية استرداد مستخدم. ويمكنك استخدام عنوان البريد الإلكتروني للمشرف أو قيمة id المميزة للمشرف في مَعلمة مسار userKey في العملية.

للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات.

طلب 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 التي representcustomerId لحسابك. هناك طريقة أخرى للحصول على قيمة customerId وهي استخدام عملية استرداد مستخدم. ويمكنك استخدام عنوان البريد الإلكتروني للمشرف أو قيمة id الفريدة للمشرف في مَعلمة مسار userKey في العملية.

للاطّلاع على سمات الطلب والاستجابة، راجِع مرجع واجهة برمجة التطبيقات.

طلب 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.