CalendarList: insert

لإدراج تقويم حالي في قائمة التقاويم لدى المستخدم. جرِّبه الآن أو شاهد مثالاً.

الطلب

طلب HTTP

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

المَعلمات

اسم المعلَمة القيمة الوصف
مَعلمات طلب البحث الاختيارية
colorRgbFormat boolean يمكنك اختيار ما إذا كنت تريد استخدام الحقلين foregroundColor وbackgroundColor لكتابة ألوان التقويم (RGB). في حال استخدام هذه الميزة، سيتم تلقائيًا ضبط حقل colorId المستند إلى الفهرس على خيار المطابقة الأفضل. اختياريّ. القيمة التلقائية هي False.

التفويض

يتطلب هذا الطلب تفويضًا بالنطاق التالي:

النطاق
https://www.googleapis.com/auth/calendar

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

نص الطلب

في نص الطلب، قدم مورد CalendarList بالخصائص التالية:

اسم الموقع القيمة الوصف Notes
الخصائص المطلوبة
id string معرّف التقويم.
الخصائص الاختيارية
backgroundColor string اللون الرئيسي للتقويم بالتنسيق السداسي العشري "#0088aa". تحل هذه السمة محل خاصية colorId المستندة إلى الفهرس. لضبط هذه السمة أو تغييرها، عليك تحديد colorRgbFormat=true في مَعلمات طرق insert وupdate وpatch. اختياريّ. قابل للكتابة
colorId string لون التقويم. هذا معرّف يشير إلى إدخال في القسم calendar من تعريف الألوان (راجِع نقطة نهاية الألوان). تحلّ السمتان backgroundColor وforegroundColor محلّ هذا الموقع، ويمكن تجاهله عند استخدام هاتين السمتَين. اختياريّ. قابل للكتابة
defaultReminders[] list هي التذكيرات التلقائية لدى المستخدم الذي تمت المصادقة عليه في هذا التقويم. قابل للكتابة
defaultReminders[].method string تمثّل هذه السمة الطريقة المستخدمة في هذا التذكير. القيم المتاحة:
  • "email" - يتم إرسال التذكيرات عبر البريد الإلكتروني.
  • "popup": يتم إرسال التذكيرات من خلال نافذة منبثقة لواجهة المستخدم.

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

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

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

 قابل للكتابة
foregroundColor string لون مقدمة التقويم بالتنسيق السداسي العشري "#ffffff". تحل هذه السمة محل سمة colorId المستندة إلى الفهرس. لضبط هذه السمة أو تغييرها، عليك تحديد colorRgbFormat=true في مَعلمات طرق insert وupdate وpatch. اختياريّ. قابل للكتابة
hidden boolean ما إذا كان التقويم مخفيًا من القائمة. اختياريّ. يتم إرجاع السمة فقط عندما يكون التقويم مخفيًا، وفي هذه الحالة تكون القيمة true. قابل للكتابة
notificationSettings object هي الإشعارات التي يتلقاها المستخدم الذي تمت مصادقته لهذا التقويم. قابل للكتابة
notificationSettings.notifications[].method string الطريقة المستخدمة لإرسال الإشعار. القيمة المحتملة هي:
  • "email" - يتم إرسال الإشعارات عبر البريد الإلكتروني.

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

 قابل للكتابة
notificationSettings.notifications[].type string نوع الإشعار. القيم المتاحة:
  • "eventCreation": يتم إرسال إشعار عند وضع حدث جديد في التقويم.
  • "eventChange" - يتم إرسال إشعار عند تغيير حدث.
  • "eventCancellation" - يتم إرسال إشعار عند إلغاء أحد الأحداث.
  • "eventResponse": يتم إرسال إشعار عندما يردّ أحد الضيوف على دعوة الحدث.
  • "agenda" - جدول أعمال يحتوي على أحداث اليوم (يتم إرسالها في الصباح).

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

 قابل للكتابة
selected boolean ما إذا كان محتوى التقويم سيظهر في واجهة مستخدم التقويم. اختياريّ. القيمة التلقائية هي False. قابل للكتابة
summaryOverride string الملخص الذي ضبطه المستخدم الذي تمت مصادقته لهذا التقويم. اختياريّ. قابل للكتابة

الإجابة

وفي حال نجاحها، تعرِض هذه الطريقة مورد CalendarList في نص الاستجابة.

أمثلة

ملاحظة: إنّ الأمثلة المرتبطة بالرموز والمتوفرة لهذه الطريقة لا تمثّل كل لغات البرمجة المتوافقة (يُرجى مراجعة صفحة مكتبات البرامج للاطّلاع على قائمة باللغات المتوافقة).

Java

تستخدم مكتبة عميل Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

تستخدم مكتبة برامج Python.

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

لاستخدام مكتبة برامج PHP.

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

تستخدم مكتبة عميل Ruby.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

تجربة

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