توفّر واجهة برمجة التطبيقات 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 |
مرفقات الملفات الخاصة بالحدث لتعديل المرفقات، يجب ضبط مَعلمة الطلب يمكن أن يكون هناك 25 مرفقًا كحد أقصى لكل حدث. |
|
attachments[].fileId |
string |
رقم تعريف الملف المرفق. للقراءة فقط. بالنسبة إلى ملفات Google Drive، هذا هو رقم تعريف إدخال مورد |
|
attachments[].fileUrl |
string |
رابط عنوان URL يؤدي إلى المرفق لإضافة مرفقات ملفات Google Drive، استخدِم التنسيق نفسه المُستخدَم في سمة مطلوب عند إضافة مرفق. |
قابل للكتابة |
attachments[].iconLink |
string |
رابط عنوان URL المؤدي إلى رمز المرفق. لا يمكن تعديل هذا الحقل إلا للمرفقات المخصّصة التابعة لجهات خارجية. | |
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 |
حالة ردّ الحاضر القيم المحتمَلة هي:
|
قابلة للكتابة |
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 |
نوع عيد الميلاد أو الحدث الخاص القيم المحتمَلة هي:
"birthday" . لا يمكن تغيير النوع بعد إنشاء الحدث. |
قابل للكتابة |
colorId |
string |
لون الحدث. هذا معرّف يشير إلى إدخال في القسم event من تعريف الألوان (اطّلِع على نقطة نهاية الألوان). اختياريّ. |
قابلة للكتابة |
conferenceData |
nested object |
المعلومات المتعلقة بالمؤتمر، مثل تفاصيل مكالمة فيديو على Google Meet. لإنشاء تفاصيل جديدة لمكالمة الفيديو، استخدِم الحقل createRequest . للاحتفاظ بالتغييرات التي أجريتها، تذكّر ضبط مَعلمة طلب conferenceDataVersion على 1 لجميع طلبات تعديل الأحداث. |
قابلة للكتابة |
conferenceData.conferenceId |
string |
رقم تعريف مكالمة الفيديو. يمكن للمطوّرين استخدامها لتتبُّع المؤتمرات، ويجب عدم عرضها للمستخدمين. يتم إنشاء قيمة المعرّف بشكلٍ مختلف لكل نوع من أنواع حلول المؤتمرات:
|
|
conferenceData.conferenceSolution |
nested object |
حلّ المؤتمرات، مثل Google Meet لم يتم ضبطها لمكالمة جماعية تم فيها رفض طلب الإنشاء. يجب استخدام إما |
|
conferenceData.conferenceSolution.iconUri |
string |
تمثّل هذه السمة الرمز المرئي للمستخدم لهذا الحلّ. | |
conferenceData.conferenceSolution.key |
nested object |
المفتاح الذي يمكنه تحديد حلّ المكالمات الجماعية لهذا الحدث بشكل فريد | |
conferenceData.conferenceSolution.key.type |
string |
نوع حل مكالمة الفيديو. وإذا واجه العميل نوعًا غير مألوف أو فارغ، من المفترض أن يظل بإمكانه عرض نقاط الدخول. ومع ذلك، يجب ألا يسمح بالتعديلات. القيم المحتملة هي:
|
|
conferenceData.conferenceSolution.name |
string |
تمثّل هذه السمة الاسم المرئي للمستخدم لهذا الحلّ. لم يتمّت ترجمتها. | |
conferenceData.createRequest |
nested object |
طلب لإنشاء مؤتمر جديد وإرفاقه بالحدث يتم إنشاء البيانات بشكل غير متزامن. لمعرفة ما إذا كانت البيانات متوفّرة، تحقَّق من الحقل status . يجب استخدام إما |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
حلّ المؤتمرات، مثل Hangouts أو Google Meet | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
نوع منصة مكالمات الفيديو وإذا واجه العميل نوعًا غير مألوف أو فارغ، من المفترض أن يظل بإمكانه عرض نقاط الدخول. ومع ذلك، يجب ألا يسمح بالتعديلات. القيم المحتملة هي:
|
|
conferenceData.createRequest.requestId |
string |
المعرّف الفريد الذي أنشأه العميل لهذا الطلب. وعلى العملاء إعادة إنشاء هذا المعرّف لكل طلب جديد. إذا كان المعرّف المقدَّم هو نفسه المعرّف الوارد في الطلب السابق، يتم تجاهل الطلب. |
|
conferenceData.createRequest.status |
nested object |
حالة طلب إنشاء المكالمة الجماعية. | |
conferenceData.createRequest.status.statusCode |
string |
الحالة الحالية لطلب إنشاء المكالمة الجماعية للقراءة فقط. القيم المحتملة هي:
|
|
conferenceData.entryPoints[] |
list |
معلومات عن نقاط دخول المؤتمرات الفردية، مثل عناوين URL أو أرقام الهواتف ويجب أن تنتمي جميعها إلى المؤتمر نفسه. يجب استخدام إما |
|
conferenceData.entryPoints[].accessCode |
string |
رمز الوصول إلى المؤتمر الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. عند إنشاء بيانات مؤتمر جديدة، املأ فقط المجموعة الفرعية من حقول { اختياريّ. |
|
conferenceData.entryPoints[].entryPointType |
string |
تمثّل هذه السمة نوع نقطة دخول المؤتمر. القيم المحتملة هي:
|
|
conferenceData.entryPoints[].label |
string |
تصنيف معرّف الموارد المنتظم (URI). مرئية للمستخدمين النهائيين. لم يتمّت ترجمتها. الحد الأقصى للطول هو 512 حرفًا. أمثلة:
اختياريّ. |
|
conferenceData.entryPoints[].meetingCode |
string |
رمز الاجتماع للوصول إلى المؤتمر الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. عند إنشاء بيانات مؤتمر جديدة، املأ فقط المجموعة الفرعية من حقول { اختياريّ. |
|
conferenceData.entryPoints[].passcode |
string |
رمز المرور للوصول إلى المؤتمر الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. عند إنشاء بيانات مكالمة فيديو جديدة، لا تتم تعبئة سوى المجموعة الفرعية من حقول { |
|
conferenceData.entryPoints[].password |
string |
كلمة المرور للوصول إلى المؤتمر الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. عند إنشاء بيانات مؤتمر جديدة، املأ فقط المجموعة الفرعية من حقول { اختياريّ. |
|
conferenceData.entryPoints[].pin |
string |
رقم التعريف الشخصي للوصول إلى المؤتمر الحد الأقصى لعدد الأحرف المسموح به هو 128 حرفًا. عند إنشاء بيانات مؤتمر جديدة، املأ فقط المجموعة الفرعية من حقول { اختياريّ. |
|
conferenceData.entryPoints[].uri |
string |
معرّف الموارد المنتظم (URI) لنقطة الدخول الحد الأقصى للطول هو 1300 حرف. طبيعة الحضور:
|
|
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 |
تمثّل هذه السمة نوع الفعالية المحدّد. لا يمكن تعديل هذا الخيار بعد إنشاء الحدث. القيم المتاحة:
|
قابلة للكتابة |
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 |
وضع عرض الأداة تمّ الإيقاف. القيم المحتمَلة هي:
|
قابلة للكتابة |
gadget.height |
integer |
ارتفاع الأداة بالبكسل يجب أن يكون الارتفاع عددًا صحيحًا أكبر من 0. اختياريّ. تمّ الإيقاف. | قابلة للكتابة |
gadget.iconLink |
string |
عنوان URL لرمز الأداة. يجب أن يكون مخطط عنوان URL هو HTTPS. تمّ الإيقاف. | قابلة للكتابة |
gadget.link |
string |
عنوان URL الخاص بالتطبيق المصغّر يجب أن يستخدم عنوان URL مخطّط HTTPS. تمّ الإيقاف. | قابلة للكتابة |
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. | قابلة للكتابة |
hangoutLink |
string |
رابط مطلق إلى Google Hangout المرتبط بهذا الحدث. للقراءة فقط. | |
htmlLink |
string |
رابط مطلق إلى هذا الحدث في واجهة مستخدم الويب في "تقويم Google" للقراءة فقط. | |
iCalUID |
string |
المعرّف الفريد للحدث على النحو المحدّد في RFC5545 ويتم استخدامه لتحديد الأحداث بشكلٍ فريد على مستوى أنظمة التقويم، ويجب تقديمه عند استيراد الأحداث من خلال طريقة import. تجدر الإشارة إلى أنّ السمتَين |
|
id |
string |
معرّف غير شفاف للحدث. عند إنشاء أحداث جديدة فردية أو متكرّرة، يمكنك تحديد معرّفاتها. يجب أن تتّبع المعرّفات المقدَّمة القواعد التالية:
إذا لم تحدّد معرّفًا، سينشئه الخادم تلقائيًا. تجدر الإشارة إلى أنّ السمتَين |
قابلة للكتابة |
kind |
string |
نوع المورد ("calendar#event "). |
|
location |
string |
الموقع الجغرافي للفعالية كنص حر الشكل. اختياريّ. | قابلة للكتابة |
locked |
boolean |
ما إذا كانت هذه نسخة حدث مقفلة لا يمكن إجراء تغييرات فيها على حقول الحدث الرئيسية "الملخّص" أو "الوصف" أو "الموقع الجغرافي" أو "البدء" أو "النهاية" أو "تكرار". القيمة التلقائية هي False. للقراءة فقط. | |
organizer |
object |
منظِّم الحدث. إذا كان المنظِّم مشاركًا أيضًا، يتم الإشارة إلى ذلك من خلال إدخال منفصل في attendees مع ضبط الحقل organizer على True. لتغيير المنظِّم، استخدِم عملية نقل. للقراءة فقط، باستثناء استيراد حدث. |
قابلة للكتابة |
organizer.displayName |
string |
تمثّل هذه السمة اسم المنظِّم، إذا كان متوفرًا. | قابلة للكتابة |
organizer.email |
string |
عنوان البريد الإلكتروني للمنظِّم، إن توفّر يجب أن يكون عنوان بريد إلكتروني صالحًا وفقًا لمعيار RFC5322. | قابلة للكتابة |
organizer.id |
string |
معرّف الملف الشخصي للمنسِق، إن توفّر | |
organizer.self |
boolean |
ما إذا كان المنظّم متوافقًا مع التقويم الذي تظهر فيه هذه النسخة من الحدث. للقراءة فقط. القيمة التلقائية هي False. | |
originalStartTime |
nested object |
في ما يتعلق بحدث متكرر، هذا هو الوقت الذي يبدأ فيه هذا الحدث وفقًا لبيانات التكرار في الحدث المتكرّر الذي تم تحديده بواسطةfrequentEventId. ويحدِّد هذا المقياس الحدث بشكلٍ فريد ضمن سلسلة الأحداث المتكرّرة حتى إذا تم نقل الحدث إلى وقت مختلف. غير قابل للتغيير. | |
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 |
الطريقة المستخدَمة في هذا التذكير القيم المحتمَلة هي:
مطلوب عند إضافة تذكير. |
قابلة للكتابة |
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 |
حالة الحدث. اختياريّ. القيم المحتمَلة هي:
|
قابلة للكتابة |
summary |
string |
تمثل هذه الخاصية عنوان الفعالية. | قابلة للكتابة |
transparency |
string |
ما إذا كان الحدث يحجب الوقت في التقويم اختياريّ. القيم المحتمَلة هي:
|
قابل للكتابة |
updated |
datetime |
وقت آخر تعديل لبيانات الحدث الرئيسية (كطابع زمني RFC3339) لن يؤدي تحديث تذكيرات الأحداث إلى تغيير هذا الأمر. للقراءة فقط. | |
visibility |
string |
مستوى رؤية الحدث اختياريّ. القيم المحتمَلة هي:
|
قابل للكتابة |
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 |
تمثّل هذه السمة نوع مكان العمل. القيم المحتمَلة هي:
مطلوب عند إضافة سمات مكان العمل. |
قابلة للكتابة |
الطُرق
- حذف
- لحذف حدث
- الحصول على
- تعرض حدثًا استنادًا إلى رقم تعريفه في "تقويم Google". لاسترداد حدث باستخدام معرّفه على iCalendar، يمكنك استدعاء الطريقة events.list باستخدام المَعلمة
iCalUID
. - import
- لاستيراد حدث. تُستخدم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. يمكن استيراد الأحداث التي لها
eventType
منdefault
فقط.السلوك الذي سيتم إيقافه نهائيًا: في حال استيراد حدث غير من النوع
default
، سيتم تغيير نوعه إلىdefault
وسيتم حذف أي خصائص خاصة بنوع الحدث قد تكون موجودة فيه. - إدراج
- إنشاء حدث
- المثيلات
- تعرض نُسخًا من الحدث المتكرّر المحدّد.
- list
- لعرض الأحداث في التقويم المحدّد
- نقل
- نقل حدث إلى تقويم آخر، مثل تغيير منظِّم الحدث. لاحظ أنه يمكن نقل
default
حدث فقط، ولا يمكن نقل أحداثbirthday
وfocusTime
وfromGmail
وoutOfOffice
وworkingLocation
. - patch
- لتعديل حدث. تتيح هذه الطريقة دلالات التصحيح. تجدر الإشارة إلى أنّ كل طلب تصحيح يستهلك ثلاث وحدات، ويفضَّل استخدام
get
متبوعة بـupdate
. تحلّ قيم الحقول التي تحدّدها محل القيم الحالية. تظل الحقول التي لا تحدّدها في الطلب بدون تغيير. إذا تم تحديد حقول الصفيف، يتم استبدال الصفائف الحالية بها، ما يؤدي إلى تجاهل أي عناصر صفيف سابقة. - quickAdd
- تُنشئ حدثًا استنادًا إلى سلسلة نصية بسيطة.
- تعديل
- تعديل حدث لا تتوافق هذه الطريقة مع دلالات التصحيح، وتعمل دائمًا على تعديل مورد الحدث بالكامل. لإجراء تعديل جزئي، نفِّذ عملية
get
متبوعة بـupdate
باستخدام العلامات الإلكترونية لضمان السمة. - مشاهدة
- راقِب التغييرات في موارد "الأحداث".