قوانین موجود در لیست کنترل دسترسی برای تقویم را برمی گرداند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
| نام پارامتر | ارزش | توضیحات |
|---|---|---|
| پارامترهای مسیر | ||
calendarId | string | شناسه تقویم برای بازیابی شناسه های تقویم با روش calendarList.list تماس بگیرید. اگر می‌خواهید به تقویم اصلی کاربر وارد شده در حال حاضر دسترسی داشته باشید، از کلمه کلیدی " primary " استفاده کنید. |
| پارامترهای پرس و جو اختیاری | ||
maxResults | integer | حداکثر تعداد ورودی های بازگشتی در یک صفحه نتیجه. به طور پیش فرض مقدار 100 ورودی است. اندازه صفحه هرگز نمی تواند بزرگتر از 250 ورودی باشد. اختیاری. |
pageToken | string | نشانه ای که مشخص می کند کدام صفحه نتیجه را برگرداند. اختیاری. |
showDeleted | boolean | آیا باید ACL های حذف شده را در نتیجه لحاظ کرد یا خیر. ACLهای حذف شده با role برابر با " none " نشان داده می شوند. اگر syncToken ارائه شود، ACLهای حذف شده همیشه شامل خواهند شد. اختیاری. پیش فرض نادرست است. |
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 ارائه می شود. |
توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).
از کتابخانه سرویس گیرنده جاوا استفاده می کند.
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());
}
از کتابخانه کلاینت پایتون استفاده می کند.
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
از کتابخانه مشتری 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 زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.