Calendar Service

日曆

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

類別

名稱簡短說明
Calendar代表使用者擁有或訂閱的日曆。
CalendarApp允許指令碼讀取及更新使用者的 Google 日曆。
CalendarEvent代表單一日曆活動。
CalendarEventSeries代表一系列事件 (週期性活動)。
Color代表日曆服務中可用的命名顏色的列舉。
EventColor代表日曆服務中可用的命名活動顏色的列舉。
EventGuest代表活動的邀請對象。
EventRecurrence代表活動系列的週期性設定。
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代表日曆服務中可用的命名活動顏色的列舉。
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取得具有指定 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取得使用者擁有的指定 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為活動新增 SMS 提醒。
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取得事件的標題。
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設定事件的標題。
setVisibility(visibility)CalendarEvent設定活動的瀏覽權限。

CalendarEventSeries

方法

方法傳回類型簡短說明
addEmailReminder(minutesBefore)CalendarEventSeries新增活動電子郵件提醒。
addGuest(email)CalendarEventSeries將邀請對像新增至活動。
addPopupReminder(minutesBefore)CalendarEventSeries為事件新增彈出式通知。
addSmsReminder(minutesBefore)CalendarEventSeries為活動新增 SMS 提醒。
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取得事件的標題。
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設定活動的名稱。
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
Olive (#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 中稱為「Sage」。
MAUVEEnum
Mauve ("3"),在日曆 UI 中稱為「Grape」。
PALE_REDEnum
日曆 UI 中的淡紅色 ("4"),稱為「Flamingo」。
YELLOWEnum
黃色 ("5"),在 Google 日曆 UI 中稱為「Banana」。
ORANGEEnum
橘色 ("6"),在 Google 日曆 UI 中稱為「陌生人」。
CYANEnum
青色 ("7"),在日曆 UI 中稱為「薰衣草色」。
GRAYEnum
灰色 ("8"),在日曆 UI 中稱為「Graphite」。
BLUEEnum
藍色 ("9"),在日曆 UI 中稱為「藍莓」。
GREENEnum
綠色 ("10"),在日曆 UI 中稱為「Basil」。
REDEnum
紅色 ("11"),在日曆 UI 中稱為「番茄形」。

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設定這個週期重複事件的時區。

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活動為公開,所有日曆讀者都能查看活動詳細資料。