CalendarList: update

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

الطلب

طلب HTTP

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

المعلمات

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

التفويض

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

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

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

نص الطلب

في نص الطلب، قدِّم مورد 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

جرّب الآن

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