Class RecurrenceRule

RecurrenceRule

一連のイベントの繰り返しルールを表します。

なお、このクラスは属している EventRecurrence も動作するため、次のようにルールを連鎖させることができます。

recurrence.addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);
times(times)interval(interval) などの修飾子は、最後に追加されたルールに適用されます。

Methods

メソッド戻り値の型概要
addDailyExclusion()RecurrenceRule毎日の発生を除外するルールを追加します。
addDailyRule()RecurrenceRuleイベントが毎日繰り返されるルールを追加します。
addDate(date)EventRecurrenceイベントを特定の日付に繰り返すルールを追加します。
addDateExclusion(date)EventRecurrence特定の日付のオカレンスを除外するルールを追加します。
addMonthlyExclusion()RecurrenceRule月 1 回の発生を除外するルールを追加します。
addMonthlyRule()RecurrenceRuleイベントを毎月繰り返すルールを追加します。
addWeeklyExclusion()RecurrenceRule発生回数を週単位で除外するルールを追加します。
addWeeklyRule()RecurrenceRuleイベントを毎週繰り返すルールを追加します。
addYearlyExclusion()RecurrenceRule毎年の発生を除外するルールを追加します。
addYearlyRule()RecurrenceRuleイベントを毎年繰り返すようにするルールを追加します。
interval(interval)RecurrenceRuleルールの時間単位のこの間隔でのみ適用されるようにルールを設定します。
onlyInMonth(month)RecurrenceRule特定の月にのみ適用するようにルールを構成します。
onlyInMonths(months)RecurrenceRule特定の月にのみ適用するようにルールを設定します。
onlyOnMonthDay(day)RecurrenceRule月の特定の日にのみ適用するようにルールを設定します。
onlyOnMonthDays(days)RecurrenceRule月の特定の日にのみ適用するようにルールを設定します。
onlyOnWeek(week)RecurrenceRule一年の特定の週にのみ適用するようにルールを構成します。
onlyOnWeekday(day)RecurrenceRule特定の曜日にのみ適用するようにルールを設定します。
onlyOnWeekdays(days)RecurrenceRule特定の曜日にのみ適用するようにルールを設定します。
onlyOnWeeks(weeks)RecurrenceRule一年の特定の週にのみ適用するようにルールを構成します。
onlyOnYearDay(day)RecurrenceRule一年の特定の日にのみ適用するようにルールを設定します。
onlyOnYearDays(days)RecurrenceRule1 年の特定の日にのみ適用するようにルールを構成します。
setTimeZone(timeZone)EventRecurrenceこの繰り返しのタイムゾーンを設定します。
times(times)RecurrenceRule指定した回数に達したらルールを終了するように設定します。
until(endDate)RecurrenceRule指定した日付(その日付を含む)に終了するようにルールを設定します。
weekStartsOn(day)RecurrenceRuleルールを適用する目的で、週の始まりの曜日を構成します。

詳細なドキュメント

addDailyExclusion()

毎日の発生を除外するルールを追加します。

// Creates a rule that recurs every week after the first 30 days.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().addDailyExclusion().times(30);

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addDailyRule()

イベントを毎日繰り返すルールを追加します。

// Creates a rule that recurs every day for ten days.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addDate(date)

イベントを特定の日付に繰り返すルールを追加します。

パラメータ

名前説明
dateDate

リターン

EventRecurrence - チェーン用のこの EventRecurrence

承認

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

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

addDateExclusion(date)

特定の日付のオカレンスを除外するルールを追加します。

パラメータ

名前説明
dateDate

リターン

EventRecurrence - チェーン用のこの EventRecurrence

承認

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

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

addMonthlyExclusion()

月 1 回の発生を除外するルールを追加します。

デフォルトでは、除外は一連の最初のイベントと同じ日に適用されますが、onlyOnMonthDay(day) または onlyOnMonthDays(days) を呼び出すことで変更できます。

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addMonthlyRule()

イベントを毎月繰り返すルールを追加します。

デフォルトでは、一連の繰り返しの最初のイベントと同じ日にそのイベントが繰り返し実行されますが、onlyOnMonthDay(day) または onlyOnMonthDays(days) を呼び出すことで、変更できます。

// Creates a rule that recurs every month for three months.
var recurrence = CalendarApp.newRecurrence().addMonthlyRule().times(4);

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addWeeklyExclusion()

発生頻度を週 1 回除外するルールを追加します。

デフォルトでは、一連のイベントの最初のイベントと同じ曜日に除外が適用されますが、onlyOnWeekday(day) または onlyOnWeekdays(days) を呼び出すことで変更できます。

// Creates a rule that recurs every day except the first four Wednesdays.
var recurrence = CalendarApp.newRecurrence().addDailyRule()
    .addWeeklyExclusion().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY).times(4);

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addWeeklyRule()

イベントを毎週繰り返すルールを追加します。

デフォルトでは、一連の定期的な予定の最初の予定と同じ曜日に繰り返されますが、onlyOnWeekday(day) または onlyOnWeekdays(days) を呼び出すことで変更できます。

// Creates a rule that recurs every week for ten weeks.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().times(10);

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addYearlyExclusion()

毎年の発生を除外するルールを追加します。

デフォルトでは、除外は一連の最初のイベントと同じ日に適用されますが、onlyOnYearDay(day) または onlyOnYearDays(days) を呼び出すことで変更できます。

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addYearlyRule()

イベントを毎年繰り返すルールを追加します。

デフォルトでは、一連の最初のイベントと同じ日にその年の定期的な予定が発生しますが、onlyOnYearDay(day) または onlyOnYearDays(days) を呼び出してこれを変更できます。

リターン

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

interval(interval)

ルールの時間単位のこの間隔でのみ適用されるようにルールを設定します。

// Creates a rule that recurs every fourth week.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);

パラメータ

名前説明
intervalIntegerルールの時間単位の間隔

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyInMonth(month)

特定の月にのみ適用するようにルールを設定します。

// Creates a rule that recurs every week in February.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().onlyInMonth(CalendarApp.Month.FEBRUARY);

パラメータ

名前説明
monthMonth

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyInMonths(months)

特定の月にのみ適用するようにルールを設定します。

// Creates a rule that recurs every week in February and March.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().onlyInMonths([CalendarApp.Month.FEBRUARY, CalendarApp.Month.MARCH]);

パラメータ

名前説明
monthsMonth[]

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnMonthDay(day)

月の特定の日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every month on the fifth day of the month.
var recurrence = CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDay(5);

パラメータ

名前説明
dayInteger日付

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnMonthDays(days)

月の特定の日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every month on the first and fifteenth day of the month.
var recurrence = CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDays([1, 15]);

パラメータ

名前説明
daysInteger[]

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeek(week)

一年の特定の週にのみ適用するようにルールを設定します。

// Creates a rule that recurs on the fifth week of every year.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);

パラメータ

名前説明
weekInteger

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeekday(day)

特定の曜日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every week on Wednesdays.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY);

パラメータ

名前説明
dayWeekday曜日

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeekdays(days)

特定の曜日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every week on Tuesdays and Thursdays.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().onlyOnWeekdays(
        [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]);

パラメータ

名前説明
daysWeekday[]曜日

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeeks(weeks)

一年の特定の週にのみ適用するようにルールを構成します。

// Creates a rule that recurs on the fifth and tenth weeks of every year.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeeks([5, 10]);

パラメータ

名前説明
weeksInteger[]週間

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnYearDay(day)

一年の特定の日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every year on February 15 (the 46th day).
var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);

パラメータ

名前説明
dayInteger日付

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnYearDays(days)

1 年の特定の日にのみ適用するようにルールを設定します。

// Creates a rule that recurs every year on January 20 and February 15.
var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);

パラメータ

名前説明
daysInteger[]1 年

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


setTimeZone(timeZone)

この繰り返しのタイムゾーンを設定します。これは、イベントが繰り返される日時と、イベントが夏時間によって変わるかどうかに影響します。デフォルトはカレンダーのタイムゾーンです。

パラメータ

名前説明
timeZoneString「long」形式で指定されたタイムゾーン(例:'America/New_York'(Joda.org によってリストされる))

リターン

EventRecurrence - チェーン用のこの EventRecurrence

承認

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

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

times(times)

指定した回数に達したらルールを終了するように設定します。

// Creates a rule that recurs every day for ten days.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

パラメータ

名前説明
timesInteger繰り返しの回数

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule


until(endDate)

指定した日付(その日付を含む)に終了するようにルールを設定します。

// Creates a rule that recurs every day through the end of 2013.
var recurrence = CalendarApp.newRecurrence()
    .addDailyRule().until(new Date('December 31, 2013'));

パラメータ

名前説明
endDateDate

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule

承認

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

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

weekStartsOn(day)

ルールを適用する目的で、週の始まりの曜日を設定します。

// Creates a weekly rule where weeks start on Monday.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().weekStartsOn(CalendarApp.Weekday.MONDAY);

パラメータ

名前説明
dayWeekday週の始まりの曜日

リターン

RecurrenceRule - チェーン用のこの RecurrenceRule