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
    ]
  }
}
اسم الموقع القيمة الوصف ملاحظات
accessRole string دور الوصول الفعّال الذي يمتلكه المستخدم الذي تمت المصادقة عليه في التقويم. للقراءة فقط. القيم المتاحة:
  • "freeBusyReader" - يوفر حق الوصول للقراءة إلى معلومات الحالة متوفّر/مشغول.
  • "reader" - توفر الإذن بقراءة التقويم. وستظهر الأحداث الخاصة للمستخدمين الذين لديهم إذن وصول القرّاء، ولكن سيتم إخفاء تفاصيلها.
  • "writer" - توفر الإذن بالقراءة والكتابة في التقويم. وستظهر الأحداث الخاصة للمستخدمين الذين لديهم إذن وصول المؤلف، وستظهر تفاصيل الحدث.
  • "owner" - توفير ملكية التقويم. ويشمل هذا الدور جميع الأذونات الممنوحة لدور الكاتب بالإضافة إلى إمكانية الاطّلاع على قوائم التحكم بالوصول (ACLs) ومعالجتها.
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.