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為活動新增簡訊提醒。
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為活動新增簡訊提醒。
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
萊姆 (#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")。
PALE_GREENEnum
淡綠色 ("2")。
MAUVEEnum
Mauve ("3")。
PALE_REDEnum
淡紅色 ("4")。
YELLOWEnum
黃色 ("5")。
ORANGEEnum
橘色 ("6")。
CYANEnum
青色 ("7")。
GRAYEnum
灰色 ("8")。
BLUEEnum
藍色 ("9")。
GREENEnum
綠色 ("10")。
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設定這個重複週期的時區。

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這是公開活動,日曆的所有讀者都能看到活動詳細資訊。