カレンダー
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
Events and invitations, as the Calendar page of the app shows them: list a window, read an event or the one a thread carries, put events on the calendar and change them, call off a meeting, and answer an invitation. A change that invites, updates or cancels attendees, and every answer, goes out by email, so it also needs emails:send.
GET/calendar/events
List occurrences in a window
from and to are REQUIRED. Occurrences are expanded from recurrence rules, so a calendar has no meaningful unbounded listing. A default window would turn an infinite series into a question with no answer. At most a year apart.
Requires the calendar:read scope.
クエリパラメーター
fromstring必須Start of the window.
形式date-timetostring必須End of the window, after
fromand at most 366 days later.形式date-timetimezonestring必須IANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
1以上100以下既定値25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
戻り値
A page of occurrences, sorted by start and then by event id, with hasMore and nextCursor. Send the same from, to and timezone with every cursor. Nothing in the window is dropped: a series repeats at most once a day, so it gives at most one occurrence per day of the window, and every one is reachable through the pages. The cursor holds the start and event id of the last row, so an event deleted or moved between pages never breaks the walk.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/calendar/events
Create an event
Puts an event on the calendar, as New event on the Calendar page of the app does. start and end are ISO 8601 with a zone, and timezone is the IANA zone the event belongs to, UTC unless you say. recurrence takes an RRULE such as FREQ=WEEKLY;BYDAY=MO, and reminders the minutes before the start.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
リクエストボディ
summarystring必須The title, 1 to 255 characters.
1〜255文字descriptionstringNotes about the event, up to 8,000 characters.
8000文字までlocationstringWhere it is: a room, an address or a link.
255文字までurlstringA link that belongs to the event.
2000文字まで形式uristartstring必須When it starts, a
Dateor ISO 8601 with a zone.形式date-timeendstring必須When it ends, after
startand at most two years later.形式date-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1〜64文字recurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.512文字までattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.200件までemailstring必須- 320文字まで形式
email namestring- 128文字まで
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.5件までminutesBeforeinteger必須- 0以上40320以下
actionstring- 次のいずれか
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.次のいずれか"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.次のいずれか"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
320文字まで
戻り値
The event, with its attendees.
エラー
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/calendar/events/{id}
Retrieve an event
The event with its attendees and their responses. rawIcs is omitted. Everything understood in it is already structured here, and /ics serves the document.
Requires the calendar:read scope.
パスパラメーター
idstring必須Event id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
戻り値
The event.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
PATCH/calendar/events/{id}
Change an event
Changes an event you organise. A field left out keeps its value, and attendees replaces the whole list. Everyone invited gets the updated invitation.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
パスパラメーター
idstring必須The event id from
GET /calendar/events.
リクエストボディ
summarystringThe title, 1 to 255 characters.
1〜255文字descriptionstringNotes about the event, up to 8,000 characters.
8000文字までlocationstringWhere it is: a room, an address or a link.
255文字までurlstringA link that belongs to the event.
2000文字まで形式uristartstringWhen it starts, a
Dateor ISO 8601 with a zone.形式date-timeendstringWhen it ends, after
startand at most two years later.形式date-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1〜64文字recurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.512文字までattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.200件までemailstring必須- 320文字まで形式
email namestring- 128文字まで
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.5件までminutesBeforeinteger必須- 0以上40320以下
actionstring- 次のいずれか
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.次のいずれか"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.次のいずれか"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
320文字まで
戻り値
The event as it stands now.
エラー
- 403
not_organizer: the event was organised by somebody else, so you can only answer it.from_address_forbidden: the key or app may not send asfrom.- 409
event_cancelled: the meeting was called off.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
DELETE/calendar/events/{id}
Remove an event
Removes an event from the calendar for good, as Remove does in the app. Nobody else is told: to call off a meeting with others in it, use POST /calendar/events/{id}/cancel.
Requires the calendar:write scope.
パスパラメーター
idstring必須The event id from
GET /calendar/events.
戻り値
The event is gone.
エラー
- 403
not_organizer: the event was organised by somebody else.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/calendar/events/{id}/ics
The event as an .ics document
Served as text/calendar with NO METHOD parameter. A METHOD makes a document actionable (a client seeing method=REQUEST draws accept/decline and can reply to the organiser), and this endpoint has no authority to invite anybody on the workspace behalf. It states what the event currently is.
Requires the calendar:read scope.
パスパラメーター
idstring必須Event id, the
eventIdof an occurrence.
戻り値
text/calendarAn iCalendar document.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/calendar/events/{id}/cancel
Cancel a meeting
Calls off a meeting you organise, as Cancel meeting does in the app. It stays on the calendar with status CANCELLED, and everyone invited is told it is off, from the address in from, so a meeting with attendees also needs emails:send. The body is optional.
Requires the calendar:write scope.
パスパラメーター
idstring必須The event id from
GET /calendar/events.
リクエストボディ
fromstringThe address the cancellation comes from. It has to be one the key may send as.
320文字まで
戻り値
The event, cancelled.
エラー
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
POST/calendar/events/{id}/respond
Answer an invitation
Accepts, declines or tentatively accepts an invitation, as the buttons of an invitation in the app do. The answer goes to the organiser by email from the invited address the key or app may send as, or from respondingAs when the invitation went to more than one of yours.
Requires the calendar:write and emails:send scopes.
パスパラメーター
idstring必須The event id from
GET /calendar/events.
リクエストボディ
responsestring必須ACCEPTED,DECLINEDorTENTATIVE.次のいずれか"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
320文字まで
戻り値
The event, with your answer.
エラー
- 403
not_invited: the event did not inviterespondingAs, or any address the key or app may send as.- 409
event_cancelled: the meeting was called off.reply_not_sent: the answer could not be sent to the organiser, so nothing changed.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/threads/{id}/event
The event a thread carries
The calendar event that came with an invitation in the thread, as the invitation card of the reading pane shows it. A thread with no event, or one the key or app does not reach, is a 404. Answer it with POST /calendar/events/{id}/respond.
Requires the calendar:read scope.
パスパラメーター
idstring必須The thread id.
戻り値
The event.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
オブジェクト
CalendarEventobject
objectstring必須- 次のいずれか
"calendar_event" idstring必須uidstring必須The iCalendar UID every copy of the event shares.
sequenceinteger- 0以上
summarystring- null も可
descriptionstring- null も可
locationstring- null も可
urlstring- null も可
startstring必須- 形式
date-time endstring必須- 形式
date-time allDaybooleantimezonestring- null も可
recurrencestringThe RRULE, when it repeats.
null も可exdatesstring[]statusstring必須CONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- null も可
emailstringnamestring- null も可
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- null も可
threadIdstring- null も可
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]必須objectstring- 次のいずれか
"calendar_attendee" emailstringnamestring- null も可
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- null も可
respondedAtstring- null も可形式
date-time
createdAtstring- 形式
date-time updatedAtstring- 形式
date-time
DeletedCalendarEventobject
objectstring必須- 次のいずれか
"calendar_event" idstring必須deletedboolean必須- 次のいずれか
true