导入事件。此操作用于将现有活动的私人副本添加到日历中。只能导入 eventType
为 default
的事件。
已废弃的行为:如果导入的事件不是 default
事件,其类型将更改为 default
,并且系统会丢弃该事件可能具有的任何事件类型专用属性。
请求
HTTP 请求
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/import
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
calendarId |
string |
日历标识符。如需检索日历 ID,请调用 calendarList.list 方法。如果您想访问当前登录用户的主要日历,请使用“primary ”关键字。
|
可选的查询参数 | ||
conferenceDataVersion |
integer |
API 客户端支持的会议数据的版本号。版本 0 假定不支持会议数据,并会忽略事件正文中的会议数据。版本 1 支持复制 ConferenceData,以及使用 conferenceData 的 createRequest 字段创建新会议。默认值为 0。
可接受的值为 0 到 1 (含)。
|
supportsAttachments |
boolean |
执行操作的 API 客户端是否支持事件附件。可选。默认值为 False。 |
授权
此请求需要获得以下至少一个范围的授权:
范围 |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
如需了解详情,请参阅身份验证和授权页面。
请求正文
在请求正文中,提供具有以下属性的 Events 资源:
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
必需属性 | |||
end |
nested object |
活动的结束时间(不含)。对于周期性活动,这是第一个实例的结束时间。 | |
iCalUID |
string |
事件唯一标识符,如 RFC5545 中所定义。它用于在日历系统中唯一标识事件,并且在通过import方法导入事件时必须提供。 请注意, |
|
start |
nested object |
活动的开始时间(包括此时间)。对于周期性活动,这是第一个实例的开始时间。 | |
可选属性 | |||
anyoneCanAddSelf |
boolean |
是否允许任何人邀请自己参加活动(已废弃)。可选。默认值为 False。 | 可写入 |
attachments[].fileUrl |
string |
指向附件的网址链接。 如需添加 Google 云端硬盘文件附件,请使用与 Drive API 中 添加附件时必须指定此值。 |
可写入 |
attendees[] |
list |
活动的参加者。如需详细了解如何与其他日历用户一起安排活动,请参阅包含参加者的活动指南。服务账号需要使用全网域授权来填充参加者名单。 | 可写入 |
attendees[].additionalGuests |
integer |
额外入住的房客人数。可选。默认值为 0。 | 可写入 |
attendees[].comment |
string |
参加者对回复的评论。可选。 | 可写入 |
attendees[].displayName |
string |
参加者姓名(如果有)。可选。 | 可写入 |
attendees[].email |
string |
参加者(如有)的电子邮件地址。添加参加者时,此字段必须填写。该地址必须是符合 RFC5322 的有效电子邮件地址。 添加参加者时必须提供。 |
可写入 |
attendees[].optional |
boolean |
此人是否为可选参加者。可选。默认值为 False。 | 可写入 |
attendees[].resource |
boolean |
参加者是否为资源。仅当参加者首次添加到活动时才能设置。系统会忽略后续的修改。可选。默认值为 False。 | 可写入 |
attendees[].responseStatus |
string |
参加者回复的状态。可能的值包括:
|
可写入 |
attendeesOmitted |
boolean |
参加者是否可能已从活动的表示法中省略。检索事件时,这可能是因为 maxAttendee 查询参数指定了限制。更新活动时,此参数可用于仅更新参与者的回复。可选。默认值为 False。 |
可写入 |
colorId |
string |
事件的颜色。此 ID 是指颜色定义的 event 部分中的条目(请参阅 颜色端点)。可选。 |
可写入 |
conferenceData |
nested object |
与会议相关的信息,例如 Google Meet 会议的详细信息。如需创建新的会议详细信息,请使用 createRequest 字段。如需保留更改,请务必为所有事件修改请求将 conferenceDataVersion 请求参数设置为 1 。 |
可写入 |
description |
string |
活动的说明。可以包含 HTML。可选。 | 可写入 |
end.date |
date |
如果是全天活动,则为日期(格式为“yyyy-mm-dd”)。 | 可写入 |
end.dateTime |
datetime |
时间,作为组合日期时间值(采用 RFC3339 格式)。除非在 timeZone 中明确指定时区,否则必须指定时区偏移量。 |
可写入 |
end.timeZone |
string |
指定时间的时区。(格式为 IANA 时区数据库名称,例如“Europe/Zurich”)。对于周期性活动,此字段是必填字段,用于指定展开周期性活动时所采用的时区。对于单个事件,此字段为可选字段,用于指明事件开始/结束的自定义时区。 | 可写入 |
extendedProperties.private |
object |
此日历上显示的活动副本的私有属性。 | 可写入 |
extendedProperties.shared |
object |
其他参加者日历中活动副本之间共享的属性。 | 可写入 |
focusTimeProperties |
nested object |
“专注时间”活动数据。如果 eventType 设为 focusTime ,则此字段适用。 |
可写入 |
gadget.display |
string |
小工具的显示模式。已弃用。可能的值包括:
|
可写入 |
gadget.height |
integer |
小工具的高度(以像素为单位)。高度必须是正整数。可选。已弃用。 | 可写入 |
gadget.iconLink |
string |
该微件图标的网址。网址架构必须为 HTTPS。已弃用。 | 可写入 |
gadget.link |
string |
该微件网址。网址架构必须为 HTTPS。已弃用。 | 可写入 |
gadget.preferences |
object |
偏好设置。 | 可写入 |
gadget.title |
string |
微件的标题。已弃用。 | 可写入 |
gadget.type |
string |
该小工具的类型。已弃用。 | 可写入 |
gadget.width |
integer |
该小工具的宽度(以像素为单位)。宽度必须是正整数。可选。已弃用。 | 可写入 |
guestsCanInviteOthers |
boolean |
组织者以外的参加者是否可以邀请他人参加活动。可选。默认值为 True。 | 可写入 |
guestsCanModify |
boolean |
组织者以外的参加者是否可以修改活动。可选。默认值为 False。 | 可写入 |
guestsCanSeeOtherGuests |
boolean |
组织者以外的参加者能否查看活动的参加者。可选。默认值为 True。 | 可写入 |
location |
string |
活动的地理位置(自由格式文本)。可选。 | 可写入 |
organizer |
object |
活动的组织者。如果组织者也是参加者,则 attendees 中会有一个单独的条目,其中 organizer 字段设置为 True。如需更改组织者,请使用移动操作。只读(导入事件时除外)。 |
可写入 |
organizer.displayName |
string |
组织者的姓名(如果有)。 | 可写入 |
organizer.email |
string |
组织者的电子邮件地址(如果有)。该地址必须是符合 RFC5322 的有效电子邮件地址。 | 可写入 |
originalStartTime.date |
date |
如果是全天活动,则为日期(格式为“yyyy-mm-dd”)。 | 可写入 |
originalStartTime.dateTime |
datetime |
时间,作为组合日期时间值(采用 RFC3339 格式)。除非在 timeZone 中明确指定时区,否则必须指定时区偏移量。 |
可写入 |
originalStartTime.timeZone |
string |
指定时间的时区。(格式为 IANA 时区数据库名称,例如“Europe/Zurich”)。对于周期性活动,此字段是必填字段,用于指定展开周期性活动时所采用的时区。对于单个事件,此字段为可选字段,用于指明事件开始/结束的自定义时区。 | 可写入 |
outOfOfficeProperties |
nested object |
“不在办公室”活动数据。如果 eventType 设为 outOfOffice ,则此字段适用。 |
可写入 |
recurrence[] |
list |
如 RFC5545 中所指定,重复性事件的 RRULE、EXRULE、RDATE 和 EXDATE 行列表。请注意,此字段不允许使用 DTSTART 和 DTEND 行;活动的开始时间和结束时间应在 start 和 end 字段中指定。对于单个事件或周期性事件的实例,系统会忽略此字段。 |
可写入 |
reminders.overrides[] |
list |
如果活动不使用默认提醒,此字段会列出特定于该活动的提醒;如果未设置,则表示未为此活动设置任何提醒。替换提醒的数量上限为 5 个。 | 可写入 |
reminders.overrides[].method |
string |
此提醒所使用的提醒方法。可能的值包括:
添加提醒时必填。 |
可写入 |
reminders.overrides[].minutes |
integer |
提醒应在活动开始前多少分钟触发。有效值介于 0 到 40320(4 周,以分钟为单位)之间。 添加提醒时必填。 |
可写入 |
reminders.useDefault |
boolean |
日历的默认提醒是否适用于活动。 | 可写入 |
sequence |
integer |
序列号(根据 iCalendar)。 | 可写入 |
source.title |
string |
来源的标题;例如网页标题或电子邮件主题。 | 可写入 |
source.url |
string |
指向资源的来源的网址。网址架构必须为 HTTP 或 HTTPS。 | 可写入 |
start.date |
date |
如果是全天活动,则为日期(格式为“yyyy-mm-dd”)。 | 可写入 |
start.dateTime |
datetime |
时间,作为组合日期时间值(采用 RFC3339 格式)。除非在 timeZone 中明确指定时区,否则必须指定时区偏移量。 |
可写入 |
start.timeZone |
string |
指定时间的时区。(格式为 IANA 时区数据库名称,例如“Europe/Zurich”)。对于周期性活动,此字段是必填字段,用于指定展开周期性活动时所采用的时区。对于单个事件,此字段为可选字段,用于指明事件开始/结束的自定义时区。 | 可写入 |
status |
string |
活动的状态。可选。可能的值包括:
|
可写入 |
summary |
string |
活动的标题。 | 可写入 |
transparency |
string |
活动是否会占用日历上的时间。可选。可能的值包括:
|
可写入 |
visibility |
string |
活动的公开范围。可选。可能的值包括:
|
可写入 |
响应
如果成功,此方法将在响应正文中返回一项 Events 资源。
示例
注意:此方法的代码示例并未列出所有受支持的编程语言(请参阅客户端库页面,查看受支持的语言列表)。
Java
使用 Java 客户端库。
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Event; import com.google.api.services.calendar.model.EventAttendee; import com.google.api.services.calendar.model.EventDateTime; import com.google.api.client.util.DateTime; import java.util.Date; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Create and initialize a new event (could also retrieve an existing event) Event event = new Event(); event.setICalUID("originalUID"); Event.Organizer organizer = new Event.Organizer(); organizer.setEmail("organizerEmail"); organizer.setDisplayName("organizerDisplayName"); event.setOrganizer(organizer); ArrayList<EventAttendee> attendees = new ArrayList<EventAttendee>(); attendees.add(new EventAttendee().setEmail("attendeeEmail")); // ... event.setAttendees(attendees); Date startDate = new Date(); Date endDate = new Date(startDate.getTime() + 3600000); DateTime start = new DateTime(startDate, TimeZone.getTimeZone("UTC")); event.setStart(new EventDateTime().setDateTime(start)); DateTime end = new DateTime(endDate, TimeZone.getTimeZone("UTC")); event.setEnd(new EventDateTime().setDateTime(end)); // Import the event into a calendar Event importedEvent = service.events().calendarImport('primary', event).execute(); System.out.println(importedEvent.getId());
Python
使用 Python 客户端库。
event = { 'summary': 'Appointment', 'location': 'Somewhere', 'organizer': { 'email': 'organizerEmail', 'displayName': 'organizerDisplayName' }, 'start': { 'dateTime': '2011-06-03T10:00:00.000-07:00' }, 'end': { 'dateTime': '2011-06-03T10:25:00.000-07:00' }, 'attendees': [ { 'email': 'attendeeEmail', 'displayName': 'attendeeDisplayName', }, # ... ], 'iCalUID': 'originalUID' } imported_event = service.events().import_(calendarId='primary', body=event).execute() print imported_event['id']
PHP
使用 PHP 客户端库。
$event = new Google_Service_Calendar_Event(); $event->setSummary('Appointment'); $event->setLocation('Somewhere'); $start = new Google_Service_Calendar_EventDateTime(); $start->setDateTime('2011-06-03T10:00:00.000-07:00'); $event->setStart($start); $end = new Google_Service_Calendar_EventDateTime(); $end->setDateTime('2011-06-03T10:25:00.000-07:00'); $event->setEnd($end); $attendee1 = new Google_Service_Calendar_EventAttendee(); $attendee1->setEmail('attendeeEmail'); // ... $attendees = array($attendee1, // ..., ); $event->attendees = $attendees; $organizer = new Google_Service_Calendar_EventOrganizer(); $organizer->setEmail('organizerEmail'); $organizer->setDisplayName('organizerDisplayName'); $event->setOrganizer($organizer); $event->setICalUID('originalUID'); $importedEvent = $service->events->import('primary', $event); echo $importedEvent->getId();
Ruby
使用 Ruby 客户端库。
event = Google::Apis::CalendarV3::Event.new( summary: 'Appointment', location: 'Somewhere', organizer: { email: 'organizerEmail', display_name: 'organizerDisplayName' }, start: { date_time: '2011-06-03T10:00:00.000-07:00' }, end: { date_time: '2011-06-03T10:25:00.000-07:00' }, attendees: [ { email: 'attendeeEmail', display_name: 'attendeeDisplayName', }, # ... ], i_cal_uid: 'originalUID' ) result = client.import_event('primary', event) print result.id
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。