アクセス制御ルールを作成します。 今すぐ試すまたは例を見る。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
calendarId |
string |
カレンダーの ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary 」を使用します。できます。
|
省略可能なクエリ パラメータ | ||
sendNotifications |
boolean |
カレンダー共有の変更に関する通知を送信するかどうか。省略可。デフォルトは True です。 |
承認
このリクエストには、次のスコープによる認証が必要です。
スコープ |
---|
https://www.googleapis.com/auth/calendar |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
リクエストの本文には、次のプロパティを使用して Acl リソースを指定します。
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
必須プロパティ | |||
role |
string |
スコープに割り当てられたロール。有効な値は次のとおりです。
|
書き込み可能 |
scope |
object |
この ACL ルールによって許可されるカレンダー アクセスの範囲。 | |
scope.type |
string |
スコープのタイプ。有効な値は次のとおりです。
default 」(公開)スコープに付与された権限は、認証されているかどうかに関係なく、すべてのユーザーに適用されます。 |
|
省略可能なプロパティ | |||
scope.value |
string |
スコープのタイプに応じて、ユーザーまたはグループのメールアドレス、またはドメインの名前。タイプ「default 」の場合は省略します。 |
書き込み可能 |
レスポンス
成功すると、このメソッドはレスポンスの本文で Acl リソースを返します。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
import com.google.api.services.calendar.Calendar; 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(); // Create access rule with associated scope AclRule rule = new AclRule(); Scope scope = new Scope(); scope.setType("scopeType").setValue("scopeValue"); rule.setScope(scope).setRole("role"); // Insert new access rule AclRule createdRule = service.acl().insert('primary', rule).execute(); System.out.println(createdRule.getId());
Python
Python クライアント ライブラリを使用します。
rule = { 'scope': { 'type': 'scopeType', 'value': 'scopeEmail', }, 'role': 'role' } created_rule = service.acl().insert(calendarId='primary', body=rule).execute() print created_rule['id']
PHP
PHP クライアント ライブラリを使用します。
$rule = new Google_Service_Calendar_AclRule(); $scope = new Google_Service_Calendar_AclRuleScope(); $scope->setType("scopeType"); $scope->setValue("scopeValue"); $rule->setScope($scope); $rule->setRole("role"); $createdRule = $service->acl->insert('primary', $rule); echo $createdRule->getId();
Ruby
Ruby クライアント ライブラリを使用します。
rule = Google::Apis::CalendarV3::AclRule.new( scope: { type: 'scopeType', value: 'scopeEmail', }, role: 'role' ) result = client.insert_acl('primary', rule) print result.id
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。