CalendarList: update

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

الطلب

طلب HTTP

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

المعلمات

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

التفويض

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

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

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

نص الطلب

في نص الطلب، قدِّم مورد CalendarList مع السمات التالية:

اسم الموقع القيمة الوصف ملاحظات
الخصائص الاختيارية
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();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

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

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

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

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

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

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

جرّب الآن

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