واجهة برمجة التطبيقات للدليل: أجهزة 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، وهي استخدام عملية استرداد مستخدم. استخدِم عنوان البريد الإلكتروني للمشرف أو قيمة المستخدم الفريد 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. وإذا كان الجهاز لا يحتوي على هاتين السمتَين، لن يتم تضمينهما في الاستجابة. للحصول على التفاصيل الكاملة، يمكنك الاطّلاع على تمثيل موارد أجهزة ChromeOS.

تصدير قائمة 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 التي تمثّل customerId لحسابك. وهناك طريقة أخرى للحصول على القيمة 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 التي تمثّل customerId لحسابك. وهناك طريقة أخرى للحصول على القيمة 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 التي تمثّل customerId لحسابك. وهناك طريقة أخرى للحصول على القيمة 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 التي تمثّل customerId لحسابك. وثمة طريقة أخرى للحصول على القيمة 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.