Class RecurrenceRule

頻度ルール

イベント シリーズの繰り返しルールを表します。

このクラスは、所属する EventRecurrence のように動作するため、次のようにルールの作成を連結できます。

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

メソッド

メソッド戻り値の型概要
addDailyExclusion()RecurrenceRule毎日発生する出来事を除外するルールを追加します。
addDailyRule()RecurrenceRuleイベントを毎日繰り返すルールを追加します。
addDate(date)EventRecurrence特定の日付にイベントを繰り返すルールを追加します。
addDateExclusion(date)EventRecurrence特定の日付の発生を除外するルールを追加します。
addMonthlyExclusion()RecurrenceRule月単位で発生する出来事を除外するルールを追加します。
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)RecurrenceRule特定の日にのみ適用されるようにルールを設定します。
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.
const 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.
const 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()

月単位で発生するケースを除外するルールを追加します。

デフォルトでは、除外はシリーズの最初のイベントと同じ月の日に適用されますが、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.
const recurrence = CalendarApp.newRecurrence().addMonthlyRule().times(4);

戻る

RecurrenceRule - 新しい RecurrenceRule

承認

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

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

addWeeklyExclusion()

週単位で発生を除外するルールを追加します。

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

// Creates a rule that recurs every day except the first four Wednesdays.
const 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.
const 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.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);

パラメータ

名前説明
intervalIntegerルールの時間単位で指定した間隔

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyInMonth(month)

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

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

パラメータ

名前説明
monthMonth

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyInMonths(months)

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

// Creates a rule that recurs every week in February and March.
const 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.
const 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.
const recurrence =
    CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDays([1, 15]);

パラメータ

名前説明
daysInteger[]毎月の特定の日

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeek(week)

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

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

パラメータ

名前説明
weekInteger

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeekday(day)

特定の曜日にのみ適用されるようにルールを構成します。

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

パラメータ

名前説明
dayWeekday曜日

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnWeekdays(days)

特定の曜日にのみ適用されるようにルールを構成します。

// Creates a rule that recurs every week on Tuesdays and Thursdays.
const 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.
const 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).
const recurrence =
    CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);

パラメータ

名前説明
dayInteger年内日数

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


onlyOnYearDays(days)

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

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

パラメータ

名前説明
daysInteger[]日付

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


setTimeZone(timeZone)

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

パラメータ

名前説明
timeZoneStringタイムゾーン(「long」形式で指定)(例: Joda.org に記載されている「America/New_York」など)

戻る

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.
const recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

パラメータ

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

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule


until(endDate)

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

// Creates a rule that recurs every day through the end of 2013.
const 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.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().weekStartsOn(
    CalendarApp.Weekday.MONDAY);

パラメータ

名前説明
dayWeekday週の開始日

戻る

RecurrenceRule - チェーン用のこの RecurrenceRule