Method: resources.calendars.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
网址采用 gRPC 转码语法。
路径参数
参数 |
customer |
string
客户 Google Workspace 账号的唯一 ID。作为账号管理员,您还可以使用 my_customer 别名来表示您账号的客户 ID。
|
查询参数
参数 |
maxResults |
integer
返回的结果数上限。
|
orderBy |
string
用于按升序或降序对结果进行排序的字段。支持的字段包括 resourceId 、resourceName 、capacity 、buildingId 和 floorName 。如果未指定顺序,则默认为升序。应采用“字段 [升序|降序]、字段 [升序|降序]、…”的形式。例如,buildingId,
capacity desc 会返回先按 buildingId 升序排序,然后按 capacity 降序排序的结果。
|
pageToken |
string
用于指定列表中的下一页的令牌。
|
query |
string
用于过滤结果的字符串查询。应采用“字段运算符值”的格式,其中字段可以是任何受支持的字段,运算符可以是任何受支持的运算。运算符包括“=”(完全匹配)、“!=”(不匹配)和“:”(前缀匹配或“HAS”匹配,如果适用)。对于前缀匹配,值后面应始终跟随一个 *。支持逻辑运算符 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
将其标识为 CalendarResource 集合。此值始终为 admin#directory#resources#calendars#calendarResourcesList 。
|
etag |
string
资源的 ETag。
|
items[] |
object (CalendarResource )
此结果页面中的 CalendarResources。
|
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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],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)."]]