Class CalendarEventSeries

تقويم Googleالأحداثالمتكررة

يمثّل سلسلة من الأحداث (حدث متكرّر).

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
addEmailReminder(minutesBefore)CalendarEventSeriesتُضيف تذكيرًا جديدًا عبر البريد الإلكتروني إلى الحدث.
addGuest(email)CalendarEventSeriesتُضيف مدعوًا إلى الحدث.
addPopupReminder(minutesBefore)CalendarEventSeriesتُضيف إشعارًا منبثقًا جديدًا إلى الحدث.
addSmsReminder(minutesBefore)CalendarEventSeriesتضيف تذكيرًا جديدًا عبر الرسائل القصيرة إلى الحدث.
anyoneCanAddSelf()Booleanلتحديد ما إذا كان بإمكان المستخدمين إضافة أنفسهم كمدعوين إلى حدث في "تقويم Google".
deleteEventSeries()voidيؤدي ذلك إلى حذف سلسلة الأحداث.
deleteTag(key)CalendarEventSeriesتحذف علامة مفتاح/قيمة من الحدث.
getAllTagKeys()String[]تحصل على جميع مفاتيح العلامات التي تم ضبطها على الحدث.
getColor()Stringتعرِض هذه السمة لون حدث التقويم.
getCreators()String[]الحصول على صنّاع فعالية معيّنة
getDateCreated()Dateتحصل على تاريخ إنشاء الحدث.
getDescription()Stringالحصول على وصف الحدث
getEmailReminders()Integer[]تحصل على قيم الدقائق لجميع التذكيرات عبر البريد الإلكتروني للحدث.
getEventType()EventTypeتحصل على EventType لهذا الحدث.
getGuestByEmail(email)EventGuestالحصول على ضيف من خلال عنوان البريد الإلكتروني
getGuestList()EventGuest[]الحصول على المدعوين للحدث، باستثناء مالك الحدث
getGuestList(includeOwner)EventGuest[]الحصول على المدعوين للحدث، بما في ذلك مالكي الحدث
getId()Stringتحصل على معرّف iCalUID الفريد للحدث.
getLastUpdated()Dateتحصل على تاريخ آخر تعديل للحدث.
getLocation()Stringالحصول على الموقع الجغرافي للحدث
getMyStatus()GuestStatusتحصل على حالة الحدث (مثل "مشارِك" أو "مدعو") للمستخدم الفعّال.
getOriginalCalendarId()Stringالحصول على رقم تعريف التقويم الذي تم إنشاء هذا الحدث فيه في الأصل
getPopupReminders()Integer[]تحصل على قيم الدقائق لجميع التذكيرات المنبثقة للحدث.
getSmsReminders()Integer[]تحصل على قيم الدقائق لجميع التذكيرات عبر الرسائل القصيرة للحدث.
getTag(key)Stringتحصل على قيمة علامة الحدث.
getTitle()Stringتحصل على عنوان الحدث.
getTransparency()EventTransparencyالحصول على شفافية الحدث
getVisibility()Visibilityالحصول على مستوى ظهور الحدث
guestsCanInviteOthers()Booleanلتحديد ما إذا كان بإمكان المدعوين دعوة مدعوين آخرين.
guestsCanModify()Booleanلتحديد ما إذا كان يمكن للمدعوين تعديل الحدث.
guestsCanSeeGuests()Booleanيحدِّد ما إذا كان بإمكان الضيوف الاطّلاع على الضيوف الآخرين.
isOwnedByMe()Booleanلتحديد ما إذا كنت مالك الحدث.
removeAllReminders()CalendarEventSeriesإزالة جميع التذكيرات من الحدث
removeGuest(email)CalendarEventSeriesإزالة مدعو من الحدث
resetRemindersToDefault()CalendarEventSeriesإعادة ضبط التذكيرات باستخدام الإعدادات التلقائية للتقويم
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSeriesلتحديد ما إذا كان بإمكان المستخدمين غير المدعوين إضافة أنفسهم إلى الحدث.
setColor(color)CalendarEventSeriesلضبط لون حدث التقويم
setDescription(description)CalendarEventSeriesلضبط وصف الحدث
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventSeriesلتحديد ما إذا كان بإمكان المدعوين دعوة ضيوف آخرين.
setGuestsCanModify(guestsCanModify)CalendarEventSeriesلضبط ما إذا كان بإمكان المدعوين تعديل الحدث.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSeriesلضبط ما إذا كان بإمكان الضيوف رؤية الضيوف الآخرين.
setLocation(location)CalendarEventSeriesلضبط الموقع الجغرافي للحدث
setMyStatus(status)CalendarEventSeriesتُستخدَم لضبط حالة الحدث (مثل "مشارِك" أو "مدعو") للمستخدم الفعّال.
setRecurrence(recurrence, startDate)CalendarEventSeriesلضبط قواعد التكرار لسلسلة أحداث تستمر طوال اليوم
setRecurrence(recurrence, startTime, endTime)CalendarEventSeriesلضبط قواعد التكرار لسلسلة الأحداث هذه
setTag(key, value)CalendarEventSeriesتُستخدَم لضبط علامة مفتاح/قيمة على الحدث لتخزين البيانات الوصفية المخصّصة.
setTitle(title)CalendarEventSeriesلضبط عنوان الحدث
setTransparency(transparency)CalendarEventSeriesلضبط شفافية الحدث.
setVisibility(visibility)CalendarEventSeriesلضبط مستوى رؤية الحدث

مستندات تفصيلية

addEmailReminder(minutesBefore)

تُضيف تذكيرًا جديدًا عبر البريد الإلكتروني إلى الحدث. يجب أن يكون التذكير قبل الحدث بمدة 5 دقائق على الأقل و4 أسابيع كحد أقصى (40320 دقيقة).

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds an email notification for 15 minutes before the event.
event.addEmailReminder(15);

المعلمات

الاسمالنوعالوصف
minutesBeforeIntegerعدد الدقائق قبل الحدث

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

عمليات الرمي

Error - إذا كان هناك أكثر من 5 تذكيرات للحدث أو إذا لم يكن الوقت ضمن النطاق القانوني

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addGuest(email)

تُضيف مدعوًا إلى الحدث.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to add
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
  }
  event.addGuest(attendeeEmail);
}

// Example 2: Add a guest to all events on a calendar within a specified
// timeframe
function addAttendeeToAllEvents() {
  // Replace the following values with your own
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to add
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate =
      new Date('YYYY-MM-DD');  // The first date to add the guest to the events
  const endDate =
      new Date('YYYY-MM-DD');  // The last date to add the guest to the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const calEvents = calendar.getEvents(startDate, endDate);
  console.log(calEvents.length);  // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.addGuest(attendeeEmail);
  }
}

المعلمات

الاسمالنوعالوصف
emailStringعنوان البريد الإلكتروني للضيف

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addPopupReminder(minutesBefore)

تُضيف إشعارًا منبثقًا جديدًا إلى الحدث. يجب أن يكون الإشعار قبل الحدث بمدة 5 دقائق على الأقل، وبمدة 4 أسابيع (40320 دقيقة) كحد أقصى.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Adds a pop-up notification for 15 minutes before the event.
event.addPopupReminder(15);

المعلمات

الاسمالنوعالوصف
minutesBeforeIntegerعدد الدقائق قبل الحدث

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addSmsReminder(minutesBefore)

تضيف تذكيرًا جديدًا عبر الرسائل القصيرة إلى الحدث. يجب أن يكون التذكير قبل الحدث بمدة 5 دقائق على الأقل و4 أسابيع كحد أقصى (40320 دقيقة).

المعلمات

الاسمالنوعالوصف
minutesBeforeIntegerعدد الدقائق قبل الحدث

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

عمليات الرمي

Error - إذا كان هناك أكثر من 5 تذكيرات للحدث أو إذا لم يكن الوقت ضمن النطاق القانوني

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

anyoneCanAddSelf()

لتحديد ما إذا كان بإمكان المستخدمين إضافة أنفسهم كمدعوين إلى حدث في "تقويم Google".

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Determines whether people can add themselves as guests to the event and logs
// it.
console.log(event.anyoneCanAddSelf());

الإرجاع

Booleantrue إذا كان بإمكان المستخدمين غير المدعوين إضافة أنفسهم إلى الحدث، false إذا لم يكن الأمر كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

deleteEventSeries()

يؤدي ذلك إلى حذف سلسلة الأحداث.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

deleteTag(key)

تحذف علامة مفتاح/قيمة من الحدث.

المعلمات

الاسمالنوعالوصف
keyStringمفتاح العلامة

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getAllTagKeys()

تحصل على جميع مفاتيح العلامات التي تم ضبطها على الحدث.

الإرجاع

String[]: مصفوفة من مفاتيح السلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getColor()

تعرِض هذه السمة لون حدث التقويم.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets the color of the calendar event and logs it.
const eventColor = event.getColor();
console.log(eventColor);

الإرجاع

String: التمثيل السطري للون الحدث، كفهرس (من 1 إلى 11) للقيم من CalendarApp.EventColor

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getCreators()

الحصول على صنّاع فعالية معيّنة

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');

// Gets a list of the creators of the event and logs it.
console.log(event.getCreators());

الإرجاع

String[] - عناوين البريد الإلكتروني لصنّاع الحدث

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDateCreated()

تحصل على تاريخ إنشاء الحدث. يجب أن يكون لديك إذن الوصول إلى التقويم.

// Opens the calendar by using its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the calendar ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 8:10 AM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 08:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the date that the
  // event was created and logs it.
  const eventCreated = event.getDateCreated();
  console.log(eventCreated);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Date - تاريخ الإنشاء

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getDescription()

الحصول على وصف الحدث يجب أن يكون لديك إذن بتعديل التقويم.

// Opens the calendar by its ID.
// To get the user's default calendar use CalendarApp.getDefault() instead.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 4:00 PM and 5:00 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 16:00:00'),
    new Date('Feb 04, 2023 17:00:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the description of the
  // event.
  event.setDescription('Important meeting');

  // Gets the description of the event and logs it.
  const description = event.getDescription();
  console.log(description);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

String: الوصف

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEmailReminders()

تحصل على قيم الدقائق لجميع التذكيرات عبر البريد الإلكتروني للحدث. يجب أن يكون لديك إذن بتعديل المحتوى في التقويم.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:00 PM and 6:00 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 15:00:00'),
    new Date('Feb 04, 2023 18:00:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, adds email reminders for
  // the user to be sent at 4 and 7 minutes before the event.
  event.addEmailReminder(4);
  event.addEmailReminder(7);

  // Gets the minute values for all email reminders that are set up for the user
  // for this event and logs it.
  const emailReminder = event.getEmailReminders();
  console.log(emailReminder);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Integer[]: مصفوفة تتطابق فيها كل قيمة مع عدد الدقائق قبل الحدث الذي يؤدي إلى بدء تذكير

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getEventType()

تحصل على EventType لهذا الحدث.

// Opens the default calendar and logs all out-of-office events for the current day.
const calendar = CalendarApp.getDefaultCalendar();
const events = calendar.getEventsForDay(new Date());
console.log(events.filter(e => e.getEventType() === CalendarApp.EventType.OUT_OF_OFFICE));

الإرجاع

EventType: نوع الحدث.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestByEmail(email)

الحصول على ضيف من خلال عنوان البريد الإلكتروني

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Gets a guest by email address.
const guestEmailId = event.getGuestByEmail('alex@example.com');

// If the email address corresponds to an event guest, logs the email address.
if (guestEmailId) {
  console.log(guestEmailId.getEmail());
}

المعلمات

الاسمالنوعالوصف
emailStringعنوان الضيف

الإرجاع

EventGuest: الضيف، أو قيمة فارغة إذا لم يكن عنوان البريد الإلكتروني مطابقًا لضيف

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getGuestList()

الحصول على المدعوين للحدث، باستثناء مالك الحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Adds two guests to the event by using their email addresses.
event.addGuest('alex@example.com');
event.addGuest('cruz@example.com');

// Gets the guests list for the event.
const guestList = event.getGuestList();

// Loops through the list to get all the guests and logs their email addresses.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

الإرجاع

EventGuest[]: صفيف الضيوف

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getGuestList(includeOwner)

الحصول على المدعوين للحدث، بما في ذلك مالكي الحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 5:00 PM and 5:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 17:00:00'),
    new Date('Feb 25,2023 17:25:00'),
    )[0];

// Gets the guests list for the event, including the owner of the event.
const guestList = event.getGuestList(true);

// Loops through the list to get all the guests and logs it.
for (const guest of guestList) {
  console.log(guest.getEmail());
}

المعلمات

الاسمالنوعالوصف
includeOwnerBooleanما إذا كان سيتم تضمين المالكين كضيوف

الإرجاع

EventGuest[]: صفيف الضيوف

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getId()

تحصل على معرّف iCalUID الفريد للحدث. يُرجى العِلم أنّ معرّف iCalUID والحدث id اللذَين تستخدمهما واجهة برمجة التطبيقات Calendar v3 API وخدمة "تقويم Google" المتقدّمة ليسا متطابقَين ولا يمكن استخدامهما بشكل متبادل. يتمثل أحد الاختلافات في الدلالات في أنّه في الأحداث المتكررة، يكون لكلّ مرّة من مرّات حدوث حدث معيّن قيمة مختلفة من ids، في حين تتشارك جميعها معرّفات iCalUID نفسها.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for January 5th, 2023 that takes place
// between 9:00 AM and 9:25 AM.
// For an event series, use calendar.getEventSeriesById('abc123456@google.com');
// and replace the series ID with your own.
const event = calendar.getEvents(
    new Date('Jan 05, 2023 09:00:00'),
    new Date('Jan 05, 2023 09:25:00'),
    )[0];

// Gets the ID of the event and logs it.
console.log(event.getId());

الإرجاع

String: معرّف iCalUID للحدث

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLastUpdated()

تحصل على تاريخ آخر تعديل للحدث.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:00 PM and 5:00 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:00:00'),
    new Date('Feb 01, 2023 17:00:00'),
    )[0];

// Gets the date the event was last updated and logs it.
const eventUpdatedDate = event.getLastUpdated();
console.log(eventUpdatedDate);

الإرجاع

Date: تاريخ التعديل الأخير

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getLocation()

الحصول على الموقع الجغرافي للحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the location of the
  // event to Mumbai.
  event.setLocation('Mumbai');

  // Gets the location of the event and logs it.
  const eventLocation = event.getLocation();
  console.log(eventLocation);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

String: الموقع الجغرافي للحدث

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getMyStatus()

تحصل على حالة الحدث (مثل "مشارِك" أو "مدعو") للمستخدم الفعّال. تُعرِض دائمًا GuestStatus.OWNER إذا كان المستخدم الفعلي هو مالك الحدث.

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the event status of
  // the effective user and logs it.
  const myStatus = event.getMyStatus();
  console.log(myStatus.toString());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

GuestStatus — الحالة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getOriginalCalendarId()

الحصول على رقم تعريف التقويم الذي تم إنشاء هذا الحدث فيه في الأصل

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 25th, 2023 that takes
// place between 4:00 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 25,2023 16:00:00'),
    new Date('Feb 25,2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the ID of the calendar
  // where the event was originally created and logs it.
  const calendarId = event.getOriginalCalendarId();
  console.log(calendarId);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

String - معرّف التقويم الأصلي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getPopupReminders()

تحصل على قيم الدقائق لجميع التذكيرات المنبثقة للحدث.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:05 PM and 5:35 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 17:05:00'),
    new Date('Feb 04, 2023 17:35:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, adds two pop-up reminders
  // to the event. The first reminder pops up 5 minutes before the event starts
  // and the second reminder pops up 3 minutes before the event starts.
  event.addPopupReminder(3);
  event.addPopupReminder(5);

  // Gets the minute values for all pop-up reminders for the event and logs it.
  const popUpReminder = event.getPopupReminders();
  console.log(popUpReminder);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Integer[]: مصفوفة تتطابق فيها كل قيمة مع عدد الدقائق قبل الحدث الذي يؤدي إلى بدء تذكير

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getSmsReminders()

تحصل على قيم الدقائق لجميع التذكيرات عبر الرسائل القصيرة للحدث.

الإرجاع

Integer[]: مصفوفة تتطابق فيها كل قيمة مع عدد الدقائق قبل الحدث الذي يؤدي إلى بدء تذكير

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTag(key)

تحصل على قيمة علامة الحدث.

المعلمات

الاسمالنوعالوصف
keyStringالمفتاح

الإرجاع

String: قيمة العلامة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTitle()

تحصل على عنوان الحدث.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, logs the title of the
  // event.
  console.log(event.getTitle());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

String: العنوان

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTransparency()

الحصول على شفافية الحدث استخدِم هذه الطريقة لتحديد ما إذا كان الحدث TRANSPARENT، ما يعني أنّ التقويم يظهر على أنّه "متاح" خلال ذلك الوقت، أو OPAQUE، ما يعني أنّ التقويم يظهر على أنّه "مشغول" خلال ذلك الوقت.

// Gets the first event from the default calendar for today.
const today = new Date();
const event = CalendarApp.getDefaultCalendar().getEventsForDay(today)[0];
// Gets the event's transparency and logs it.
const transparency = event.getTransparency();
Logger.log(transparency);

الإرجاع

EventTransparency: قيمة الشفافية

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getVisibility()

الحصول على مستوى ظهور الحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, gets the visibility of the
  // event and logs it.
  const eventVisibility = event.getVisibility();
  console.log(eventVisibility.toString());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Visibility: قيمة مستوى الظهور

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanInviteOthers()

لتحديد ما إذا كان بإمكان المدعوين دعوة مدعوين آخرين.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether guests
  // can invite other guests and logs it.
  console.log(event.guestsCanInviteOthers());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Booleantrue إذا كان بإمكان المدعوين دعوة آخرين، false إذا لم يكن الأمر كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanModify()

لتحديد ما إذا كان يمكن للمدعوين تعديل الحدث.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // guests can't modify it.
  event.setGuestsCanModify(false);

  // Determines whether guests can modify the event and logs it.
  console.log(event.guestsCanModify());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Booleantrue إذا كان بإمكان المدعوين تعديل الحدث، false إذا لم يكن الأمر كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

guestsCanSeeGuests()

يحدِّد ما إذا كان بإمكان الضيوف الاطّلاع على الضيوف الآخرين.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether guests
  // can see other guests and logs it.
  console.log(event.guestsCanSeeGuests());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Booleantrue إذا كان بإمكان المدعوين رؤية المدعوين الآخرين، false إذا لم يكن الأمر كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

isOwnedByMe()

لتحديد ما إذا كنت مالك الحدث.

// Opens the calendar by its ID. You must have view access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, determines whether you're
  // the owner of the event and logs it.
  console.log(event.isOwnedByMe());
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

Booleantrue إذا كان الحدث مملوكًا للمستخدم الفعلي، false إذا لم يكن كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

removeAllReminders()

إزالة جميع التذكيرات من الحدث

// Opens the calendar by its ID. You must have edit access to the calendar
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 1,2023 16:10:00'),
    new Date('Feb 1,2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, removes all reminders from
  // the event.
  event.removeAllReminders();
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

removeGuest(email)

إزالة مدعو من الحدث

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to remove
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar containing
  // event
  const eventId = '123abc';  // ID of event instance

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  const event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
  }
  event.removeGuest(attendeeEmail);
}

// Example 2: Remove a guest from all events on a calendar within a specified
// timeframe
function removeGuestFromAllEvents() {
  // Replace the following values with your own
  const attendeeEmail =
      'user@example.com';  // Email address of the person you need to remove
  const calendarId =
      'calendar_123@group.calendar.google.com';  // ID of calendar with the
  // events
  const startDate = new Date(
      'YYYY-MM-DD');  // The first date to remove the guest from the events
  const endDate = new Date(
      'YYYY-MM-DD');  // The last date to remove the attendee from the events

  const calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  const calEvents = calendar.getEvents(startDate, endDate);
  console.log(calEvents.length);  // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (let i = 0; i < calEvents.length; i++) {
    const event = calEvents[i];
    event.removeGuest(attendeeEmail);
  }
}

المعلمات

الاسمالنوعالوصف
emailStringعنوان البريد الإلكتروني للضيف

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

resetRemindersToDefault()

إعادة ضبط التذكيرات باستخدام الإعدادات التلقائية للتقويم

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 1, 2023 16:10:00'),
    new Date('Feb 1, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, resets the reminders using
  // the calendar's default settings.
  event.resetRemindersToDefault();
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setAnyoneCanAddSelf(anyoneCanAddSelf)

لتحديد ما إذا كان بإمكان المستخدمين غير المدعوين إضافة أنفسهم إلى الحدث.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 15th, 2023 that takes
// place between 3:30 PM and 4:30 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 15, 2023 15:30:00'),
    new Date('Feb 15, 2023 16:30:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // non-guests can't add themselves to the event.
  event.setAnyoneCanAddSelf(false);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
anyoneCanAddSelfBooleanما إذا كان بإمكان أي مستخدم دعوة نفسه

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setColor(color)

لضبط لون حدث التقويم

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the color of the
  // calendar event to green.
  event.setColor(CalendarApp.EventColor.GREEN);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
colorStringفهرس لون عدد صحيح كسلسلة أو قيمة من CalendarApp.EventColor

الإرجاع

CalendarEventSeries: حدث التقويم هذا، لتسلسل الأحداث

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

لضبط وصف الحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 4th, 2023 that takes
// place between 5:05 PM and 5:35 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 04, 2023 17:05:00'),
    new Date('Feb 04, 2023 17:35:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the description of the
  // event to 'Meeting.'
  event.setDescription('Meeting');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
descriptionStringالوصف الجديد

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanInviteOthers(guestsCanInviteOthers)

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

// Opens the calendar by its ID.
// TODO(developer): Replace the ID with your own. You must have edit access to
// the calendar.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 9:35 AM and 9:40 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 09:35:00'),
    new Date('Feb 01, 2023 09:40:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event so that
  // guests can invite other guests.
  event.setGuestsCanInviteOthers(true);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
guestsCanInviteOthersBooleanما إذا كان بإمكان المدعوّين دعوة مستخدمين آخرين

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanModify(guestsCanModify)

لضبط ما إذا كان بإمكان المدعوين تعديل الحدث.

المعلمات

الاسمالنوعالوصف
guestsCanModifyBooleanما إذا كان بإمكان المدعوين تعديل الحدث

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setGuestsCanSeeGuests(guestsCanSeeGuests)

لضبط ما إذا كان بإمكان الضيوف رؤية الضيوف الآخرين.

المعلمات

الاسمالنوعالوصف
guestsCanSeeGuestsBooleanما إذا كان بإمكان المدعوين رؤية الآخرين

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setLocation(location)

لضبط الموقع الجغرافي للحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the location of the
  // event to Noida.
  event.setLocation('Noida');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
locationStringالموقع الجغرافي الجديد

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setMyStatus(status)

تُستخدَم لضبط حالة الحدث (مثل "مشارِك" أو "مدعو") للمستخدم الفعّال.

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for February 1st, 2023 that takes
// place between 4:10 PM and 4:25 PM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Feb 01, 2023 16:10:00'),
    new Date('Feb 01, 2023 16:25:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, sets the event status for
  // the current user to maybe.
  event.setMyStatus(CalendarApp.GuestStatus.MAYBE);
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
statusGuestStatusالحالة الجديدة

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

setRecurrence(recurrence, startDate)

لضبط قواعد التكرار لسلسلة أحداث تستمر طوال اليوم يؤدي تطبيق هذه الطريقة إلى تغيير سلسلت أحداث عادية إلى سلسلة أحداث على مدار اليوم.

// Sets the events in a series to take place every Wednesday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '123456789@google.com',
);
const startDate = new Date('January 2, 2013 03:00:00 PM EST');
const recurrence = CalendarApp.newRecurrence()
                       .addWeeklyRule()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startDate);

المعلمات

الاسمالنوعالوصف
recurrenceEventRecurrenceقواعد التكرار التي تريد استخدامها
startDateDateتاريخ الحدث الأول في السلسلة (يتم استخدام اليوم فقط، ويتم تجاهل الوقت)

الإرجاع

CalendarEventSeries - سلسلة CalendarEventSeries هذه لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setRecurrence(recurrence, startTime, endTime)

لضبط قواعد التكرار لسلسلة الأحداث هذه يؤدي تطبيق هذه الطريقة إلى تغيير سلسلة أحداث على مدار اليوم إلى سلسلة أحداث عادية.

// Sets the events in a series to take place from 3pm to 4pm every Tuesday and
// Thursday in 2013.
const eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById(
    '123456789@google.com',
);
const startTime = new Date('January 1, 2013 03:00:00 PM EST');
const endTime = new Date('January 1, 2013 04:00:00 PM EST');
const recurrence =
    CalendarApp.newRecurrence()
        .addWeeklyRule()
        .onlyOnWeekdays(
            [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
        .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startTime, endTime);

المعلمات

الاسمالنوعالوصف
recurrenceEventRecurrenceقواعد التكرار التي تريد استخدامها
startTimeDateتاريخ ووقت بدء الحدث الأول في السلسلة
endTimeDateتاريخ ووقت انتهاء الحدث الأول في السلسلة

الإرجاع

CalendarEventSeries - سلسلة CalendarEventSeries هذه لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTag(key, value)

تُستخدَم لضبط علامة مفتاح/قيمة على الحدث لتخزين البيانات الوصفية المخصّصة.

المعلمات

الاسمالنوعالوصف
keyStringمفتاح العلامة
valueStringقيمة العلامة

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTitle(title)

لضبط عنوان الحدث

// Opens the calendar by its ID. You must have edit access to the calendar.
// TODO(developer): Replace the ID with your own.
const calendar = CalendarApp.getCalendarById(
    'abc123456@group.calendar.google.com',
);

// Gets the first event from the calendar for January 31st, 2023 that takes
// place between 9:05 AM and 9:15 AM. For an event series, use
// calendar.getEventSeriesById('abc123456@google.com'); and replace the series
// ID with your own.
const event = calendar.getEvents(
    new Date('Jan 31, 2023 09:05:00'),
    new Date('Jan 31, 2023 09:15:00'),
    )[0];

if (event) {
  // If an event exists within the given time frame, changes its title to
  // Event1.
  event.setTitle('Event1');
} else {
  // If no event exists within the given time frame, logs that information to
  // the console.
  console.log('No events exist for the specified range');
}

المعلمات

الاسمالنوعالوصف
titleStringالعنوان الجديد

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTransparency(transparency)

لضبط شفافية الحدث. استخدِم هذه الطريقة لتحديد ما إذا كان الحدث TRANSPARENT، ما يعني أنّ التقويم يظهر على أنّه "متاح" خلال ذلك الوقت، أو OPAQUE، ما يعني أنّ التقويم يظهر على أنّه "مشغول" خلال ذلك الوقت.

// Gets an event by its ID. For an event series, use getEventSeriesById(iCalId)
// instead.
// TODO(developer): Replace the string with the event ID that you want to get.
const event = CalendarApp.getEventById('abc123456');
// Sets the event's transparency to TRANSPARENT.
event.setTransparency(CalendarApp.EventTransparency.TRANSPARENT);

المعلمات

الاسمالنوعالوصف
transparencyEventTransparencyقيمة الشفافية

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setVisibility(visibility)

لضبط مستوى رؤية الحدث

المعلمات

الاسمالنوعالوصف
visibilityVisibility

الإرجاع

CalendarEventSeries — هذا CalendarEventSeries لإنشاء سلسلة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة التطبيقات REST ذات الصلة:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds