このページは Cloud Translation API によって翻訳されました。

Class CalendarApp

スクリプトによるユーザーの Google カレンダーの読み取りと更新を許可します。このクラスを使用すると、ユーザーのデフォルトカレンダーへの追加や、カレンダーに割り当てた追加のカレンダーの取得も登録する必要があります。

プロパティ

プロパティ	タイプ	説明
`Color`	`Color`	カレンダーサービスで使用できる名前付きの色を表す列挙型。
`EventColor`	`EventColor`	カレンダーサービスで使用可能な名前付き予定の色を表す列挙型。
`GuestStatus`	`GuestStatus`	イベントに関してゲストが持つ可能性のあるステータスを表す列挙型。
`Month`	`Month`	月を表す列挙型。
`Visibility`	`Visibility`	イベントの可視性を表す列挙型。
`Weekday`	`Weekday`	曜日を表す列挙型。

メソッド

メソッド	戻り値の型	概要
`createAllDayEvent(title, date)`	`CalendarEvent`	新しい終日の予定を作成します。
`createAllDayEvent(title, startDate, endDate)`	`CalendarEvent`	複数日にわたる終日の予定を新規作成します。
`createAllDayEvent(title, startDate, endDate, options)`	`CalendarEvent`	複数日にわたる終日の予定を新規作成します。
`createAllDayEvent(title, date, options)`	`CalendarEvent`	新しい終日の予定を作成します。
`createAllDayEventSeries(title, startDate, recurrence)`	`CalendarEventSeries`	新しい終日の予定を作成します。
`createAllDayEventSeries(title, startDate, recurrence, options)`	`CalendarEventSeries`	新しい終日の予定を作成します。
`createCalendar(name)`	`Calendar`	ユーザーが所有する新しいカレンダーを作成します。
`createCalendar(name, options)`	`Calendar`	ユーザーが所有する新しいカレンダーを作成します。
`createEvent(title, startTime, endTime)`	`CalendarEvent`	新しいイベントを作成します。
`createEvent(title, startTime, endTime, options)`	`CalendarEvent`	新しいイベントを作成します。
`createEventFromDescription(description)`	`CalendarEvent`	自由形式の説明からイベントを作成します。
`createEventSeries(title, startTime, endTime, recurrence)`	`CalendarEventSeries`	新しいイベント系列を作成します。
`createEventSeries(title, startTime, endTime, recurrence, options)`	`CalendarEventSeries`	新しいイベント系列を作成します。
`getAllCalendars()`	`Calendar[]`	ユーザーが所有している、または登録しているすべてのカレンダーを取得します。
`getAllOwnedCalendars()`	`Calendar[]`	ユーザーが所有するすべてのカレンダーを取得します。
`getCalendarById(id)`	`Calendar`	指定された ID のカレンダーを取得します。
`getCalendarsByName(name)`	`Calendar[]`	ユーザーが所有または登録している、指定された名前のカレンダーをすべて取得します。
`getColor()`	`String`	カレンダーの色を取得します。
`getDefaultCalendar()`	`Calendar`	ユーザーのデフォルトのカレンダーを取得します。
`getDescription()`	`String`	カレンダーの説明を取得します。
`getEventById(iCalId)`	`CalendarEvent`	指定された ID のイベントを取得します。
`getEventSeriesById(iCalId)`	`CalendarEventSeries`	指定された ID のイベントシリーズを取得します。
`getEvents(startTime, endTime)`	`CalendarEvent[]`	指定された期間内に発生するすべてのイベントを取得します。
`getEvents(startTime, endTime, options)`	`CalendarEvent[]`	指定された期間内に発生し、指定された条件を満たすすべてのイベントを取得します。
`getEventsForDay(date)`	`CalendarEvent[]`	指定した日に発生したすべてのイベントを取得します。
`getEventsForDay(date, options)`	`CalendarEvent[]`	指定された日に発生し、指定された条件を満たすすべてのイベントを取得します。
`getId()`	`String`	カレンダーの ID を取得します。
`getName()`	`String`	カレンダーの名前を取得します。
`getOwnedCalendarById(id)`	`Calendar`	指定された ID のカレンダーを取得します（ユーザーが所有している場合）。
`getOwnedCalendarsByName(name)`	`Calendar[]`	ユーザーが所有する、指定された名前のカレンダーをすべて取得します。
`getTimeZone()`	`String`	カレンダーのタイムゾーンを取得します。
`isHidden()`	`Boolean`	ユーザーインターフェース上でカレンダーを非表示にするかどうかを指定します。
`isMyPrimaryCalendar()`	`Boolean`	カレンダーを有効なユーザーのメインカレンダーにするかどうかを決定します。
`isOwnedByMe()`	`Boolean`	カレンダーのオーナーが自分かどうかを確認します。
`isSelected()`	`Boolean`	カレンダーの予定をユーザーインターフェースに表示するかどうかを決定します。
`newRecurrence()`	`EventRecurrence`	新しい繰り返しオブジェクトを作成します。このオブジェクトを使用して、予定の繰り返しルールを作成できます。
`setColor(color)`	`Calendar`	カレンダーの色を設定します。
`setDescription(description)`	`Calendar`	カレンダーの説明を設定します。
`setHidden(hidden)`	`Calendar`	カレンダーをユーザーインターフェースに表示するかどうかを設定します。
`setName(name)`	`Calendar`	カレンダーの名前を設定します。
`setSelected(selected)`	`Calendar`	カレンダーの予定をユーザーインターフェースに表示するかどうかを設定します。
`setTimeZone(timeZone)`	`Calendar`	カレンダーのタイムゾーンを設定します。
`subscribeToCalendar(id)`	`Calendar`	ユーザーが登録を許可されている場合、指定された ID のカレンダーにユーザーを登録します。
`subscribeToCalendar(id, options)`	`Calendar`	ユーザーが登録を許可されている場合、指定された ID のカレンダーにユーザーを登録します。

詳細なドキュメント

`createAllDayEvent(title, date)`

新しい終日の予定を作成します。

// Creates an all-day event for the moon landing and logs the ID.
var 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.
var 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.
var 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.
var 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.
var 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.
var 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".
var 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 summary and color.
var calendar = CalendarApp.createCalendar('Travel Plans', {
  summary: '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`	カレンダーの場所
`summary`	`String`	カレンダーの説明
`timeZone`	`String`	カレンダーを設定するタイムゾーン（「long」で指定します）形式（例:「America/New_York」（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.
var 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.
var 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.
var 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.
var 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.
var 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.
var 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.
var 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.
var 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".
var 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.
var 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) にのみ発信していますは、デフォルトのカレンダーにイベントを返します。

一連のイベントが 1 つの場合、複数のイベントは同じ 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 の場合、この場合、一連のイベントのうち 1 つだけで 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.
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var 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".
var now = new Date();
var twoHoursFromNow = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var 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.
var today = new Date();
var 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)`

指定された日に発生し、指定された条件を満たすすべてのイベントを取得します。

このメソッドは、指定された日中に開始されたイベント、指定した日中に終了したイベント、または思います。

// Determines how many events are happening today and contain the term "meeting".
var today = new Date();
var 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.
var 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".
var 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 - 「long」の形式で指定されるタイムゾーン（たとえば、リストされている「America/New_York」 Joda.org）。

承認

このメソッドを使用するスクリプトでは、次のスコープの 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.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
var 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`	"long" で指定されたタイムゾーン（例: 「America/New_York」、 Joda.org で確認）できます。

戻る

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".
var 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.
var 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