コーディング レベル: 初級
所要時間: 5 分
プロジェクトの種類: カスタム メニューとイベントドリブン トリガーを使用した自動化
目標
- ソリューションの機能について理解する。
- ソリューション内での Apps Script サービスの役割を理解する。
- スクリプトを設定します。
- スクリプトを実行します。
このソリューションについて
エンドツーエンドのイベント登録システムを作成します。会議などのイベントが近づいている場合は、会議セッション用の新しいカレンダーを設定し、登録フォームを作成して、参加者ごとにカスタマイズされた日程表を自動的にメールで送信できます。
仕組み
このソリューションでは、Google スプレッドシートのカスタム メニューを使用して、イベント登録システムを自動化します。このスクリプトにより、スプレッドシートに表示されている会議イベントを含むカレンダーが作成されます。次に、参加者が登録できるイベントのリストを含むフォームが作成されます。参加者がフォームに入力すると、スクリプトは参加者をカレンダーの予定に追加し、旅行プランをメールで送信します。
Apps Script サービス
このソリューションでは、次のサービスを使用します。
- スプレッドシート サービス - 他のサービスにイベント情報を提供します。
- カレンダー サービス - イベントの新しいカレンダーを作成し、カレンダーにイベントを追加し、登録したイベントに出席者を追加します。
- プロパティ サービス - カレンダー サービスによって作成されたカレンダーの ID を保存します。ユーザーがカスタムの [会議] メニューから [会議を設定] をクリックすると、プロパティ サービスはカレンダー ID プロパティが存在するかどうかを確認して、イベント登録システムがすでに設定されているかどうかを確認します。これにより、重複するフォームやカレンダーの作成を回避できます。
- フォーム サービス - スプレッドシートの情報から、参加者がセッションに登録できるフォームを作成します。
- スクリプト サービス - 参加者がフォームに記入したときにトリガーを実行します。
- ドキュメント サービス - 参加者が登録したイベントのイベント情報を取得し、イベントのリストを新しいドキュメントに追加します。このスクリプトにより、参加者にドキュメントの編集権限が付与されます。
- 郵送サービス - 日程表ドキュメントを参加者にメールで送信します。
前提条件
このサンプルを使用するには、次の前提条件を満たしている必要があります。
- Google アカウント(Google Workspace アカウントの場合、管理者の承認が必要となる可能性があります)。
- インターネットに接続できるウェブブラウザ。
スクリプトを設定する
- 次のボタンをクリックして、会議でのセミナーの登録フォームを作成するサンプル スプレッドシートのコピーを作成します。このソリューションの Apps Script プロジェクトがスプレッドシートに添付されています。
コピーを作成
- [会議] > [会議を設定] をクリックします。このカスタム メニューが表示されるように、ページを更新する必要がある場合があります。
プロンプトが表示されたら、スクリプトを承認します。OAuth 同意画面に [このアプリは確認されていません] という警告が表示された場合は、[詳細] > [{プロジェクト名} に移動(安全でない)] を選択して続行します。
[会議] > [会議をセットアップ] をもう一度クリックします。
スクリプトを実行する
- [ツール] > [フォームを管理] > [ライブフォームに移動] をクリックします。
- フォームに記入し、送信します。
- calendar.google.com にアクセスします。
- 左側の [会議カレンダー] の横にあるチェックボックスがオンになっていることを確認します。
- 登録したイベントの日付に移動し、参加者として追加されていることを確認します。
(省略可)ソリューションをリセットする
このソリューションをもう一度試す場合や、独自のイベント情報を使用するようにカスタマイズする場合は、スクリプトを初めて実行したときに設定した一部の項目をリセットする必要があります。ソリューションをリセットする手順を表示するには、下の [ソリューションをリセットする] をクリックします。
ソリューションをリセットする
ステップ 1: 保存されているスクリプト プロパティをリセットする
スクリプトを複数回実行しようとすると、「会議はすでに設定されています。Google ドライブで登録フォームを探してください。
これは、カンファレンス カレンダーが作成されると、カレンダー ID がスクリプト プロパティとして保存されるためです。スクリプトが実行されると、カレンダー ID プロパティがすでに存在するかどうかが確認され、存在する場合は実行が停止します。
既存のカレンダー ID プロパティを削除する手順は次のとおりです。
- スプレッドシートで、[拡張機能] > [Apps Script] をクリックします。
- Apps Script エディタで、関数のプルダウン リストから
resetProperties
を選択し、[実行] をクリックします。
ステップ 2: 会議のカレンダーを削除する
スクリプトが実行されるたびに、新しいカレンダーが作成されます。作成した元のカレンダーを保持しない場合は、次の操作を行います。
- calendar.google.com にアクセスします。
- 会議カレンダーの横にある会議カレンダーのオプション アイコン > [設定と共有] をクリックします。
- 設定の一番下までスクロールし、[削除] をクリックします。
このスクリプトは、実行するたびにフォーム送信のトリガーを作成します。複数のトリガーが重複メールの原因にならないようにするには、元のトリガーを削除します。手順は次のとおりです。
- スプレッドシートで、[拡張機能] > [Apps Script] をクリックします。
- Apps Script プロジェクトの左側にある [トリガー] をクリックします。
- トリガーの横にあるその他アイコン
> [トリガーを削除] をクリックします。
スクリプトを実行するたびに、新しいフォームが作成されます。フォームとスプレッドシートのリンクを解除して削除する手順は次のとおりです。
- スプレッドシートで [フォームの回答] シートを右クリックし、[フォームのリンクを解除] > [OK] をクリックします。
- [フォームの回答] シートをもう一度右クリックし、[削除] > [OK] をクリックします。
- forms.google.com にアクセスします。
- [Conference Form] を右クリックし、[削除] > [ゴミ箱に移動] をクリックします。
ソリューションをリセットしたら、独自のデータを追加するか、サンプルデータを引き続き使用してスクリプトを再度実行できます。
コードを確認する
このソリューションの Apps Script コードを確認するには、下の [ソースコードを表示] をクリックします。
ソースコードを表示
コード.gs
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/event-session-signup
/*
Copyright 2022 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* Inserts a custom menu when the spreadsheet opens.
*/
function onOpen() {
SpreadsheetApp.getUi().createMenu('Conference')
.addItem('Set up conference', 'setUpConference_')
.addToUi();
}
/**
* Uses the conference data in the spreadsheet to create
* Google Calendar events, a Google Form, and a trigger that allows the script
* to react to form responses.
*/
function setUpConference_() {
let scriptProperties = PropertiesService.getScriptProperties();
if (scriptProperties.getProperty('calId')) {
Browser.msgBox('Your conference is already set up. Look in Google Drive for your'
+ ' sign-up form!');
return;
}
let ss = SpreadsheetApp.getActive();
let sheet = ss.getSheetByName('Conference Setup');
let range = sheet.getDataRange();
let values = range.getValues();
setUpCalendar_(values, range);
setUpForm_(ss, values);
ScriptApp.newTrigger('onFormSubmit').forSpreadsheet(ss).onFormSubmit()
.create();
}
/**
* Creates a Google Calendar with events for each conference session in the
* spreadsheet, then writes the event IDs to the spreadsheet for future use.
* @param {Array<string[]>} values Cell values for the spreadsheet range.
* @param {Range} range A spreadsheet range that contains conference data.
*/
function setUpCalendar_(values, range) {
let cal = CalendarApp.createCalendar('Conference Calendar');
// Start at 1 to skip the header row.
for (let i = 1; i < values.length; i++) {
let session = values[i];
let title = session[0];
let start = joinDateAndTime_(session[1], session[2]);
let end = joinDateAndTime_(session[1], session[3]);
let options = {location: session[4], sendInvites: true};
let event = cal.createEvent(title, start, end, options)
.setGuestsCanSeeGuests(false);
session[5] = event.getId();
}
range.setValues(values);
// Stores the ID for the Calendar, which is needed to retrieve events by ID.
let scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperty('calId', cal.getId());
}
/**
* Creates a single Date object from separate date and time cells.
*
* @param {Date} date A Date object from which to extract the date.
* @param {Date} time A Date object from which to extract the time.
* @return {Date} A Date object representing the combined date and time.
*/
function joinDateAndTime_(date, time) {
date = new Date(date);
date.setHours(time.getHours());
date.setMinutes(time.getMinutes());
return date;
}
/**
* Creates a Google Form that allows respondents to select which conference
* sessions they would like to attend, grouped by date and start time in the
* caller's time zone.
*
* @param {Spreadsheet} ss The spreadsheet that contains the conference data.
* @param {Array<String[]>} values Cell values for the spreadsheet range.
*/
function setUpForm_(ss, values) {
// Group the sessions by date and time so that they can be passed to the form.
let schedule = {};
// Start at 1 to skip the header row.
for (let i = 1; i < values.length; i++) {
let session = values[i];
let day = session[1].toLocaleDateString();
let time = session[2].toLocaleTimeString();
if (!schedule[day]) {
schedule[day] = {};
}
if (!schedule[day][time]) {
schedule[day][time] = [];
}
schedule[day][time].push(session[0]);
}
// Creates the form and adds a multiple-choice question for each timeslot.
let form = FormApp.create('Conference Form');
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());
form.addTextItem().setTitle('Name').setRequired(true);
form.addTextItem().setTitle('Email').setRequired(true);
Object.keys(schedule).forEach(function(day) {
let header = form.addSectionHeaderItem().setTitle('Sessions for ' + day);
Object.keys(schedule[day]).forEach(function(time) {
let item = form.addMultipleChoiceItem().setTitle(time + ' ' + day)
.setChoiceValues(schedule[day][time]);
});
});
}
/**
* Sends out calendar invitations and a
* personalized Google Docs itinerary after a user responds to the form.
*
* @param {Object} e The event parameter for form submission to a spreadsheet;
* see https://developers.google.com/apps-script/understanding_events
*/
function onFormSubmit(e) {
let user = {name: e.namedValues['Name'][0], email: e.namedValues['Email'][0]};
// Grab the session data again so that we can match it to the user's choices.
let response = [];
let values = SpreadsheetApp.getActive().getSheetByName('Conference Setup')
.getDataRange().getValues();
for (let i = 1; i < values.length; i++) {
let session = values[i];
let title = session[0];
let day = session[1].toLocaleDateString();
let time = session[2].toLocaleTimeString();
let timeslot = time + ' ' + day;
// For every selection in the response, find the matching timeslot and title
// in the spreadsheet and add the session data to the response array.
if (e.namedValues[timeslot] && e.namedValues[timeslot] == title) {
response.push(session);
}
}
sendInvites_(user, response);
sendDoc_(user, response);
}
/**
* Add the user as a guest for every session he or she selected.
* @param {object} user An object that contains the user's name and email.
* @param {Array<String[]>} response An array of data for the user's session choices.
*/
function sendInvites_(user, response) {
let id = ScriptProperties.getProperty('calId');
let cal = CalendarApp.getCalendarById(id);
for (let i = 0; i < response.length; i++) {
cal.getEventSeriesById(response[i][5]).addGuest(user.email);
}
}
/**
* Creates and shares a personalized Google Doc that shows the user's itinerary.
* @param {object} user An object that contains the user's name and email.
* @param {Array<string[]>} response An array of data for the user's session choices.
*/
function sendDoc_(user, response) {
let doc = DocumentApp.create('Conference Itinerary for ' + user.name)
.addEditor(user.email);
let body = doc.getBody();
let table = [['Session', 'Date', 'Time', 'Location']];
for (let i = 0; i < response.length; i++) {
table.push([response[i][0], response[i][1].toLocaleDateString(),
response[i][2].toLocaleTimeString(), response[i][4]]);
}
body.insertParagraph(0, doc.getName())
.setHeading(DocumentApp.ParagraphHeading.HEADING1);
table = body.appendTable(table);
table.getRow(0).editAsText().setBold(true);
doc.saveAndClose();
// Emails a link to the Doc as well as a PDF copy.
MailApp.sendEmail({
to: user.email,
subject: doc.getName(),
body: 'Thanks for registering! Here\'s your itinerary: ' + doc.getUrl(),
attachments: doc.getAs(MimeType.PDF),
});
}
/**
* Removes the calId script property so that the 'setUpConference_()' can be run again.
*/
function resetProperties(){
let scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.deleteAllProperties();
}
寄稿者
このサンプルは、Google デベロッパー エキスパートの協力を得て Google によって管理されています。
次のステップ