Method: chromeosdevices.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera ponumerowane listy urządzeń z Chrome OS na koncie.
Żądanie HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
customerId |
string
Unikalny identyfikator konta Google Workspace klienta. Jako administrator konta możesz też użyć aliasu my_customer, aby reprezentować customerId na Twoim koncie. Wartość customerId jest też zwracana w ramach zasobu Users.
|
Parametry zapytania
| Parametry |
maxResults |
integer
Maksymalna liczba wyników do zwrócenia. Wartość nie powinna przekraczać 300.
|
orderBy |
enum (OrderBy)
Właściwość urządzenia używana do sortowania wyników.
|
orgUnitPath |
string
Pełna ścieżka jednostki organizacyjnej (bez wiodącego znaku /) lub jej unikalny identyfikator.
|
pageToken |
string
Parametr zapytania pageToken służy do wywołania następnej strony z wynikami zapytania. Parametr zapytania pageToken następnego żądania to parametr nextPageToken z poprzedniej odpowiedzi.
|
projection |
enum (Projection)
Określa, czy odpowiedź zawiera pełną listę właściwości czy tylko ich podzbiór.
|
query |
string
Ciąg wyszukiwania w formacie podanym na stronie https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder)
Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej. Musi być używany z parametrem orderBy.
|
includeChildOrgunits |
boolean
Zwraca urządzenia ze wszystkich podrzędnych jednostek organizacyjnych oraz z wybranej jednostki organizacyjnej. Jeśli ma wartość Prawda, musisz podać wartość „orgUnitPath”.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice)
}
],
"nextPageToken": string
} |
| Pola |
kind |
string
Rodzaj zasobu.
|
etag |
string
ETag zasobu.
|
chromeosdevices[] |
object (ChromeOsDevice)
Lista obiektów urządzenia z Chrome OS.
|
nextPageToken |
string
Token używany do uzyskiwania dostępu do następnej strony z tymi wynikami. Aby uzyskać dostęp do następnej strony, użyj wartości tego tokena w składniku pageToken tego żądania.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
OrderBy
| Wartości w polu enum |
ANNOTATED_LOCATION |
Lokalizacja urządzenia z Chrome oznaczona adnotacją przez administratora. |
ANNOTATED_USER |
Użytkownik Chromebooka oznaczony adnotacją przez administratora. |
LAST_SYNC |
Data i godzina ostatniej synchronizacji urządzenia z Chrome z ustawieniami zasad w konsoli administracyjnej. |
NOTES |
Notatki na urządzeniu z Chrome oznaczone adnotacjami przez administratora. |
SERIAL_NUMBER |
Numer seryjny urządzenia z Chrome podany podczas włączania urządzenia. |
STATUS |
Stan urządzenia z Chrome. Więcej informacji znajdziesz w chromeosdevices. |
Odwzorowanie
Typ projekcji wyświetlanej na urządzeniach.
| Wartości w polu enum |
BASIC |
Uwzględnia tylko podstawowe pola metadanych (np.deviceId, serialNumber, status i user). |
FULL |
Obejmuje wszystkie pola metadanych. |
SortOrder
Kolejność sortowania, która powinna być zastosowana do listy urządzeń.
| Wartości w polu enum |
ASCENDING |
rosnąco; |
DESCENDING |
w kolejności malejącej. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
