CalendarList

مجموعة التقاويم في قائمة التقاويم الخاصة بالمستخدم. يُرجى الاطّلاع أيضًا على مقالة "التقاويم" في مقابل "قائمة التقاويم".

للحصول على قائمة بالطرق لهذا المورد، راجع نهاية هذه الصفحة.

تمثيلات الموارد

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
اسم الموقع القيمة الوصف Notes
accessRole string دور الوصول الفعّال الذي يمتلكه المستخدم الذي تمت المصادقة عليه في التقويم. للقراءة فقط. القيم المتاحة:
  • "freeBusyReader": يوفر هذا الإذن إمكانية وصول للقراءة إلى معلومات الحالة متوفّر/مشغول.
  • "reader" - يوفر حق الوصول للقراءة إلى التقويم. ستظهر الأحداث الخاصة للمستخدمين الذين لديهم إمكانية وصول للقراءة، ولكن سيتم إخفاء تفاصيل الحدث.
  • "writer" - يوفر الإذن بقراءة التقويم والكتابة فيه. ستظهر الأحداث الخاصة للمستخدمين الذين لديهم إذن وصول الكتاب، وستكون تفاصيل الحدث مرئية.
  • "owner" - يوفر ملكية التقويم. يمتلك هذا الدور جميع أذونات دور الكاتب مع إمكانية إضافية رؤية قوائم التحكم في الوصول (ACL) ومعالجتها.
backgroundColor string اللون الرئيسي للتقويم بالتنسيق السداسي العشري "#0088aa". تحل هذه السمة محل خاصية colorId المستندة إلى الفهرس. لضبط هذه السمة أو تغييرها، عليك تحديد colorRgbFormat=true في مَعلمات طرق insert وupdate وpatch. اختياريّ. قابل للكتابة
colorId string لون التقويم. هذا معرّف يشير إلى إدخال في القسم calendar من تعريف الألوان (راجِع نقطة نهاية الألوان). تحلّ السمتان backgroundColor وforegroundColor محلّ هذا الموقع، ويمكن تجاهله عند استخدام هاتين السمتَين. اختياريّ. قابل للكتابة
conferenceProperties nested object خصائص مكالمات الفيديو لهذا التقويم، على سبيل المثال، أنواع المؤتمرات المسموح بها
conferenceProperties.allowedConferenceSolutionTypes[] list أنواع حلول مكالمات الفيديو المتاحة لهذا التقويم.

في ما يلي القيم المحتمَلة:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
اختيارية.

defaultReminders[] list هي التذكيرات التلقائية لدى المستخدم الذي تمت المصادقة عليه في هذا التقويم. قابل للكتابة
defaultReminders[].method string تمثّل هذه السمة الطريقة المستخدمة في هذا التذكير. القيم المتاحة:
  • "email" - يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup": يتم إرسال التذكيرات من خلال نافذة منبثقة لواجهة المستخدم.

مطلوبة عند إضافة تذكير.

قابل للكتابة
defaultReminders[].minutes integer عدد الدقائق قبل بدء الحدث التي يجب تشغيل التذكير خلالها. تتراوح القيم الصالحة بين 0 و40320 (4 أسابيع بالدقائق).

مطلوبة عند إضافة تذكير.

قابل للكتابة
deleted boolean ما إذا تم حذف إدخال قائمة التقويم هذا من قائمة التقويم أم لا. للقراءة فقط. اختياريّ. القيمة التلقائية هي False.
description string وصف التقويم. اختياريّ. للقراءة فقط.
etag etag علامة ETag للمورد.
foregroundColor string لون مقدمة التقويم بالتنسيق السداسي العشري "#ffffff". تحل هذه السمة محل سمة colorId المستندة إلى الفهرس. لضبط هذه السمة أو تغييرها، عليك تحديد colorRgbFormat=true في مَعلمات طرق insert وupdate وpatch. اختياريّ. قابل للكتابة
hidden boolean ما إذا كان التقويم مخفيًا من القائمة. اختياريّ. يتم إرجاع السمة فقط عندما يكون التقويم مخفيًا، وفي هذه الحالة تكون القيمة true. قابل للكتابة
id string معرّف التقويم.
kind string نوع المورد ("calendar#calendarListEntry").
location string الموقع الجغرافي للتقويم كنص مرن. اختياريّ. للقراءة فقط.
notificationSettings object هي الإشعارات التي يتلقاها المستخدم الذي تمت مصادقته لهذا التقويم. قابل للكتابة
notificationSettings.notifications[] list قائمة الإشعارات التي تم ضبطها لهذا التقويم.
notificationSettings.notifications[].method string الطريقة المستخدمة لإرسال الإشعار. القيمة المحتملة هي:
  • "email" - يتم إرسال الإشعارات عبر البريد الإلكتروني.

مطلوبة عند إضافة إشعار.

قابل للكتابة
notificationSettings.notifications[].type string نوع الإشعار. القيم المتاحة:
  • "eventCreation": يتم إرسال إشعار عند وضع حدث جديد في التقويم.
  • "eventChange" - يتم إرسال إشعار عند تغيير حدث.
  • "eventCancellation" - يتم إرسال إشعار عند إلغاء أحد الأحداث.
  • "eventResponse": يتم إرسال إشعار عندما يردّ أحد الضيوف على دعوة الحدث.
  • "agenda" - جدول أعمال يحتوي على أحداث اليوم (يتم إرسالها في الصباح).

مطلوبة عند إضافة إشعار.

قابل للكتابة
primary boolean ما إذا كان التقويم هو التقويم الأساسي للمستخدم الذي تمت مصادقته. للقراءة فقط. اختياريّ. القيمة التلقائية هي False.
selected boolean ما إذا كان محتوى التقويم سيظهر في واجهة مستخدم التقويم. اختياريّ. القيمة التلقائية هي False. قابل للكتابة
summary string عنوان التقويم. للقراءة فقط.
summaryOverride string الملخص الذي ضبطه المستخدم الذي تمت مصادقته لهذا التقويم. اختياريّ. قابل للكتابة
timeZone string المنطقة الزمنية للتقويم. اختياريّ. للقراءة فقط.

الطُرق

حذف
لإزالة تقويم من قائمة التقاويم لدى المستخدم.
الحصول على
عرض تقويم من قائمة التقاويم لدى المستخدم.
إدراج
لإدراج تقويم حالي في قائمة تقويم المستخدم.
list
عرض التقاويم في قائمة التقاويم لدى المستخدم.
حزمة
تحديث تقويم حالي في قائمة تقويم المستخدم تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعة بعلامة update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدّدها في الطلب بدون تغيير. تؤدي حقول المصفوفة، في حال تحديدها، إلى استبدال الصفائف الحالية، ويؤدي هذا إلى إلغاء أي عناصر صفيف سابقة.
تعديل
تحديث تقويم حالي في قائمة تقويم المستخدم
ساعة
انتبِه إلى التغييرات التي تطرأ على موارد CalendarList.