Method: resources.calendars.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera uma lista de recursos de agenda de uma conta.
Solicitação HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
customer |
string
O ID exclusivo da conta do Google Workspace do cliente. Como administrador da conta, você também pode usar o alias my_customer para representar o ID de cliente da sua conta.
|
Parâmetros de consulta
Parâmetros |
maxResults |
integer
Número máximo de resultados a serem retornados.
|
orderBy |
string
Campos para classificar os resultados em ordem crescente ou decrescente. Os campos aceitos incluem resourceId , resourceName , capacity , buildingId e floorName . Se nenhuma ordem for especificada, o padrão será crescente. Precisa estar no formato "campo [asc|desc], campo [asc|desc], ...". Por exemplo, buildingId,
capacity desc retornaria resultados classificados primeiro por buildingId em ordem crescente e depois por capacity em ordem decrescente.
|
pageToken |
string
Token para especificar a próxima página na lista.
|
query |
string
Consulta de string usada para filtrar resultados. Precisa estar no formato "campo operador valor", em que "campo" pode ser qualquer um dos campos aceitos e "operador" pode ser qualquer uma das operações aceitas. Os operadores incluem '=' para correspondência exata, '!=' para incompatibilidade e ':' para correspondência de prefixo ou HAS, quando aplicável. Para correspondência de prefixo, o valor precisa ser sempre seguido por um *. Os operadores lógicos NOT e AND são aceitos (nesta ordem de precedência). Os campos aceitos incluem generatedResourceName , name , buildingId , floorName , capacity , featureInstances.feature.name , resourceEmail e resourceCategory . Por exemplo, buildingId=US-NYC-9TH AND
featureInstances.feature.name:Phone .
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
API pública: Resources.calendars
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (CalendarResource )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
Identifica isso como uma coleção de CalendarResources. Isso é sempre admin#directory#resources#calendars#calendarResourcesList .
|
etag |
string
ETag do recurso.
|
items[] |
object (CalendarResource )
Os recursos de agenda nesta página de resultados.
|
nextPageToken |
string
O token de continuação, usado para percorrer conjuntos grandes de resultados. Forneça esse valor em uma solicitação subsequente para retornar a próxima página de resultados.
|
Escopos de autorização
Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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)."]]