スクリプトがユーザーの Google カレンダーを読み取り、更新できるようにします。このクラスは、ユーザーのデフォルト カレンダーへの直接アクセスを提供し、ユーザーが所有または定期購入している追加のカレンダーを取得する機能も提供します。
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
Color | Color | カレンダー サービスで使用できる名前付きの色を表す列挙型。 |
EventColor | EventColor | カレンダー サービスで使用できる名前付きの予定の色を表す列挙型。 |
GuestStatus | GuestStatus | イベントのゲストに設定できるステータスを表す列挙型。 |
Month | Month | 1 年の月を表す列挙型。 |
Visibility | Visibility | イベントの公開設定を表す列挙型。 |
Weekday | Weekday | 曜日を表す列挙型。 |
メソッド
詳細なドキュメント
createAllDayEvent(title, date)
新しい終日の予定を作成します。
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル。 |
date | Date | イベントの日付(日付のみが使用され、時刻は無視されます)。 |
戻る
CalendarEvent
- 作成されたイベント。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
複数日にまたがる新しい終日の予定を作成します。
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル。 |
startDate | Date | イベントの開始日(日付のみが使用され、時刻は無視されます)。 |
endDate | Date | イベントの終了日(日付のみが使用され、時刻は無視されます)。終了日は範囲に含まれません。 |
戻る
CalendarEvent
- 作成されたイベント。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
複数日にまたがる新しい終日の予定を作成します。
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}, ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル。 |
startDate | Date | イベントの開始日(日付のみが使用され、時刻は無視されます)。 |
endDate | Date | イベントの終了日(日付のみが使用され、時刻は無視されます)。終了日は範囲に含まれません。 |
options | Object | 以下に示す詳細なパラメータを指定する JavaScript オブジェクト。 |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | イベントの説明です。 |
location | String | イベントの場所。 |
guests | String | ゲストとして追加するメールアドレスのカンマ区切りリスト。 |
sendInvites | Boolean | 招待メールを送信するかどうか(デフォルト: false )。 |
戻る
CalendarEvent
- 作成されたイベント。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
新しい終日の予定を作成します。
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル。 |
date | Date | イベントの日付(日付のみが使用され、時刻は無視されます)。 |
options | Object | 以下に示す詳細なパラメータを指定する JavaScript オブジェクト。 |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | イベントの説明です。 |
location | String | イベントの場所。 |
guests | String | ゲストとして追加するメールアドレスのカンマ区切りリスト。 |
sendInvites | Boolean | 招待メールを送信するかどうか(デフォルト: false )。 |
戻る
CalendarEvent
- 作成されたイベント。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
新しい終日の予定シリーズを作成します。
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | シリーズ内の各イベントのタイトル |
startDate | Date | シリーズ内の最初のイベントの日付(日付のみが使用され、時刻は無視されます) |
recurrence | EventRecurrence | イベント シリーズの繰り返し設定 |
戻る
CalendarEventSeries
- 作成されたイベント シリーズ
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
新しい終日の予定シリーズを作成します。
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | シリーズ内の各イベントのタイトル |
startDate | Date | シリーズ内の最初のイベントの日付(日付のみが使用され、時刻は無視されます) |
recurrence | EventRecurrence | イベント シリーズの繰り返し設定 |
options | Object | 以下に示すように、高度なパラメータを指定する JavaScript オブジェクト |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | シリーズ内の各イベントの説明 |
location | String | 一連の予定の場所 |
guests | String | シリーズのイベントにゲストとして追加するメールアドレスのカンマ区切りリスト |
sendInvites | Boolean | 招待メールを送信するかどうか(デフォルト: false ) |
戻る
CalendarEventSeries
- 作成されたイベント シリーズ
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name)
ユーザーが所有する新しいカレンダーを作成します。
// Creates a new calendar named "Travel Plans". const calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しいカレンダーの名前 |
戻る
Calendar
- 新しく作成されたカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createCalendar(name, options)
ユーザーが所有する新しいカレンダーを作成します。
// Creates a new calendar named "Travel Plans" with a description and color. const calendar = CalendarApp.createCalendar('Travel Plans', { description: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE, }); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しいカレンダーの名前 |
options | Object | 以下に示すように、高度なパラメータを指定する JavaScript オブジェクト |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
location | String | カレンダーの場所 |
description | String | カレンダーの説明 |
timeZone | String | カレンダーに設定するタイムゾーン。長い形式で指定します(例: 「アメリカ/ニューヨーク」(Joda.org に記載されているもの) |
color | String | 16 進数カラー文字列(「#rrggbb」)または CalendarApp.Colors の値 |
hidden | Boolean | カレンダーがユーザー インターフェースに非表示かどうか(デフォルト: false ) |
selected | Boolean | カレンダーの予定をユーザー インターフェースに表示するかどうか(デフォルト: true ) |
戻る
Calendar
- 新しく作成されたカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
新しいイベントを作成します。
タイムゾーンが指定されていない場合、時刻値はスクリプトのタイムゾーンのコンテキストで解釈されます。これは、カレンダーのタイムゾーンとは異なる場合があります。
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC'), ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル |
startTime | Date | イベントの開始日時 |
endTime | Date | イベントの終了日時 |
戻る
CalendarEvent
- 作成されたイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
新しいイベントを作成します。
タイムゾーンが指定されていない場合、時刻値はスクリプトのタイムゾーンのコンテキストで解釈されます。これは、カレンダーのタイムゾーンとは異なる場合があります。
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | イベントのタイトル |
startTime | Date | イベントの開始日時 |
endTime | Date | イベントの終了日時 |
options | Object | 以下に示すように、高度なパラメータを指定する JavaScript オブジェクト |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | イベントの説明 |
location | String | イベントの場所 |
guests | String | ゲストとして追加するメールアドレスのカンマ区切りリスト |
sendInvites | Boolean | 招待メールを送信するかどうか(デフォルト: false ) |
戻る
CalendarEvent
- 作成されたイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventFromDescription(description)
自由形式の説明からイベントを作成します。
説明には、UI の[クイック追加] 機能と同じ形式を使用する必要があります。
// Creates a new event and logs its ID. const event = CalendarApp.getDefaultCalendar().createEventFromDescription( 'Lunch with Mary, Friday at 1PM', ); Logger.log(`Event ID: ${event.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | イベントの自由形式の説明 |
戻る
CalendarEvent
- 作成されたイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
新しいイベント シリーズを作成します。
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | シリーズ内の各イベントのタイトル |
startTime | Date | シリーズの最初のイベントの開始日時 |
endTime | Date | シリーズの最初のイベントが終了した日時 |
recurrence | EventRecurrence | イベント シリーズの繰り返し設定 |
戻る
CalendarEventSeries
- 作成されたイベント シリーズ
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
新しいイベント シリーズを作成します。
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
title | String | シリーズ内の各イベントのタイトル |
startTime | Date | シリーズの最初のイベントの開始日時 |
endTime | Date | シリーズの最初のイベントが終了した日時 |
recurrence | EventRecurrence | イベント シリーズの繰り返し設定 |
options | Object | 以下に示すように、高度なパラメータを指定する JavaScript オブジェクト |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | シリーズ内の各イベントの説明 |
location | String | 一連の予定の場所 |
guests | String | シリーズのイベントにゲストとして追加するメールアドレスのカンマ区切りリスト |
sendInvites | Boolean | 招待メールを送信するかどうか(デフォルト: false ) |
戻る
CalendarEventSeries
- 作成されたイベント シリーズ
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
getAllCalendars()
ユーザーが所有または定期購入しているすべてのカレンダーを取得します。
// Determines how many calendars the user can access. const calendars = CalendarApp.getAllCalendars(); Logger.log( 'This user owns or is subscribed to %s calendars.', calendars.length, );
戻る
Calendar[]
- ユーザーがアクセスできるすべてのカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getAllOwnedCalendars()
ユーザーが所有するすべてのカレンダーを取得します。
// Determines how many calendars the user owns. const calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);
戻る
Calendar[]
- ユーザーが所有するすべてのカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarById(id)
指定された ID のカレンダーを取得します。
// Gets the public calendar "US Holidays" by ID. const calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | カレンダー ID |
戻る
Calendar
- 指定された ID のカレンダー。カレンダーが存在しない場合、ユーザーがアクセスできない場合、またはユーザーがカレンダーに登録されていない場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getCalendarsByName(name)
ユーザーが所有または登録している、指定された名前のすべてのカレンダーを取得します。名前では大文字と小文字が区別されません。
// Gets the public calendar named "US Holidays". const calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | カレンダー名 |
戻る
Calendar[]
- ユーザーがアクセスできる、この名前のすべてのカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getColor()
カレンダーの色を取得します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the color of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getColor() instead. const calendarColor = calendar.getColor(); console.log(calendarColor);
戻る
String
- 16 進数色文字列(#rrggbb)。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDefaultCalendar()
ユーザーのデフォルト カレンダーを取得します。
// Determines the time zone of the user's default calendar. const calendar = CalendarApp.getDefaultCalendar(); Logger.log( 'My default calendar is set to the time zone "%s".', calendar.getTimeZone(), );
戻る
Calendar
- ユーザーのデフォルト カレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getDescription()
カレンダーの説明を取得します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the description of the calendar to 'Test description.' calendar.setDescription('Test description'); // Gets the description of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getDescription() instead. const description = calendar.getDescription(); console.log(description);
戻る
String
- このカレンダーの説明。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventById(iCalId)
指定された ID のイベントを取得します。シリーズがデフォルトのカレンダー以外のカレンダーに属している場合は、そのカレンダーからこのメソッドを呼び出す必要があります。getEventById(iCalId)
を呼び出すと、デフォルトのカレンダーの予定のみが返されます。
イベント シリーズに属する複数のイベントに同じ ID を割り当てることができます。この場合、このメソッドは、そのシリーズの最初のイベントのみを返します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event for the moon landing. const event = calendar.createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:05:00 UTC'), new Date('July 20, 1969 20:17:00 UTC'), ); // Gets the calendar event ID and logs it to the console. const iCalId = event.getId(); console.log(iCalId); // Gets the event by its ID and logs the title of the event to the console. // For the default calendar, you can use CalendarApp.getEventById(iCalId) // instead. const myEvent = calendar.getEventById(iCalId); console.log(myEvent.getTitle());
パラメータ
名前 | 型 | 説明 |
---|---|---|
iCalId | String | イベントの ID。 |
戻る
CalendarEvent
- 指定された ID のイベント。イベントが存在しない場合、またはユーザーがアクセスできない場合は null
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
指定された ID のイベントシリーズを取得します。指定された ID が単一の CalendarEvent
の場合、シリーズ内の単一のイベントを含む CalendarEventSeries
が返されます。イベント シリーズがデフォルト カレンダー以外のカレンダーに属している場合は、その CalendarApp
からこのメソッドを呼び出す必要があります。getEventSeriesById(iCalId)
を直接呼び出すと、デフォルト カレンダーに存在するイベント シリーズのみが返されます。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event series for a daily team meeting from 1 PM to 2 PM. // The series adds the daily event from January 1, 2023 through December 31, // 2023. const eventSeries = calendar.createEventSeries( 'Team meeting', new Date('Jan 1, 2023 13:00:00'), new Date('Jan 1, 2023 14:00:00'), CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')), ); // Gets the ID of the event series. const iCalId = eventSeries.getId(); // Gets the event series by its ID and logs the series title to the console. // For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) // instead. console.log(calendar.getEventSeriesById(iCalId).getTitle());
パラメータ
名前 | 型 | 説明 |
---|---|---|
iCalId | String | イベントシリーズの ID。 |
戻る
CalendarEventSeries
- 指定された ID のシリーズ。シリーズが存在しない場合、またはユーザーがシリーズにアクセスできない場合は null
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
指定された期間内に発生したすべてのイベントを取得します。
このメソッドは、指定された期間中に開始、終了、または期間全体にわたるイベントを返します。タイムゾーンが指定されていない場合、時刻値はスクリプトのタイムゾーンのコンテキストで解釈されます。これは、カレンダーのタイムゾーンとは異なる場合があります。
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
startTime | Date | 期間の開始 |
endTime | Date | 期間の終了日時(この日時を含まない) |
戻る
CalendarEvent[]
- 期間内に発生したイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
指定した期間内に発生し、指定した条件を満たすすべてのイベントを取得します。
このメソッドは、指定された期間内に開始、終了、または期間全体にわたるイベントを返します。タイムゾーンが指定されていない場合、時刻値はスクリプトのタイムゾーンのコンテキストで解釈されます。これは、カレンダーのタイムゾーンとは異なる場合があります。
author
、search
、statusFilters
のフィルタリングは、start
と max
の適用後に行われます。つまり、他のイベントが条件を満たしていても、返されるイベント数が max
未満になる場合があります。
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
startTime | Date | 期間の開始 |
endTime | Date | 期間の終了日時(この日時を含まない) |
options | Object | 以下に示すように、高度なパラメータを指定する JavaScript オブジェクト |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 返される最初のイベントのインデックス |
max | Integer | 返されるイベントの最大数 |
author | String | イベント作成者による結果のフィルタに使用されるメールアドレス |
search | String | 結果のフィルタリングに使用される全文検索クエリ |
statusFilters[] | GuestStatus | 結果のフィルタリングに使用されるステータスの配列 |
戻る
CalendarEvent[]
- 期間内に発生し、条件に一致するイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date)
特定の日に発生したすべてのイベントを取得します。
このメソッドは、指定した日に開始または終了するイベント、またはその日を含むイベントを返します。
Date オブジェクトの日付部分のみが使用され、時刻部分は無視されます。日付は、カレンダーのタイムゾーンでその日の午前 0 時から翌日の午前 0 時までと解釈されます。
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | イベントを取得する日付(日付のみが使用され、時刻は無視されます) |
戻る
CalendarEvent[]
- 指定した日付に発生するイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
特定の日に発生し、指定された条件を満たすすべてのイベントを取得します。
このメソッドは、指定した日に開始または終了するイベント、またはその日を含むイベントを返します。
Date オブジェクトの日付部分のみが使用され、時刻部分は無視されます。日付は、カレンダーのタイムゾーンでその日の午前 0 時から翌日の午前 0 時までと解釈されます。
author
、search
、statusFilters
のフィルタリングは、start
と max
の適用後に行われます。つまり、他のイベントが条件を満たしていても、返されるイベント数が max
未満になる場合があります。
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, { search: 'meeting', }); Logger.log(`Number of events: ${events.length}`);
パラメータ
名前 | 型 | 説明 |
---|---|---|
date | Date | イベントを取得する日付(日付のみが使用され、時刻は無視されます) |
options | Object | 高度なフィルタリング オプション |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 返される最初のイベントのインデックス |
max | Integer | 返されるイベントの最大数 |
author | String | イベント作成者による結果のフィルタに使用されるメールアドレス |
search | String | 結果のフィルタリングに使用される全文検索クエリ |
statusFilters[] | GuestStatus | 結果のフィルタリングに使用されるステータスの配列 |
戻る
CalendarEvent[]
- 指定した日に発生し、条件に一致するイベント
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getId()
カレンダーの ID を取得します。ユーザーのデフォルト カレンダーの ID はメールアドレスです。
// Opens the calendar by its ID. // To get the user's default calendar, use CalendarApp.getDefaultCalendar(). // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the ID of the calendar and logs it to the console. const calendarId = calendar.getId(); console.log(calendarId);
戻る
String
- カレンダーの ID。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getName()
カレンダーの名前を取得します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the name of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getName() instead. const calendarName = calendar.getName(); console.log(calendarName);
戻る
String
- このカレンダーの名前。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarById(id)
指定された ID のカレンダーを取得します(ユーザーが所有している場合)。
カレンダー ID を確認するには、Google カレンダーでカレンダー名の横にある矢印をクリックし、[カレンダーの設定] を選択します。ID は設定ページの下部に表示されます。
// Gets a (non-existent) private calendar by ID. const calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | カレンダー ID |
戻る
Calendar
- 指定された ID のカレンダー。カレンダーが存在しない場合や、ユーザーが所有していない場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getOwnedCalendarsByName(name)
ユーザーが所有する、指定された名前のすべてのカレンダーを取得します。名前では大文字と小文字が区別されません。
// Gets a private calendar named "Travel Plans". const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | カレンダー名 |
戻る
Calendar[]
- ユーザーが所有するこの名前のすべてのカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
getTimeZone()
カレンダーのタイムゾーンを取得します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the time zone of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getTimeZone() instead. const timeZone = calendar.getTimeZone(); console.log(timeZone);
戻る
String
- タイムゾーン(「長い」形式で指定します。Joda.org に記載されている「America/New_York」など)。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isHidden()
カレンダーをユーザー インターフェースに表示するかどうかを決定します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is hidden in the user interface and logs it // to the console. For the default calendar, you can use CalendarApp.isHidden() // instead. const isHidden = calendar.isHidden(); console.log(isHidden);
戻る
Boolean
- カレンダーがユーザー インターフェースで非表示になっている場合は true
、そうでない場合は false
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
カレンダーが有効なユーザーのメイン カレンダーかどうかを判断します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is the default calendar for // the effective user and logs it to the console. // For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() // instead. const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar(); console.log(isMyPrimaryCalendar);
戻る
Boolean
- カレンダーが有効なユーザーのデフォルト カレンダーの場合は true
、そうでない場合は false
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isOwnedByMe()
カレンダーが自分の所有かどうかを判断します。
// Gets a calendar by its ID. To get the user's default calendar, use // CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with the calendar ID that you want to use. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Determines whether the calendar is owned by you and logs it. console.log(calendar.isOwnedByMe());
戻る
Boolean
- カレンダーのオーナーが自分自身の場合は true
、そうでない場合は false
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
isSelected()
カレンダーの予定をユーザー インターフェースに表示するかどうかを決定します。
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Determines whether the calendar's events are displayed in the user interface // and logs it. console.log(calendar.isSelected());
戻る
Boolean
- カレンダーの予定がユーザー インターフェースに表示されている場合は true
、表示されていない場合は false
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
newRecurrence()
イベントの繰り返しのルールの作成に使用できる新しい繰り返しオブジェクトを作成します。
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const recurrence = CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);
戻る
EventRecurrence
- ルールが設定されていない新しい繰り返しオブジェクト(毎週の繰り返しとして動作)
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.googleapis.com/auth/calendar.readonly
-
https://www.google.com/calendar/feeds
setColor(color)
カレンダーの色を設定します。
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the color of the calendar to pink using the Calendar Color enum. // For the default calendar, you can use CalendarApp.setColor() instead. calendar.setColor(CalendarApp.Color.PINK);
パラメータ
名前 | 型 | 説明 |
---|---|---|
color | String | CalendarApp.Color または 16 進数色文字列(「#rrggbb」)。 |
戻る
Calendar
- チェーン用のカレンダー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setDescription(description)
カレンダーの説明を設定します。
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the description of the calendar. // TODO(developer): Update the string with the description that you want to use. calendar.setDescription('Updated calendar description.');
パラメータ
名前 | 型 | 説明 |
---|---|---|
description | String | このカレンダーの説明 |
戻る
Calendar
- チェーン用のカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setHidden(hidden)
カレンダーをユーザー インターフェースに表示するかどうかを設定します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
hidden | Boolean | true : ユーザー インターフェースでカレンダーを非表示にする。false : カレンダーを表示する |
戻る
Calendar
- チェーン用のカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setName(name)
カレンダーの名前を設定します。
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the name of the calendar. // TODO(developer): Update the string with the name that you want to use. calendar.setName('Example calendar name');
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しい名前 |
戻る
Calendar
- チェーン用のカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setSelected(selected)
カレンダーの予定をユーザー インターフェースに表示するかどうかを設定します。
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Selects the calendar so that its events are displayed in the user interface. // To unselect the calendar, set the parameter to false. calendar.setSelected(true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
selected | Boolean | true : カレンダーの予定をユーザー インターフェースに表示します。false : 非表示にします。 |
戻る
Calendar
- チェーン用のカレンダー
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
カレンダーのタイムゾーンを設定します。
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the time zone of the calendar to America/New York (US/Eastern) time. calendar.setTimeZone('America/New_York');
パラメータ
名前 | 型 | 説明 |
---|---|---|
timeZone | String | タイムゾーン(「長い」形式で指定します。Joda.org に記載されている「America/New_York」など)。 |
戻る
Calendar
- チェーン用のカレンダー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id)
ユーザーが登録を許可されている場合、指定された ID のカレンダーにユーザーを登録します。
// Subscribe to the calendar "US Holidays". const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 登録するカレンダーの ID |
戻る
Calendar
- 新しく登録したカレンダー
例外
Error
- この ID のカレンダーが存在しない場合
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
subscribeToCalendar(id, options)
ユーザーが登録を許可されている場合、指定された ID のカレンダーにユーザーを登録します。
// Subscribe to the calendar "US Holidays", and set it to the color blue. const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', {color: CalendarApp.Color.BLUE}, ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 定期購入するカレンダーの ID。 |
options | Object | 以下に示す詳細なパラメータを指定する JavaScript オブジェクト。 |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
color | String | 16 進数色文字列(「#rrggbb」)または CalendarApp.Colors の値。 |
hidden | Boolean | カレンダーがユーザー インターフェースに非表示かどうか(デフォルト: false )。 |
selected | Boolean | カレンダーの予定をユーザー インターフェースに表示するかどうか(デフォルト: color も指定されている場合は true 、それ以外の場合は false )。 |
戻る
Calendar
- 新しく登録したカレンダー。
例外
Error
- この ID のカレンダーが存在しない場合
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上、または関連する REST API の適切なスコープの承認が必要です。
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds