Directory API: Perangkat Chrome

Mengambil semua perangkat Chrome untuk akun

Untuk menampilkan daftar semua perangkat Chrome yang ditetapkan ke akun, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

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 adalah ID unik Akun Google pelanggan.
  • Sebagai administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Retrieve a user. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.

Untuk properti string kueri, permintaan, dan respons, lihat Referensi API.

Contoh: Memfilter perangkat menurut pengguna

Contoh ini menelusuri pengguna tertentu menggunakan query=user:help desk. Responsnya berisi satu resource chromeosdevice, dengan annotatedUser adalah help desk:

Permintaan 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

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

Contoh: Memfilter perangkat menurut nomor seri

Contoh ini menelusuri nomor seri tertentu menggunakan query=id:123456, dengan 123456 adalah nomor seri perangkat. Respons yang ditampilkan di bawah berisi satu balasan yang cocok, dengan properti serialNumber cocok dengan nilai penelusuran.

Permintaan 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

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

Contoh respons ini menyertakan properti model, meid, dan macAddress. Jika perangkat tidak memiliki properti ini, properti tersebut tidak disertakan dalam respons. Untuk mengetahui detail selengkapnya, lihat representasi resource Chromeosdevices.

Mengekspor daftar MEID

meid adalah ID Peralatan Seluler (MEID) untuk kartu seluler 3G di perangkat Chrome. MEID biasanya digunakan saat menambahkan perangkat ke paket layanan pascabayar operator nirkabel. Untuk mengekspor daftar MEID, gunakan permintaan GET berikut dan nilai nextPageToken untuk mengambil daftar lengkap MEID. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

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

Mengambil perangkat Chrome

Untuk mengambil properti perangkat Chrome, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Permintaan otorisasi. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

GET https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId adalah ID unik Akun Google pelanggan.
  • Sebagai administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Retrieve a user. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.
  • deviceId adalah ID unik untuk perangkat dan ditemukan sebagai respons terhadap operasi Retrieve all Chrome devices.

Untuk properti string kueri, permintaan, dan respons, lihat Referensi API.

Permintaan JSON

Contoh permintaan. Agar mudah dibaca, contoh kode ini diberi pemisahan baris. 
GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/devices/
chromeos/deviceId?projection=full

Respons JSON

Permintaan yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons akan menampilkan properti perangkat 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"
}

Mengupdate perangkat Chrome

Untuk mengupdate perangkat Chrome, gunakan permintaan PUT berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/{my_customer|customerId}/
devices/chromeos/deviceId?projection={FULL|BASIC}
  • customerId adalah ID unik Akun Google pelanggan.
  • Sebagai administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Retrieve a user. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.
  • deviceId adalah ID unik untuk perangkat dan ditemukan sebagai respons terhadap operasi Retrieve all Chrome devices.

Untuk properti string kueri, permintaan, dan respons, lihat Referensi API.

Permintaan JSON

Contoh permintaan JSON berikut memperbarui properti annotatedUser, annotatedLocation, annotatedAssetId, notes, dan orgUnitPath perangkat Chrome. Agar mudah dibaca, contoh kode ini diberi pemisahan baris. 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/deviceId?projection=full
 Contoh isi permintaan: 
{
  "deviceId": "device_id_value",
  "annotatedUser": "help desk",
  "annotatedLocation": "Mountain View help desk Chromebook",
  "annotatedAssetId": "1234567890",
  "notes": "Loaned from support",
  "orgUnitPath": "/corp/sales"
}

Untuk permintaan pembaruan, hanya sertakan properti dengan nilai yang diperbarui dalam permintaan Anda.

Permintaan yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons akan menampilkan properti untuk perangkat Chrome yang diperbarui.

Mencabut akses atau menonaktifkan perangkat Chrome

Untuk membatalkan penyediaan atau menonaktifkan perangkat Chrome, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

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

  • customerId adalah ID unik Akun Google pelanggan.
  • Sebagai administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Retrieve a user. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.

Untuk properti permintaan dan respons, lihat Referensi API.

Permintaan JSON

Permintaan JSON berikut menunjukkan contoh permintaan untuk mencabut akses dan menonaktifkan perangkat Chrome: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos:batchChangeStatus
 Isi permintaan untuk contoh penghapusan penyediaan adalah: 
{
  "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
  "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
  "deprovisionReason": "DEPROVISION_REASON_RETIRING_DEVICE"
}
 Isi permintaan untuk menonaktifkan adalah: 
  {
    "deviceIds": ["deviceId_1", "deviceId_2", "deviceId_3"],
    "changeChromeOsDeviceStatusAction": "CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
  }

Permintaan yang berhasil akan menampilkan kode status HTTP 200.

Memindahkan perangkat Chrome ke Unit Organisasi

Untuk memindahkan hingga 50 perangkat Chrome ke Unit Organisasi, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. Agar mudah dibaca, contoh kode ini diberi pemisahan baris: 

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/
devices/chromeos/moveDevicesToOu?orgUnitPath=/SomeOuName
  • customerId adalah ID unik Akun Google pelanggan.
  • Sebagai administrator akun, Anda juga dapat menggunakan string my_customer yang mewakili customerId akun Anda. Cara lain untuk mendapatkan nilai customerId adalah dengan menggunakan operasi Mengambil pengguna. Gunakan alamat email administrator atau nilai id pengguna unik administrator Anda di parameter jalur userKey operasi.

Untuk properti permintaan dan respons, lihat Referensi API.

Permintaan JSON

Permintaan JSON berikut menunjukkan contoh permintaan untuk memindahkan 3 perangkat Chrome ke Unit Organisasi bernama /Marketing: 

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

Isi permintaan untuk pemindahan perangkat adalah:

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

Permintaan yang berhasil akan menampilkan kode status HTTP 200.