Event
サポートされているコール
create()、delete()、describeLayout()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、search()、undelete()、update()、upsert()
項目
| 項目 | 詳細 |
|---|---|
| AcceptedEventInviteeIds | |
| AccountId |
|
| ActivityDate | |
| ActivityDateTime |
|
| ClientGuid |
|
| CurrencyIsoCode | |
| DeclinedEventInviteeIds | |
| Description |
|
| Division |
|
| DurationInMinutes |
|
| EndDate |
|
| EndDateTime |
|
| EventSubtype | |
| EventWhoIds | |
| GroupEventType |
|
| IsAllDayEvent |
|
| IsArchived |
|
| IsChild |
|
| IsClientManaged |
|
| IsGroupEvent |
|
| IsPrivate |
|
| IsRecurrence |
|
| IsRecurrence2 |
|
| IsRecurrence2Exception |
|
| IsRecurrence2Exclusion |
|
| IsReminderSet | |
| IsVisibleInSelfService |
|
| Location |
|
| OwnerId |
|
| Recurrence2PatternStartDate |
|
| Recurrence2PatternText |
|
| Recurrence2PatternTimeZone |
|
| Recurrence2PatternVersion |
|
| RecurrenceActivityId |
|
| RecurrenceDayOfMonth |
|
| RecurrenceDayOfWeekMask |
|
| RecurrenceEndDateOnly |
|
| RecurrenceInstance |
|
| RecurrenceInterval |
|
| RecurrenceMonthOfYear |
|
| RecurrenceStartDateTime |
|
| RecurrenceTimeZoneSidKey |
|
| RecurrenceType |
|
| ReminderDateTime |
|
| ShowAs |
|
| StartDateTime |
|
| Subject |
|
| Type |
|
| UndecidedEventInviteeIds | |
| WhatCount |
|
| WhatId |
|
| WhoCount |
|
| WhoId |
|
使用方法
Event を使用して、カレンダーの予定を管理します。
行動のクエリと絞り込み
行動に関するクエリは、大きすぎるデータを使用する場合、タイムアウトする前に拒否されます。そのような場合、例外コード OPERATION_TOO_LARGE が返されます。OPERATION_TOO_LARGE を受け取った場合、より少量のデータをスキャンするか、クエリを再構成します。
- ActivityDate 項目が協定世界時 (UTC) タイムゾーンの 2003 年 2 月 14 日に等しい。
- ActivityDate 項目がユーザのローカルタイムゾーンの 2003 年 2 月 14 日の午前 0 時以降、かつユーザのローカルタイムゾーンの 2003 年 2 月 15 日午前 0 時以前の値。
また、バージョン 13.0 以降では、StartDateTime で絞り込み、特定の期日の行動を検索することができます。たとえば、期日が 2003 年 2 月 14 日であるすべての行動を検索するには、ローカルタイムゾーンの 2003 年 2 月 14 日の午前 0 時以降、かつユーザのローカルタイムゾーンの 2003 年 2 月 15 日午前 0 時以前の StartDateTime で絞り込みます。
EventRelation オブジェクトの EventId 項目は必ずマスターレコードを指し示します。グループ行動の招待者は EventRelation オブジェクトを照会して、マスターレコードを参照できます。
- 複数日の行動はバージョン 13.0 以降で使用できます。また、以前のバージョンの SOQL クエリは、複数日の行動を返しません。
- 複数日の行動を有効にするには、ユーザインターフェースの [設定] から [クイック検索] ボックスに「活動設定」と入力し、[活動設定] を選択します。
- 複数日の行動機能が有効な場合、API バージョン 13.0 以降では、DurationInMinutes 項目の 1440 を超える値をサポートします。API バージョン 12.0 以前では、DurationInMinutes が 1440 を超える行動オブジェクトにはアクセスできません。
- 複数日の行動は 14 日を超えることができません。
Lightning Experience では、複数回発生する行動を一連の行動と呼び、IsRecurrence2 項目を true に設定して示します。Salesforce Classic では、複数回発生する行動を定期的な行動と呼び、IsRecurrence 項目を true に設定して示します。どちらの項目も、同じ行動に対して true に設定できません。
- Lightning Experience の一連の行動は、API バージョン 44.0 以降で参照のみの項目として使用できます。Recurrence2PatternText 項目で指定される繰り返しパターンは、API バージョン 52.0 以降で作成できます。Salesforce Classic の定期的な行動は、バージョン 7.0 以降で使用できます。それより前のバージョンでは、SOQL クエリを実行しても、Lightning Experience の一連の行動は返されません。
- 行動を作成した後、IsRecurrence2 または IsRecurrence の値を true から false (またはその逆) に変更することはできません。
- IsRecurrence が true に設定されている行動で IsRecurrence2 に関連付けられた項目は設定できません (その逆もできません)。
- Lightning Experience の一連の行動で IsRecurrence2 が true の場合、1 つまたは残りすべての行動を削除するには、REST API コールを使用します。Salesforce Classic の定期的な行動で IsRecurrence が true の場合、API で定期的な行動を削除すると、過去と将来の一連の行動がすべて削除されます。ただし、ユーザインターフェースで定期的な行動を削除すると、将来の行動だけが削除されます。
- Salesforce Classic の定期的な行動を作成する場合、行動の時間は 24 時間以下である必要があります。Salesforce Classic の定期的な行動を作成すると、複数日の行動が有効な場合は、個々の行動時間を 24 時間以上に延長できます。詳細は、「複数日の行動」を参照してください。
- Salesforce Classic の定期的な行動の場合、RecurrenceStartDateTime、RecurrenceEndDateOnly, RecurrenceType, および特定の繰り返し種別に関連付けられたプロパティ (「Recurrence Field Usage for Salesforce Classic Recurring Events」 (Salesforce Classic の定期的な行動の繰り返し項目の使用) 表を参照) に値を入力する必要があります。
- Salesforce Classic の定期的な行動を更新する際、定期的な行動オブジェクトの EventRelation と、個々の行動オブジェクトの EventRelation を同時に更新することはできません。
- Lightning Experience の一連の行動には ID がないため、一連の行動内の他の行動を検索することができません。Salesforce Classic の定期的な行動では、RecurrenceActivityId を使用して他の行動を検索できます。
- Lightning Experience の一連の行動と Salesforce Classic の定期的な行動のどちらも、行動が毎日、毎月、または毎年繰り返す場合、行動を 1 日、1 か月、または 1 年に 1 回のみスケジュールできます。毎週オプションを使用すると、1 週間の複数日に行動をスケジュールできます。
Lightning Experience の一連の行動の制限および Salesforce Classic の定期的な行動の制限も適用されます。
Lightning Experience の一連の行動と定期的な行動
| 繰り返しパターン | RRULE の例 |
|---|---|
| 5 日間毎日 | RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5 |
| 毎週月曜日、火曜日、水曜日、木曜日、および金曜日 (終了日なし) | RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR |
| 隔週月曜日と金曜日を 10 回 | RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,FR;COUNT=10 |
| 2020 年 1 月まで毎月 1 日 | RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1;UNTIL=20200101T100000Z |
| 毎年 7 月 4 日を 3 回 (この例では、日付は StartDateTime を使用して指定) | RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=7;BYMONTHDAY=4;COUNT=3 |
| 2022 年 1 月 1 日まで毎日 (終了日なし) | RRULE:FREQ=DAILY;UNTIL=20220101T000000Z |
| 毎月第 3 金曜日 (終了日なし) | RRULE:FREQ=MONTHLY;BYSETPOS=3;BYDAY=FR |
Recurrence2PatternText で定義された RRULE は、インターネットカレンダーおよびスケジュールのための RFC 5545 標準のサブセットをサポートします。サポートされる RRULE 部分には、FREQ、BYMONTH、BYMONTHDAY、BYDAY、WKST、BYSETPOS、INTERVAL、UNTIL、COUNT があります。
- RRULE 部分は、FREQ、BYMONTH、BYMONTHDAY、BYDAY、WKST、BYSETPOS、INTERVAL、UNTIL、COUNT の順所で配置されます。
- 欠落しているデフォルト値がある場合は、挿入されます。たとえば、RRULE に INTERVAL が含まれていない場合は、INTERVAL=1 が追加されます。
- RRULE の先頭に RRULE: が指定されていない場合は、RRULE: が指定されます。
| RRULE 部分 | サポートされる RFC 5545 実装 |
|---|---|
| FREQ | 必須。繰り返しルールの種別を示します。有効な値は、次のとおりです。
|
| BYMONTH | 月。有効な値は 1 ~ 12 です。 |
| BYMONTHDAY | 日付。有効な値は 1 ~ 31 です。BYMONTHDAY が 31 で月の日数が 31 より少ない場合は、月の最終日に行動が作成されます。 |
| BYDAY | 曜日のカンマ区切りのリスト。有効な値は、SU、MO、TU、WE、TH、FR、SA です。RRULES の頻度が毎年または毎月の場合、BYDAY は次のいずれかにする必要があります。
毎月または毎年の RRULE 内で、各 BYDAY 値の前には、特定の曜日の n 番目の発生を示す整数を指定できます。使用できる値は、-1、1、2、3、4 です。BYDAY 値に異なる数値を使用することはできません。たとえば、次の RRULE はサポートされません。RRULE:FREQ=MONTHLY;INTERVAL=2;COUNT=10;BYDAY=1SU,-1SU BYDAY 値の前に数値が指定されている場合、RRULE に BYSETPOS を含めることはできません。 |
| WKST | 1 週間の勤務日数が始まる曜日を指定します。有効な値は、MO、TU、WE、TH、FR、SA、SU です。デフォルト値は、ユーザのロケールに基づいて設定されます。 |
| BYSETPOS | ルールで指定された一連の繰り返しインスタンス内の n 番目の発生に対応する値をカンマで区切ったリスト。有効な値は、-1、1、2、3、または 4 です。デフォルト値は 1 です。 たとえば、月の最後の週末を示すには、RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1 を使用します。 |
| INTERVAL | 繰り返し間隔。有効な値は、次のとおりです。
|
| UNTIL | 繰り返しルールが停止する日時を UTC 形式で指定します。サポートされる形式は、yyyyMMddTHHmmssZ です。たとえば、20210419T083000Z のように指定します。 RRULE に UNTIL と COUNT の両方を含めることはできません。UNTIL または COUNT のいずれも指定されていない定期的な行動は、無期限に繰り返されます。 |
| COUNT | 出現数。使用できる値は 1 ~ 999 です。 RRULE に UNTIL と COUNT の両方を含めることはできません。UNTIL または COUNT のいずれも指定されていない定期的な行動は、無期限に繰り返されます。 |
| BYWEEKNO | 年間の週を示す値のリストのカンマ区切りリストを指定します。有効な値は、次のとおりです。
たとえば、年間の特定の週を示すには、次のようにします: RRULE: BYWEEKNO=20, -20。 このルールパートは、FREQ ルールパートが YEARLY 以外に設定されている場合は使用できません。たとえば、3 は年内の 3 番目の週を表します。 注意: 月曜日から週を開始する場合は、53 週目が発生するのは 1 月 1 日が木曜日の場合か、うるう年で 1 月 1 日が水曜日の場合のみです。 |
| BYYEARDAY | 年間の日付を指す値のカンマ区切りリストを指定します。有効な値は、次のとおりです。
たとえば、年間の特定の日付を示すには、次のようにします: RRULE:BYYEARDAY=1,100,200、または RRULE:BYYEARDAY=1,-2 |
Salesforce Classic の一連の行動と定期的な行動
次の表では、Salesforce Classic の定期的な行動の繰り返し項目の使用について説明します。それぞれの繰り返しのタイプでは、すべてのプロパティが指定されている必要があります。未使用のプロパティはすべて null に設定する必要があります。
| RecurrenceType の値 | プロパティ | パターンの例 |
|---|---|---|
| RecursDaily | RecurrenceInterval | 1 日おき |
| RecursEveryWeekday | RecurrenceDayOfWeekMask | 土曜、日曜以外のすべての平日 |
| RecursMonthly | RecurrenceDayOfMonth RecurrenceInterval | 1 か月おき、月の 3 日目 |
| RecursMonthlyNth | RecurrenceInterval RecurrenceInstance RecurrenceDayOfWeekMask | 1 か月おき、月の最終金曜日 |
| RecursWeekly | RecurrenceInterval RecurrenceDayOfWeekMask | 2 週間おきの水曜日と金曜日 |
| RecursYearly | RecurrenceDayOfMonth RecurrenceMonthOfYear | 毎年 3 月の 26 日 |
| RecursYearlyNth | RecurrenceDayOfWeekMask RecurrenceInstanceRecurrenceMonthOfYear | 毎年 10 月の第 1 土曜日 |
GroupEventType 項目は、行動の参加者が行動に含まれていることを示します。リソースは、対応可能な場合にのみ行動に追加できます。リソースに割り当て可能な参加状況は「参加」のみです。追加したリソースが対応不可の場合、行動を保存することはできません。
JunctionIdList
1public void createEventNew(Contact[] contacts) {
2 String[] contactIds = new String[contacts.size()];
3 for (int i = 0; i < contacts.size(); i++) {
4 contactIds[i] = contacts[i].getID();
5 }
6 Event event = new Event();
7 event.setSubject("New Event");
8 event.setEventWhoIds(contactIds);
9 SaveResult[] results = null;
10 try {
11 results = connection.create(new Event[] {
12 task
13 });
14 } catch (ConnectionException ce) {
15 ce.printStackTrace();
16 }
17}被招集者の状況 (「参加または未定」、「不参加」、または「無回答」) は Microsoft® Exchange または Google から Salesforce に同期されますが、Salesforce から Exchange または Google には同期されません。双方向に同期するように設定されたユーザの場合、Salesforce で被招集者の状況を更新する API フローの作成には注意してください。最終的に、Salesforce で加えられた更新は Exchange または Google の元の状況で上書きされます。
関連付けられたオブジェクト
このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。
- EventChangeEvent (API バージョン 44.0)
- このオブジェクトには変更イベントを利用できます。
- EventFeed (API バージョン 20.0)
- このオブジェクトにはフィード追跡を利用できます。