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

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

要求主體

請勿使用這個方法提供請求主體。

回應

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

{
  "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

試試看!

使用下方的 APIs Explorer,針對即時資料呼叫這個方法,看看會有什麼結果。