Acl: list

Retorna as regras na lista de controle de acesso da agenda. Faça um teste agora ou veja um exemplo.

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 recuperar IDs de agendas, chame o método calendarList.list. Para acessar a agenda principal do usuário conectado, use "primary" palavra-chave.
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 é de 100 entradas. O tamanho da página não pode ser maior do que 250 entradas. Opcional.
pageToken string Token que especifica qual página de resultados deve ser retornada. Opcional.
showDeleted boolean Define se as ACLs excluídas devem ser 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 entradas que foram alteradas 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 "False".
Se a syncToken expirar, o servidor responderá com um código de resposta 410 GONE, e o cliente precisará limpar o armazenamento e fazer uma sincronização completa sem nenhuma 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 o seguinte escopo:

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

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 coleção ("calendar#acl").
etag etag ETag da coleção.
nextPageToken string Token usado para acessar a próxima página deste resultado. Omitido se nenhum outro resultado estiver disponível. Nesse caso, nextSyncToken é fornecido.
items[] list Lista de regras na lista de controle de acesso.
nextSyncToken string Token usado posteriormente para recuperar apenas as entradas que foram alteradas desde que esse resultado foi retornado. Omitido se outros resultados estiverem disponíveis. Nesse caso, nextPageToken é fornecido.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Acl;
import com.google.api.services.calendar.model.AclRule;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over a list of access rules
Acl acl = service.acl().list('primary').execute();

for (AclRule rule : acl.getItems()) {
  System.out.println(rule.getId() + ": " + rule.getRole());
}

Python

Usa a biblioteca cliente de Python.

acl = service.acl().list(calendarId='primary').execute()

for rule in acl['items']:
  print '%s: %s' % (rule['id'], rule['role'])

PHP

Usa a biblioteca cliente de PHP.

$acl = $service->acl->listAcl('primary');

foreach ($acl->getItems() as $rule) {
  echo $rule->getId() . ': ' . $rule->getRole();
}

Ruby

Usa a biblioteca de cliente Ruby.

result = client.list_acls('primary')
result.items.each do |e|
  print e.id + ": " + e.role + "\n"
end

Confira!

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