Class Calendar

カレンダー

ユーザーがオーナーまたは登録先のカレンダーを表します。

Methods

メソッド戻り値の型概要
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終日の予定シリーズを新規作成します。
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新しいイベント シリーズを作成します。
deleteCalendar()voidカレンダーを完全に削除します。
getColor()Stringカレンダーの色を取得します。
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カレンダーの名前を取得します。
getTimeZone()Stringカレンダーのタイムゾーンを取得します。
isHidden()Booleanユーザー インターフェースでカレンダーを非表示にするかどうかを決定します。
isMyPrimaryCalendar()Booleanカレンダーが、アクティブ ユーザーのデフォルトのカレンダーかどうかを判断します。
isOwnedByMe()Booleanカレンダーを実質的なユーザーがオーナーであるかどうかを指定します。
isSelected()Booleanカレンダーの予定をユーザー インターフェースに表示するかどうかを指定します。
setColor(color)Calendarカレンダーの色を設定します。
setDescription(description)Calendarカレンダーの説明を設定します。
setHidden(hidden)Calendarカレンダーをユーザー インターフェースに表示するかどうかを設定します。
setName(name)Calendarカレンダーの名前を設定します。
setSelected(selected)Calendarカレンダーの予定をユーザー インターフェースに表示するかどうかを設定します。
setTimeZone(timeZone)Calendarカレンダーのタイムゾーンを設定します。
unsubscribeFromCalendar()voidユーザーのカレンダーへの登録を解除します。

詳細なドキュメント

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());

パラメータ

名前型説明
titleString予定のタイトル。
dateDateイベントの日付（日のみ、時刻は無視されます）。

復路

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());

パラメータ

名前型説明
titleString予定のタイトル。
startDateDateイベントの開始日（日のみが使用され、時間は無視されます）。
endDateDateイベントの終了日（日のみが使用され、時間は無視されます）。終了日にはご利用いただけません。

復路

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());

パラメータ

名前型説明
titleString予定のタイトル。
startDateDateイベントの開始日（日のみが使用され、時間は無視されます）。
endDateDateイベントの終了日（日のみが使用され、時間は無視されます）。終了日にはご利用いただけません。
optionsObject詳細パラメータを指定する JavaScript オブジェクト。下記のリストをご覧ください。

拡張パラメータ

名前型説明
descriptionStringイベントの説明。
locationStringイベントの場所。
guestsStringゲストとして追加するメールアドレスのカンマ区切りリスト。
sendInvitesBoolean招待メールを送信するかどうか（デフォルト: 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());

パラメータ

名前型説明
titleString予定のタイトル。
dateDateイベントの日付（日のみ、時刻は無視されます）。
optionsObject詳細パラメータを指定する JavaScript オブジェクト。下記のリストをご覧ください。

拡張パラメータ

名前型説明
descriptionStringイベントの説明。
locationStringイベントの場所。
guestsStringゲストとして追加するメールアドレスのカンマ区切りリスト。
sendInvitesBoolean招待メールを送信するかどうか（デフォルト: 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());

パラメータ

名前型説明
titleString一連の予定のタイトル
startDateDate一連の最初のイベントの日付（1 日のみを使用し、時刻は無視されます）
recurrenceEventRecurrence一連の定期的な予定の繰り返し設定

復路

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());

パラメータ

名前型説明
titleString一連の予定のタイトル
startDateDate一連の最初のイベントの日付（1 日のみを使用し、時刻は無視されます）
recurrenceEventRecurrence一連の定期的な予定の繰り返し設定
optionsObject詳細パラメータを指定する JavaScript オブジェクト（下記を参照）

拡張パラメータ

名前型説明
descriptionString一連のイベントの説明
locationStringシリーズ内のイベントの場所
guestsString一連の予定のゲストとしてゲストとして追加するメールアドレスのカンマ区切りリスト
sendInvitesBoolean招待メールを送信するかどうか（デフォルト: false）

復路

CalendarEventSeries - 作成されたイベント シリーズ

承認

このメソッドを使用するスクリプトには、次の 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());

パラメータ

名前型説明
titleStringイベントのタイトル
startTimeDateイベントの開始日時
endTimeDateイベントの終了日時

復路

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());

パラメータ

名前型説明
titleStringイベントのタイトル
startTimeDateイベントの開始日時
endTimeDateイベントの終了日時
optionsObject詳細パラメータを指定する JavaScript オブジェクト（下記を参照）

拡張パラメータ

名前型説明
descriptionStringイベントの説明
locationStringイベントの場所
guestsStringゲストとして追加するメールアドレスのカンマ区切りリスト
sendInvitesBoolean招待メールを送信するかどうか（デフォルト: 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());

パラメータ

名前型説明
descriptionString自由形式のイベントの説明

復路

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());

パラメータ

名前型説明
titleString一連の予定のタイトル
startTimeDate一連の定期的な予定のうち、最初の予定の開始日時
endTimeDate定期的な予定の最初の予定の終了日時
recurrenceEventRecurrence一連の定期的な予定の繰り返し設定

復路

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());

パラメータ

名前型説明
titleString一連の予定のタイトル
startTimeDate一連の定期的な予定のうち、最初の予定の開始日時
endTimeDate定期的な予定の最初の予定の終了日時
recurrenceEventRecurrence一連の定期的な予定の繰り返し設定
optionsObject詳細パラメータを指定する JavaScript オブジェクト（下記を参照）

拡張パラメータ

名前型説明
descriptionString一連のイベントの説明
locationStringシリーズ内のイベントの場所
guestsString一連の予定のゲストとしてゲストとして追加するメールアドレスのカンマ区切りリスト
sendInvitesBoolean招待メールを送信するかどうか（デフォルト: false）

復路

CalendarEventSeries - 作成されたイベント シリーズ

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

deleteCalendar()

カレンダーを完全に削除します。削除できるのは自分がオーナーのカレンダーのみです。

例外

Error - 読み込んだカレンダーの場合

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

getColor()

カレンダーの色を取得します。

復路

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

getDescription()

カレンダーの説明を取得します。

復路

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 のイベントを取得します。シリーズがデフォルトのカレンダー以外のカレンダーに属している場合は、そのカレンダーからこのメソッドを呼び出す必要があります。CalendarApp.getEventById(iCalId) を呼び出すと、デフォルトのカレンダー内の予定のみが返されます。

イベントシリーズの一部である場合、複数のイベントで同じ ID を持つことがあります。この場合、このメソッドはそのシリーズの最初のイベントのみを返します。

パラメータ

名前型説明
iCalIdStringイベントの 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 が返されます。イベント シリーズがデフォルト カレンダー以外のカレンダーに属している場合は、このメソッドをその Calendar から呼び出す必要があります。CalendarApp.getEventSeriesById(iCalId) を直接呼び出すと、デフォルト カレンダーに存在するイベント シリーズのみが返されます。

パラメータ

名前型説明
iCalIdStringイベント シリーズの 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);

パラメータ

名前型説明
startTimeDate期間の開始日
endTimeDate期間の終了時（非包括的）

復路

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);

パラメータ

名前型説明
startTimeDate期間の開始日
endTimeDate期間の終了時（非包括的）
optionsObject詳細パラメータを指定する JavaScript オブジェクト（下記を参照）

拡張パラメータ

名前型説明
startInteger最初に返されるイベントのインデックス
maxInteger返される最大イベント数
authorStringイベント作成者による結果のフィルタリングに使用するメールアドレス
searchString結果のフィルタに使用する全文検索クエリ
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)

特定の日に発生したすべてのイベントを取得します。

このメソッドは、特定の日から始まる、日中に終了する、または日が含まれる場合に返されます。

日付オブジェクトの日付部分のみが使用され、時間部分は無視されます。日付は、カレンダーのタイムゾーンで翌日の午前 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);

パラメータ

名前型説明
dateDateイベントを取得する日付（1 日のみが使用され、時間は無視されます）

復路

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)

指定した日付に発生するイベントのうち、指定の基準を満たすものをすべて取得します。

このメソッドは、特定の日から始まる、日中に終了する、または日が含まれる場合に返されます。

日付オブジェクトの日付部分のみが使用され、時間部分は無視されます。日付は、カレンダーのタイムゾーンで翌日の午前 0 時と解釈されます。

author、search、statusFilters でのフィルタリングは、start と max の適用後に行われます。つまり、追加のイベントが条件を満たしている場合でも、返されるイベントの数は max より少なくなることがあります。 

// 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);

パラメータ

名前型説明
dateDateイベントを取得する日付（1 日のみが使用され、時間は無視されます）
optionsObject高度なフィルタのオプション

拡張パラメータ

名前型説明
startInteger最初に返されるイベントのインデックス
maxInteger返される最大イベント数
authorStringイベント作成者による結果のフィルタリングに使用するメールアドレス
searchString結果のフィルタに使用する全文検索クエリ
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 はメールアドレスです。

復路

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()

カレンダーの名前を取得します。

復路

String - このカレンダーの名前

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.google.com/calendar/feeds

getTimeZone()

カレンダーのタイムゾーンを取得します。

復路

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()

ユーザー インターフェースでカレンダーを非表示にするかどうかを決定します。

復路

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()

カレンダーが、アクティブ ユーザーのデフォルトのカレンダーかどうかを判断します。

復路

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()

カレンダーを実質的なユーザーがオーナーであるかどうかを指定します。

復路

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()

カレンダーの予定をユーザー インターフェースに表示するかどうかを指定します。

復路

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

setColor(color)

カレンダーの色を設定します。

パラメータ

名前型説明
colorStringCalendarApp.Color または 16 進数のカラー文字列（#rrggbb）。

復路

Calendar - 連結するためのカレンダー。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setDescription(description)

カレンダーの説明を設定します。

パラメータ

名前型説明
descriptionStringこのカレンダーの説明

復路

Calendar - 連結用のこのカレンダー

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setHidden(hidden)

カレンダーをユーザー インターフェースに表示するかどうかを設定します。

パラメータ

名前型説明
hiddenBooleantrue: ユーザー インターフェースでカレンダーを非表示にします。false で表示します。

復路

Calendar - 連結用のこのカレンダー

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setName(name)

カレンダーの名前を設定します。

パラメータ

名前型説明
nameString新しい名前

復路

Calendar - 連結用のこのカレンダー

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setSelected(selected)

カレンダーの予定をユーザー インターフェースに表示するかどうかを設定します。

パラメータ

名前型説明
selectedBooleantrue: ユーザー インターフェースでカレンダーの予定を表示し、false で非表示にします。

復路

Calendar - 連結用のこのカレンダー

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

setTimeZone(timeZone)

カレンダーのタイムゾーンを設定します。

パラメータ

名前型説明
timeZoneString「long」形式で指定されたタイムゾーン（例:「America/New_York」（Joda.org を参照）

復路

Calendar - 連結用のこのカレンダー

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

unsubscribeFromCalendar()

ユーザーのカレンダーへの登録を解除します。ユーザーは自分のカレンダーを登録解除できません。

例外

Error - 自分のカレンダーの場合

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API からの適切なスコープによる承認が必要です。

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds