カレンダーのアクセス制御リスト内のルールを返します。今すぐ試すまたは例を見る。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
calendarId |
string |
カレンダー ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary 」キーワードを使用します。
|
省略可能なクエリ パラメータ | ||
maxResults |
integer |
1 つの結果ページで返されるエントリの最大数。デフォルトでは、値は 100 エントリです。ページサイズは 250 エントリを超えることはできません。省略可能。 |
pageToken |
string |
返される結果ページを指定するトークン。省略可能。 |
showDeleted |
boolean |
削除された ACL を結果に含めるかどうか。削除された ACL は、「none 」に等しい role で表されます。syncToken が指定されている場合、削除された ACL は常に含まれます。省略可。デフォルトは False です。
|
syncToken |
string |
前のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。これにより、このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれます。前回のリスト リクエスト以降に削除されたエントリはすべて、常に結果セットに含まれます。showDeleted を False に設定することはできません。syncToken が期限切れになると、サーバーは 410 GONE レスポンス コードで応答します。クライアントはストレージを消去し、syncToken なしで完全同期を実行する必要があります。増分同期の詳細 省略可。デフォルトでは、すべてのエントリが返されます。 |
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
範囲 |
---|
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
Ruby クライアント ライブラリを使用します。
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。