Method: resources.calendars.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור רשימה של משאבי יומן בחשבון.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
customer |
string
המזהה הייחודי של חשבון Google Workspace של הלקוח. כאדמינים של החשבון, אתם יכולים גם להשתמש בכתובת החלופית my_customer כדי לייצג את מספר הלקוח של החשבון.
|
פרמטרים של שאילתה
| פרמטרים |
maxResults |
integer
המספר המקסימלי של תוצאות להחזרה.
|
orderBy |
string
השדות שבהם רוצים למיין את התוצאות בסדר עולה או יורד. השדות הנתמכים כוללים את resourceId, resourceName, capacity, buildingId ו-floorName. אם לא צוין סדר, ברירת המחדל היא סדר עולה. צריך להיות בפורמט 'שדה [asc|desc], שדה [asc|desc], …'. לדוגמה, buildingId,
capacity desc יחזיר תוצאות שממוינות קודם לפי buildingId בסדר עולה ואז לפי capacity בסדר יורד.
|
pageToken |
string
אסימון לציון הדף הבא ברשימה.
|
query |
string
שאילתת מחרוזת שמשמשת לסינון התוצאות. צריך להיות בפורמט 'שדה אופרטור ערך', כאשר השדה יכול להיות כל אחד מהשדות הנתמכים והאופרטורים יכולים להיות כל אחת מהפעולות הנתמכות. האופרטורים כוללים את '=' להתאמה מדויקת, את '!=' להתאמה לא מדויקת ואת ':' להתאמה לתחילית או להתאמה מסוג 'יש', במקרים הרלוונטיים. בהתאמה לקידומת, הערך צריך תמיד להיות אחרי *. יש תמיכה באופרטורים הלוגיים NOT ו-AND (בסדר העדיפות הזה). השדות הנתמכים כוללים את generatedResourceName, name, buildingId, floorName, capacity, featureInstances.feature.name, resourceEmail, resourceCategory. לדוגמה buildingId=US-NYC-9TH AND
featureInstances.feature.name:Phone.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
ממשק API ציבורי: Resources.calendars
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource)
}
],
"nextPageToken": string
} |
| שדות |
kind |
string
זהו מאפיין שמזהה את האובייקט כקבוצה של CalendarResources. הערך הזה הוא תמיד admin#directory#resources#calendars#calendarResourcesList.
|
etag |
string
ה-ETag של המשאב.
|
items[] |
object (CalendarResource)
משאבי היומן בדף התוצאות הזה.
|
nextPageToken |
string
אסימון ההמשך, שמשמש לגלילה בין דפים של קבוצות תוצאות גדולות. מציינים את הערך הזה בבקשה הבאה כדי להציג את דף התוצאות הבא.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://apps-apis.google.com/a/feeds/calendar/resource/
https://www.googleapis.com/auth/admin.directory.resource.calendar
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: resources.calendars.list\n\nRetrieves a list of calendar resources for an account.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `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 customer ID. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. |\n| `orderBy` | `string` Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field \\[asc\\|desc\\], field \\[asc\\|desc\\], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order. |\n| `pageToken` | `string` Token to specify the next page in the list. |\n| `query` | `string` String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a \\*. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floorName`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nPublic API: Resources.calendars\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/workspace/admin/directory/reference/rest/v1/resources.calendars#CalendarResource) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[CalendarResource](/workspace/admin/directory/reference/rest/v1/resources.calendars#CalendarResource)`)` The CalendarResources in this page of results. |\n| `nextPageToken` | `string` The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/calendar/resource/`\n- `\n https://www.googleapis.com/auth/admin.directory.resource.calendar`\n- `\n https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
