Acl: list

Retorna as regras na lista de controle de acesso da agenda. Faça o teste agora.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
calendarId string Identificador da agenda. Para extrair os IDs de agenda, chame o método calendarList.list. Se você quiser acessar a agenda principal do usuário conectado, use a palavra-chave "primary".
Parâmetros de consulta opcionais
maxResults integer Número máximo de entradas retornadas em uma página de resultados. Por padrão, o valor é 100 entradas. O tamanho da página nunca pode ser maior que 250 entradas. Opcional.
pageToken string Token que especifica qual página de resultados será retornada. Opcional.
showDeleted boolean Se as ACLs excluídas serão incluídas no resultado. As ACLs excluídas são representadas por role igual a "none". As ACLs excluídas sempre serão incluídas se syncToken for fornecido. Opcional. O valor padrão é falso.
syncToken string Token recebido do campo nextSyncToken retornado na última página de resultados da solicitação de lista anterior. Isso faz com que o resultado dessa solicitação de lista contenha apenas as entradas que mudaram desde então. Todas as entradas excluídas desde a solicitação de lista anterior sempre estarão no conjunto de resultados, e não é permitido definir showDeleted como Falso.
Se o syncToken expirar, o servidor vai responder com um código de resposta 410 GONE, e o cliente vai precisar limpar o armazenamento e realizar uma sincronização completa sem nenhum syncToken.
Saiba mais sobre a sincronização incremental.
Opcional. O padrão é retornar todas as entradas.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.acls
https://www.googleapis.com/auth/calendar.acls.readonly

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "calendar#acl",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    acl Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Tipo da coletânea ("calendar#acl").
etag etag ETag da coletânea.
nextPageToken string Token usado para acessar a próxima página desse resultado. Omitido se não houver mais resultados disponíveis. Nesse caso, nextSyncToken será fornecido.
items[] list Lista de regras na lista de controle de acesso.
nextSyncToken string Token usado em um momento posterior para recuperar apenas as entradas que mudaram desde que o resultado foi retornado. Omitido se outros resultados estiverem disponíveis. Nesse caso, nextPageToken será fornecido.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.