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 ما إذا كان بإمكان أي شخص دعوة نفسه إلى الحدث (متوقف) اختياريّ. القيمة التلقائية هي False. قابل للكتابة
attachments[] list مرفقات الملفات للحدث

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

يمكن إضافة 25 مرفقًا كحدّ أقصى في كل حدث.
attachments[].fileId string رقم تعريف الملف المرفق. للقراءة فقط.

بالنسبة إلى ملفات Google Drive، هذا هو رقم تعريف إدخال مورد Files المقابل في واجهة برمجة تطبيقات Drive.
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 النوع المحدد للحدث. ولا يمكن تعديل هذا الاسم بعد إنشاء الحدث. القيم المتاحة:
  • "default" - حدث عادي أو لم يتم تحديده بعد
  • "outOfOffice" - حدث خارج المكتب. يجب توفير مَعلمة outOfOfficeProperties لإنشاء حدث صالح (حتى إذا كان فارغًا).
  • "focusTime" - حدث لوقت التركيز يجب توفير مَعلمة focusTimeProperties لإنشاء حدث صالح (حتى إذا كان فارغًا).
  • "workingLocation" - حدث في مكان العمل
في الوقت الحالي، لا يمكن إنشاء سوى أحداث "default " و "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 بالنسبة إلى حدث متكرر، هذا هو الوقت الذي سيبدأ فيه هذا الحدث وفقًا لبيانات التكرار في الحدث المتكرر الذي تم تحديده بواسطة المتكررة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 في حال ضبط هذه السياسة على "صحيح"، يتم إيقاف نشر الأحداث. يُرجى العلم أنّ الأمر يختلف عن خصائص الأحداث الخاصة. اختياريّ. غير قابل للتغيير. القيمة التلقائية هي False.
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" - لا يحظر الحدث وقتًا في التقويم. يعادل ذلك إعداد عرضي كـ على متاح في واجهة مستخدم التقويم.
 قابل للكتابة
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
لاستيراد حدث. يتم استخدام هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم.
إدراج
لإنشاء حدث.
المثيلات
عرض حالات من الحدث المتكرر المحدد.
list
عرض الأحداث في التقويم المحدد.
نقل
نقل حدث إلى تقويم آخر، أي تغيير منظِّم الحدث تجدر الإشارة إلى أنه لا يمكن نقل سوى أحداث default، ولا يمكن نقل أحداث outOfOffice وfocusTime وworkingLocation.
حزمة
لتحديث حدث. تدعم هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات حصة، ويفضّل استخدام get متبوعة بعلامة update. تحلّ قيم الحقول التي تحدّدها محلّ القيم الحالية. تبقى الحقول التي لا تحدّدها في الطلب بدون تغيير. تؤدي حقول المصفوفة، في حال تحديدها، إلى استبدال الصفائف الحالية، ويؤدي هذا إلى إلغاء أي عناصر صفيف سابقة.
quickAdd
لإنشاء حدث استنادًا إلى سلسلة نصية بسيطة.
تعديل
لتحديث حدث. لا تتيح هذه الطريقة دلالات التصحيح وتعمل دائمًا على تحديث مورد الحدث بالكامل. لإجراء تعديل جزئي، نفِّذ get متبوعةً بـ update باستخدام علامات e-tags لضمان نشر صور بشكل كامل.
ساعة
تابِع التغييرات في مراجع "الأحداث".