Calendar Service

日曆

這項服務可讓指令碼存取及修改使用者的 Google 日曆,包括使用者訂閱的其他日曆。

類別

名稱簡短說明
Calendar代表使用者擁有或訂閱的日曆。
CalendarApp允許指令碼讀取及更新使用者的 Google 日曆。
CalendarEvent代表單一日曆活動。
CalendarEventSeries代表一系列活動 (週期性活動)。
Color這個列舉代表日曆服務中可用的具名顏色。
EventColor這個列舉代表日曆服務中可用的具名活動顏色。
EventGuest代表活動的邀請對象。
EventRecurrence代表一系列活動的週期性設定。
EventTransparency代表活動透明度的列舉。
EventType代表事件類型的列舉。
GuestStatus列舉項目,代表邀請對象的活動狀態。
RecurrenceRule代表一系列活動的週期性規則。
Visibility代表活動顯示設定的列舉。

Calendar

方法

方法傳回類型簡短說明
createAllDayEvent(title, date)CalendarEvent建立新的全天活動。
createAllDayEvent(title, startDate, endDate)CalendarEvent建立新的全天活動,可跨越多天。
createAllDayEvent(title, startDate, endDate, options)CalendarEvent建立新的全天活動,可跨越多天。
createAllDayEvent(title, date, options)CalendarEvent建立新的全天活動。
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeries建立新的全天活動系列。
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeries建立新的全天活動系列。
createEvent(title, startTime, endTime)CalendarEvent建立新活動。
createEvent(title, startTime, endTime, options)CalendarEvent建立新活動。
createEventFromDescription(description)CalendarEvent根據任意形式的說明建立活動。
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeries建立新的活動系列。
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeries建立新的活動系列。
deleteCalendar()void永久刪除日曆。
getColor()String取得日曆的顏色。
getDescription()String取得日曆說明。
getEventById(iCalId)CalendarEvent取得具有指定 ID 的活動。
getEventSeriesById(iCalId)CalendarEventSeries取得具有指定 ID 的活動系列。
getEvents(startTime, endTime)CalendarEvent[]取得指定時間範圍內發生的所有事件。
getEvents(startTime, endTime, options)CalendarEvent[]取得在指定時間範圍內發生且符合指定條件的所有事件。
getEventsForDay(date)CalendarEvent[]取得特定日期發生的所有事件。
getEventsForDay(date, options)CalendarEvent[]取得在指定日期發生且符合指定條件的所有事件。
getId()String取得日曆的 ID。
getName()String取得日曆名稱。
getTimeZone()String取得日曆的時區。
isHidden()Boolean決定日曆是否隱藏在使用者介面中。
isMyPrimaryCalendar()Boolean判斷日曆是否為有效使用者的主要日曆。
isOwnedByMe()Boolean判斷日曆是否為你所有。
isSelected()Boolean決定是否要在使用者介面中顯示日曆活動。
setColor(color)Calendar設定日曆的顏色。
setDescription(description)Calendar設定日曆說明。
setHidden(hidden)Calendar設定日曆是否顯示在使用者介面中。
setName(name)Calendar設定日曆名稱。
setSelected(selected)Calendar設定是否要在使用者介面中顯示日曆活動。
setTimeZone(timeZone)Calendar設定日曆的時區。
unsubscribeFromCalendar()void取消訂閱日曆。

CalendarApp

屬性

屬性類型說明
ColorColor這個列舉代表日曆服務中可用的具名顏色。
EventColorEventColor這個列舉代表日曆服務中可用的具名活動顏色。
EventTransparencyEventTransparencyEventTransparency 列舉。
EventTypeEventTypeEventType 列舉。
GuestStatusGuestStatus列舉項目,代表邀請對象的活動狀態。
MonthMonth代表一年中各月份的列舉。
VisibilityVisibility代表活動顯示設定的列舉。
WeekdayWeekday代表星期幾的列舉。

方法

方法傳回類型簡短說明
createAllDayEvent(title, date)CalendarEvent建立新的全天活動。
createAllDayEvent(title, startDate, endDate)CalendarEvent建立新的全天活動,可跨越多天。
createAllDayEvent(title, startDate, endDate, options)CalendarEvent建立新的全天活動,可跨越多天。
createAllDayEvent(title, date, options)CalendarEvent建立新的全天活動。
createAllDayEventSeries(title, startDate, recurrence)CalendarEventSeries建立新的全天活動系列。
createAllDayEventSeries(title, startDate, recurrence, options)CalendarEventSeries建立新的全天活動系列。
createCalendar(name)Calendar建立使用者擁有的新日曆。
createCalendar(name, options)Calendar建立使用者擁有的新日曆。
createEvent(title, startTime, endTime)CalendarEvent建立新活動。
createEvent(title, startTime, endTime, options)CalendarEvent建立新活動。
createEventFromDescription(description)CalendarEvent根據任意形式的說明建立活動。
createEventSeries(title, startTime, endTime, recurrence)CalendarEventSeries建立新的活動系列。
createEventSeries(title, startTime, endTime, recurrence, options)CalendarEventSeries建立新的活動系列。
getAllCalendars()Calendar[]取得使用者擁有或訂閱的所有日曆。
getAllOwnedCalendars()Calendar[]取得使用者擁有的所有日曆。
getCalendarById(id)Calendar|null取得具有指定 ID 的日曆。
getCalendarsByName(name)Calendar[]取得使用者擁有或訂閱的所有指定名稱日曆。
getColor()String取得日曆的顏色。
getDefaultCalendar()Calendar取得使用者的預設日曆。
getDescription()String取得日曆說明。
getEventById(iCalId)CalendarEvent取得具有指定 ID 的活動。
getEventSeriesById(iCalId)CalendarEventSeries取得具有指定 ID 的活動系列。
getEvents(startTime, endTime)CalendarEvent[]取得指定時間範圍內發生的所有事件。
getEvents(startTime, endTime, options)CalendarEvent[]取得在指定時間範圍內發生且符合指定條件的所有事件。
getEventsForDay(date)CalendarEvent[]取得特定日期發生的所有事件。
getEventsForDay(date, options)CalendarEvent[]取得在指定日期發生且符合指定條件的所有事件。
getId()String取得日曆的 ID。
getName()String取得日曆名稱。
getOwnedCalendarById(id)Calendar|null如果使用者擁有指定 ID 的日曆,系統會擷取該日曆。
getOwnedCalendarsByName(name)Calendar[]取得使用者擁有的所有指定名稱日曆。
getTimeZone()String取得日曆的時區。
isHidden()Boolean決定日曆是否隱藏在使用者介面中。
isMyPrimaryCalendar()Boolean判斷日曆是否為有效使用者的主要日曆。
isOwnedByMe()Boolean判斷日曆是否為你所有。
isSelected()Boolean決定是否要在使用者介面中顯示日曆活動。
newRecurrence()EventRecurrence建立新的週期性物件,可用於建立活動週期性規則。
setColor(color)Calendar設定日曆的顏色。
setDescription(description)Calendar設定日曆說明。
setHidden(hidden)Calendar設定日曆是否顯示在使用者介面中。
setName(name)Calendar設定日曆名稱。
setSelected(selected)Calendar設定是否要在使用者介面中顯示日曆活動。
setTimeZone(timeZone)Calendar設定日曆的時區。
subscribeToCalendar(id)Calendar如果使用者有權訂閱,系統會使用指定 ID 訂閱日曆。
subscribeToCalendar(id, options)Calendar如果使用者有權訂閱,系統會使用指定 ID 訂閱日曆。

CalendarEvent

方法

方法傳回類型簡短說明
addEmailReminder(minutesBefore)CalendarEvent為活動新增電子郵件提醒。
addGuest(email)CalendarEvent將邀請對象新增到活動中。
addPopupReminder(minutesBefore)CalendarEvent為活動新增彈出式通知。
addSmsReminder(minutesBefore)CalendarEvent為活動新增簡訊提醒。
anyoneCanAddSelf()Boolean決定使用者是否能將自己新增為日曆活動的邀請對象。
deleteEvent()void刪除日曆活動。
deleteTag(key)CalendarEvent從事件中刪除鍵/值標記。
getAllDayEndDate()Date取得這個全天日曆活動的結束日期。
getAllDayStartDate()Date取得這個全天日曆活動的開始日期。
getAllTagKeys()String[]取得事件中設定的所有標記鍵。
getColor()String傳回日曆活動的顏色。
getCreators()String[]取得活動建立者。
getDateCreated()Date取得活動的建立日期。
getDescription()String取得活動說明。
getEmailReminders()Integer[]取得活動所有電子郵件提醒的分鐘值。
getEndTime()Date取得日曆活動的結束日期和時間。
getEventSeries()CalendarEventSeries取得此活動所屬的週期性活動系列。
getEventType()EventType取得這項活動的 EventType
getGuestByEmail(email)EventGuest依電子郵件地址取得邀請對象。
getGuestList()EventGuest[]取得活動的邀請對象,但不包括活動擁有者。
getGuestList(includeOwner)EventGuest[]取得活動的邀請對象,可能包括活動擁有者。
getId()String取得活動的專屬 iCalUID。
getLastUpdated()Date取得活動上次更新的日期。
getLocation()String取得活動地點。
getMyStatus()GuestStatus取得有效使用者的活動狀態 (例如出席或受邀)。
getOriginalCalendarId()String取得當初建立活動的日曆 ID。
getPopupReminders()Integer[]取得活動所有彈出式提醒的分鐘值。
getSmsReminders()Integer[]取得活動所有簡訊提醒的分鐘值。
getStartTime()Date取得這項日曆活動的開始日期和時間。
getTag(key)String取得事件的標記值。
getTitle()String取得活動的名稱。
getTransparency()EventTransparency取得活動的透明度。
getVisibility()Visibility取得活動的顯示設定。
guestsCanInviteOthers()Boolean決定邀請對象是否可以邀請其他邀請對象。
guestsCanModify()Boolean決定邀請對象是否可以修改活動。
guestsCanSeeGuests()Boolean決定邀請對象是否能看到其他邀請對象。
isAllDayEvent()Boolean判斷這是否為全天活動。
isOwnedByMe()Boolean判斷您是否為活動擁有者。
isRecurringEvent()Boolean判斷活動是否為系列活動的一部分。
removeAllReminders()CalendarEvent移除活動中的所有提醒。
removeGuest(email)CalendarEvent從活動中移除邀請對象。
resetRemindersToDefault()CalendarEvent使用日曆的預設設定重設提醒。
setAllDayDate(date)CalendarEvent設定活動日期。
setAllDayDates(startDate, endDate)CalendarEvent設定活動日期。
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEvent設定非邀請對象是否可自行加入活動。
setColor(color)CalendarEvent設定日曆活動的顏色。
setDescription(description)CalendarEvent設定活動說明。
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEvent設定邀請對象是否可以邀請其他邀請對象。
setGuestsCanModify(guestsCanModify)CalendarEvent設定邀請對象是否可以修改活動。
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEvent設定邀請對象是否能看到其他邀請對象。
setLocation(location)CalendarEvent設定活動地點。
setMyStatus(status)CalendarEvent設定有效使用者的活動狀態 (例如出席或受邀)。
setTag(key, value)CalendarEvent在事件中設定鍵/值標記,用於儲存自訂中繼資料。
setTime(startTime, endTime)CalendarEvent設定活動的開始和結束日期與時間。
setTitle(title)CalendarEvent設定活動名稱。
setTransparency(transparency)CalendarEvent設定活動的透明度。
setVisibility(visibility)CalendarEvent設定活動的顯示狀態。

CalendarEventSeries

方法

方法傳回類型簡短說明
addEmailReminder(minutesBefore)CalendarEventSeries為活動新增電子郵件提醒。
addGuest(email)CalendarEventSeries將邀請對象新增到活動中。
addPopupReminder(minutesBefore)CalendarEventSeries為活動新增彈出式通知。
addSmsReminder(minutesBefore)CalendarEventSeries為活動新增簡訊提醒。
anyoneCanAddSelf()Boolean決定使用者是否能將自己新增為日曆活動的邀請對象。
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取得當初建立活動的日曆 ID。
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設定活動的顯示狀態。

Color

屬性

屬性類型說明
BLUEEnum
藍色 (#2952A3)。
BROWNEnum
棕色 (#8D6F47)。
CHARCOALEnum
石墨黑 (#4E5D6C)。
CHESTNUTEnum
栗棕色 (#865A5A)。
GRAYEnum
灰色 (#5A6986)。
GREENEnum
綠色 (#0D7813)。
INDIGOEnum
Indigo (#5229A3)。
LIMEEnum
Lime (#528800)。
MUSTARDEnum
芥末 (#88880E)。
OLIVEEnum
橄欖色 (#6E6E41)。
ORANGEEnum
橘色 (#BE6D00)。
PINKEnum
粉紅色 (#B1365F)。
PLUMEnum
紫紅色 (#705770)。
PURPLEEnum
紫色 (#7A367A)。
REDEnum
紅色 (#A32929)。
RED_ORANGEEnum
橘紅色 (#B1440E)。
SEA_BLUEEnum
海藍色 (#29527A)。
SLATEEnum
插入畫面 (#4A716C)。
TEALEnum
藍綠色 (#28754E)。
TURQOISEEnum
藍綠色 (#1B887A)。
YELLOWEnum
黃色 (#AB8B00)。

EventColor

屬性

屬性類型說明
PALE_BLUEEnum
淺藍色 ("1"),在日曆 UI 中稱為「薰衣草色」。
PALE_GREENEnum
淡綠色 ("2"),在日曆 UI 中稱為「鼠尾草」。
MAUVEEnum
紫紅色 ("3"),在日曆 UI 中稱為「葡萄」。
PALE_REDEnum
淺紅色 ("4"),在日曆 UI 中稱為「火鶴」。
YELLOWEnum
黃色 ("5"),在 Google 日曆使用者介面中稱為「香蕉」。
ORANGEEnum
橘色 ("6"),在日曆 UI 中稱為「橙橘色」。
CYANEnum
青色 ("7"),在 Google 日曆使用者介面中稱為「孔雀藍」。
GRAYEnum
灰色 ("8"),在日曆使用者介面中稱為「石墨色」。
BLUEEnum
藍色 ("9"),在日曆 UI 中稱為「藍莓」。
GREENEnum
綠色 ("10"),在日曆 UI 中稱為「羅勒」。
REDEnum
紅色 ("11"):在日曆使用者介面中稱為「番茄」。

EventGuest

方法

方法傳回類型簡短說明
getAdditionalGuests()Integer取得這位訪客表示會出席的額外人數。
getEmail()String取得邀請對象的電子郵件地址。
getGuestStatus()GuestStatus取得活動邀請對象的狀態。
getName()String取得訪客姓名。

EventRecurrence

方法

方法傳回類型簡短說明
addDailyExclusion()RecurrenceRule新增規則,每天排除特定情況。
addDailyRule()RecurrenceRule新增規則,讓活動每天重複發生。
addDate(date)EventRecurrence新增規則,讓活動在特定日期重複發生。
addDateExclusion(date)EventRecurrence新增規則,排除特定日期的活動。
addMonthlyExclusion()RecurrenceRule新增規則,每月排除特定日期。
addMonthlyRule()RecurrenceRule新增規則,讓活動每月重複發生。
addWeeklyExclusion()RecurrenceRule新增規則,每週排除特定日期。
addWeeklyRule()RecurrenceRule新增規則,讓活動每週重複發生。
addYearlyExclusion()RecurrenceRule新增每年排除特定日期的規則。
addYearlyRule()RecurrenceRule新增規則,讓活動每年重複發生。
setTimeZone(timeZone)EventRecurrence設定這個週期性活動的時區。

EventTransparency

屬性

屬性類型說明
OPAQUEEnum活動會封鎖日曆上的時間。
TRANSPARENTEnum活動不會在日曆上封鎖時間。

EventType

屬性

屬性類型說明
DEFAULTEnum活動為一般活動。
BIRTHDAYEnum活動是每年舉辦的特殊全天活動。
FOCUS_TIMEEnum活動為專注時間活動。
FROM_GMAILEnum活動是從 Gmail 建立。
OUT_OF_OFFICEEnum活動為不在辦公室的活動。
WORKING_LOCATIONEnum活動是工作地點活動。

GuestStatus

屬性

屬性類型說明
INVITEDEnum已邀請受邀者,但對方尚未表明是否出席。
MAYBEEnum邀請對象表示可能會出席。
NOEnum邀請對象已表明不會出席。
OWNEREnum邀請對象是活動擁有者。
YESEnum邀請對象已表示會出席。

RecurrenceRule

方法

方法傳回類型簡短說明
addDailyExclusion()RecurrenceRule新增規則,每天排除特定情況。
addDailyRule()RecurrenceRule新增規則,讓活動每天重複發生。
addDate(date)EventRecurrence新增規則,讓活動在特定日期重複發生。
addDateExclusion(date)EventRecurrence新增規則,排除特定日期的活動。
addMonthlyExclusion()RecurrenceRule新增規則,每月排除特定日期。
addMonthlyRule()RecurrenceRule新增規則,讓活動每月重複發生。
addWeeklyExclusion()RecurrenceRule新增規則,每週排除特定日期。
addWeeklyRule()RecurrenceRule新增規則,讓活動每週重複發生。
addYearlyExclusion()RecurrenceRule新增每年排除特定日期的規則。
addYearlyRule()RecurrenceRule新增規則,讓活動每年重複發生。
interval(interval)RecurrenceRule設定規則,只在規則時間單位的這個間隔套用規則。
onlyInMonth(month)RecurrenceRule設定規則,只在特定月份生效。
onlyInMonths(months)RecurrenceRule設定規則,只套用至特定月份。
onlyOnMonthDay(day)RecurrenceRule設定規則,只在每月的特定日期套用。
onlyOnMonthDays(days)RecurrenceRule設定規則,只在每月的特定日期套用。
onlyOnWeek(week)RecurrenceRule設定規則,只套用至一年中的特定週。
onlyOnWeekday(day)RecurrenceRule設定規則,只在一週的特定一天套用。
onlyOnWeekdays(days)RecurrenceRule設定規則,只在一週內的某幾天套用。
onlyOnWeeks(weeks)RecurrenceRule設定規則,只在一年中的特定週套用。
onlyOnYearDay(day)RecurrenceRule設定規則,只在一年中的特定日期套用。
onlyOnYearDays(days)RecurrenceRule設定規則,只在一年中的特定日期套用。
setTimeZone(timeZone)EventRecurrence設定這個週期性活動的時區。
times(times)RecurrenceRule設定規則,在達到指定次數後結束。
until(endDate)RecurrenceRule設定規則的結束日期 (含)。
weekStartsOn(day)RecurrenceRule設定一週的起始日,以套用規則。

Visibility

屬性

屬性類型說明
CONFIDENTIALEnum活動為私人活動。
DEFAULTEnum使用日曆中活動的預設瀏覽權限。
PRIVATEEnum活動為私人性質,只有活動出席者可以查看活動詳細資料。
PUBLICEnum活動為公開,日曆的所有讀者都能查看活動詳細資料。