Acl: insert

建立存取權控管規則。立即試用參閱範例

要求

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
https://www.googleapis.com/auth/calendar.acls

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

要求主體

在要求主體中,請提供具有下列屬性的 Acl 資源

屬性名稱 說明 附註
必要屬性
role string 指派給範圍的角色。可能的值包括:
  • none」- 不提供存取權。
  • freeBusyReader」:提供空閒/忙碌資訊的讀取權。
  • reader」:提供日曆的讀取存取權。私人活動會向具有讀取權限的使用者顯示,但活動詳細資料會隱藏。
  • writer」:提供日曆的讀取及寫入存取權。私人活動會顯示給擁有編輯者存取權的使用者,且可查看活動詳細資料。
  • owner」:提供日曆的擁有權。這個角色具有「作者」角色的所有權限,並可查看及操作 ACL。
可寫入
scope object 這項 ACL 規則授予的日曆存取權程度。
scope.type string 範圍的類型。可能的值包括:
  • default」- 公開範圍。這是預設值。
  • user」:將範圍限制為單一使用者。
  • group」:將範圍限制為群組。
  • domain」- 將範圍限制為一個網域。
注意:授予「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 用戶端程式庫

rule = Google::Apis::CalendarV3::AclRule.new(
  scope: {
    type: 'scopeType',
    value: 'scopeEmail',
  },
  role: 'role'
)
result = client.insert_acl('primary', rule)
print result.id

試試看!

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