Events: import

导入事件。此操作用于将现有活动的不公开副本添加到日历。只能导入 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，以及使用 sessionData 的 createRequest 字段创建新会议。默认值为 0。 可接受的值包括 0 到 1（含）。
supportsAttachments boolean 执行操作的 API 客户端是否支持事件附件。可选。默认值为 False。

授权

此请求需要获得以下至少一个范围的授权：

范围
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

如需了解详情，请参阅身份验证和授权页面。

请求正文

在请求正文中，提供具有以下属性的 Events 资源：

属性名称 值 说明 备注
必需属性
end nested object 相应事件的（不含）结束时间。对于周期性活动，这是首次实例的结束时间。
iCalUID string RFC5545 中定义的事件唯一标识符。该属性用于跨日历系统唯一标识活动，并且必须在通过 import 方法导入事件时提供。

请注意，iCalUID 和 id 不完全相同，在创建事件时应仅提供其中一个。它们在语义上的一个区别是，在周期性事件中，一个事件的所有出现都具有不同的 id，而它们都具有相同的 iCalUID。如需使用事件的 iCalUID 检索事件，请使用 iCalUID 参数调用 events.list 方法。要使用事件的 id 检索事件，请调用 events.get 方法。
start nested object 事件开始时间（含此时间）。对于周期性活动，这是首次实例的开始时间。
可选属性
anyoneCanAddSelf boolean 是否任何人都可以邀请自己参加活动（已弃用）。可选。默认值为 False。 可写入
attachments[].fileUrl string 指向附件的网址链接。

如需添加 Google 云端硬盘文件附件，请使用与 Drive API 中 Files 资源的 alternateLink 属性相同的格式。

添加附件时必填。

 可写入
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 参加者的回复状态。可能的值有：
  • “needsAction”- 参加者尚未回复邀请（建议用于新活动）。
  • “declined”- 参加者已拒绝邀请。
  • “tentative”- 参加者暂时接受邀请。
  • “accepted”- 参加者已接受邀请。
 可写入
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 时区数据库名称，例如“欧洲/苏黎世”）。对于周期性活动，此字段为必填字段，用于指定重复活动在哪个时区展开。对于单个事件，此字段为可选字段，表示事件开始/结束的自定义时区。 可写入
extendedProperties.private object 仅对此日历上显示的活动副本有效的属性。 可写入
extendedProperties.shared object 在其他参加者的日历上的活动副本之间共享的属性。 可写入
focusTimeProperties nested object 专注时间事件数据。如果 eventType 为 focusTime，使用此属性。 可写入
gadget.display string 小工具的显示模式。已弃用。可能的值有：
  • “icon”- 小工具会显示在日历视图中的活动标题旁边。
  • “chip”- 用户点击活动时，系统会显示小工具。
 可写入
gadget.height integer 小工具的高度（以像素为单位）。高度必须是大于 0 的整数。可选。已弃用。 可写入
gadget.preferences object 偏好设置。 可写入
gadget.title string 小工具的标题。已弃用。 可写入
gadget.type string 小工具的类型。已弃用。 可写入
gadget.width integer 小工具的宽度（以像素为单位）。宽度必须是大于 0 的整数。可选。已弃用。 可写入
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 时区数据库名称，例如“欧洲/苏黎世”）。对于周期性活动，此字段为必填字段，用于指定重复活动在哪个时区展开。对于单个事件，此字段为可选字段，表示事件开始/结束的自定义时区。 可写入
outOfOfficeProperties nested object 不在办公室的活动数据。如果 eventType 为 outOfOffice，使用此属性。 可写入
recurrence[] list RFC5545 中指定的周期性事件的 RRULE、EXRULE、RDATE 和 EXDATE 行列表。请注意，此字段中不允许使用 DTSTART 和 DTEND 行，而要在 start 和 end 字段中指定事件的开始时间和结束时间。单个活动或周期性活动实例将省略此字段。 可写入
reminders.overrides[] list 如果活动未使用默认提醒，则会列出专门针对该活动的提醒；如果未设置提醒，则表示没有为此活动设置提醒。替换提醒数量上限为 5 个。 可写入
reminders.overrides[].method string 此提醒使用的方法。可能的值有：
  • “email”- 提醒通过电子邮件发送。
  • “popup”- 通过界面弹出式窗口发送提醒。

添加提醒时必填。

 可写入
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 时区数据库名称，例如“欧洲/苏黎世”）。对于周期性活动，此字段为必填字段，用于指定重复活动在哪个时区展开。对于单个事件，此字段为可选字段，表示事件开始/结束的自定义时区。 可写入
status string 事件的状态。可选。可能的值有：
  • “confirmed”：活动已确认。这是默认状态。
  • “tentative”- 系统暂时确认活动。
  • “cancelled”- 活动已取消（已删除）。只有在执行增量同步时（指定 syncToken 或 updatedMin 时）或 showDeleted 标志设置为 true 时，list 方法才会返回已取消的事件。get 方法始终会返回这些属性。

    “已取消”状态表示两种不同的状态，具体取决于事件类型：

    1. 已取消取消的周期性活动的异常表示不应再向用户显示此实例。客户端应在父级周期性事件的生命周期内存储这些事件。

      对于已取消的异常，系统只会保证填充 id、recurringEventId 和 originalStartTime 字段的值。其他字段可能为空。

    2. 所有其他已取消的活动均表示已删除的活动。客户端应移除其本地同步的副本。此类取消的事件最终会消失，因此请不要指望它们无限期可用。

      对于已删除的活动，只能保证填充 id 字段。

    。在组织者的日历中，已取消的活动会继续显示活动详细信息（摘要、地点等），以便您恢复（取消删除）这些活动。同样，用户受邀参与但用户手动移除的活动仍会提供详细信息。但是，showDeleted 设置为 false 的增量同步请求不会返回这些详细信息。

    如果某个活动更改了组织者（例如通过移动操作），而原组织者不在参加者列表中，则该活动留下已取消的活动，而系统保证只填充 id 字段。

 可写入
summary string 活动的标题。 可写入
transparency string 活动是否会在日历上占用时间。可选。可能的值有：
  • “opaque”- 默认值。此活动会占用日历上的时间。效果相当于在 Google 日历界面中将状态显示为设置为忙碌。
  • “transparent”- 此活动不会阻止日历上的时间。这相当于在日历界面中将显示为设置为有空。
 可写入
visibility string 活动的公开范围。可选。可能的值有：
  • “default”- 使用日历中活动的默认公开范围。这是默认值。
  • “public”- 此活动是公开的，日历的所有读者均可看到活动详细信息。
  • “private”- 此活动是私人活动，只有活动参加者才能查看活动详细信息。
  • “confidential”- 此活动是不公开的活动。提供此值是为了确保兼容性。
 可写入

响应

如果成功，此方法将在响应正文中返回一项 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 对实际数据调用此方法，并查看响应。