CalendarList

مجموعة التقاويم في قائمة تقاويم المستخدم. راجِع أيضًا التقاويم مقابل CalendarList.

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

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

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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
    ]
  }
}
اسم السمة القيمة الوصف ملاحظات
accessRole string دور الوصول الفعّال الذي يملكه المستخدم الذي تمت المصادقة عليه في التقويم. للقراءة فقط. القيم المحتمَلة هي:
  • "freeBusyReader": يتيح إذن القراءة لمعلومات وقت الانشغال/التفرغ.
  • "reader": يتيح هذا الإذن الوصول إلى التقويم للقراءة فقط. ستظهر الأحداث الخاصة للمستخدمين الذين لديهم إذن الوصول للقراءة، ولكن سيتم إخفاء تفاصيل الحدث.
  • "writer": يتيح هذا النطاق إمكانية القراءة والكتابة في التقويم. ستظهر الأحداث الخاصة للمستخدمين الذين لديهم إذن الوصول ككاتب، وستكون تفاصيل الحدث مرئية.
  • "owner": يمنح المدير إذن الوصول إلى التقويم. يتمتع هذا الدور بجميع أذونات دور "الكاتب" مع إمكانية إضافية تتمثّل في الاطّلاع على مستويات وصول المستخدمين الآخرين وتعديلها.

backgroundColor string اللون الأساسي للتقويم بتنسيق سداسي عشري "#0088aa". تحلّ هذه السمة محل السمة colorId المستندة إلى الفهرس. لضبط هذه السمة أو تغييرها، عليك تحديد colorRgbFormat=true في مَعلمات طرق الإدراج والتعديل والتعديل الجزئي. اختيارية: قابل للكتابة
colorId string لون التقويم هذا هو رقم التعريف الذي يشير إلى إدخال في القسم calendar من تعريف الألوان (راجِع نقطة نهاية الألوان). تم استبدال هذه السمة بالسمتَين backgroundColor وforegroundColor، ويمكن تجاهلها عند استخدام هاتين السمتَين. اختيارية: قابل للكتابة
conferenceProperties nested object سمات المؤتمرات لهذا التقويم، مثل أنواع المؤتمرات المسموح بها
conferenceProperties.allowedConferenceSolutionTypes[] list تمثّل هذه السمة أنواع حلول المؤتمرات المتوافقة مع هذا التقويم.

القيم المحتملة هي:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
اختياري.
dataOwner string عنوان البريد الإلكتروني لمالك التقويم يتم ضبط هذا الخيار للتقاويم الثانوية فقط. للقراءة فقط.
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 في مَعلمات طرق الإدراج والتعديل والتعديل الجزئي. اختيارية: قابل للكتابة
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
تعرض هذه الطريقة التقاويم في قائمة تقاويم المستخدم.
patch
تعدّل هذه الطريقة تقويمًا حاليًا في قائمة تقاويم المستخدم. تتيح هذه الطريقة استخدام دلالات التصحيح. يُرجى العِلم أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، لذا يُفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لم تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول المصفوفة، سيتم استبدال المصفوفات الحالية، ما يؤدي إلى تجاهل أي عناصر مصفوفة سابقة.
تعديل
تعدّل هذه الطريقة تقويمًا حاليًا في قائمة تقاويم المستخدم.
watch
مراقبة التغييرات التي تطرأ على موارد CalendarList: