Events: import

تستورِد هذه الطريقة حدثًا. تُستخدَم هذه العملية لإضافة نسخة خاصة من حدث حالي إلى تقويم. يمكن استيراد الأحداث التي تتضمّن eventType بقيمة default فقط.

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

جرِّب الميزة الآن.

طلب

طلب HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/import

المعلمات

اسم المعلَمة القيمة الوصف
مَعلمات المسار
calendarId string معرّف التقويم لاسترداد أرقام تعريف التقويم، استخدِم طريقة calendarList.list. إذا أردت الوصول إلى التقويم الأساسي للمستخدم الذي سجّل الدخول حاليًا، استخدِم الكلمة الرئيسية "primary".
مَعلمات طلب البحث الاختيارية
conferenceDataVersion integer رقم إصدار بيانات المؤتمرات المتوافق مع عميل واجهة برمجة التطبيقات لا تفترض الإصدار 0 إمكانية استخدام بيانات المؤتمر وتتجاهل بيانات المؤتمر في نص الحدث. يتيح الإصدار 1 إمكانية نسخ ConferenceData بالإضافة إلى إنشاء مكالمات فيديو جديدة باستخدام حقل createRequest في ConferenceData. القيمة التلقائية هي 0. القيم المقبولة هي من 0 إلى 1، بشكلٍ شامل.
supportsAttachments boolean تحديد ما إذا كان عميل واجهة برمجة التطبيقات الذي ينفّذ العملية يتيح إرفاق أحداث. اختياريّ. القيمة التلقائية هي False.

التفويض

يتطلّب هذا الطلب الحصول على تفويض باستخدام نطاق واحد على الأقل من النطاقات التالية:

النطاق
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

لمزيد من المعلومات، يُرجى الاطّلاع على صفحة المصادقة والتفويض.

نص الطلب

في نص الطلب، قدِّم مرجع أحداث يتضمّن السمات التالية:

اسم السمة القيمة الوصف ملاحظات
السمات المطلوبة
end nested object تمثّل هذه السمة وقت انتهاء الحدث (غير شامل). بالنسبة إلى حدث متكرّر، هذا هو وقت انتهاء النسخة الأولى.
iCalUID string المعرّف الفريد للحدث على النحو المحدّد في RFC5545 يُستخدَم لتحديد الأحداث بشكل فريد في جميع أنظمة التقويم، ويجب توفيره عند استيراد الأحداث باستخدام طريقة import.

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

start nested object وقت بدء الحدث (شامل) بالنسبة إلى حدث متكرّر، هذا هو وقت بدء المرة الأولى.
السمات الاختيارية
anyoneCanAddSelf boolean تُستخدَم لتحديد ما إذا كان بإمكان أي مستخدم دعوة نفسه إلى الحدث (تم إيقافها نهائيًا). اختياريّ. القيمة التلقائية هي False. قابل للكتابة
attachments[].fileUrl string رابط عنوان URL للمرفق

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

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

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

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

قابل للكتابة
attendees[].optional boolean تُستخدَم لتحديد ما إذا كان الضيف اختياريًا. اختياريّ. القيمة التلقائية هي False. قابل للكتابة
attendees[].resource boolean تُستخدَم لتحديد ما إذا كان الضيف عبارة عن مورد. لا يمكن ضبطها إلا عند إضافة الضيف إلى الحدث للمرة الأولى. ويتم تجاهل التعديلات اللاحقة. اختياريّ. القيمة التلقائية هي False. قابل للكتابة
attendees[].responseStatus string تمثّل هذه السمة حالة استجابة الضيف. القيم المحتمَلة هي:
  • "needsAction": لم يستجب الضيف للدعوة (يُنصح به للأحداث الجديدة).
  • "declined": رفض الضيف الدعوة.
  • "tentative": يشير إلى أنّ الضيف قبل الدعوة مبدئيًا.
  • "accepted": قبل الضيف الدعوة.
قابل للكتابة
attendeesOmitted boolean تُستخدَم لتحديد ما إذا كان قد تم حذف الضيوف من تمثيل الحدث. عند استرداد حدث، قد يكون ذلك بسبب قيود محدّدة من خلال مَعلمة طلب البحث maxAttendee. عند تعديل حدث، يمكن استخدام هذا الحقل لتعديل رد المشارك فقط. اختياريّ. القيمة التلقائية هي False. قابل للكتابة
colorId string تمثّل هذه السمة لون الفعالية. هذا هو رقم التعريف الذي يشير إلى إدخال في القسم event من تعريف الألوان (راجِع نقطة نهاية الألوان). اختياريّ. قابل للكتابة
conferenceData nested object المعلومات المتعلّقة بالمؤتمر، مثل تفاصيل مؤتمر Google Meet لإنشاء تفاصيل مؤتمر جديدة، استخدِم الحقل createRequest. للحفاظ على التغييرات، احرص على ضبط مَعلمة الطلب conferenceDataVersion على 1 لجميع طلبات تعديل الأحداث. قابل للكتابة
description string تمثّل هذه السمة وصف الفعالية. يمكن أن يحتوي على HTML. اختياريّ. قابل للكتابة
end.date date التاريخ بالتنسيق "yyyy-mm-dd"، إذا كان الحدث سيستمر طوال اليوم. قابل للكتابة
end.dateTime datetime الوقت، كقيمة مجمّعة للتاريخ والوقت (منسّقة وفقًا RFC3339) يجب تحديد إزاحة المنطقة الزمنية ما لم يتم تحديد منطقة زمنية بشكلٍ صريح في timeZone. قابل للكتابة
end.timeZone string المنطقة الزمنية التي تم تحديد الوقت فيها (يتم تنسيقه كاسم في "قاعدة بيانات المناطق الزمنية IANA"، مثلاً "Europe/Zurich"). بالنسبة إلى الأحداث المتكررة، يكون هذا الحقل مطلوبًا ويحدّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء الحدث/انتهائه. قابل للكتابة
extendedProperties.private object السمات الخاصة بنسخة الحدث التي تظهر في هذا التقويم قابل للكتابة
extendedProperties.shared object السمات التي تتم مشاركتها بين نُسخ الحدث في تقاويم الضيوف الآخرين قابل للكتابة
focusTimeProperties nested object بيانات حدث "وقت التركيز" يجب استخدامها إذا كانت قيمة eventType هي focusTime. قابل للكتابة
gadget.display string وضع عرض الأداة تمّ الإيقاف. القيم المحتمَلة هي:
  • "icon": يعرض الأداة بجانب عنوان الحدث في طريقة عرض التقويم.
  • ‫"chip": يتم عرض الأداة عند النقر على الحدث.
قابل للكتابة
gadget.height integer تمثّل هذه السمة ارتفاع الأداة بالبكسل. يجب أن يكون الارتفاع عددًا صحيحًا أكبر من 0. اختياريّ. تمّ الإيقاف. قابل للكتابة
gadget.preferences object التفضيلات. قابل للكتابة
gadget.title string تمثّل هذه السمة عنوان الأداة. تمّ الإيقاف. قابل للكتابة
gadget.type string نوع الأداة تمّ الإيقاف. قابل للكتابة
gadget.width integer تمثّل هذه السمة عرض الأداة بالبكسل. يجب أن يكون العرض عددًا صحيحًا أكبر من 0. اختياريّ. تمّ الإيقاف. قابل للكتابة
guestsCanInviteOthers boolean تُستخدَم لتحديد ما إذا كان بإمكان الضيوف الآخرين غير المنظِّم دعوة مستخدمين آخرين إلى الحدث. اختياريّ. القيمة التلقائية هي True. قابل للكتابة
guestsCanModify boolean تحديد ما إذا كان بإمكان المشاركين غير المنظِّم تعديل الحدث اختياريّ. القيمة التلقائية هي False. قابل للكتابة
guestsCanSeeOtherGuests boolean تُستخدَم لتحديد ما إذا كان بإمكان الضيوف الآخرين غير المنظِّم الاطّلاع على قائمة الضيوف في الحدث. اختياريّ. القيمة التلقائية هي True. قابل للكتابة
location string تمثّل هذه السمة الموقع الجغرافي للحدث كنص حر. اختياريّ. قابل للكتابة
organizer object تمثّل هذه السمة منظّم الحدث. إذا كان المنظّم مشاركًا أيضًا، يتم الإشارة إلى ذلك بإدخال منفصل في attendees مع ضبط الحقل organizer على "صحيح". لتغيير المنظِّم، استخدِم عملية النقل. إذن بالقراءة فقط، باستثناء عند استيراد حدث قابل للكتابة
organizer.displayName string تمثّل هذه السمة اسم المُنظِّم، إذا كان ذلك منطبقًا. قابل للكتابة
organizer.email string تمثّل هذه السمة عنوان البريد الإلكتروني للمنظِّم، إذا كان متوفّرًا. يجب أن يكون عنوان بريد إلكتروني صالحًا وفقًا RFC5322. قابل للكتابة
originalStartTime.date date التاريخ بالتنسيق "yyyy-mm-dd"، إذا كان الحدث سيستمر طوال اليوم. قابل للكتابة
originalStartTime.dateTime datetime الوقت، كقيمة مجمّعة للتاريخ والوقت (منسّقة وفقًا RFC3339) يجب تحديد إزاحة المنطقة الزمنية ما لم يتم تحديد منطقة زمنية بشكلٍ صريح في timeZone. قابل للكتابة
originalStartTime.timeZone string المنطقة الزمنية التي تم تحديد الوقت فيها (يتم تنسيقه كاسم في "قاعدة بيانات المناطق الزمنية IANA"، مثلاً "Europe/Zurich"). بالنسبة إلى الأحداث المتكررة، يكون هذا الحقل مطلوبًا ويحدّد المنطقة الزمنية التي يتم فيها توسيع التكرار. بالنسبة إلى الأحداث الفردية، يكون هذا الحقل اختياريًا ويشير إلى منطقة زمنية مخصّصة لبدء الحدث/انتهائه. قابل للكتابة
outOfOfficeProperties nested object بيانات حدث خارج المكتب يجب استخدامها إذا كانت قيمة eventType هي outOfOffice. قابل للكتابة
recurrence[] list قائمة بأسطر RRULE وEXRULE وRDATE وEXDATE لحدث متكرّر، كما هو محدّد في RFC5545. يُرجى العِلم أنّه لا يُسمح باستخدام السطرَين DTSTART وDTEND في هذا الحقل، بل يتم تحديد وقتَي بدء الفعالية وانتهائها في الحقلَين start وend. يتم حذف هذا الحقل للأحداث الفردية أو مثيلات الأحداث المتكررة. قابل للكتابة
reminders.overrides[] list إذا لم يستخدم الحدث التذكيرات التلقائية، سيتم عرض التذكيرات الخاصة بالحدث، أو سيتم الإشارة إلى عدم ضبط أي تذكيرات لهذا الحدث في حال عدم ضبطها. الحدّ الأقصى لعدد التذكيرات التي يمكن تجاهلها هو 5. قابل للكتابة
reminders.overrides[].method string الطريقة المستخدَمة في هذا التذكير. القيم المحتمَلة هي:
  • email: يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup": يتم إرسال التذكيرات من خلال نافذة منبثقة في واجهة المستخدم.

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

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

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

قابل للكتابة
reminders.useDefault boolean تحديد ما إذا كانت التذكيرات التلقائية للتقويم تنطبق على الحدث قابل للكتابة
sequence integer الرقم التسلسلي وفقًا لتنسيق iCalendar قابل للكتابة
source.title string تمثّل هذه السمة عنوان المستند المصدر، مثل عنوان صفحة ويب أو موضوع رسالة إلكترونية. قابل للكتابة
source.url string تمثّل هذه السمة عنوان URL للمصدر الذي يشير إلى أحد الموارد. يجب أن يكون مخطط عنوان URL هو HTTP أو HTTPS. قابل للكتابة
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".
قابل للكتابة
visibility string تمثّل هذه السمة مستوى رؤية الحدث. اختياريّ. القيم المحتمَلة هي:
  • ‫"default": يستخدم مستوى الرؤية التلقائي للأحداث في التقويم. هذه هي القيمة الافتراضية.
  • "public": الحدث متاح للجميع ويمكن لجميع قارئي التقويم الاطّلاع على تفاصيله.
  • ‫"private": الحدث خاص ويمكن للمشاركين فيه فقط الاطّلاع على تفاصيله.
  • ‫"confidential": الحدث خاص. يتم توفير هذه القيمة لأسباب تتعلّق بالتوافق.
قابل للكتابة

الردّ

في حال نجاح هذا الإجراء، سيعرض مورد "الأحداث" في نص الاستجابة.

جرِّبها الآن.

استخدِم "مستكشف واجهات برمجة التطبيقات" أدناه لطلب البيانات من خلال هذه الطريقة والاطّلاع على الردّ.