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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": 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.
birthdayProperties nested object بيانات أعياد الميلاد أو الأحداث الخاصة يجب استخدامها إذا كانت قيمة eventType هي "birthday". غير قابل للتغيير قابل للكتابة
birthdayProperties.contact string اسم المورد لجهة الاتصال المرتبطة بحدث عيد الميلاد هذا. يمكن استخدامها لاسترداد تفاصيل جهات الاتصال من People API. التنسيق: "people/c12345" للقراءة فقط.
birthdayProperties.customTypeName string تصنيف النوع المخصّص المحدّد لهذا الحدث تتم تعبئة هذا الحقل إذا تم ضبط birthdayProperties.type على "custom". للقراءة فقط.
birthdayProperties.type string نوع عيد الميلاد أو المناسبة الخاصة القيم المحتمَلة هي:
  • "anniversary": ذكرى سنوية غير عيد الميلاد يحتوي دائمًا على contact.
  • "birthday": حدث عيد ميلاد هذه هي القيمة الافتراضية.
  • "custom": تاريخ خاص يتم تحديد تصنيفه بشكل أكبر في الحقل customTypeName. يحتوي دائمًا على contact.
  • "other": تاريخ خاص لا يندرج ضمن الفئات الأخرى، وليس له تصنيف مخصّص. يحتوي دائمًا على contact.
  • "self": عيد ميلاد مالك التقويم لا يمكن أن يتضمّن contact.
لا تتيح Calendar API سوى إنشاء أحداث من النوع "birthday". لا يمكن تغيير النوع بعد إنشاء الحدث.
قابل للكتابة
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"، مثلاً "Europe/Zurich"). بالنسبة إلى الأحداث المتكررة، يكون هذا الحقل مطلوبًا ويحدّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء الحدث/انتهائه. قابل للكتابة
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 يُستخدَم لتحديد الأحداث بشكل فريد في جميع أنظمة التقويم، ويجب توفيره عند استيراد الأحداث باستخدام طريقة الاستيراد.

يُرجى العِلم أنّ 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"، مثلاً "Europe/Zurich"). بالنسبة إلى الأحداث المتكررة، يكون هذا الحقل مطلوبًا ويحدّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء الحدث/انتهائه. قابل للكتابة
outOfOfficeProperties nested object بيانات حدث خارج المكتب يجب استخدامها إذا كانت قيمة eventType هي outOfOffice. قابل للكتابة
outOfOfficeProperties.autoDeclineMode string ما إذا كان سيتم رفض دعوات الاجتماعات التي تتداخل مع أحداث "خارج المكتب" القيم الصالحة هي declineNone، ما يعني عدم رفض أي دعوات لحضور اجتماعات، وdeclineAllConflictingInvitations، ما يعني رفض جميع الدعوات المتعارضة لحضور اجتماعات تتعارض مع الحدث، وdeclineOnlyNewConflictingInvitations، ما يعني رفض الدعوات الجديدة فقط لحضور اجتماعات تتعارض مع الحدث والتي تصل أثناء وجود حدث "خارج المكتب".
outOfOfficeProperties.declineMessage string رسالة الردّ التي سيتم ضبطها في حال رفض "تقويم Google" تلقائيًا لحدث حالي أو دعوة جديدة
privateCopy boolean في حال ضبطها على "صحيح"، يتم إيقاف نقل الأحداث. يُرجى العِلم أنّها تختلف عن خصائص الأحداث الخاصة. اختياريّ. غير قابل للتغيير القيمة التلقائية هي False.
recurrence[] list قائمة بأسطر RRULE وEXRULE و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"، مثلاً "Europe/Zurich"). بالنسبة إلى الأحداث المتكررة، يكون هذا الحقل مطلوبًا ويحدّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء الحدث/انتهائه. قابل للكتابة
status string تمثّل هذه السمة حالة الحدث. اختياريّ. القيم المحتمَلة هي:
  • ‫"confirmed": تم تأكيد الحدث. هذه هي الحالة التلقائية.
  • ‫"tentative": تم تأكيد الحدث مبدئيًا.
  • ‫"cancelled": تم إلغاء الحدث (حذفه). تعرض طريقة القائمة الأحداث الملغاة فقط عند المزامنة التزايدية (عند تحديد 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". لاسترداد حدث باستخدام معرّف iCalendar الخاص به، استدعِ طريقة events.list باستخدام المَعلمة iCalUID.
استيراد
يستورد حدثًا. تُستخدَم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. يمكن استيراد الأحداث التي تتضمّن eventType بقيمة default فقط.

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

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