Method: resources.calendars.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recupera una lista de recursos de calendario para una cuenta.
Solicitud HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros |
customer |
string
El ID único de la cuenta de Google Workspace del cliente. Como administrador de la cuenta, también puedes usar el alias my_customer para representar el ID de cliente de tu cuenta.
|
Parámetros de consulta
Parámetros |
maxResults |
integer
Cantidad máxima de resultados que se mostrarán.
|
orderBy |
string
Son los campos por los que se ordenan los resultados de forma ascendente o descendente. Los campos admitidos incluyen resourceId , resourceName , capacity , buildingId y floorName . Si no se especifica ningún orden, el valor predeterminado es ascendente. Debe tener el formato "campo [asc|desc], campo [asc|desc], …". Por ejemplo, buildingId,
capacity desc mostraría resultados ordenados primero por buildingId en orden ascendente y, luego, por capacity en orden descendente.
|
pageToken |
string
Es un token para especificar la página siguiente de la lista.
|
query |
string
Es la consulta de cadena que se usa para filtrar los resultados. Debe tener el formato "valor del operador de campo", en el que el campo puede ser cualquiera de los campos admitidos y los operadores pueden ser cualquiera de las operaciones admitidas. Los operadores incluyen "=" para la concordancia exacta, "!>=" para la no concordancia y ":" para la concordancia de prefijo o HAS, cuando corresponda. En el caso de la concordancia de prefijos, el valor siempre debe ir seguido de un *. Se admiten los operadores lógicos NOT y AND (en este orden de precedencia). Los campos admitidos incluyen generatedResourceName , name , buildingId , floorName , capacity , featureInstances.feature.name , resourceEmail y resourceCategory . Por ejemplo, buildingId=US-NYC-9TH AND
featureInstances.feature.name:Phone .
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
API pública: Resources.calendars
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
Identifica esto como una colección de CalendarResources. Siempre es admin#directory#resources#calendars#calendarResourcesList .
|
etag |
string
ETag del recurso.
|
items[] |
object (CalendarResource )
CalendarResources en esta página de resultados.
|
nextPageToken |
string
Es el token de continuación, que se usa para desplazarse por grandes conjuntos de resultados. Proporciona este valor en una solicitud posterior para mostrar la página siguiente de resultados.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de 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
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]