Calendars

مجموعة من جميع التقاويم الحالية راجِع أيضًا التقاويم مقابل CalendarList.

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

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

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
اسم السمة القيمة الوصف ملاحظات
autoAcceptInvitations boolean تُستخدَم لتحديد ما إذا كان هذا التقويم يقبل الدعوات تلقائيًا. لا يمكن استخدامها إلا مع تقاويم الموارد.
conferenceProperties nested object سمات المؤتمرات لهذا التقويم، مثل أنواع المؤتمرات المسموح بها
conferenceProperties.allowedConferenceSolutionTypes[] list تمثّل هذه السمة أنواع حلول المؤتمرات المتوافقة مع هذا التقويم.

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

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

dataOwner string عنوان البريد الإلكتروني لمالك التقويم يتم ضبط هذا الخيار للتقاويم الثانوية فقط. للقراءة فقط.
description string وصف التقويم اختياريّ. قابل للكتابة
etag etag تمثّل هذه السمة علامة ETag الخاصة بالمرجع.
id string معرّف التقويم لاسترداد أرقام التعريف، استدعِ طريقة calendarList.list().
kind string نوع المورد ("calendar#calendar")
labelProperties nested object سمات التصنيفات المحدّدة في هذا التقويم في حال تحديدها، سيتم استبدال خصائص التصنيف الحالية. في حال عدم تحديدها، ستبقى خصائص التصنيف بدون تغيير. قابل للكتابة
labelProperties.eventLabels[] list تصنيفات الأحداث المحدّدة في هذا التقويم إذا كان هذا الحقل متوفّرًا عند تعديل التقويم، سيتم استبدال تصنيفات الأحداث الحالية به.

وسِّع القائمة لإضافة تصنيف جديد للأحداث، وأزِل الكيانات من القائمة لحذف تصنيف من التقويم.

يمكن أن يحتوي كل تقويم على 200 تصنيف كحد أقصى.

قابل للكتابة
labelProperties.eventLabels[].backgroundColor string لون خلفية التصنيف بتنسيق سداسي عشري، مثل "#039be5" يتم عرض الأحداث التي تحمل هذا التصنيف بهذا اللون. الحقل مطلوب. قابل للكتابة
labelProperties.eventLabels[].id string معرّف التصنيف اختياري عند إدراج تصنيف جديد في حال عدم توفيره، سيتم إنشاء معرّف فريد. مطلوب عند تعديل تصنيف.

في حال توفّره، يجب أن يكون المعرّف فريدًا ضمن التقويم وأن يتّبع تنسيق UUID.

قابل للكتابة
labelProperties.eventLabels[].name string اسم التصنيف. اختياريّ.

يجب ألا يزيد عدد الأحرف عن 50 حرفًا في حال توفُّرها.

قابل للكتابة
location string الموقع الجغرافي للتقويم كنص حر اختياريّ. قابل للكتابة
summary string عنوان التقويم قابل للكتابة
timeZone string المنطقة الزمنية للتقويم (يتم تنسيقه كاسم في "قاعدة بيانات المناطق الزمنية IANA"، مثلاً "Europe/Zurich"). اختياريّ. قابل للكتابة

الطُرق

محو
يمحو تقويمًا أساسيًا. تؤدي هذه العملية إلى حذف جميع الأحداث المرتبطة بالتقويم الأساسي لأحد الحسابات.
حذف
لحذف تقويم ثانوي استخدِم calendars.clear لمحو جميع الأحداث في التقاويم الأساسية.
الحصول على
تعرض هذه الطريقة البيانات الوصفية الخاصة بتقويم.
إدراج
تنشئ هذه الطريقة تقويمًا ثانويًا.

يصبح المستخدم الذي تمّت المصادقة عليه في الطلب هو مالك البيانات في التقويم الجديد.

patch
تعديل البيانات الوصفية لتقويم تتيح هذه الطريقة استخدام دلالات التصحيح. يُرجى العِلم أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، لذا يُفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محل القيم الحالية. تبقى الحقول التي لم تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول المصفوفة، سيتم استبدال المصفوفات الحالية، ما يؤدي إلى تجاهل أي عناصر مصفوفة سابقة.
transferOwnership
تنقل هذه الطريقة تقويمًا ثانويًا بين المستخدمين داخل مؤسسة Google Workspace. يتطلب مصادقة المستخدم من خلال امتياز مشرف إدارة التقاويم، وأحد نطاقات التفويض التالية:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
في الطلب، اضبط قيمة useAdminAccess على true. يجب أن يكون التقويم الثانوي نشطًا ليتم نقله. لا يمكن نقل التقاويم التي تم إيقافها أو حذفها.
تعديل
تعديل البيانات الوصفية لتقويم