CalendarList: insert

یک تقویم موجود را در لیست تقویم کاربر درج می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .

درخواست

درخواست HTTP

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

مولفه های

نام پارامتر ارزش شرح
پارامترهای پرس و جو اختیاری
colorRgbFormat boolean برای نوشتن رنگ‌های تقویم (RGB) از فیلدهای foregroundColor و backgroundColor استفاده شود یا خیر. اگر از این ویژگی استفاده شود، فیلد colorId مبتنی بر فهرست به طور خودکار روی بهترین گزینه تطبیق تنظیم می شود. اختیاری. حالت پیش فرض غلط است.

مجوز

این درخواست به مجوز با محدوده زیر نیاز دارد:

محدوده
https://www.googleapis.com/auth/calendar

برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.

درخواست بدن

در بدنه درخواست، یک منبع CalendarList با ویژگی های زیر ارائه کنید:

نام ملک ارزش شرح یادداشت
خواص مورد نیاز
id string شناسه تقویم
ویژگی های اختیاری
backgroundColor string رنگ اصلی تقویم در قالب هگزادسیمال " #0088aa ". این ویژگی جایگزین خاصیت colorId مبتنی بر شاخص می‌شود. برای تنظیم یا تغییر این ویژگی، باید colorRgbFormat=true در پارامترهای متدهای insert ، update و patch مشخص کنید. اختیاری. قابل نوشتن
colorId string رنگ تقویم. این شناسه ای است که به ورودی در بخش calendar تعریف رنگ ها اشاره دارد ( نقطه پایانی رنگ ها را ببینید). این ویژگی با ویژگی های backgroundColor و foregroundColor جایگزین می شود و هنگام استفاده از این ویژگی ها می توان نادیده گرفت. اختیاری. قابل نوشتن
defaultReminders[] list یادآوری های پیش فرضی که کاربر احراز هویت شده برای این تقویم دارد. قابل نوشتن
defaultReminders[]. method string روش استفاده شده توسط این یادآوری. مقادیر ممکن عبارتند از:
  • " email " - یادآوری ها از طریق ایمیل ارسال می شوند.
  • " popup " - یادآوری ها از طریق یک پنجره بازشو UI ارسال می شوند.

هنگام افزودن یادآوری لازم است.

 قابل نوشتن
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 آیا محتوای تقویم در رابط کاربری تقویم نشان داده می‌شود یا خیر. اختیاری. حالت پیش فرض غلط است. قابل نوشتن
summaryOverride string خلاصه ای که کاربر احراز هویت شده برای این تقویم تنظیم کرده است. اختیاری. قابل نوشتن

واکنش

در صورت موفقیت آمیز بودن، این روش یک منبع CalendarList را در بدنه پاسخ برمی گرداند.

مثال ها

توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

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());

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

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 استفاده می کند.

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

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

آن را امتحان کنید!

از APIs Explorer زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.