Acl: list

ملاحظة: يجب تقديم تفويض.

لعرض القواعد في قائمة التحكم بالوصول إلى التقويم. جرِّبه الآن أو شاهد مثالاً.

الطلب

طلب HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl

المَعلمات

اسم المعلَمة	القيمة	الوصف
مَعلمات المسار
calendarId	string	معرِّف التقويم. لاسترداد معرّفات التقويم، يمكنك استدعاء الطريقة calendarList.list. إذا كنت تريد الوصول إلى التقويم الأساسي للمستخدم المسجّل دخوله حاليًا، استخدِم الكلمة الرئيسية "primary".
مَعلمات طلب البحث الاختيارية
maxResults	integer	أقصى عدد للإدخالات التي يتم عرضها في صفحة نتائج واحدة. القيمة التلقائية هي 100 إدخال. لا يمكن أبدًا أن يتجاوز حجم الصفحة 250 إدخالاً. اختياريّ.
pageToken	string	رمز مميز يحدد صفحة النتائج المراد عرضها اختياريّ.
showDeleted	boolean	ما إذا كان سيتم تضمين قوائم التحكم بالوصول المحذوفة في النتيجة أم لا. يتم تمثيل قوائم التحكم بالوصول المحذوفة بـ role يساوي "none". وسيتم دائمًا تضمين قوائم التحكم بالوصول المحذوفة إذا تم توفير syncToken. اختياريّ. القيمة التلقائية هي False.
syncToken	string	تم الحصول على رمز مميّز من الحقل nextSyncToken في الصفحة الأخيرة من النتائج من طلب القائمة السابق. ويجعل نتيجة طلب القائمة هذا تحتوي فقط على الإدخالات التي تم تغييرها منذ ذلك الحين. تم حذف جميع الإدخالات لأن طلب القائمة السابق سيظل دائمًا في مجموعة النتائج، ولا يُسمح بضبط showDeleted على "خطأ". إذا انتهت صلاحية syncToken، سيستجيب الخادم برمز الاستجابة 410 GONE، ويجب على العميل محو مساحة التخزين وإجراء مزامنة كاملة بدون استخدام syncToken. مزيد من المعلومات حول المزامنة التزايدية اختيارية. الإعداد التلقائي هو عرض جميع الإدخالات.

التفويض

يتطلب هذا الطلب تفويضًا بالنطاق التالي:

النطاق
https://www.googleapis.com/auth/calendar

للحصول على مزيد من المعلومات، يُرجى الاطّلاع على صفحة المصادقة والتفويض.

نص الطلب

لا توفِّر نص طلب بهذه الطريقة.

الإجابة

في حال نجاحها، تعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "calendar#acl",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    acl Resource
  ]
}

اسم الموقع	القيمة	الوصف	Notes
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

تجربة

يمكنك استخدام مستكشف واجهات برمجة التطبيقات أدناه لطلب هذه الطريقة على البيانات المباشرة والاطّلاع على الاستجابة.