Возвращает правила в списке управления доступом для календаря. Попробуйте сейчас или посмотрите пример .
Запрос
HTTP-запрос
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
Параметры
Имя параметра | Ценить | Описание |
---|---|---|
Параметры пути | ||
calendarId | string | Идентификатор календаря. Чтобы получить идентификаторы календаря, вызовите метод CalendarList.list . Если вы хотите получить доступ к основному календарю вошедшего в систему пользователя, используйте ключевое слово « primary ». |
Необязательные параметры запроса | ||
maxResults | integer | Максимальное количество записей, возвращаемых на одной странице результатов. По умолчанию значение составляет 100 записей. Размер страницы никогда не может превышать 250 записей. Необязательный. |
pageToken | string | Токен, указывающий, какую страницу результатов следует вернуть. Необязательный. |
showDeleted | boolean | Включать ли в результат удаленные списки управления доступом. Удаленные списки ACL представлены role , равной « none ». Удаленные списки ACL всегда будут включены, если указан syncToken . Необязательный. По умолчанию установлено значение Ложь. |
syncToken | string | Токен, полученный из поля nextSyncToken , возвращенного на последней странице результатов предыдущего запроса списка. Результат этого запроса списка будет содержать только записи, которые изменились с тех пор. Все записи, удаленные после предыдущего запроса списка, всегда будут в наборе результатов, и для параметра showDeleted не разрешено устанавливать значение False.Если срок действия syncToken истечет, сервер ответит кодом ответа 410 GONE, и клиент должен очистить свое хранилище и выполнить полную синхронизацию без какого-либо syncToken .Узнайте больше об инкрементной синхронизации. Необязательный. По умолчанию возвращаются все записи. |
Авторизация
Этот запрос требует авторизации со следующей областью действия:
Объем |
---|
https://www.googleapis.com/auth/calendar |
Дополнительную информацию см. на странице аутентификации и авторизации .
Тело запроса
Не предоставляйте тело запроса с помощью этого метода.
Ответ
В случае успеха этот метод возвращает тело ответа следующей структуры:
{ "kind": "calendar#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
kind | string | Тип коллекции (" calendar#acl "). | |
etag | etag | ETag коллекции. | |
nextPageToken | string | Токен, используемый для доступа к следующей странице этого результата. Опускается, если дальнейшие результаты недоступны, и в этом случае предоставляется nextSyncToken . | |
items[] | list | Список правил в списке контроля доступа. | |
nextSyncToken | string | Токен, используемый позднее для получения только тех записей, которые изменились с момента возврата этого результата. Опускается, если доступны дополнительные результаты, и в этом случае предоставляется nextPageToken . |
Примеры
Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).
Ява
Использует клиентскую библиотеку 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 .
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
PHP
Использует клиентскую библиотеку PHP .
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Руби
Использует клиентскую библиотеку Ruby .
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
Попробуйте!
Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.