Acl: list

傳回日曆存取控制清單中的規則。立即試用或參閱範例。

要求

HTTP 要求

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

參數

參數名稱 值 說明
路徑參數
calendarId string 日曆 ID。如要擷取日曆 ID，請呼叫 calendarList.list 方法。如果您想存取目前登入使用者的主日曆，請使用「primary」關鍵字。
選用查詢參數
maxResults integer 一個結果頁面中傳回的項目數量上限。預設值為 100 個項目。頁面大小不得超過 250 個項目。選用。
pageToken string 符記，可指定要傳回的結果頁面。選用。
showDeleted boolean 是否要在結果中納入已刪除的 ACL。已刪除的 ACL 會以 role 表示，且等於「none」。如果提供 syncToken，系統一律會納入已刪除的 ACL。選用設定。預設值為 False。
syncToken string 從先前列出要求的最後一個結果頁面傳回的 nextSyncToken 欄位取得的符記。這會讓這項清單要求的結果只包含自該日期起變更的項目。自上次清單要求刪除的所有項目一律會列入結果集，且不得將 showDeleted 設為 False。
如果 syncToken 到期，伺服器會傳回 410 GONE 回應碼，而用戶端應清除儲存空間，並在沒有任何 syncToken 的情況下執行完整同步作業。
進一步瞭解增量同步處理。
選用。預設會傳回所有項目。

授權

這項要求需要至少具備下列其中一個範圍的授權：

範圍
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.acls
https://www.googleapis.com/auth/calendar.acls.readonly

詳情請參閱「驗證與授權」頁面。

要求主體

請勿透過此方法提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "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 用戶端程式庫。

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

試試看！

您可以使用下方的 API Explorer，針對即時資料呼叫這個方法，然後查看回應。