Calendars

مجموعة من جميع التقاويم الحالية يُرجى الاطّلاع أيضًا على 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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
اسم السمة القيمة الوصف ملاحظات
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".) اختياريّ. قابل للكتابة
workingHours object تمثّل هذه السمة المعلومات حول ساعات عمل المستخدم. تتوفّر هذه الميزة للتقاويم الأساسية لمستخدمي Google Workspace فقط. لتعديل ساعات العمل، يجب تمرير عنصر ساعات العمل بالكامل. في حال عدم تحديد ساعات العمل (أو تمريرها كقيمة فارغة أو كائن فارغ)، تبقى ساعات العمل الحالية بدون تغيير. لإيقاف ساعات العمل أو محو الجدول الزمني، اضبط workingHoursEnabled على "خطأ" (واحذف availableTimes أو مرِّر قائمة فارغة). قابل للكتابة
workingHours.availableTimes[] list ساعات العمل وتمثّل كل فترة توفّر مجموعة ساعات عمل المستخدم خلال يوم واحد. قابل للكتابة
workingHours.availableTimes[].dayOfWeek string يوم من الأسبوع الحقل مطلوب. القيم المحتمَلة هي:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
قابل للكتابة
workingHours.availableTimes[].periodEnd integer نهاية الفترة، بالدقائق من بداية اليوم، غير شاملة الحقل مطلوب. قابل للكتابة
workingHours.availableTimes[].periodStart integer بداية الفترة، بالدقائق من بداية اليوم، شاملة الحقل مطلوب. قابل للكتابة
workingHours.workingHoursEnabled boolean ما إذا كانت ساعات العمل مفعَّلة لهذا التقويم لا يمكن ضبط القيمة على "صحيح" عندما يكون حقل "availableTimes" فارغًا. قابل للكتابة

الطُرق

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

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

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