Events

توفّر واجهة برمجة التطبيقات Calendar API نكهات مختلفة لموارد الأحداث، ويمكنك العثور على مزيد من المعلومات في لمحة عن الأحداث.

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

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

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
اسم الموقع القيمة الوصف Notes
anyoneCanAddSelf boolean ما إذا كان بإمكان أي شخص دعوة نفسه إلى الحدث (متوقف). اختياريّ. والقيمة التلقائية هي "خطأ". قابل للكتابة
attachments[] list مرفقات الملفات الخاصة بالحدث

لتعديل المرفقات، يجب ضبط معلَمة الطلب supportsAttachments على true.

يمكن إضافة 25 مرفقًا كحدّ أقصى لكل حدث

attachments[].fileId string رقم تعريف الملف المرفق. للقراءة فقط

بالنسبة إلى ملفات Google Drive، هذا هو رقم تعريف إدخال المورد المقابل في Files في Drive API.

attachments[].fileUrl string عنوان URL المؤدي إلى المرفق.

لإضافة مرفقات ملفات من Google Drive، استخدِم التنسيق نفسه المستخدَم في السمة alternateLink في المورد Files في Drive API.

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

قابل للكتابة
attachments[].mimeType string نوع وسائط الإنترنت (نوع MIME) المرفق
attachments[].title string عنوان المرفق.
attendeesOmitted boolean تُستخدَم لتحديد ما إذا كان قد تم حذف الضيوف من تمثيل الحدث. عند استرداد حدث، قد يرجع ذلك إلى قيود تحدّدها مَعلمة طلب البحث maxAttendee. عند تحديث حدث، يمكن استخدام ذلك لتحديث رد المشارك فقط. اختياريّ. والقيمة التلقائية هي "خطأ". قابل للكتابة
attendees[] list المشاركون في الفعالية. يمكنك الاطّلاع على دليل الأحداث التي يشارك فيها ضيوف للحصول على مزيد من المعلومات حول جدولة الأحداث مع مستخدمي التقويم الآخرين. يجب أن تستخدم حسابات الخدمة تفويض المرجع على مستوى النطاق لتعبئة قائمة الضيوف. قابل للكتابة
attendees[].additionalGuests integer عدد النزلاء الإضافيين اختياريّ. والقيمة التلقائية هي 0. قابل للكتابة
attendees[].comment string التعليق على ردّ الضيف اختياريّ. قابل للكتابة
attendees[].displayName string تشير هذه السمة إلى اسم الضيف، إذا كان متوفّرًا. اختياريّ. قابل للكتابة
attendees[].email string عنوان البريد الإلكتروني للضيف، إذا كان متاحًا يجب أن يكون هذا الحقل متاحًا عند إضافة ضيف. ويجب أن يكون عنوان بريد إلكتروني صالحًا وفق RFC5322.

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

قابل للكتابة
attendees[].id string رقم تعريف الملف الشخصي للضيف، إذا كان متاحًا.
attendees[].optional boolean ما إذا كان هذا الحاضر اختياريًا. اختياريّ. والقيمة التلقائية هي "خطأ". قابل للكتابة
attendees[].organizer boolean تُستخدَم لتحديد ما إذا كان الضيف هو منظِّم الحدث. للقراءة فقط والقيمة التلقائية هي "خطأ".
attendees[].resource boolean تُستخدَم لتحديد ما إذا كان الضيف مصدرًا. لا يمكن ضبط هذا الإعداد إلا عند إضافة الضيف إلى الحدث للمرة الأولى. ويتم تجاهل التعديلات اللاحقة. اختياريّ. والقيمة التلقائية هي "خطأ". قابل للكتابة
attendees[].responseStatus string حالة ردّ الضيف القيم المتاحة:
  • "needsAction" - لم يردّ الضيف على الدعوة (وهذا الإجراء مقترَح للأحداث الجديدة).
  • "declined" - رفض الضيف الدعوة.
  • "tentative" - قبل الضيف الدعوة بشكل مبدئي.
  • "accepted" - قبل الضيف الدعوة.
قابل للكتابة
attendees[].self boolean ما إذا كان هذا الإدخال يمثل التقويم الذي تظهر فيه هذه النسخة من الحدث. للقراءة فقط والقيمة التلقائية هي "خطأ".
colorId string لون الحدث هذا معرّف يشير إلى إدخال في القسم event من تعريف الألوان (راجِع نقطة نهاية الألوان). اختياريّ. قابل للكتابة
conferenceData nested object المعلومات المتعلقة بمكالمات الفيديو، مثل تفاصيل مكالمة فيديو على Google Meet لإنشاء تفاصيل جديدة لمكالمات الفيديو، استخدِم الحقل createRequest. للاستمرار في إجراء التغييرات، تذكّر ضبط مَعلمة طلب conferenceDataVersion على 1 لجميع طلبات تعديل الأحداث. قابل للكتابة
conferenceData.conferenceId string رقم تعريف المؤتمر.

يمكن للمطوّرين استخدامها لتتبُّع مكالمات الفيديو، ويجب عدم عرضها للمستخدمين.

يتم تكوين قيمة المعرّف بشكل مختلف لكل نوع من أنواع حلّ مكالمات الفيديو:

  • eventHangout: لم يتم ضبط رقم التعريف. (تم إيقاف نوع مكالمات الفيديو هذا نهائيًا.)
  • eventNamedHangout: المعرف هو اسم جلسة Hangout. (تم إيقاف نوع مكالمات الفيديو هذا نهائيًا.)
  • hangoutsMeet: المعرّف هو رمز الاجتماع المكوّن من 10 أحرف، على سبيل المثال aaa-bbbb-ccc.
  • addOn: يُحدِّد مقدّم الخدمة التابع لطرف ثالث المعرّف.
اختيارية.

conferenceData.conferenceSolution nested object حل مكالمات الفيديو، مثل Google Meet.

يتم إلغاء الضبط لمكالمة فيديو بسبب تعذُّر طلب الإنشاء.

يجب توفير السمة conferenceSolution وسمة entryPoint واحدة على الأقل أو createRequest.

conferenceData.conferenceSolution.iconUri string تمثّل هذه السمة الرمز الظاهر للمستخدم لهذا الحلّ.
conferenceData.conferenceSolution.key nested object المفتاح الذي يمكنه تحديد حل المؤتمرات لهذا الحدث بشكل فريد.
conferenceData.conferenceSolution.key.type string نوع حلّ المؤتمر

إذا صادف العميل نوعًا غير مألوف أو فارغًا، يجب أن يظل قادرًا على عرض نقاط الدخول. ومع ذلك، يجب أن تمنع التعديلات.

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

  • "eventHangout" لمنصة Hangouts للمستهلكين (تم إيقافها نهائيًا، وقد تعرض الفعاليات الحالية هذا النوع من حلول مكالمات الفيديو، ولكن لا يمكن إنشاء مكالمات فيديو جديدة)
  • "eventNamedHangout" لمستخدمي تطبيق Google Workspace الكلاسيكي (تم إيقافه نهائيًا، وقد تعرض الأحداث الحالية هذا النوع من حلول مكالمات الفيديو، ولكن لا يمكن إنشاء مكالمات فيديو جديدة)
  • "hangoutsMeet" لتطبيق Google Meet (http://meet.google.com)
  • "addOn" لمقدّمي مكالمات الفيديو التابعين لجهات خارجية

conferenceData.conferenceSolution.name string تمثّل هذه السمة اسم هذا الحلّ مرئيًا للمستخدم. غير مترجَمة.
conferenceData.createRequest nested object طلب لإنشاء مكالمة فيديو جديدة وإرفاقها بالحدث. يتم إنشاء البيانات بشكل غير متزامن. لمعرفة ما إذا كانت البيانات متوفرة، راجِع الحقل status.

يجب توفير السمة conferenceSolution وسمة entryPoint واحدة على الأقل أو createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object حل المؤتمرات، مثل Hangouts أو Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string نوع حلّ المؤتمر

إذا صادف العميل نوعًا غير مألوف أو فارغًا، يجب أن يظل قادرًا على عرض نقاط الدخول. ومع ذلك، يجب أن تمنع التعديلات.

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

  • "eventHangout" لمنصة Hangouts للمستهلكين (تم إيقافها نهائيًا، وقد تعرض الفعاليات الحالية هذا النوع من حلول مكالمات الفيديو، ولكن لا يمكن إنشاء مكالمات فيديو جديدة)
  • "eventNamedHangout" لمستخدمي تطبيق Google Workspace الكلاسيكي (تم إيقافه نهائيًا، وقد تعرض الأحداث الحالية هذا النوع من حلول مكالمات الفيديو، ولكن لا يمكن إنشاء مكالمات فيديو جديدة)
  • "hangoutsMeet" لتطبيق Google Meet (http://meet.google.com)
  • "addOn" لمقدّمي مكالمات الفيديو التابعين لجهات خارجية

conferenceData.createRequest.requestId string المعرِّف الفريد الذي ينشئه العميل لهذا الطلب.

وعلى العملاء إعادة إنشاء هذا المعرّف لكلّ طلب جديد. إذا كان رقم التعريف المقدَّم مطابقًا للرقم التعريفي للطلب السابق، يتم تجاهل الطلب.

conferenceData.createRequest.status nested object حالة طلب إنشاء مكالمة الفيديو.
conferenceData.createRequest.status.statusCode string الحالة الحالية لطلب إنشاء مكالمة الفيديو. للقراءة فقط

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

  • "pending": لا يزال طلب إنشاء مكالمة الفيديو قيد المعالجة.
  • "success": تم تنفيذ طلب إنشاء مكالمة الفيديو بنجاح، وتمت تعبئة نقاط الدخول.
  • "failure": تعذّر طلب إنشاء مكالمة الفيديو، ما مِن نقاط دخول.

conferenceData.entryPoints[] list معلومات حول نقاط دخول مكالمات الفيديو الفردية، مثل عناوين URL أو أرقام الهواتف

يجب أن تنتمي جميعها إلى نفس المؤتمر.

يجب توفير السمة conferenceSolution وسمة entryPoint واحدة على الأقل أو createRequest.

conferenceData.entryPoints[].accessCode string رمز الدخول للدخول إلى مكالمة الفيديو. الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا.

عند إنشاء بيانات مكالمات فيديو جديدة، يجب تعبئة المجموعة الفرعية فقط من الحقول {meetingCode, accessCode, passcode, password, pin} التي تتطابق مع المصطلحات التي يستخدمها مقدّم خدمة مكالمات الفيديو. يجب عرض الحقول التي تمت تعبئتها فقط.

اختياريّ.

conferenceData.entryPoints[].entryPointType string تمثّل هذه السمة نوع نقطة دخول المؤتمر.

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

  • "video" - الانضمام إلى مكالمة فيديو عبر HTTP لا يمكن أن تحتوي مكالمة الفيديو على نقطة دخول واحدة أو يمكن أن تحتوي على نقطة دخول video واحدة.
  • "phone" - الانضمام إلى مكالمة فيديو عن طريق طلب رقم هاتف لا يمكن أن تحتوي مكالمة الفيديو على أي نقطة دخول أو أكثر من نقاط phone.
  • "sip" - الانضمام إلى مكالمة فيديو عبر SIP. لا يمكن أن تحتوي مكالمة الفيديو على نقطة دخول واحدة أو يمكن أن تحتوي على نقطة دخول sip واحدة.
  • "more" - تعليمات إضافية للانضمام إلى مكالمات الفيديو، مثل أرقام الهواتف الإضافية لا يمكن أن تحتوي مكالمة الفيديو على نقطة دخول واحدة أو يمكن أن تحتوي على نقطة دخول more واحدة. يُرجى العِلم أنّ مكالمة الفيديو التي تتضمن نقطة دخول more فقط لا تُعتبر صالحة.

conferenceData.entryPoints[].label string تصنيف معرف الموارد المنتظم (URI). مرئية للمستخدمين النهائيين. غير مترجَمة. الحد الأقصى لعدد الأحرف المسموح به هو 512 حرفًا.

أمثلة:

  • لـ video: meet.google.com/aaa-bbbb-ccc
  • لِـ phone: +1 123 268 2601
  • لـ sip: 12345678@altostrat.com
  • لـ more: يجب عدم ملء هذا الحقل

اختياريّ.

conferenceData.entryPoints[].meetingCode string رمز الاجتماع للدخول إلى مكالمة الفيديو. الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا.

عند إنشاء بيانات مكالمات فيديو جديدة، يجب تعبئة المجموعة الفرعية فقط من الحقول {meetingCode, accessCode, passcode, password, pin} التي تتطابق مع المصطلحات التي يستخدمها مقدّم خدمة مكالمات الفيديو. يجب عرض الحقول التي تمت تعبئتها فقط.

اختياريّ.

conferenceData.entryPoints[].passcode string رمز المرور للدخول إلى مكالمة الفيديو. الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا.

عند إنشاء بيانات مكالمات فيديو جديدة، يجب تعبئة المجموعة الفرعية فقط من الحقول {meetingCode, accessCode, passcode, password, pin} التي تتطابق مع المصطلحات التي يستخدمها مقدّم خدمة مكالمات الفيديو. يجب عرض الحقول التي تمت تعبئتها فقط.

conferenceData.entryPoints[].password string كلمة المرور للدخول إلى المؤتمر. الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا.

عند إنشاء بيانات مكالمات فيديو جديدة، يجب تعبئة المجموعة الفرعية فقط من الحقول {meetingCode, accessCode, passcode, password, pin} التي تتطابق مع المصطلحات التي يستخدمها مقدّم خدمة مكالمات الفيديو. يجب عرض الحقول التي تمت تعبئتها فقط.

اختياريّ.

conferenceData.entryPoints[].pin string رقم التعريف الشخصي للدخول إلى مكالمة الفيديو. الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا.

عند إنشاء بيانات مكالمات فيديو جديدة، يجب تعبئة المجموعة الفرعية فقط من الحقول {meetingCode, accessCode, passcode, password, pin} التي تتطابق مع المصطلحات التي يستخدمها مقدّم خدمة مكالمات الفيديو. يجب عرض الحقول التي تمت تعبئتها فقط.

اختياريّ.

conferenceData.entryPoints[].uri string تمثّل هذه السمة معرّف الموارد المنتظم (URI) لنقطة الدخول. الحد الأقصى لعدد الأحرف المسموح به هو 1300 حرف.

طبيعة الحضور:

  • يجب توفّر مخطط video أو http: أو https:.
  • بالنسبة إلى phone، يجب إدخال مخطط tel:. يجب أن يتضمّن معرّف الموارد المنتظم (URI) تسلسل الاتصال بالكامل (مثل tel:+12345678900,,,123456789;1234).
  • يجب توفير مخطط sip: لـ sip، مثل sip:12345678@myprovider.com.
  • يجب توفّر مخطط more أو http: أو https:.

conferenceData.notes string ملاحظات إضافية (مثل التعليمات من مشرف النطاق والإشعارات القانونية) لعرضها للمستخدم يمكن أن تحتوي على HTML. الحد الأقصى لعدد الأحرف المسموح به هو 2048 حرفًا. اختياريّ.
conferenceData.signature string توقيع بيانات مكالمة الفيديو.

تم إنشاؤه من جهة الخادم.

يتم إلغاء الضبط لمكالمة فيديو بسبب تعذُّر طلب الإنشاء.

اختيارية لمكالمات الفيديو التي تتضمّن طلب إنشاء في انتظار المراجعة.

created datetime وقت إنشاء الحدث (كطابع زمني RFC3339) للقراءة فقط
creator object منشئ الحدث. للقراءة فقط
creator.displayName string تشير هذه السمة إلى اسم صانع المحتوى، إذا كان متوفّرًا.
creator.email string عنوان البريد الإلكتروني الخاص بصانع المحتوى، إذا كان متاحًا
creator.id string رقم تعريف الملف الشخصي الخاص بصانع المحتوى، إذا كان متوفّرًا
creator.self boolean ما إذا كان منشئ الحدث متوافقًا مع التقويم الذي تظهر فيه هذه النسخة من الحدث للقراءة فقط والقيمة التلقائية هي "خطأ".
description string تمثّل هذه السمة وصف الفعالية. يمكن أن تحتوي على HTML. اختياريّ. قابل للكتابة
end nested object تمثّل هذه السمة وقت انتهاء الحدث (الحصري). بالنسبة إلى حدث متكرر، هذا هو وقت انتهاء الحدث الأول.
end.date date التاريخ، بالتنسيق "yyyy-mm-dd"، إذا كان هذا الحدث يستمر طوال اليوم. قابل للكتابة
end.dateTime datetime الوقت، كقيمة مجمّعة للتاريخ والوقت (بتنسيق RFC3339). يجب معادلة المنطقة الزمنية ما لم يتم تحديد منطقة زمنية صراحةً في timeZone. قابل للكتابة
end.timeZone string المنطقة الزمنية التي يتم تحديد الوقت فيها. (منسق كاسم قاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثل "أوروبا/زيورخ"). بالنسبة إلى الأحداث المتكرّرة، يكون هذا الحقل مطلوبًا، ويحدّد المنطقة الزمنية التي يتم توسيع التكرار فيها. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبداية الحدث أو نهايته. قابل للكتابة
endTimeUnspecified boolean ما إذا كان وقت الانتهاء غير محدَّد فعليًا ويبقى يتوفر وقت انتهاء لأسباب تتعلق بالتوافق، حتى في حال ضبط هذه السمة على "صحيح". والقيمة التلقائية هي "خطأ".
etag etag علامة ETag للمورد.
eventType string النوع المحدّد للحدث لا يمكن تعديل هذا الاسم بعد إنشاء الحدث. القيم المتاحة:
  • "default" - حدث عادي أو لم يتم تحديده بعد
  • "outOfOffice" - حدث خارج المكتب.
  • "focusTime": حدث لوقت التركيز
  • "workingLocation": حدث في مكان العمل
قابل للكتابة
extendedProperties object السمات الموسّعة للحدث.
extendedProperties.private object الخصائص الخاصة بنسخة الحدث الذي يظهر في هذا التقويم. قابل للكتابة
extendedProperties.private.(key) string اسم الملكية الخاصة والقيمة المقابلة لها.
extendedProperties.shared object الخصائص التي تتم مشاركتها بين نُسخ الحدث في تقاويم الضيوف الآخرين. قابل للكتابة
extendedProperties.shared.(key) string اسم الموقع المشترك والقيمة المقابلة له.
focusTimeProperties nested object بيانات أحداث وقت التركيز تُستخدَم إذا كانت قيمة eventType هي focusTime. قابل للكتابة
focusTimeProperties.autoDeclineMode string ما إذا كان سيتم رفض دعوات الاجتماعات التي تتداخل مع أحداث وقت التركيز. والقيم الصالحة هي declineNone، ما يعني أنه لا يتم رفض أي دعوات اجتماعات، declineAllConflictingInvitations، ما يعني أنه يتم رفض جميع دعوات الاجتماعات المتعارضة التي تتعارض مع الحدث، وdeclineOnlyNewConflictingInvitations، ما يعني أنه سيتم رفض فقط دعوات الاجتماعات الجديدة المتعارضة التي تصل أثناء وجود حدث وقت التركيز.
focusTimeProperties.chatStatus string حالة وضع علامة على المستخدم في Chat والمنتجات ذات الصلة يمكن أن يكون إما available أو doNotDisturb.
focusTimeProperties.declineMessage string رسالة الرد لضبط ما إذا كان "تقويم Google" يرفض تلقائيًا حدثًا حاليًا أو دعوة جديدة.
gadget object أداة تمدِّد هذا الحدث تم إيقاف الأدوات، حيث يتم استخدام هذه البنية فقط لعرض البيانات الوصفية لتقويم عيد الميلاد.
gadget.display string وضع عرض الأداة. تمّ الإيقاف. القيم المتاحة:
  • "icon" - يتم عرض الأداة إلى جانب عنوان الحدث في عرض التقويم.
  • "chip" - يتم عرض الأداة عند النقر على الحدث.
قابل للكتابة
gadget.height integer ارتفاع الأداة بالبكسل. يجب أن يكون الارتفاع عددًا صحيحًا أكبر من 0. اختياريّ. تمّ الإيقاف. قابل للكتابة
gadget.preferences object الإعدادات المفضّلة. قابل للكتابة
gadget.preferences.(key) string اسم الخيار المفضّل والقيمة المناظرة
gadget.title string عنوان الأداة. تمّ الإيقاف. قابل للكتابة
gadget.type string نوع الأداة. تمّ الإيقاف. قابل للكتابة
gadget.width integer عرض الأداة بالبكسل. يجب أن يكون العرض عددًا صحيحًا أكبر من 0. اختياريّ. تمّ الإيقاف. قابل للكتابة
guestsCanInviteOthers boolean ما إذا كان بإمكان الضيوف غير المنظِّم دعوة الآخرين إلى الحدث اختياريّ. والقيمة التلقائية هي "صحيح". قابل للكتابة
guestsCanModify boolean ما إذا كان بإمكان الضيوف غير المنظِّم تعديل الحدث اختياريّ. والقيمة التلقائية هي "خطأ". قابل للكتابة
guestsCanSeeOtherGuests boolean ما إذا كان بإمكان الضيوف، غير المنظِّم، معرفة الحاضرين في الحدث. اختياريّ. والقيمة التلقائية هي "صحيح". قابل للكتابة
iCalUID string المعرّف الفريد للحدث على النحو المحدّد في RFC5545. ويتم استخدامه لتعريف الأحداث بشكل فريد عبر أنظمة التقويم ويجب تقديمه عند استيراد الأحداث من خلال طريقة import.

يُرجى العِلم أنّ حقلَي iCalUID وid غير متطابقَين ويجب تقديم حقل واحد منهما فقط في وقت إنشاء الحدث. الاختلاف الوحيد في دلالاتهما هو أنه في الأحداث المتكررة، تحتوي جميع تكرارات أحد الأحداث على id مختلفة بينما تشترك جميعها في نفس iCalUID. لاسترداد حدث باستخدام السمة iCalUID، يمكنك استدعاء طريقةevents.list باستخدام مَعلمة iCalUID. لاسترداد حدث باستخدام id التابع له، يمكنك استدعاء طريقة events.get.

id string معرّف مبهم للحدث عند إنشاء أحداث فردية أو متكرّرة جديدة، يمكنك تحديد أرقام تعريفها. يجب أن تلتزم المعرّفات المقدَّمة بالقواعد التالية:
  • الأحرف المسموح بها في المعرّف هي تلك المستخدَمة في ترميز base32hex، أي الأحرف الصغيرة a-v والأرقام من 0 إلى 9، راجِع الفقرة 3.1.2 في RFC2938.
  • يجب أن يتراوح طول المعرّف بين 5 و1,024 حرفًا.
  • يجب أن يكون المعرّف فريدًا لكل تقويم
نظرًا لطبيعة النظام الموزعة عالميًا، لا يمكننا ضمان الكشف عن تصادمات المعرِّفات في وقت إنشاء الحدث. للحدّ من خطر الاصطدامات، نقترح استخدام خوارزمية UUID معروفة (UUID) كما هو موضّح في RFC4122.

إذا لم تحدّد معرِّفًا، سينشئه الخادم تلقائيًا.

يُرجى العِلم أنّ حقلَي icalUID وid غير متطابقَين ويجب تقديم حقل واحد منهما فقط في وقت إنشاء الحدث. الاختلاف الوحيد في دلالاتهما هو أنه في الأحداث المتكررة، تحتوي جميع تكرارات أحد الأحداث على id مختلفة بينما تشترك جميعها في نفس icalUID.

قابل للكتابة
kind string نوع المورد ("calendar#event").
location string الموقع الجغرافي للفعالية كنص مرن اختياريّ. قابل للكتابة
locked boolean ما إذا كان هذا هو نسخة حدث مقفلة يتعذّر فيها إجراء أي تغييرات على حقول الحدث الرئيسية، مثل "الملخّص" أو "الوصف" أو "الموقع الجغرافي" أو "البدء" أو "الانتهاء" أو "التكرار". والقيمة التلقائية هي "خطأ". للقراءة فقط
organizer object منظِّم الحدث. وإذا كان المنظِّم أيضًا ضيفًا، تتم الإشارة إلى ذلك بإدخال منفصل في attendees مع ضبط الحقل organizer على "صحيح". لتغيير المنظم، استخدِم عملية النقل. للقراءة فقط، إلا عند استيراد حدث. قابل للكتابة
organizer.displayName string تشير هذه السمة إلى اسم المنظِّم، إذا كان متاحًا. قابل للكتابة
organizer.email string تمثّل هذه السمة عنوان البريد الإلكتروني للمنظِّم، إذا كان متاحًا. ويجب أن يكون عنوان بريد إلكتروني صالحًا وفق RFC5322. قابل للكتابة
organizer.id string رقم تعريف الملف الشخصي للمنظِّم، إذا كان متاحًا.
organizer.self boolean ما إذا كان المنظّم متوافقًا مع التقويم الذي تظهر فيه هذه النسخة من الحدث للقراءة فقط والقيمة التلقائية هي "خطأ".
originalStartTime nested object بالنسبة إلى حدث متكرّر، يكون هذا هو الوقت الذي يبدأ فيه هذا الحدث وفقًا لبيانات التكرار في الحدث المتكرّر الذي تم تحديده بواسطة متكررةEventId. ويحدِّد الحدث المثيل بشكلٍ فريد داخل سلسلة الأحداث المتكرّرة حتى إذا تم نقل الحدث إلى وقت مختلف. غير قابل للتغيير.
originalStartTime.date date التاريخ، بالتنسيق "yyyy-mm-dd"، إذا كان هذا الحدث يستمر طوال اليوم. قابل للكتابة
originalStartTime.dateTime datetime الوقت، كقيمة مجمّعة للتاريخ والوقت (بتنسيق RFC3339). يجب معادلة المنطقة الزمنية ما لم يتم تحديد منطقة زمنية صراحةً في timeZone. قابل للكتابة
originalStartTime.timeZone string المنطقة الزمنية التي يتم تحديد الوقت فيها. (منسق كاسم قاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثل "أوروبا/زيورخ"). بالنسبة إلى الأحداث المتكرّرة، يكون هذا الحقل مطلوبًا، ويحدّد المنطقة الزمنية التي يتم توسيع التكرار فيها. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبداية الحدث أو نهايته. قابل للكتابة
outOfOfficeProperties nested object بيانات الأحداث خارج المكتب تُستخدَم إذا كانت قيمة eventType هي outOfOffice. قابل للكتابة
outOfOfficeProperties.autoDeclineMode string ما إذا كان سيتم رفض دعوات الاجتماعات التي تتداخل مع أحداث "خارج المكتب". القيم الصالحة هي declineNone، ما يعني أنه لا يتم رفض أي دعوات اجتماعات، declineAllConflictingInvitations، ما يعني أنه يتم رفض جميع دعوات الاجتماعات المتعارضة التي تتعارض مع الحدث، وdeclineOnlyNewConflictingInvitations، ما يعني أنه سيتم رفض فقط دعوات الاجتماعات المتضاربة الجديدة التي تصل أثناء وجود حدث "خارج المكتب".
outOfOfficeProperties.declineMessage string رسالة الرد لضبط ما إذا كان "تقويم Google" يرفض تلقائيًا حدثًا حاليًا أو دعوة جديدة.
privateCopy boolean في حال ضبط هذه السياسة على "صحيح"، يتم إيقاف نشر الحدث. يُرجى العلم أنّ الأمر يختلف عن مواقع الأحداث الخاصة. اختياريّ. غير قابل للتغيير. والقيمة التلقائية هي "خطأ".
recurrence[] list قائمة أسطر RRU وEXCODE وRDATE وEXDATE لحدث متكرر، على النحو المحدّد في RFC5545. تجدر الإشارة إلى أنّه لا يُسمح باستخدام أسطر DTSTART وDTEND في هذا الحقل، مع العلم أنّ وقت بدء الحدث ووقت انتهائه محدّدان في الحقلَين start وend. يتم حذف هذا الحقل للأحداث الفردية أو الحالات المتكررة للأحداث. قابل للكتابة
recurringEventId string بالنسبة إلى حدث متكرّر، يمثّل هذا الحدث id للحدث المتكرّر الذي ينتمي إليه هذا الحدث. غير قابل للتغيير.
reminders object معلومات عن تذكيرات الحدث للمستخدم الذي تمت المصادقة عليه.
reminders.overrides[] list إذا كان الحدث لا يستخدم التذكيرات التلقائية، سيؤدّي ذلك إلى إدراج التذكيرات الخاصة بالحدث، أو إذا لم يتم ضبطه، يشير إلى أنّه لم يتم ضبط أيّ تذكيرات لهذا الحدث. الحد الأقصى لعدد تذكيرات الإلغاء هو 5. قابل للكتابة
reminders.overrides[].method string تمثّل هذه السمة الطريقة المستخدمة في هذا التذكير. القيم المتاحة:
  • "email" - يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup" - يتم إرسال التذكيرات من خلال نافذة منبثقة لواجهة المستخدم.

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

قابل للكتابة
reminders.overrides[].minutes integer يشير ذلك إلى عدد الدقائق التي تسبق بدء الحدث والتزامن مع تشغيل التذكير. تتراوح القيم الصالحة بين 0 و40320 (4 أسابيع بالدقائق).

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

قابل للكتابة
reminders.useDefault boolean ما إذا كانت التذكيرات التلقائية للتقويم تنطبق على الحدث أم لا. قابل للكتابة
sequence integer رقم التسلسل وفقًا لـ iالتقويم قابل للكتابة
source object المصدر الذي تم إنشاء الحدث منه. على سبيل المثال، صفحة ويب أو رسالة إلكترونية أو أي مستند يمكن التعرّف عليه من خلال عنوان URL يستخدم مخطَّط HTTP أو HTTPS. لا يمكن لأحد رؤية الحدث أو تعديله إلا من قِبل منشئ الحدث.
source.title string عنوان المصدر، مثل عنوان صفحة ويب أو موضوع رسالة إلكترونية. قابل للكتابة
source.url string تمثّل هذه السمة عنوان URL للمصدر الذي يشير إلى مورد. يجب أن يكون مخطط عنوان URL إما HTTP أو HTTPS. قابل للكتابة
start nested object وقت بدء الحدث (بشكل شامل). بالنسبة إلى حدث متكرر، يكون هذا هو وقت بدء الحدث الأول.
start.date date التاريخ، بالتنسيق "yyyy-mm-dd"، إذا كان هذا الحدث يستمر طوال اليوم. قابل للكتابة
start.dateTime datetime الوقت، كقيمة مجمّعة للتاريخ والوقت (بتنسيق RFC3339). يجب معادلة المنطقة الزمنية ما لم يتم تحديد منطقة زمنية صراحةً في timeZone. قابل للكتابة
start.timeZone string المنطقة الزمنية التي يتم تحديد الوقت فيها. (منسق كاسم قاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثل "أوروبا/زيورخ"). بالنسبة إلى الأحداث المتكرّرة، يكون هذا الحقل مطلوبًا، ويحدّد المنطقة الزمنية التي يتم توسيع التكرار فيها. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبداية الحدث أو نهايته. قابل للكتابة
status string حالة الحدث اختياريّ. القيم المتاحة:
  • "confirmed" - تم تأكيد الحدث. وهذه هي الحالة التلقائية.
  • "tentative" - تم تأكيد الحدث مبدئيًا.
  • "cancelled" - تم إلغاء الحدث (محذوف). تعرض طريقة list الأحداث الملغاة فقط في المزامنة التزايدية (عند تحديد syncToken أو updatedMin) أو في حال ضبط علامة showDeleted على true. وتعرض طريقة get دائمًا هذه القيم.

    تمثّل الحالة "تم الإلغاء" حالتَين مختلفتَين استنادًا إلى نوع الحدث:

    1. تشير الاستثناءات الملغاة لحدث متكرّر لم يتم إلغاؤه إلى أنّه يجب عدم تقديم هذا المثيل للمستخدم بعد ذلك. وعلى العملاء تخزين هذه الأحداث طوال فترة الحدث الرئيسي المتكرّر.

      يمكن أن تضمن الاستثناءات المُلغاة فقط تعبئة قيم الحقول id وrecurringEventId وoriginalStartTime. وقد تكون الحقول الأخرى فارغة.

    2. أما جميع الأحداث الأخرى المُلغاة، فتمثل أحداثًا محذوفة. وعلى العملاء إزالة النُسخ التي تمت مزامنتها محليًا. ستختفي هذه الأحداث الملغاة في النهاية، لذا لا تعتمد على إتاحتها إلى أجل غير مسمى.

      يمكن ضمان تعبئة الحقل id فقط للأحداث المحذوفة.

    في تقويم المنظِّم، تستمر الأحداث المُلغاة في عرض تفاصيل الحدث (الملخص والموقع الجغرافي وما إلى ذلك) حتى يمكن استعادتها (إلغاء حذفها). وبالمثل، تستمر الأحداث التي تمت دعوة المستخدم إليها والتي تمت إزالتها يدويًا في تقديم التفاصيل. ومع ذلك، لن تعرض طلبات المزامنة المتزايدة عند ضبط showDeleted على "خطأ" هذه التفاصيل.

    في حال تغيير منظِّم الحدث (من خلال عملية النقل مثلاً) ولم يكن المنظِّم الأصلي مدرَجًا في قائمة الضيوف، سيترك حدثًا ملغيًا حيث يمكن ضمان تعبئة الحقل id فقط.

قابل للكتابة
summary string تمثل هذه الخاصية عنوان الفعالية. قابل للكتابة
transparency string ما إذا كان الحدث سيحظر الوقت في التقويم اختياريّ. القيم المتاحة:
  • "opaque" - القيمة التلقائية يحظر الحدث وقتًا في التقويم. يعادل ذلك إعداد عرض كـ على مشغول في واجهة مستخدم التقويم.
  • "transparent": لا يحظر الحدث وقتًا في التقويم. يعادل ذلك ضبط عرضي كـ على متاح في واجهة مستخدم "تقويم Google".
قابل للكتابة
updated datetime وقت آخر تعديل للحدث (كطابع زمني RFC3339) للقراءة فقط
visibility string مستوى رؤية الحدث. اختياريّ. القيم المتاحة:
  • "default" - يستخدم مستوى الرؤية التلقائي للأحداث في التقويم. هذه هي القيمة الافتراضية.
  • "public" - الحدث علني وتفاصيل الحدث مرئية لجميع برامج قراءة التقويم.
  • "private" - الحدث خاص ويمكن لضيوف الحدث فقط الاطّلاع على تفاصيله.
  • "confidential" - الحدث خاص. يتم توفير هذه القيمة لأسباب تتعلق بالتوافق.
قابل للكتابة
workingLocationProperties nested object بيانات أحداث مكان العمل قابل للكتابة
workingLocationProperties.customLocation object وفي حال توفّره، يتم تحديد أنّ المستخدم يعمل من موقع جغرافي مخصّص. قابل للكتابة
workingLocationProperties.customLocation.label string تصنيف إضافي اختياري للحصول على معلومات إضافية. قابل للكتابة
workingLocationProperties.homeOffice any value في حال توفّر السمة، يتم تحديد أنّ المستخدم يعمل في المنزل. قابل للكتابة
workingLocationProperties.officeLocation object في حال توفّر السمة، يتم تحديد أنّ المستخدم يعمل من مكتب. قابل للكتابة
workingLocationProperties.officeLocation.buildingId string معرّف مبنى اختياري. يجب أن يشير هذا إلى رقم تعريف مبنى في قاعدة بيانات موارد المؤسسة. قابل للكتابة
workingLocationProperties.officeLocation.deskId string معرّف سطح المكتب الاختياري قابل للكتابة
workingLocationProperties.officeLocation.floorId string تمثّل هذه السمة معرّف حد اختياري. قابل للكتابة
workingLocationProperties.officeLocation.floorSectionId string تمثّل هذه السمة معرّفًا اختياريًا لقسم الطابق. قابل للكتابة
workingLocationProperties.officeLocation.label string اسم المكتب الذي يتم عرضه في برامج "تقويم Google" على الويب والأجهزة الجوّالة. ننصحك بالإشارة إلى اسم مبنى في قاعدة بيانات "الموارد" بالمؤسسة. قابل للكتابة
workingLocationProperties.type string نوع مكان العمل القيم المتاحة:
  • "homeOffice": المستخدم يعمل في المنزل.
  • "officeLocation": المستخدم يعمل من مكتب.
  • "customLocation": يعمل المستخدم من موقع جغرافي مخصّص.
يتم تحديد أي تفاصيل في حقل فرعي للاسم المحدّد، ولكن قد يكون هذا الحقل مفقودًا إذا كان فارغًا. ويتم تجاهل أي حقول أخرى.

مطلوب عند إضافة مواقع جغرافية للعمل.

قابل للكتابة

الطُرق

حذف
لحذف حدث ما.
الحصول على
عرض حدث استنادًا إلى معرّف "تقويم Google" الخاص به. لاسترداد حدث باستخدام معرّف iالتقويم، يمكنك استدعاء طريقةevents.list باستخدام مَعلمة iCalUID.
import
لاستيراد حدث. تُستخدم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. لا يمكن استيراد سوى الأحداث التي تحتوي على eventType من default.

السلوك المتوقّف نهائيًا: إذا تم استيراد حدث ليس "default"، سيتم تغيير نوعه إلى "default" وسيتم استبعاد أي خصائص من نوع الحدث قد تكون مدرَجة.

إدراج
لإنشاء حدث.
المثيلات
عرض حالات الحدث المتكرر المحدّد.
list
لعرض الأحداث في التقويم المحدد.
نقل
نقل حدث إلى تقويم آخر، أي تغيير منظِّم الحدث تجدر الإشارة إلى أنّه لا يمكن نقل سوى default حدث، أي أنّه لا يمكن نقل أحداث outOfOffice وfocusTime وworkingLocation.
تصحيح
لتحديث حدث. تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعًا بـ update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدِّدها في الطلب بدون تغيير. تستبدل حقول الصفيف، إذا تم تحديدها، الصفائف الحالية، مما يؤدي إلى تجاهل أي عناصر صفيف سابقة.
quickAdd
لإنشاء حدث استنادًا إلى سلسلة نصية بسيطة.
تعديل
لتحديث حدث. لا تتيح هذه الطريقة دلالات التصحيح وتعمل دائمًا على تحديث مورد الحدث بالكامل. لإجراء تعديل جزئي، عليك تنفيذ عملية get متبوعة بالرمز update باستخدام علامات etag لضمان تقسيم قيم الذرة.
ساعة
تابِع التغييرات في موارد الفعاليات.