Method: chromeosdevices.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengambil daftar perangkat Chrome OS yang di-pagination dalam akun.
Permintaan HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
customerId |
string
ID unik untuk akun Google Workspace pelanggan. Sebagai administrator akun, Anda juga dapat menggunakan alias my_customer untuk mewakili customerId akun Anda. customerId juga ditampilkan sebagai bagian dari resource Pengguna.
|
Parameter kueri
| Parameter |
maxResults |
integer
Jumlah hasil maksimum yang akan ditampilkan. Nilai tidak boleh melebihi 300.
|
orderBy |
enum (OrderBy)
Properti perangkat yang akan digunakan untuk mengurutkan hasil.
|
orgUnitPath |
string
Jalur lengkap unit organisasi (tanpa / di awal) atau ID uniknya.
|
pageToken |
string
Parameter kueri pageToken digunakan untuk meminta halaman hasil kueri berikutnya. Parameter kueri pageToken untuk permintaan berikutnya adalah nextPageToken dari respons Anda sebelumnya.
|
projection |
enum (Projection)
Menentukan apakah respons berisi daftar lengkap properti atau hanya sebagian.
|
query |
string
String penelusuran dalam format yang diberikan di https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder)
Apakah akan menampilkan hasil dalam urutan menaik atau menurun. Harus digunakan dengan parameter orderBy.
|
includeChildOrgunits |
boolean
Menampilkan perangkat dari semua unit organisasi turunan, serta unit organisasi yang ditentukan. Jika disetel ke benar (true), 'orgUnitPath' harus diberikan.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice)
}
],
"nextPageToken": string
} |
| Kolom |
kind |
string
Jenis resource ini.
|
etag |
string
ETag resource.
|
chromeosdevices[] |
object (ChromeOsDevice)
Daftar objek Perangkat Chrome OS.
|
nextPageToken |
string
Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini. Untuk mengakses halaman berikutnya, gunakan nilai token ini dalam string kueri pageToken dari permintaan ini.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
OrderBy
| Enum |
ANNOTATED_LOCATION |
Lokasi perangkat Chrome seperti yang dianotasi oleh administrator. |
ANNOTATED_USER |
Pengguna Chromebook seperti yang dianotasi oleh administrator. |
LAST_SYNC |
Tanggal dan waktu perangkat Chrome terakhir kali disinkronkan dengan setelan kebijakan di konsol Admin. |
NOTES |
Catatan perangkat Chrome seperti yang dianotasi oleh administrator. |
SERIAL_NUMBER |
Nomor seri perangkat Chrome yang dimasukkan saat perangkat diaktifkan. |
STATUS |
Status perangkat Chrome. Untuk mengetahui informasi selengkapnya, lihat <a chromeosdevices. |
Proyeksi
Jenis proyeksi yang akan ditampilkan untuk perangkat.
| Enum |
BASIC |
Hanya menyertakan kolom metadata dasar (misalnya, deviceId, serialNumber, status, dan user) |
FULL |
Menyertakan semua kolom metadata |
SortOrder
Urutan pengurutan yang harus diterapkan ke daftar perangkat.
| Enum |
ASCENDING |
Urutan menaik. |
DESCENDING |
Urutan menurun. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["# Method: chromeosdevices.list\n\nRetrieves a paginated list of Chrome OS devices within an account.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. Value should not exceed 300. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#OrderBy)`)` Device property to use for sorting results. |\n| `orgUnitPath` | `string` The full path of the organizational unit (minus the leading `/`) or its unique ID. |\n| `pageToken` | `string` The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#Projection)`)` Determines whether the response contains the full list of properties or only a subset. |\n| `query` | `string` Search string in the format given at \u003chttps://developers.google.com/workspace/admin/directory/v1/list-query-operators\u003e |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/chromeosdevices/list#SortOrder)`)` Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. |\n| `includeChildOrgunits` | `boolean` Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"chromeosdevices\": [ { object (/workspace/admin/directory/reference/rest/v1/chromeosdevices#ChromeOsDevice) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `chromeosdevices[]` | `object (`[ChromeOsDevice](/workspace/admin/directory/reference/rest/v1/chromeosdevices#ChromeOsDevice)`)` A list of Chrome OS Device objects. |\n| `nextPageToken` | `string` Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.device.chromeos`\n- `\n https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ANNOTATED_LOCATION` | Chrome device location as annotated by the administrator. |\n| `ANNOTATED_USER` | Chromebook user as annotated by administrator. |\n| `LAST_SYNC` | The date and time the Chrome device was last synchronized with the policy settings in the Admin console. |\n| `NOTES` | Chrome device notes as annotated by the administrator. |\n| `SERIAL_NUMBER` | The Chrome device serial number entered when the device was enabled. |\n| `STATUS` | Chrome device status. For more information, see the \\\u003ca [chromeosdevices](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices.html). |\n\nProjection\n----------\n\nThe type of projection to show for the devices.\n\n| Enums ||\n|---------|------------------------------------------------------------------------------------------|\n| `BASIC` | Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) |\n| `FULL` | Includes all metadata fields |\n\nSortOrder\n---------\n\nThe sorting order that should be applied to the device list.\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]
