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
  ]
}

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

جرّب الآن

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