Method: resources.calendars.list

Recupera uma lista de recursos da agenda para 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 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 ter o 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 da lista.
query

string

Consulta de string usada para filtrar os resultados. Precisa estar no formato "valor do operador de campo" em que o campo pode ser qualquer um dos campos suportados e os operadores podem 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 deve sempre vir seguido de um *. Os operadores lógicos NOT e AND são compatíveis (nessa ordem de precedência). Os campos aceitos incluem generatedResourceName, name, buildingId, floorName, capacity, featureInstances.feature.name, resourceEmail, 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 um conjunto de CalendarResources. É sempre admin#directory#resources#calendars#calendarResourcesList.
etag

string

ETag do recurso.
items[]

object (CalendarResource)

O CalendarResources 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.