Acl: list

返回日历访问控制列表中的规则。 立即试用或查看示例。

请求

HTTP 请求

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

参数

参数名称 值 说明
路径参数
calendarId string 日历标识符。要检索日历 ID，请调用 calendarList.list 方法。如果您想访问当前登录用户的主日历，请使用“primary”关键字。
可选的查询参数
maxResults integer 一个结果页上返回的条目数上限。默认值为 100 个条目。页面大小不得超过 250 个条目。可选。
pageToken string 用于指定要返回的结果页面的令牌。可选。
showDeleted boolean 是否在结果中包含已删除的 ACL。已删除的 ACL 由等于“none”的 role 表示。如果提供了 syncToken，则系统将始终包含已删除的 ACL。可选。默认值为 False。
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

使用 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

使用 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

使用 Ruby 客户端库。

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

试试看！

使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。