Method: chromeosdevices.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור רשימה מחולקת לדפים של מכשירי Chrome OS בחשבון.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
customerId |
string
המזהה הייחודי של חשבון Google Workspace של הלקוח. כאדמינים של החשבון, אתם יכולים גם להשתמש בכתובת החלופית my_customer כדי לייצג את customerId של החשבון. הערך customerId מוחזר גם כחלק ממשאב המשתמשים.
|
פרמטרים של שאילתה
| פרמטרים |
maxResults |
integer
המספר המקסימלי של תוצאות להחזרה. הערך לא יכול להיות גדול מ-300.
|
orderBy |
enum (OrderBy)
מאפיין המכשיר שמשמש למיון התוצאות.
|
orgUnitPath |
string
הנתיב המלא של היחידה הארגונית (ללא / המוביל) או המזהה הייחודי שלה.
|
pageToken |
string
פרמטר השאילתה pageToken משמש לבקשת הדף הבא של תוצאות השאילתה. פרמטר השאילתה pageToken של הבקשה הבאה הוא הערך nextPageToken מהתגובה הקודמת.
|
projection |
enum (Projection)
קובע אם התשובה מכילה את רשימת הנכסים המלאה או רק קבוצת משנה.
|
query |
string
מחרוזת חיפוש בפורמט שמופיע בכתובת https://developers.google.com/workspace/admin/directory/v1/list-query-operators
|
sortOrder |
enum (SortOrder)
האם להציג את התוצאות בסדר עולה או יורד. חובה להשתמש בו עם הפרמטר orderBy.
|
includeChildOrgunits |
boolean
הפונקציה מחזירה מכשירים מכל היחידות הארגוניות המשניות, וגם מהיחידה הארגונית שצוינה. אם הערך מוגדר כ-true, צריך לספק את 'orgUnitPath'.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"kind": string,
"etag": string,
"chromeosdevices": [
{
object (ChromeOsDevice)
}
],
"nextPageToken": string
} |
| שדות |
kind |
string
סוג המשאב.
|
etag |
string
ה-ETag של המשאב.
|
chromeosdevices[] |
object (ChromeOsDevice)
רשימה של אובייקטים של מכשירי Chrome OS.
|
nextPageToken |
string
אסימון המשמש לגישה לדף הבא של התוצאה הזו. כדי לגשת לדף הבא, צריך להשתמש בערך האסימון הזה במחרוזת השאילתה pageToken של הבקשה הזו.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/admin.directory.device.chromeos
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
מידע נוסף זמין במדריך ההרשאות.
OrderBy
| טיפוסים בני מנייה (enum) |
ANNOTATED_LOCATION |
המיקום של מכשיר Chrome כפי שצוין על ידי האדמין. |
ANNOTATED_USER |
משתמש ב-Chromebook כפי שצוין על ידי האדמין. |
LAST_SYNC |
התאריך והשעה שבהם מכשיר Chrome סונכרן לאחרונה עם הגדרות המדיניות במסוף Admin. |
NOTES |
הערות על מכשירי Chrome שנוספו על ידי האדמין. |
SERIAL_NUMBER |
המספר הסידורי של מכשיר Chrome שהוזן כשהמכשיר הופעל. |
STATUS |
סטטוס המכשיר ב-Chrome. מידע נוסף זמין במאמר chromeosdevices. |
היטל
סוג התחזית שמוצגת לגבי המכשירים.
| טיפוסים בני מנייה (enum) |
BASIC |
כולל רק את שדות המטא-נתונים הבסיסיים (למשל, deviceId, serialNumber, status ו-user) |
FULL |
כולל את כל שדות המטא-נתונים |
SortOrder
סדר המיון שצריך להחיל על רשימת המכשירים.
| טיפוסים בני מנייה (enum) |
ASCENDING |
סדר עולה. |
DESCENDING |
בסדר יורד. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
