Zwraca reguły na liście kontroli dostępu do kalendarza. Wypróbuj teraz lub zobacz przykład.
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
Parametry
Nazwa parametru | Wartość | Opis |
---|---|---|
Parametry ścieżki | ||
calendarId |
string |
Identyfikator kalendarza. Aby pobrać identyfikatory kalendarzy, wywołaj metodę calendarList.list. Jeśli chcesz uzyskać dostęp do kalendarza głównego obecnie zalogowanego użytkownika, użyj słowa kluczowego „primary ”.
|
Opcjonalne parametry zapytania | ||
maxResults |
integer |
Maksymalna liczba wpisów zwróconych na jednej stronie wyników. Domyślnie jest to 100 wpisów. Rozmiar strony nigdy nie może przekraczać 250 wpisów. Opcjonalne. |
pageToken |
string |
Token określający stronę wyników do zwrócenia. Opcjonalne. |
showDeleted |
boolean |
Określa, czy uwzględnić w wynikach usunięte listy kontroli dostępu. Usunięte listy ACL są reprezentowane przez wartość role równą „none ”. Usunięte listy ACL są zawsze uwzględniane, jeśli podano listę syncToken . Opcjonalne. Wartość domyślna to Fałsz.
|
syncToken |
string |
Token uzyskany z pola nextSyncToken zwrócony na ostatniej stronie wyników z poprzedniego żądania listy. W wyniku tego żądania listy wyświetlane są tylko wpisy, które od tego czasu uległy zmianie. Wszystkie wpisy usunięte od poprzedniego żądania listy zawsze będą dostępne w wynikach i nie mogą mieć wartości Fałsz w zasadzie showDeleted . Gdy kontroler syncToken utraci ważność, serwer zwróci kod odpowiedzi 410 GONE, a klient powinien wyczyścić pamięć i przeprowadzić pełną synchronizację bez użycia syncToken . Dowiedz się więcej o przyrostowej synchronizacji. Opcjonalnie. Domyślnie zwracane są wszystkie wpisy. |
Upoważnienie
To żądanie wymaga autoryzacji w następującym zakresie:
Zakres |
---|
https://www.googleapis.com/auth/calendar |
Więcej informacji znajdziesz na stronie uwierzytelniania i autoryzacji.
Treść żądania
Nie udostępniaj treści żądania tą metodą.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:
{ "kind": "calendar#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
Nazwa właściwości | Wartość | Opis | Uwagi |
---|---|---|---|
kind |
string |
Typ kolekcji („calendar#acl ”). |
|
etag |
etag |
ETag kolekcji. | |
nextPageToken |
string |
Token, dzięki któremu można uzyskać dostęp do następnej strony tego wyniku. Pominięto, jeśli nie są dostępne żadne dalsze wyniki. W takim przypadku podano nextSyncToken . |
|
items[] |
list |
Lista reguł na liście kontroli dostępu. | |
nextSyncToken |
string |
Token używany później w celu pobrania tylko wpisów, które zostały zmienione od chwili zwrócenia tego wyniku. Pominięto, jeśli dostępne są dalsze wyniki. W takim przypadku podano nextPageToken . |
Przykłady
Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.
Java
Używa biblioteki klienta w języku 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
Używa biblioteki klienta dla języka Python.
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
PHP
Używa biblioteki klienta PHP.
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Ruby
Używa biblioteki klienta Ruby.
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
Wypróbuj
Skorzystaj z eksploratora interfejsów API poniżej, aby wywołać tę metodę w aktywnych danych i zobaczyć odpowiedź.