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
}
اسم الموقع القيمة الوصف ملاحظات
anyoneCanAddSelf boolean ما إذا كان يمكن لأي شخص دعوة نفسه إلى الحدث (متوقف). اختياريّ. وتكون القيمة التلقائية False. قابل للكتابة
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. عند تحديث حدث، يمكن استخدام ذلك لتحديث رد المشارك فقط. اختياريّ. وتكون القيمة التلقائية False. قابل للكتابة
attendees[] list حضور الفعالية. يمكنك الاطّلاع على دليل الأحداث التي يشارك فيها ضيوف للحصول على مزيد من المعلومات عن جدولة الأحداث مع مستخدمي التقويم الآخرين. يجب أن تستخدم حسابات الخدمة تفويض السلطة على مستوى النطاق لتعبئة قائمة الضيوف. قابل للكتابة
attendees[].additionalGuests integer عدد النزلاء الإضافيين. اختياريّ. القيمة التلقائية هي 0. قابل للكتابة
attendees[].comment string تعليق ردّ الضيف اختياريّ. قابلة للكتابة
attendees[].displayName string اسم الحاضر، إذا كان متاحًا اختياريّ. قابل للكتابة
attendees[].email string تمثّل هذه السمة عنوان البريد الإلكتروني للضيف، إذا كان متوفرًا. يجب أن يكون هذا الحقل متوفرًا عند إضافة ضيف. يجب أن يكون عنوان بريد إلكتروني صالحًا وفقًا لمعيار RFC5322.

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

قابل للكتابة
attendees[].id string رقم تعريف الملف الشخصي للضيف، إذا كان متوفّرًا.
attendees[].optional boolean ما إذا كان هذا الحضور اختياري أم لا. اختياريّ. وتكون القيمة التلقائية False. قابل للكتابة
attendees[].organizer boolean ما إذا كان الضيف هو منظِّم الحدث. للقراءة فقط. وتكون القيمة التلقائية False.
attendees[].resource boolean ما إذا كان الحاضر مورّدًا لا يمكن ضبط هذا الإعداد إلا عند إضافة الضيف إلى الحدث لأول مرة. ويتم تجاهل التعديلات اللاحقة. اختياريّ. وتكون القيمة التلقائية False. قابل للكتابة
attendees[].responseStatus string حالة ردّ الضيف القيم المتاحة:
  • "needsAction" - عدم ردّ الضيف على الدعوة (يُنصح بهذا الإجراء للأحداث الجديدة)
  • "declined" - رفض الضيف الدعوة.
  • "tentative" - إذا قبِل الضيف الدعوة بشكل مبدئي.
  • "accepted": قبِل الحاضر الدعوة.
قابلة للكتابة
attendees[].self boolean ما إذا كان هذا الإدخال يمثل التقويم الذي تظهر عليه هذه النسخة من الحدث. للقراءة فقط. وتكون القيمة التلقائية False.
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" لمستخدمي Hangouts الكلاسيكي لمستخدمي 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" لمستخدمي Hangouts الكلاسيكي لمستخدمي 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 ما إذا كان المنشئ يتوافق مع التقويم الذي تظهر فيه هذه النسخة من الحدث. للقراءة فقط. وتكون القيمة التلقائية False.
description string تمثّل هذه السمة وصف الفعالية. ويمكن أن يحتوي على HTML. اختياريّ. قابل للكتابة
end nested object وقت انتهاء الفعالية (الحصري) وبالنسبة إلى الحدث المتكرّر، يكون هذا هو وقت انتهاء الحدث الأول.
end.date date التاريخ، بالتنسيق "yyyy-mm-dd"، إذا كان هذا الحدث يستمر طوال اليوم. قابل للكتابة
end.dateTime datetime الوقت، كقيمة تاريخ ووقت مجمّعة (منسّقة وفقًا لـ RFC3339) يجب تحديد توقيت المنطقة الزمنية ما لم يتم تحديد منطقة زمنية صراحةً في timeZone. قابل للكتابة
end.timeZone string المنطقة الزمنية التي يتم تحديد الوقت فيها. (بتنسيق اسم قاعدة بيانات المناطق الزمنية IANA، مثل "أوروبا/زيورخ") هذا الحقل مطلوب للأحداث المتكرّرة ويحدِّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء/انتهاء الحدث. قابلة للكتابة
endTimeUnspecified boolean ما إذا كان وقت الانتهاء غير محدّد فعلاً يبقى وقت الانتهاء متاحًا لأسباب تتعلّق بالتوافق، حتى إذا تم ضبط هذه السمة على "صحيح". وتكون القيمة التلقائية False.
etag etag علامة ETag للمورد.
eventType string نوع محدّد للحدث. لا يمكن تعديل هذا الاسم بعد إنشاء الحدث. القيم المتاحة:
  • "birthday" - حدث خاص يستمر طوال اليوم ويكون تكراره سنويًا.
  • "default" - حدث عادي أو لم يتم تحديده بعد.
  • "focusTime" - حدث في وقت التركيز.
  • "fromGmail" - حدث من Gmail. لا يمكن إنشاء هذا النوع من الأحداث.
  • "outOfOffice" - حدث خارج المكتب.
  • "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 ما إذا كان بإمكان الضيوف الآخرين غير المنظّم دعوة الآخرين إلى الحدث اختياريّ. الإعداد الافتراضي هو True. قابل للكتابة
guestsCanModify boolean ما إذا كان بإمكان الضيوف الآخرين غير المنظّم تعديل الحدث اختياريّ. وتكون القيمة التلقائية False. قابل للكتابة
guestsCanSeeOtherGuests boolean ما إذا كان بإمكان الضيوف الآخرين غير المنظّم الاطّلاع على هوية ضيوف الحدث اختياريّ. الإعداد الافتراضي هو True. قابل للكتابة
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 و1024 حرفًا
  • يجب أن يكون المعرّف فريدًا لكل تقويم.
نظرًا لطبيعة النظام الموزَّعة على مستوى العالم، لا يمكننا ضمان رصد حالات تعارض المعرِّفات عند إنشاء الحدث. للحد من خطر الاصطدامات، ننصحك باستخدام خوارزمية UUID، كما هو موضح في RFC4122.

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

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

قابل للكتابة
kind string نوع المورد ("calendar#event").
location string الموقع الجغرافي للفعالية كنص حر الشكل. اختياريّ. قابل للكتابة
locked boolean ما إذا كانت هذه النسخة عبارة عن نسخة من حدث مُقفَل لا يمكن فيها إجراء أي تغييرات على حقول الحدث الرئيسية "الملخّص" و"الوصف" و"الموقع الجغرافي" و"البدء" و"النهاية" أو "التكرار". وتكون القيمة التلقائية False. قراءة فقط
organizer object منظِّم الحدث. إذا كان المنظِّم أيضًا أحد الضيوف، تتم الإشارة إلى ذلك من خلال إدخال منفصل في attendees مع ضبط الحقل organizer على "صحيح". لتغيير المنظِّم، يمكنك استخدام عملية النقل. للقراءة فقط، باستثناء عند استيراد حدث. قابل للكتابة
organizer.displayName string تمثّل هذه السمة اسم المنظِّم، إذا كان متوفرًا. قابل للكتابة
organizer.email string تمثّل هذه السمة عنوان البريد الإلكتروني الخاص بالمنظِّم، إذا كان متوفرًا. يجب أن يكون عنوان بريد إلكتروني صالحًا وفقًا لمعيار RFC5322. قابلة للكتابة
organizer.id string رقم تعريف الملف الشخصي للمنظِّم، إذا كان متاحًا.
organizer.self boolean ما إذا كان المنظّم متوافقًا مع التقويم الذي تظهر فيه هذه النسخة من الحدث. للقراءة فقط. القيمة التلقائية هي False.
originalStartTime nested object بالنسبة إلى نسخة من حدث متكرّر، هذا هو الوقت الذي سيبدأ فيه هذا الحدث وفقًا لبيانات التكرار في الحدث المتكرّر الذي تم تحديده من خلال recurringEventId. ويحدِّد المثيل بشكلٍ فريد داخل سلسلة الأحداث المتكرّرة حتى إذا تم نقل المثيل إلى وقت مختلف. غير قابل للتغيير.
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 في حال ضبط هذه السياسة على "صحيح"، سيتم إيقاف نشر الحدث. يُرجى العِلم أنّ الأمر يختلف عن مواقع الأحداث الخاصة. اختياريّ. غير قابل للتغيير. القيمة التلقائية هي False.
recurrence[] list قائمة سطور Rالقواعد وEXالقواعد وRDATE وEXDATE لحدث متكرر كما هو موضح في RFC5545. تجدر الإشارة إلى أنّه لا يُسمح باستخدام الأسطر DTSTART وDTEND في هذا الحقل. يتم تحديد وقت بدء الحدث وانتهائه في الحقلين start وend. تم حذف هذا الحقل للأحداث الفردية أو مثيلات الأحداث المتكرّرة. قابل للكتابة
recurringEventId string في ما يتعلق بحدث متكرر، يكون هذا هو id من الحدث المتكرر الذي ينتمي إليه هذا المثيل. غير قابل للتغيير.
reminders object معلومات حول تذكيرات الحدث للمستخدم الذي تمت مصادقته. يُرجى العلم أنّ تغيير التذكيرات لن يؤدي أيضًا إلى تغيير السمة updated للحدث المضمّن.
reminders.overrides[] list إذا لم يستخدم الحدث التذكيرات التلقائية، يتم إدراج التذكيرات الخاصة بالحدث، أو يشير ذلك إلى عدم ضبط أي تذكيرات لهذا الحدث في حال عدم ضبطها. الحد الأقصى لعدد تذكيرات الإلغاء هو 5. قابل للكتابة
reminders.overrides[].method string الطريقة المستخدمة في هذا التذكير القيم المتاحة:
  • "email" - يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup" - يتم إرسال التذكيرات عبر نافذة منبثقة لواجهة المستخدم.

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

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

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

قابل للكتابة
reminders.useDefault boolean ما إذا كانت التذكيرات التلقائية في التقويم تنطبق على الحدث أم لا. قابل للكتابة
sequence integer الرقم التسلسلي وفقًا لـ icalendar. قابل للكتابة
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" - القيمة التلقائية. يحدد الحدث الوقت في التقويم. يعادل ذلك ضبط إظهار كـ على مشغول في واجهة مستخدم "تقويم Google".
  • "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تقويم Google، يمكنك استدعاء طريقة events.list باستخدام المعلمة iCalUID.
import
لاستيراد حدث. تُستخدم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. يمكن فقط استيراد الأحداث التي تحتوي على eventType من default.

سلوك الإيقاف: في حال استيراد حدث ليس من النوع default، سيتم تغيير نوعه إلى default، وسيتم تجاهل أي سمات محدّدة لنوع الحدث.

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