ユーザーが最適なハイキングルートを見つけるのに役立つアプリを想像してみてください。ハイキング プランをカレンダーの予定として追加すると、自動的に整理された状態を維持できます。Google カレンダーでは計画の共有や通知ができるので、ストレスなく準備をすることができます。また、Google サービスがシームレスに統合されているおかげで、Google Now が出発時刻を通知し、Google マップから定刻に集合場所へ連れて行ってくれます。
この記事では、カレンダーの予定を作成し、ユーザーのカレンダーに追加する方法について説明します。
予定の追加
イベントを作成するには、少なくとも次のパラメータを指定して events.insert()
メソッドを呼び出します。
calendarId
はカレンダー ID です。予定を作成するカレンダーのメールアドレスか、ログインしているユーザーのメイン カレンダーを使用する特殊なキーワード'primary'
になります。使用するカレンダーのメールアドレスがわからない場合は、Google カレンダー ウェブ UI のカレンダー設定([カレンダーのアドレス] セクション)で確認できます。また、calendarList.list()
の呼び出し結果で調べることもできます。event
は、開始や終了などの必要な詳細をすべて含むイベントです。必須項目は、start
とend
の 2 つのみです。すべてのイベント フィールドについては、event
リファレンスをご覧ください。
イベントを作成するには、以下の操作を行う必要があります。
- OAuth スコープを
https://www.googleapis.com/auth/calendar
に設定して、ユーザーのカレンダーに対する編集権限を付与します。 - 認証されたユーザーが、指定した
calendarId
でカレンダーへの書き込みアクセス権を持っていることを確認します(たとえば、calendarId
に対してcalendarList.get()
を呼び出し、accessRole
を確認します)。
イベント メタデータを追加する
カレンダーの予定を作成する際に、必要に応じて予定のメタデータを追加できます。作成時にメタデータを追加しない場合、events.update()
を使用して多くのフィールドを更新できます。ただし、イベント ID など、一部のフィールドは events.insert()
オペレーション中にのみ設定できます。
- ロケーション
住所欄に住所を追加すると、次のような機能が使えるようになります。
「出発時刻」や、経路案内の地図なども表示できます。
- 予定 ID
イベントを作成する際に、独自のイベント ID を生成できます。
フォーマットの要件に準拠する必要がありますこれにより、ローカル データベースのエンティティを Google カレンダーの予定と同期できます。また、カレンダーのバックエンドで正常に実行された後、ある時点でオペレーションが失敗しても、予定が重複して作成されることを防ぎます。イベント ID が指定されていない場合は、サーバーによってイベント ID が生成されます。詳細については、イベント ID のリファレンスをご覧ください。
- 参加者
作成した予定は、組織のすべてのメインの Google カレンダーに
同じ予定 ID を持つ参加者だけが表示されます。挿入リクエストで
sendNotifications
をtrue
に設定すると、イベントのメール通知も参加者に送信されます。詳しくは、複数の参加者がいるイベントのガイドをご覧ください。
次の例は、イベントを作成し、そのメタデータを設定する方法を示しています。
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 ドライブ ファイルをカレンダーの予定に添付できます。更新の一環として、events.insert()
以降でイベントを作成するときに、events.patch()
などのアタッチメントを追加できます。
予定に Google ドライブ ファイルを添付するには、次の 2 つの処理が必要です。
-
Drive API ファイル リソースからファイル
alternateLink
の URL、title
、mimeType
を取得します。通常は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()
予定にビデオ会議や電話会議を追加する
イベントをハングアウトや Google Meet の会議に関連付けることで、ユーザーは電話やビデオ通話でリモートで会議できるようになります。
conferenceData
フィールドを使用して、既存の会議の詳細の読み取り、コピー、消去を行うことができます。また、新しい会議の生成をリクエストすることもできます。会議の詳細の作成と変更を許可するには、conferenceDataVersion
リクエスト パラメータを 1
に設定します。
現在サポートされている conferenceData
には、conferenceData.conferenceSolution.key.type
で示されるように、次の 3 つのタイプがあります。
- 一般ユーザー向けハングアウト(
eventHangout
) - Google Workspace ユーザー向け従来のハングアウト(非推奨、
eventNamedHangout
) - Google Meet(
hangoutsMeet
)
ユーザーの特定のカレンダーでサポートされている会議の種類は、calendars
および calendarList
コレクションの conferenceProperties.allowedConferenceSolutionTypes
で確認できます。また、settings
コレクションの autoAddHangouts
設定を確認することで、ユーザーが新たに作成したすべてのイベントでハングアウトを作成するように設定するかどうかも確認できます。
conferenceSolution
には、type
のほかに、次のように会議ソリューションを表すために使用できる 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);
イベント用に新しい会議を作成するには、新しく生成された requestId
(ランダムな string
を使用可能)を createRequest
に指定します。会議は非同期で作成されますが、リクエストのステータスをいつでも確認して、何が起こっているかをユーザーに知らせることができます。
たとえば、既存のイベントの会議生成をリクエストするには、次のようにします。
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
がまだ含まれていない場合があります。これは、status フィールドのステータス コード pending
によって示されます。会議情報が入力されると、ステータス コードが success
に変わります。entryPoints
フィールドには、ユーザーがダイヤルインに使用できる動画と電話の URI に関する情報が格納されます。
複数のカレンダーの予定に同じ会議の詳細を設定する場合は、ある予定から別の予定に conferenceData
全体をコピーします。
コピーは、特定の状況で役立ちます。たとえば、候補者と面接担当者に対して別々のイベントを設定する採用アプリケーションを開発するとします。面接担当者の ID は保護しつつ、すべての参加者が同じグループ通話に参加できるようにするとします。