假设有一款应用可以帮助用户查找最佳徒步路线。通过将 远足计划作为日历活动,那么用户会获得很多帮助 自动整理照片Google 日历能帮助他们 提醒他们要做的事,以便他们可以放心无忧。此外,多亏了 无缝集成了 Google 产品,Google 即时会向他们发出 Google 地图会准时将其定向到会面地点。
本文介绍了如何创建日历活动并将其添加到用户的 日历。
添加活动
要创建事件,请调用
events.insert()
方法提供
至少这些参数:
calendarId
是日历标识符,可以是电子邮件地址 日历的名称或特殊关键字'primary'
,将使用登录用户的主日历。如果 您不知道要使用的日历的电子邮件地址, 可以在 Google 日历网页版的日历设置中查看 (在“日历网址”部分),您也可以查找 的calendarList.list()
调用。event
是要创建的事件,其中包含所有必要详细信息(例如 start) 和结束。仅有的两个必填字段是start
和end
。请参阅 有关完整事件集的event
参考文档 字段。
要成功创建事件,您需要:
- 将 OAuth 范围设置为
https://www.googleapis.com/auth/calendar
, 您拥有该用户的日历的编辑权限。 - 确保通过身份验证的用户拥有对该日历的写入权限,
您提供的
calendarId
(例如,通过调用calendarList.get()
适用于calendarId
并检查accessRole
)。
添加事件元数据
您可以在创建日历活动时选择添加活动元数据。如果您
选择在创建过程中不添加元数据,您可以使用
events.update()
;但有些字段
只能在活动触发期间设置
events.insert()
操作。
- 位置
在位置字段中添加地址可启用一些功能,例如:
“该出发了”或显示包含路线的地图。
- 事件 ID
创建活动时,您可以选择生成自己的活动 ID
并且符合我们的格式要求这样,您可以将实体 与 Google 日历中的活动保持同步。它还 防止在操作失败后某个时间点创建重复的活动 已成功在日历后端执行。如果拒绝 事件 ID,服务器会为您生成一个。请参阅事件 ID 参考。
- 参加者
您创建的活动会显示在以下所有主 Google 日历中:
同一活动 ID 所关联的参加者。如果您将 插入请求向
true
发送sendNotifications
,参加者将 还会收到有关该活动的电子邮件通知。使用 针对多名参加者的指南 。
以下示例演示了如何创建事件并设置其元数据:
Go
// Refer to the Go quickstart on how to setup the environment:
// https://developers.google.com/calendar/quickstart/go
// Change the scope to calendar.CalendarScope and delete any stored credentials.
event := &calendar.Event{
Summary: "Google I/O 2015",
Location: "800 Howard St., San Francisco, CA 94103",
Description: "A chance to hear more about Google's developer products.",
Start: &calendar.EventDateTime{
DateTime: "2015-05-28T09:00:00-07:00",
TimeZone: "America/Los_Angeles",
},
End: &calendar.EventDateTime{
DateTime: "2015-05-28T17:00:00-07:00",
TimeZone: "America/Los_Angeles",
},
Recurrence: []string{"RRULE:FREQ=DAILY;COUNT=2"},
Attendees: []*calendar.EventAttendee{
&calendar.EventAttendee{Email:"lpage@example.com"},
&calendar.EventAttendee{Email:"sbrin@example.com"},
},
}
calendarId := "primary"
event, err = srv.Events.Insert(calendarId, event).Do()
if err != nil {
log.Fatalf("Unable to create event. %v\n", err)
}
fmt.Printf("Event created: %s\n", event.HtmlLink)
Java
// Refer to the Java quickstart on how to setup the environment:
// https://developers.google.com/calendar/quickstart/java
// Change the scope to CalendarScopes.CALENDAR and delete any stored
// credentials.
Event event = new Event()
.setSummary("Google I/O 2015")
.setLocation("800 Howard St., San Francisco, CA 94103")
.setDescription("A chance to hear more about Google's developer products.");
DateTime startDateTime = new DateTime("2015-05-28T09:00:00-07:00");
EventDateTime start = new EventDateTime()
.setDateTime(startDateTime)
.setTimeZone("America/Los_Angeles");
event.setStart(start);
DateTime endDateTime = new DateTime("2015-05-28T17:00:00-07:00");
EventDateTime end = new EventDateTime()
.setDateTime(endDateTime)
.setTimeZone("America/Los_Angeles");
event.setEnd(end);
String[] recurrence = new String[] {"RRULE:FREQ=DAILY;COUNT=2"};
event.setRecurrence(Arrays.asList(recurrence));
EventAttendee[] attendees = new EventAttendee[] {
new EventAttendee().setEmail("lpage@example.com"),
new EventAttendee().setEmail("sbrin@example.com"),
};
event.setAttendees(Arrays.asList(attendees));
EventReminder[] reminderOverrides = new EventReminder[] {
new EventReminder().setMethod("email").setMinutes(24 * 60),
new EventReminder().setMethod("popup").setMinutes(10),
};
Event.Reminders reminders = new Event.Reminders()
.setUseDefault(false)
.setOverrides(Arrays.asList(reminderOverrides));
event.setReminders(reminders);
String calendarId = "primary";
event = service.events().insert(calendarId, event).execute();
System.out.printf("Event created: %s\n", event.getHtmlLink());
JavaScript
// Refer to the JavaScript quickstart on how to setup the environment:
// https://developers.google.com/calendar/quickstart/js
// Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
// stored credentials.
const event = {
'summary': 'Google I/O 2015',
'location': '800 Howard St., San Francisco, CA 94103',
'description': 'A chance to hear more about Google\'s developer products.',
'start': {
'dateTime': '2015-05-28T09:00:00-07:00',
'timeZone': 'America/Los_Angeles'
},
'end': {
'dateTime': '2015-05-28T17:00:00-07:00',
'timeZone': 'America/Los_Angeles'
},
'recurrence': [
'RRULE:FREQ=DAILY;COUNT=2'
],
'attendees': [
{'email': 'lpage@example.com'},
{'email': 'sbrin@example.com'}
],
'reminders': {
'useDefault': false,
'overrides': [
{'method': 'email', 'minutes': 24 * 60},
{'method': 'popup', 'minutes': 10}
]
}
};
const request = gapi.client.calendar.events.insert({
'calendarId': 'primary',
'resource': event
});
request.execute(function(event) {
appendPre('Event created: ' + event.htmlLink);
});
Node.js
// Refer to the Node.js quickstart on how to setup the environment:
// https://developers.google.com/calendar/quickstart/node
// Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
// stored credentials.
const event = {
'summary': 'Google I/O 2015',
'location': '800 Howard St., San Francisco, CA 94103',
'description': 'A chance to hear more about Google\'s developer products.',
'start': {
'dateTime': '2015-05-28T09:00:00-07:00',
'timeZone': 'America/Los_Angeles',
},
'end': {
'dateTime': '2015-05-28T17:00:00-07:00',
'timeZone': 'America/Los_Angeles',
},
'recurrence': [
'RRULE:FREQ=DAILY;COUNT=2'
],
'attendees': [
{'email': 'lpage@example.com'},
{'email': 'sbrin@example.com'},
],
'reminders': {
'useDefault': false,
'overrides': [
{'method': 'email', 'minutes': 24 * 60},
{'method': 'popup', 'minutes': 10},
],
},
};
calendar.events.insert({
auth: auth,
calendarId: 'primary',
resource: event,
}, function(err, event) {
if (err) {
console.log('There was an error contacting the Calendar service: ' + err);
return;
}
console.log('Event created: %s', event.htmlLink);
});
PHP
$event = new Google_Service_Calendar_Event(array(
'summary' => 'Google I/O 2015',
'location' => '800 Howard St., San Francisco, CA 94103',
'description' => 'A chance to hear more about Google\'s developer products.',
'start' => array(
'dateTime' => '2015-05-28T09:00:00-07:00',
'timeZone' => 'America/Los_Angeles',
),
'end' => array(
'dateTime' => '2015-05-28T17:00:00-07:00',
'timeZone' => 'America/Los_Angeles',
),
'recurrence' => array(
'RRULE:FREQ=DAILY;COUNT=2'
),
'attendees' => array(
array('email' => 'lpage@example.com'),
array('email' => 'sbrin@example.com'),
),
'reminders' => array(
'useDefault' => FALSE,
'overrides' => array(
array('method' => 'email', 'minutes' => 24 * 60),
array('method' => 'popup', 'minutes' => 10),
),
),
));
$calendarId = 'primary';
$event = $service->events->insert($calendarId, $event);
printf('Event created: %s\n', $event->htmlLink);
Python
# Refer to the Python quickstart on how to setup the environment:
# https://developers.google.com/calendar/quickstart/python
# Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
# stored credentials.
event = {
'summary': 'Google I/O 2015',
'location': '800 Howard St., San Francisco, CA 94103',
'description': 'A chance to hear more about Google\'s developer products.',
'start': {
'dateTime': '2015-05-28T09:00:00-07:00',
'timeZone': 'America/Los_Angeles',
},
'end': {
'dateTime': '2015-05-28T17:00:00-07:00',
'timeZone': 'America/Los_Angeles',
},
'recurrence': [
'RRULE:FREQ=DAILY;COUNT=2'
],
'attendees': [
{'email': 'lpage@example.com'},
{'email': 'sbrin@example.com'},
],
'reminders': {
'useDefault': False,
'overrides': [
{'method': 'email', 'minutes': 24 * 60},
{'method': 'popup', 'minutes': 10},
],
},
}
event = service.events().insert(calendarId='primary', body=event).execute()
print 'Event created: %s' % (event.get('htmlLink'))
Ruby
event = Google::Apis::CalendarV3::Event.new(
summary: 'Google I/O 2015',
location: '800 Howard St., San Francisco, CA 94103',
description: 'A chance to hear more about Google\'s developer products.',
start: Google::Apis::CalendarV3::EventDateTime.new(
date_time: '2015-05-28T09:00:00-07:00',
time_zone: 'America/Los_Angeles'
),
end: Google::Apis::CalendarV3::EventDateTime.new(
date_time: '2015-05-28T17:00:00-07:00',
time_zone: 'America/Los_Angeles'
),
recurrence: [
'RRULE:FREQ=DAILY;COUNT=2'
],
attendees: [
Google::Apis::CalendarV3::EventAttendee.new(
email: 'lpage@example.com'
),
Google::Apis::CalendarV3::EventAttendee.new(
email: 'sbrin@example.com'
)
],
reminders: Google::Apis::CalendarV3::Event::Reminders.new(
use_default: false,
overrides: [
Google::Apis::CalendarV3::EventReminder.new(
reminder_method: 'email',
minutes: 24 * 60
),
Google::Apis::CalendarV3::EventReminder.new(
reminder_method: 'popup',
minutes: 10
)
]
)
)
result = client.insert_event('primary', event)
puts "Event created: #{result.html_link}"
为活动添加云端硬盘附件
您可以附加 Google 云端硬盘
如 Google 文档中的会议记录、Google 文档中的预算
表格、Google 幻灯片中的演示文稿
将相关的 Google 云端硬盘文件与您的日历活动相关联。您可以将
创建活动时添加附件
events.insert()
或更高版本(作为
更新,例如使用 events.patch()
将 Google 云端硬盘文件附加到活动的过程包含两个部分:
- 从 获取文件
alternateLink
网址、title
和mimeType
Drive API Files 资源,通常是 使用files.get()
方法。 - 使用请求中设置的
attachments
字段创建或更新事件 并将supportsAttachments
参数设为true
。
以下代码示例演示了如何更新现有要添加的事件 附件:
Java
public static void addAttachment(Calendar calendarService, Drive driveService, String calendarId,
String eventId, String fileId) throws IOException {
File file = driveService.files().get(fileId).execute();
Event event = calendarService.events().get(calendarId, eventId).execute();
List<EventAttachment> attachments = event.getAttachments();
if (attachments == null) {
attachments = new ArrayList<EventAttachment>();
}
attachments.add(new EventAttachment()
.setFileUrl(file.getAlternateLink())
.setMimeType(file.getMimeType())
.setTitle(file.getTitle()));
Event changes = new Event()
.setAttachments(attachments);
calendarService.events().patch(calendarId, eventId, changes)
.setSupportsAttachments(true)
.execute();
}
PHP
function addAttachment($calendarService, $driveService, $calendarId, $eventId, $fileId) {
$file = $driveService->files->get($fileId);
$event = $calendarService->events->get($calendarId, $eventId);
$attachments = $event->attachments;
$attachments[] = array(
'fileUrl' => $file->alternateLink,
'mimeType' => $file->mimeType,
'title' => $file->title
);
$changes = new Google_Service_Calendar_Event(array(
'attachments' => $attachments
));
$calendarService->events->patch($calendarId, $eventId, $changes, array(
'supportsAttachments' => TRUE
));
}
Python
def add_attachment(calendarService, driveService, calendarId, eventId, fileId):
file = driveService.files().get(fileId=fileId).execute()
event = calendarService.events().get(calendarId=calendarId,
eventId=eventId).execute()
attachments = event.get('attachments', [])
attachments.append({
'fileUrl': file['alternateLink'],
'mimeType': file['mimeType'],
'title': file['title']
})
changes = {
'attachments': attachments
}
calendarService.events().patch(calendarId=calendarId, eventId=eventId,
body=changes,
supportsAttachments=True).execute()
为活动添加视频和电话会议
您可以将事件与 Hangouts和 Google Meet 会议 让您的用户通过电话或视频通话进行远程会议。
conferenceData
字段
用于读取、复制和清除现有会议详细信息;也可以是
用于请求生成新会议。要允许创建和
修改会议详细信息,设置 conferenceDataVersion
请求
参数设为 1
。
目前支持三种类型的 conferenceData
,分别以
conferenceData.conferenceSolution.key.type
:
- 个人用户版 Hangouts (
eventHangout
) - 面向用户的 Google Workspace 传统版 Hangouts
(已弃用;
eventNamedHangout
) - Google Meet (
hangoutsMeet
)
您可以了解某个日历服务的任何指定日历支持哪种会议类型,
通过查看 API 中的 conferenceProperties.allowedConferenceSolutionTypes
calendars
和
calendarList
个集合。您还可以
了解用户是否更愿意
通过检查autoAddHangouts
“settings
”集合。
除 type
之外,conferenceSolution
还提供 name
和
iconUri
字段,您可以使用这些字段来表示会议解决方案,如下所示
如下:
JavaScript
const solution = event.conferenceData.conferenceSolution;
const content = document.getElementById("content");
const text = document.createTextNode("Join " + solution.name);
const icon = document.createElement("img");
icon.src = solution.iconUri;
content.appendChild(icon);
content.appendChild(text);
您可以提供 createRequest
,以便为活动创建新会议,具体方法是:
新生成的 requestId
,可以是随机 string
。会议为
但您可以随时查看请求的状态
告知用户所发生的情况
例如,如需为现有活动请求生成会议,请使用以下代码:
JavaScript
const eventPatch = {
conferenceData: {
createRequest: {requestId: "7qxalsvy0e"}
}
};
gapi.client.calendar.events.patch({
calendarId: "primary",
eventId: "7cbh8rpc10lrc0ckih9tafss99",
resource: eventPatch,
sendNotifications: true,
conferenceDataVersion: 1
}).execute(function(event) {
console.log("Conference created for event: %s", event.htmlLink);
});
此调用的即时响应可能尚未包含完全填充的
conferenceData
;则会返回 pending
状态代码,
状态
字段。收到会议信息后,状态代码会更改为 success
填充。entryPoints
字段包含
您的用户可通过电话 URI 拨号加入会议。
如果您希望在同一项活动中安排多个日历活动,
您可将一个活动中的整个conferenceData
复制到
另一个。
复制操作在某些情况下非常有用。例如,假设您正在开发 为候选人和 即您不仅希望保护面试官的身份, 希望确保所有参与者都加入同一场电话会议。