Class CalendarEvent

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
CalendarEvent

単一のカレンダーの予定を表します。

Methods

方法戻り値の型概要
addEmailReminder(minutesBefore)CalendarEvent新しいリマインダー メールを予定に追加します。
addGuest(email)CalendarEvent予定にゲストを追加します。
addPopupReminder(minutesBefore)CalendarEvent新しいポップアップ リマインダーが予定に追加されます。
addSmsReminder(minutesBefore)CalendarEvent新しい SMS リマインダーを予定に追加します。
anyoneCanAddSelf()Boolean自分を自分で招待できるユーザーを指定します。
deleteEvent()void予定を削除します。
deleteTag(key)CalendarEventイベントから Key-Value タグを削除します。
getAllDayEndDate()Dateこの終日カレンダーの終了日の日付を取得します。
getAllDayStartDate()Dateこの終日カレンダーの予定の開始日を取得します。
getAllTagKeys()String[]イベントに設定されているタグのすべてのキーを取得します。
getColor()Stringカレンダーの予定の色を返します。
getCreators()String[]イベントの作成者を取得します。
getDateCreated()Dateイベントの作成日を取得します。
getDescription()Stringイベントの説明を取得します。
getEmailReminders()Integer[]その予定のすべてのメールリマインダーの分値を取得します。
getEndTime()Dateこのカレンダーの予定の終了日時を取得します。
getEventSeries()CalendarEventSeriesこのイベントが属する一連の繰り返しイベントを取得します。
getGuestByEmail(email)EventGuestメールアドレスでゲストを取得します。
getGuestList()EventGuest[]予定の主催者を除く、その予定のゲストを取得します。
getGuestList(includeOwner)EventGuest[]予定のゲストを取得します。場合によっては、予定の主催者も含まれます。
getId()Stringイベントの一意の iCalUID を取得します。
getLastUpdated()Dateイベントが最後に更新された日付を取得します。
getLocation()Stringイベントの場所を取得します。
getMyStatus()GuestStatus有効なユーザーのイベント ステータス(出席など)を取得します。
getOriginalCalendarId()Stringこの予定を最初に作成したカレンダーの ID を取得します。
getPopupReminders()Integer[]イベントのすべてのポップアップ リマインダーの分値を取得します。
getSmsReminders()Integer[]イベントのすべての SMS リマインダーの分値を取得します。
getStartTime()Dateこのカレンダー イベントの開始日時を取得します。
getTag(key)Stringイベントのタグ値を取得します。
getTitle()Stringイベントのタイトルを取得します。
getVisibility()Visibilityイベントの可視性を取得します。
guestsCanInviteOthers()Booleanゲストが他のゲストを招待できるかどうかを決定します。
guestsCanModify()Booleanゲストが予定を変更できるかどうかを指定します。
guestsCanSeeGuests()Booleanゲストが他のゲストを表示できるかどうかを指定します。
isAllDayEvent()Boolean終日の予定であるかどうかを指定します。
isOwnedByMe()Boolean有効なユーザーがイベントのオーナーかどうかを判断します。
isRecurringEvent()Booleanイベントがイベントシリーズの一部かどうかを指定します。
removeAllReminders()CalendarEvent予定からすべてのリマインダーを削除します。
removeGuest(email)CalendarEvent予定からゲストを削除します。
resetRemindersToDefault()CalendarEventカレンダーのデフォルト設定を使用してリマインダーをリセットします。
setAllDayDate(date)CalendarEventイベントの日付を設定します。
setAllDayDates(startDate, endDate)CalendarEventイベントの日付を設定します。
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventゲスト以外のユーザーが自分自身をイベントに追加できるかどうかを設定します。
setColor(color)CalendarEventカレンダーの予定の色を設定します。
setDescription(description)CalendarEventイベントの説明を設定します。
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventゲストが他のゲストを招待できるかどうかを設定します。
setGuestsCanModify(guestsCanModify)CalendarEventゲストが予定を変更できるかどうかを設定します。
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventゲストが他のゲストを表示できるかどうかを指定します。
setLocation(location)CalendarEventイベントの場所を設定します。
setMyStatus(status)CalendarEvent有効なユーザーのイベント ステータス(出席など)を設定します。
setTag(key, value)CalendarEventカスタム メタデータを保存するために、イベントに Key-Value タグを設定します。
setTime(startTime, endTime)CalendarEventイベントの開始日時と終了日時を設定します。
setTitle(title)CalendarEventイベントのタイトルを設定します。
setVisibility(visibility)CalendarEventイベントの公開設定を設定します。

詳細なドキュメント

addEmailReminder(minutesBefore)

新しいリマインダー メールを予定に追加します。リマインダーは、予定の 5 分前~ 4 週間(40,320 分)前までに設定してください。

パラメータ

名前説明
minutesBeforeInteger予定の何分前から

戻る

CalendarEvent - このチェーン用の CalendarEvent

スロー値

Error - イベントに関するリマインダーが 5 件を超えるか、時間が法律上の範囲内の場合

認可

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

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

addGuest(email)

予定にゲストを追加します。

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.addGuest(attendeeEmail);
  }

// Example 2: Add a guest to all events on a calendar within a specified timeframe
function addAttendeeToAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and add the attendee to each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

パラメータ

名前説明
emailStringゲストのメールアドレス。

戻る

CalendarEvent - チェーン用の CalendarEvent

認可

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

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

addPopupReminder(minutesBefore)

新しいポップアップ リマインダーが予定に追加されます。リマインダーは、予定の 5 分前~ 4 週間(40,320 分)前までに設定してください。

パラメータ

名前説明
minutesBeforeInteger予定の何分前から

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

addSmsReminder(minutesBefore)

新しい SMS リマインダーを予定に追加します。リマインダーは、予定の 5 分前~ 4 週間(40,320 分)前までに設定してください。

パラメータ

名前説明
minutesBeforeInteger予定の何分前から

戻る

CalendarEvent - このチェーン用の CalendarEvent

スロー値

Error - イベントに関するリマインダーが 5 件を超えるか、時間が法律上の範囲内の場合

認可

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

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

anyoneCanAddSelf()

自分を自分で招待できるユーザーを指定します。

戻る

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

deleteEvent()

予定を削除します。

認可

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

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

deleteTag(key)

イベントから Key-Value タグを削除します。

パラメータ

名前説明
keyStringタグキー

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

getAllDayEndDate()

この終日カレンダーの終了日の日付を取得します。(これが終日イベントでない場合、このメソッドは例外をスローします。)返される Date は、イベントが終了した翌日の午後 0 時(スクリプトのタイムゾーン)を表します。カレンダーのタイムゾーンを使用するには、getEndTime() を呼び出します。

戻る

Date - この終日の予定(終了日)

スロー値

Error - このイベントが終日の予定でない場合

認可

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

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

getAllDayStartDate()

この終日カレンダーの予定の開始日を取得します。(これが終日イベントでない場合、このメソッドは例外をスローします。)返される Date は、イベントの開始日時の深夜 0 時(スクリプトのタイムゾーンで)を表します。カレンダーのタイムゾーンを使用するには、getStartTime() を呼び出します。

戻る

Date - この終日の予定の開始日

スロー値

Error - このイベントが終日の予定でない場合

認可

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

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

getAllTagKeys()

イベントに設定されているタグのすべてのキーを取得します。

戻る

String[] - 文字列キーの配列

認可

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

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

getColor()

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

戻る

String - イベントカラーの文字列表現。CalendarApp.EventColor からの値のインデックス(1 ~ 11)。

認可

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

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

getCreators()

イベントの作成者を取得します。

戻る

String[] - イベント作成者のメールアドレス

認可

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

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

getDateCreated()

イベントの作成日を取得します。

戻る

Date - 作成日

認可

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

getEmailReminders()

その予定のすべてのメールリマインダーの分値を取得します。

戻る

Integer[] - 各値が、リマインダーがトリガーされるイベントの前の分数に対応する配列

認可

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

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

getEndTime()

このカレンダーの予定の終了日時を取得します。終日以外のイベントの場合、これはイベントが終了した時刻になります。終了日だけではなく、日付と時刻だけを保存する終日の予定の場合は、カレンダーのタイムゾーンで予定が終了した日の深夜 0 時です。これにより、すべてのタイプのイベントの終了時間を有意に比較できます。ただし、元の日付を変更せずに保持できるとは限りません。

終日のイベントの場合、ほとんどの場合、このメソッドよりも getAllDayEndDate() を呼び出す必要があります。

戻る

Date - このカレンダーの予定の終了時間

認可

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

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

getEventSeries()

このイベントが属する一連の繰り返しイベントを取得します。このイベントはシリーズに属していなくても CalendarEventSeries オブジェクトが返されるため、新しい繰り返し設定を追加できます。

戻る

CalendarEventSeries - このイベントが属するイベントシリーズ。まだシリーズに属していない場合は新しいイベントシリーズ。

認可

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

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

getGuestByEmail(email)

メールアドレスでゲストを取得します。

パラメータ

名前説明
emailStringゲストの住所

戻る

EventGuest - ゲスト。メールアドレスがゲストに対応していない場合は null です。

認可

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

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

getGuestList()

予定の主催者を除く、その予定のゲストを取得します。

戻る

EventGuest[] - ゲストの配列

認可

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

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

getGuestList(includeOwner)

予定のゲストを取得します。場合によっては、予定の主催者も含まれます。

パラメータ

名前説明
includeOwnerBooleanオーナーをゲストとして追加するかどうか

戻る

EventGuest[] - ゲストの配列

認可

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

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

getId()

イベントの一意の iCalUID を取得します。Calendar v3 APICalendar Advanced Service で使用される iCalUID とイベント id は同じではなく、同じものとして使用することはできません。セマンティクスの違いの 1 つは、定期的なイベントでは、1 つのイベントが発生するたびにすべての ids が異なるのに、すべて同じ iCalUID を共有することです。

戻る

String - イベントの iCalUID

認可

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

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

getLastUpdated()

イベントが最後に更新された日付を取得します。

戻る

Date - 最終更新日

認可

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

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

getLocation()

イベントの場所を取得します。

戻る

String - イベントの場所

認可

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

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

getMyStatus()

有効なユーザーのイベント ステータス(出席など)を取得します。有効なユーザーがイベントのオーナーである場合、常に GuestStatus.OWNER を返します。

戻る

GuestStatus - ステータス

認可

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

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

getOriginalCalendarId()

この予定を最初に作成したカレンダーの 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

getPopupReminders()

イベントのすべてのポップアップ リマインダーの分値を取得します。

戻る

Integer[] - 各値が、リマインダーがトリガーされるイベントの前の分数に対応する配列

認可

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

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

getSmsReminders()

イベントのすべての SMS リマインダーの分値を取得します。

戻る

Integer[] - 各値が、リマインダーがトリガーされるイベントの前の分数に対応する配列

認可

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

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

getStartTime()

このカレンダー イベントの開始日時を取得します。終日以外のイベントの場合、これはイベントが開始したときに定義された時刻です。開始日だけ(日付と時刻は保存しない)だけの終日の予定の場合は、カレンダーのタイムゾーン内で予定の開始時刻の深夜 0 時になります。これにより、すべてのタイプのイベントの開始時間を比較できます。ただし、元の日付を変更せずに保持できるとは限りません。

終日の予定の場合、ほとんどの場合、このメソッドよりも getAllDayStartDate() を呼び出す必要があります。

戻る

Date - このカレンダーの予定の開始時間

認可

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

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

getTag(key)

イベントのタグ値を取得します。

パラメータ

名前説明
keyStringキー

戻る

String - タグ値

認可

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

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

getTitle()

イベントのタイトルを取得します。

戻る

String - タイトル

認可

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

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

getVisibility()

イベントの可視性を取得します。

戻る

Visibility - 表示設定値

認可

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

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

guestsCanInviteOthers()

ゲストが他のゲストを招待できるかどうかを決定します。

戻る

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

guestsCanModify()

ゲストが予定を変更できるかどうかを指定します。

戻る

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

guestsCanSeeGuests()

ゲストが他のゲストを表示できるかどうかを指定します。

戻る

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

isAllDayEvent()

終日の予定であるかどうかを指定します。

戻る

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

isRecurringEvent()

イベントがイベントシリーズの一部かどうかを指定します。

戻る

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

removeAllReminders()

予定からすべてのリマインダーを削除します。

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

removeGuest(email)

予定からゲストを削除します。

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let event = calendar.getEventById(eventId);
  if (event === null) {
    // Event not found
    console.log('Event not found', eventId);
    return;
    }
  event.removeGuest(attendeeEmail);
  }

// Example 2: Remove a guest from all events on a calendar within a specified timeframe
function removeGuestFromAllEvents(){
// Replace the following values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let calEvents = calendar.getEvents(startDate,endDate);
  console.log(calEvents.length); // Checks how many events are found
  // Loop through all events and remove the attendee from each of them
  for (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

パラメータ

名前説明
emailStringゲストのメールアドレス

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

resetRemindersToDefault()

カレンダーのデフォルト設定を使用してリマインダーをリセットします。

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setAllDayDate(date)

イベントの日付を設定します。この方法を適用すると、通常の予定が終日の予定に変更されます。

パラメータ

名前説明
dateDateイベントの日付(時刻は無視されます)

戻る

CalendarEvent - チェーン用のこの CalendarEvent

認可

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

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

setAllDayDates(startDate, endDate)

イベントの日付を設定します。この方法を適用すると、通常のイベントが終日の予定に変更されます。

パラメータ

名前説明
startDateDateイベントの開始日(時刻は無視されます)
endDateDateイベントの終了日(時刻は無視されます)

戻る

CalendarEvent - チェーン用のこの CalendarEvent

認可

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

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

setAnyoneCanAddSelf(anyoneCanAddSelf)

ゲスト以外のユーザーが自分自身をイベントに追加できるかどうかを設定します。

パラメータ

名前説明
anyoneCanAddSelfBoolean自分を招待できるかどうか

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setColor(color)

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

パラメータ

名前説明
colorString文字列の色を示す整数の文字列、または CalendarApp.EventColor の値。

戻る

CalendarEvent - 連結するカレンダー イベント。

認可

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

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

setDescription(description)

イベントの説明を設定します。

パラメータ

名前説明
descriptionString新しい説明文

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setGuestsCanInviteOthers(guestsCanInviteOthers)

ゲストが他のゲストを招待できるかどうかを設定します。

パラメータ

名前説明
guestsCanInviteOthersBooleanゲストが他のユーザーを招待できるかどうか

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setGuestsCanModify(guestsCanModify)

ゲストが予定を変更できるかどうかを設定します。

パラメータ

名前説明
guestsCanModifyBooleanゲストが予定を変更できるかどうか

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setGuestsCanSeeGuests(guestsCanSeeGuests)

ゲストが他のゲストを表示できるかどうかを指定します。

パラメータ

名前説明
guestsCanSeeGuestsBooleanゲストに他のユーザーの表示を許可するかどうか

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setLocation(location)

イベントの場所を設定します。

パラメータ

名前説明
locationString新しい場所

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setMyStatus(status)

有効なユーザーのイベント ステータス(出席など)を設定します。

パラメータ

名前説明
statusGuestStatus新しいステータス

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setTag(key, value)

カスタム メタデータを保存するために、イベントに Key-Value タグを設定します。

パラメータ

名前説明
keyStringタグキー
valueStringタグの値

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setTime(startTime, endTime)

イベントの開始日時と終了日時を設定します。この方法を適用すると、終日の予定が通常の予定に変更されます。

パラメータ

名前説明
startTimeDate予定の新しい開始時間
endTimeDate予定の新しい終了

戻る

CalendarEvent - チェーン用のこの CalendarEvent

認可

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

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

setTitle(title)

イベントのタイトルを設定します。

パラメータ

名前説明
titleString新しいタイトル

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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

setVisibility(visibility)

イベントの公開設定を設定します。

パラメータ

名前説明
visibilityVisibility

戻る

CalendarEvent - このチェーン用の CalendarEvent

認可

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

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