この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Event

カレンダーの行動を表します。ユーザインターフェースで、行動と ToDo レコードは活動として集合的に参照されます。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

メモ

  • EventRelation オブジェクトは、下位行動に関連付けることはできません。また、下位行動には [招待者] 関連リストは含まれません。
  • API バージョン 25.0 以前では、複数の取引先責任者に関連する行動で、query()delete()、および update() は許可されません。
  • create() および update() は、Lightning Experience の一連の行動の参照のみ項目では使用できません。
  • upsert() および undelete() は、API で Lightning Sync 機能を使用してイベントに加えた変更の同期ではサポートされません。

メモ

サポートされているコール

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert()

項目

項目 詳細
AcceptedEventInviteeIds
JunctionIdList
プロパティ
Create、Update
説明
この行動を承諾した取引先責任者またはリードの ID の文字列配列。この JunctionIdList は、AcceptedEventRelation 子リレーションにリンクしています。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

警告

AccountId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
関連する取引先の ID を表します。AccountId は次のように決定されます。

WhatId の値が次のオブジェクトのいずれかである場合、Salesforce はそのオブジェクトの AccountId を使用します。

  • Account
  • Opportunity
  • Contract
  • Account の子であるカスタムオブジェクト

WhatId 項目の値がその他のオブジェクトで、かつ WhoId 項目の値が取引先責任者オブジェクトである場合、Salesforce はその取引先責任者の AccountId を使用します。(組織で Shared Activities を使用している場合、Salesforce では主取引先責任者の AccountId を使用します)。

それ以外の場合は、Salesforce は AccountId 項目の値を null に設定します。

ID についての詳細は、「ID データ型」を参照してください。

これはリレーション項目です。
リレーション名
Account
リレーション種別
Lookup
参照先
Account
ActivityDate
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
IsAllDayEvent フラグが true に設定されている場合、行動の期日が含まれます。この項目には、協定世界時 (UTC) タイムゾーンの午前 0 時に常に設定されている日付項目があります。タイムゾーンの違いを考慮してタイムスタンプを変更しないでください。表示ラベルは [期日のみ] です。

IsAllDayEvent フラグが true に設定されている場合、この項目はバージョン 12.0 以前で必須です。

この項目の値と StartDateTime が一致するか、いずれかが null である必要があります。

ActivityDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
IsAllDayEvent フラグが false に設定されている場合、行動の期日が含まれます。この項目の時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。表示ラベルは [期日 時間] です。

IsAllDayEvent フラグが false に設定されている場合、この項目はバージョン 12.0 以前で必須です。

この項目の値と StartDateTime が一致するか、いずれかが null である必要があります。

ClientGuid
string
プロパティ
Filter、Group、Nillable、Sort
説明
クライアントのグローバル一意識別子は、行動の作成に使用される外部 API クライアントを識別します。表示ラベルは [クライアント GUID] です。
CurrencyIsoCode
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
複数の currency 機能を有効化している組織にのみ使用できます。組織で使用できる currency の ISO コードが指定されています。
DeclinedEventInviteeIds
JunctionIdLIst
プロパティ
Create、Update
説明
この行動を拒否した取引先責任者、リード、またはユーザの ID の文字列配列。この JunctionIdList は、DeclinedEventRelation 子リレーションにリンクしています。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

警告

Description
textarea
プロパティ
Create、Nillable、Update
説明
行動のテキストによる説明が含まれます。最大 32,000 文字です。
Division
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
組織のデータの論理セグメントです。たとえば、会社がさまざまな事業単位によって構成されている場合、「北米」、「ヘルスケア」、「コンサルティグ」など、各事業単位のディビジョンを作成することができます。組織でディビジョン権限が有効化されている場合にのみ使用可能です。
DurationInMinutes
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動の長さ (分) が含まれます。時間を表す値ですが、Date/Time 型ではなく integer 型です。

IsAllDayEvent が false の場合、バージョン 12.0 以前では必須。

バージョン 13.0 以降の場合、次の条件によって指定可能なものや省略可能なものが変わります。
  • IsAllDayEvent が true の場合、DurationInMinutes または EndDateTime のいずれかに値を指定できます。指定した値が同じ時間になる場合は、両方の項目に値を指定できます。両方の項目が null の場合、時間はデフォルトの 1 日になります。
  • IsAllDayEvent が false の場合、DurationInMinutes または EndDateTime のいずれかの値にする必要があります。指定した値が同じ時間になる場合は、両方の項目に値を指定できます。

複数日の行動機能が有効な場合、API バージョン 13.0 以降では、DurationInMinutes 項目の 1440 を超える値をサポートします。API バージョン 12.0 以前では、DurationInMinutes が 1440 を超える行動オブジェクトにはアクセスできません。詳細は、「複数日の行動」を参照してください。

使用している API バージョンによって、DurationInMinutes 項目および EndDateTime 項目に関するエラーの表示場所が異なる場合があります。
  • バージョン 38.0 以前 — エラーは常に DurationInMinutes 項目に表示されます。
  • バージョン 39.0 以降 — DurationInMinutes 項目に値がない場合、エラーは EndDateTime 項目に表示されます。値がある場合は DurationInMinutes 項目に表示されます。
EndDate
date
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。バージョン 46.0 以降で使用できます。この項目では、EndDateTime 項目に表示される日付値が提供されます。この項目には、協定世界時 (UTC) タイムゾーンの午前 0 時に常に設定されている日付項目があります。
EndDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
バージョン 13.0 以降で使用できます。この項目の時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。

この項目は、次の条件によって指定可能なものや省略可能なものが変わります。

  • IsAllDayEvent が true の場合、DurationInMinutes または EndDateTime のいずれかに値を指定できます。指定した値が同じ時間になる場合は、両方の項目に値を指定できます。両方の項目が null の場合、時間はデフォルトの 1 日になります。
  • IsAllDayEvent が false の場合、DurationInMinutes または EndDateTime のいずれかの値にする必要があります。指定した値が同じ時間になる場合は、両方の項目に値を指定できます。
使用している API バージョンによって、DurationInMinutes 項目および EndDateTime 項目に関するエラーの表示場所が異なる場合があります。
  • バージョン 38.0 以前 — エラーは常に DurationInMinutes 項目に表示されます。
  • バージョン 39.0 以降 — DurationInMinutes 項目に値がない場合、エラーは EndDateTime 項目に表示されます。値がある場合は DurationInMinutes 項目に表示されます。
EventSubtype
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort
説明
標準のサブタイプを提供して、行動の作成および検索を容易にします。この項目は更新できません。
EventWhoIds
JunctionIdList
プロパティ
Create、Update
説明
共有行動による多対多リレーションの作成に使用された取引先責任者またはリードの ID の文字列配列。EventWhoIds は、Shared Activities 設定が有効な場合に使用できます。主 WhoId が指定されていないと、リスト内の最初の取引先責任者またはリード ID が主 WhoId になります。EventWhoIds 項目を null に設定すると、リスト内のすべてのエントリが削除され、WhoId の値が最初のエントリとして追加されます。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

警告

GroupEventType
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
参照のみ。API バージョン 19.0 以降で使用できます。
値は次のとおりです。
  • 0 (グループでない行動) — 招待者がない行動。
  • 1 (グループの行動) — 招待者がある行動。
  • 2 (提案済み行動) — Salesforce ユーザインターフェースを使用して取引先責任者、リード、または個人取引先とのミーティングを要請する場合に作成される行動。ユーザがミーティングを確認すると、提案済み行動はグループの行動になります。API では提案済み行動を作成、編集または削除することはできません。この値は、API バージョン 41.0 以降では使用できなくなりました。
  • 3 (IsRecurrence2 の定期的な行動パターン) — Lightning Experience での一連のイベントの繰り返しパターンを表す行動。
IsAllDayEvent
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
ActivityDate 項目 (true) または ActivityDateTime 項目 (false) のどちらを使用して、行動の日付/時間を定義するかを示します。表示ラベルは [終日の行動] です。DurationInMinutesEndDateTimeも参照してください。
IsArchived
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
行動がアーカイブされたかどうかを示します。
IsChild
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
行動が別の行動の子 (下位行動) であるか (true)、否か (false) を示します。
下位行動では、IsReminderSet および ReminderDateTime のみを更新できます。下位行動をクエリおよび削除することができます。下位行動に関連するオブジェクトが親行動に関連するオブジェクトと異なる場合 (この違いは、API バージョン 25.0 以前を使用している場合に発生する可能性がある)、下位行動に関連するいずれかのオブジェクトが削除されると、データの整合性を確保するために親行動に関連するオブジェクトが更新されます。
IsClientManaged
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
外部クライアントによって行動が管理されているかどうかを示します。この項目の値が false の場合、行動は外部クライアントによって所有または管理されておらず、Salesforce を使用して更新できます。値が true の場合、Salesforce で変更できる行動の項目は、重要性の低い項目のみになります。表示ラベルは [はクライアントが管理] です。
IsGroupEvent
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
行動がグループ行動かどうか、つまり行動に招待者が含まれているか (true)、否か (false) を示します。
IsPrivate
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
行動の作成者以外のユーザが、行動を作成したユーザのカレンダーを表示した場合に、行動の詳細を表示できるか (false)、否か (true) を示します。なお、「すべてのデータの参照」または「すべてのデータの編集」権限を持つユーザは、レポートや検索、または他のユーザのカレンダーを参照したときに、非公開の行動を参照できます。非公開の行動を、商談、取引先、ケース、キャンペーン、契約、リードまたは取引先責任者に関連付けることはできません。表示ラベルは [非公開] です。
IsRecurrence
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort
説明
Salesforce Classic の行動が繰り返すようスケジュール指定されているか (true)、1 回だけ実行するか (false) を示します。この項目は、レコード作成時ではなく、レコード更新時に参照のみとなります。この項目の値が true である場合、RecurrenceEndDateOnlyRecurrenceStartDateTimeRecurrenceType、��よび指定された繰り返しタイプが関連付けられている繰り返しの項目には必ず値を入力します。表示ラベルは [定期的な行動を作成] です。
IsRecurrence2
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
参照のみ。この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の行動が繰り返すようスケジュール指定されているか (true)、1 回だけ実行するか (false) を示します。この項目の値が true である場合、Recurrence2PatternTextRecurrence2PatternVersion に値を入力する必要があります。表示ラベルは [繰り返し] です。
IsRecurrence2Exception
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
参照のみ。この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の一連の行動のうち、1 つの行動に残りの行動とな異なる繰り返しパターンがあり、例外となるかどうかを示します。
IsRecurrence2Exclusion
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
参照のみ。この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の一連の行動の繰り返しパターンが更新されたが、影響があるのは将来の行動のみであるかどうかを示します。過去に発生した行動の場合、IsRecurrence2Exclusiontrue に設定され、一連の繰り返しパターンから過去の行動が除外されます。
IsReminderSet
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
活動がアラームであるか (true)、否か (false) を示します。
IsVisibleInSelfService
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
オブジェクトに関連付けられた行動をカスタマーポータルで参照できるか (true)、否か (false) を示します。組織でデジタルエクスペリエンスが有効な場合、IsVisibleInSelfService とマークされた行動は、行動が作成されたレコードへのアクセス権を持つ Experience Cloud サイト内の外部ユーザに表示されます。この項目を使用できるのは、次の場合です。
  • カスタマーポータルまたはパートナーポータルが有効である
または
  • デジタルエクスペリエンスが有効になっており、カスタマーポータルまたはパートナーポータルのライセンスを所有している
Location
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動の場所が含まれます。
OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
行動を所有する公開カレンダーの ID が含まれます。表示ラベルは [割当先 ID] です。
これは多態的なリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
Calendar、User
Recurrence2PatternStartDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
参照のみ。この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の一連の行動が開始する日時を示します。この項目の時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。
Recurrence2PatternText
textarea
プロパティ
Create、Nillable
説明
Lightning Experience の一連の行動の繰り返しパターンを示す RRULE。インターネットカレンダーおよびスケジュールのための RFC 5545 標準のサブセットをサポートします。使用例については、このトピックの「一連の行動」セクションを参照してください。この項目には、最大で 512 文字を含めることができます。

この項目は、API バージョン 44.0 以降で使用できます。また、API バージョン 52.0 以降では、この項目に Create プロパティがあります。

Recurrence2PatternTimeZone
string
プロパティ
Filter、Group、Nillable、Sort
説明
この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の一連の行動が作成または更新されたタイムゾーンを示します。この項目では標準の Java TimeZone ID が使用されます。たとえば、America/Los_Angeles です。
Recurrence2PatternVersion
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
参照のみ。この項目は API バージョン 44.0 以降で使用できます。Lightning Experience の一連の行動の繰り返しパターンの標準仕様を示します。有効値は 1 (RFC 5545 v4 RRULE) のみです。RFC 5545 はインターネットカレンダーおよびスケジュールの標準仕様セットで、IsRecurrence2 は一連の行動の繰り返しパターンについて準拠しています。一連の行動の繰り返しパターンの RFC 5545 仕様は RRULES と呼ばれます。rrule の使用例については、このトピックの「一連の行動」セクションを参照してください。
RecurrenceActivityId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。create には必須ではありません。Salesforce Classic の定期的な行動の主レコードの ID が含まれます。後続の行動には、この項目の同じ値が指定されます。
RecurrenceDayOfMonth
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動を繰り返す日付を示します。
RecurrenceDayOfWeekMask
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
Salesforce Classic の定期的な行動が繰り返される曜日 (複数可) を示します。この項目にはビットマスクが指定されます。値は次のようになります。
  • 日曜日 = 1
  • 月曜日 = 2
  • 火曜日 = 4
  • 水曜日 = 8
  • 木曜日 = 16
  • 金曜日 = 32
  • 土曜日 = 64
複数の日付は、それらの値の合計で示されます。たとえば、火曜日と木曜日 = 4 + 16 = 20 です。
RecurrenceEndDateOnly
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動を繰り返した最終日を示します。複数の日にわたる Salesforce Classic の定期的な行動の場合、これは最後の行動が開始した日付です。この項目には、協定世界時 (UTC) タイムゾーンの午前 0 時に常に設定されている日付項目があります。タイムゾーンの違いを考慮してタイムスタンプを変更しないでください。
RecurrenceInstance
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
Salesforce Classic の行動の繰り返し頻度を示します。たとえば、2nd または 3rd です。
RecurrenceInterval
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
Salesforce Classic の定期的な行動間の間隔を示します。
RecurrenceMonthOfYear
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
Salesforce Classic の定期的な行動を繰り返す月を示します。
RecurrenceStartDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
Salesforce Classic の定期的な行動が開始する日時を示します。値は RecurrenceEndDateOnly よりも前の日時にする必要があります。この項目の時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。
RecurrenceTimeZoneSidKey
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
Salesforce Classic の定期的な行動に関連付けられたタイムゾーンを示します。たとえば、太平洋標準時の「UTC-8:00」です。
RecurrenceType
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
Salesforce Classic の行動を繰り返す頻度を示します。たとえば、毎日、毎週、または n か月ごと (「n か月」は RecurrenceInstance で指定) です。
ReminderDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
IsReminderSettrue に設定されている場合、アラームが起動するよう指定されている時間を表します。IsReminderSetfalse に設定されている場合、Salesforce ユーザインターフェースのアラームチェックボックスの選択が解除されているか、またはその値が示す時間にはすでにアラームが起動しています。
ShowAs
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
別のユーザがカレンダーを参照した場合にこの行動がどのように表示されるか (予定あり、外出中、空き時間など) を示します。表示ラベルは [予定の公開方法] です。
StartDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
行動の開始日時を示します。バージョン 13.0 以降で使用できます。

行動の IsAllDayEvent フラグが true (終日の行動であることを示す) に設定されると、行動の開始日に関する情報が、StartDateTime 項目で指定されます。この項目の時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。

行動の IsAllDayEvent フラグが false に設定されると (終日の行動でないことを示す) 行動の開始日に関する情報が、StartDateTime 項目で指定されます。時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換する必要があります。

この項目に値が指定されている場合、ActivityDate および ActivityDateTime のいずれかが null であるか、この項目の値と一致する必要があります。

Subject
combobox
プロパティ
Create、Filter、Nillable、Sort、Update
説明
「電話」、「メール」、または「会議」など、行動の件名行。最大 255 文字です。
Type
picklist
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
電話、メール、またはミーティングなど、行動の種別を示します。
UndecidedEventInviteeIds
JunctionIdList
プロパティ
Create、Update
説明
この行動に関して未定の取引先責任者、リード、またはユーザの ID の文字列配列。この JunctionIdList は、UndecidedEventRelation 子リレーションにリンクしています。

JunctionIdList 項目名を fieldsToNull プロパティに追加すると、関連するすべての連結レコードが削除されます。このアクションは元に戻すことができません。

警告

WhatCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
組織で Shared Activities が有効化されている場合に使用できます。WhatId に関する関連 EventRelation の件数を示します。WhatId の件数は、1 以下である必要があります。
WhatId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
WhatId は、取引先、商談、キャンペーン、ケース、カスタムオブジェクトなど、人以外のオブジェクトを表します。WhatId は、多態的です。多態的とは、WhatId が関連オブジェクトの ID に相当することを意味します。表示ラベルは [関連先 ID] です。
これは多態的なリレーション項目です。
リレーション名
What
リレーション種別
Lookup
参照先
Account、Accreditation、AssessmentIndicatorDefinition、AssessmentTask、AssessmentTaskContentDocument、AssessmentTaskDefinition、AssessmentTaskOrder、Asset、AssetRelationship、AssignedResource、Award、BoardCertification、BusinessLicense、BusinessMilestone、BusinessProfile、Campaign、CareBarrier、CareBarrierDeterminant、CareBarrierType、CareDeterminant、CareDeterminantType、CareDiagnosis、CareInterventionType、CareMetricTarget、CareObservation、CareObservationComponent、CarePgmProvHealthcareProvider、CarePreauth、CarePreauthItem、CareProgram、CareProgramCampaign、CareProgramEligibilityRule、CareProgramEnrollee、CareProgramEnrolleeProduct、CareProgramEnrollmentCard、CareProgramGoal、CareProgramProduct、CareProgramProvider、CareProgramTeamMember、CareProviderAdverseAction、CareProviderFacilitySpecialty、CareProviderSearchableField、CareRegisteredDevice、CareRequest、CareRequestDrug、CareRequestExtension、CareRequestItem、CareSpecialty、CareSpecialtyTaxonomy、CareTaxonomy、Case、CommSubscriptionConsent、ContactEncounter、ContactEncounterParticipant、ContactRequest、Contract、CoverageBenefit、CoverageBenefitItem、CreditMemo、DelegatedAccount、DocumentChecklistItem、EnrollmentEligibilityCriteria、HealthcareFacility、HealthcareFacilityNetwork、HealthcarePayerNetwork、HealthcarePractitionerFacility、HealthcareProvider、HealthcareProviderNpi、HealthcareProviderSpecialty、HealthcareProviderTaxonomy、IdentityDocument、Image、IndividualApplication、Invoice、ListEmail、Location、MemberPlan、Opportunity、Order、OtherComponentTask、PartyConsent、PersonLifeEvent、PlanBenefit、PlanBenefitItem、ProcessException、Product2、ProductItem、ProductRequest、ProductRequestLineItem、ProductTransfer、PurchaserPlan、ReceivedDocument、ResourceAbsence、ReturnOrder、ReturnOrderLineItem、ServiceAppointment、ServiceResource、Shift、Shipment、ShipmentItem、Solution、Visit、VisitedParty、VolunteerProject、WorkOrder、WorkOrderLineItem
WhoCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
Shared Activities が有効化されている組織で使用できます。WhoId に関する関連 EventRelation の件数を示します。
WhoId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
WhoId は、リードや取引先責任者など、人を表します。WhoId は、多態的です。多態的とは、WhoId が取引先責任者の ID やリードの ID に相当するという意味です。表示ラベルは [名前 ID] です。

Shared Activities が有効な場合、この項目の値は関連するリードまたは主取引先責任者の ID になります。WhoId 項目を追加、更新、または削除した場合、このレコードに関連付けられたトリガ、ワークフロー、およびデータ入力規則で問題が発生する可能性があります。表示ラベルは [名前 ID] です。

JunctionIdList 項目が使用されている場合、リレーションリストにすべての WhoId が含まれます。

API バージョン 37.0 以降、WhoId 項目の取引先責任者またはリード ID が EventWhoIds リストにない場合、エラーは発生せず、EventWhoIds に ID が主 WhoId として追加されます。WhoId が null に設定されている場合、既存の EventWhoIds リスト内のいずれかの ID が最初の位置に移動されます。

これは多態的なリレーション項目です。
リレーション名
Who
リレーション種別
Lookup
参照先
Contact、Lead

使用方法

Event を使用して、カレンダーの予定を管理します。

行動のクエリと絞り込み

行動に関するクエリは、大きすぎるデータを使用する場合、タイムアウトする前に拒否されます。そのような場合、例外コード OPERATION_TOO_LARGE が返されます。OPERATION_TOO_LARGE を受け取った場合、より少量のデータをスキャンするか、クエリを再構成します。

特定の期日を持つ行動にクエリを実行する場合、ActivityDateTimeand 項目および ActivityDate 項目を絞り込む必要があります。たとえば、期日が 2003 年 2 月 14 日の場合、次の 2 つの条件が必要です。
  • 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 (またはその逆) に変更することはできません。
  • IsRecurrencetrue に設定されている行動で IsRecurrence2 に関連付けられた項目は設定できません (その逆もできません)。
  • Lightning Experience の一連の行動で IsRecurrence2true の場合、1 つまたは残りすべての行動を削除するには、REST API コールを使用します。Salesforce Classic の定期的な行動で IsRecurrencetrue の場合、API で定期的な行動を削除すると、過去と将来の一連の行動がすべて削除されます。ただし、ユーザインターフェースで定期的な行動を削除すると、将来の行動だけが削除されます。
  • Salesforce Classic の定期的な行動を作成する場合、行動の時間は 24 時間以下である必要があります。Salesforce Classic の定期的な行動を作成すると、複数日の行動が有効な場合は、個々の行動時間を 24 時間以上に延長できます。詳細は、「複数日の行動」を参照してください。
  • Salesforce Classic の定期的な行動の場合、RecurrenceStartDateTimeRecurrenceEndDateOnly, 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 の一連の行動と定期的な行動

Lightning Experience の一連の行動の繰り返しパターンを指定するには、Recurrence2PatternText 項目を使用します。参照ルールまたは「RRULES」と呼ばれるこれらの繰り返しパターンでは、RFC 5545 標準のサブセットがサポートされます。次の表には一般的な RRULE の例が含まれます。
繰り返しパターン 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 は、必要な形式に従うように変更されることがあります。
  • RRULE 部分は、FREQ、BYMONTH、BYMONTHDAY、BYDAY、WKST、BYSETPOS、INTERVAL、UNTIL、COUNT の順所で配置されます。
  • 欠落しているデフォルト値がある場合は、挿入されます。たとえば、RRULE に INTERVAL が含まれていない場合は、INTERVAL=1 が追加されます。
  • RRULE の先頭に RRULE: が指定されていない場合は、RRULE: が指定されます。
RRULE 部分 サポートされる RFC 5545 実装
FREQ 必須。繰り返しルールの種別を示します。有効な値は、次のとおりです。
  • DAILY — サポートされる部分には、FREQ、INTERVAL、UNTIL、COUNT があります。
  • WEEKLY — サポートされる部分には、INTERVAL、UNTIL、COUNT、BYDAY、WKST があります。BYDAY は必須ですが、前に数値を指定することはできません。

    たとえば、2023 年 9 月 1 日まで毎週火曜日と木曜日に示すには、RRULE:FREQ=WEEKLY;UNTIL=20230901T000000Z;BYDAY=TU,TH を使用します。

  • MONTHLY — サポートされるパターンは次のとおりです。
    • BYMONTHDAY

      たとえば、毎月 3 日に示すには、RRULE:FREQ=MONTHLY;BYMONTHDAY=3 を使用します。

    • BYDAY および BYSETPOS

      たとえば、月の最後の週末を示すには、RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1 を使用します。

    • BYDAY。BYDAY の値は、数値で指定します。

      たとえば、毎月第 1 金曜日に 10 回示すには、RRULE:FREQ=MONTHLY;COUNT=10;BYDAY=1FR を使用します。

  • YEARLY — サポートされるパターンは次のとおりです。
    • BYMONTH、BYDAY、BYSETPOS

      たとえば、毎年 1 月の第 2 金曜日に示すには、RRULE:FREQ=YEARLY;BYMONTH=1;BYDAY=FR;BYSETPOS=2 を使用します。

    • BYMONTH および BYMONTHDAY

      たとえば、毎年 10 月 31 日に示すには、RRULE:FREQ=YEARLY;BYMONTH=10;BYMONTHDAY=31 を使用します。

      たとえば、5 月と 9 月に 7 日と 15 日の 2 回、6 月、7 月、8 月に 1 日の 1 回のメンテナンスパターンを作成するには、2 つの RRULE を使用します: RRULE: FREQ=MONTHLY; BYMONTH=5,9; BYMONTHDAY=7, 15 RRULE:FREQ=MONTHLY; BYMONTH=6,7,8; BYMONTHDAY=1

BYMONTH 月。有効な値は 112 です。
BYMONTHDAY 日付。有効な値は 131 です。BYMONTHDAY が 31 で月の日数が 31 より少ない場合は、月の最終日に行動が作成されます。
BYDAY 曜日のカンマ区切りのリスト。有効な値は、SUMOTUWETHFRSA です。RRULES の頻度が毎年または毎月の場合、BYDAY は次のいずれかにする必要があります。
  • 1 日
  • 週末
  • 平日
  • 毎日

毎月または毎年の RRULE 内で、各 BYDAY 値の前には、特定の曜日の n 番目の発生を示す整数を指定できます。使用できる値は、-11234 です。BYDAY 値に異なる数値を使用することはできません。たとえば、次の RRULE はサポートされませんRRULE:FREQ=MONTHLY;INTERVAL=2;COUNT=10;BYDAY=1SU,-1SU BYDAY 値の前に数値が指定されている場合、RRULE に BYSETPOS を含めることはできません。

WKST 1 週間の勤務日数が始まる曜日を指定します。有効な値は、MOTUWETHFRSASU です。デフォルト値は、ユーザのロケールに基づいて設定されます。
BYSETPOS ルールで指定された一連の繰り返しインスタンス内の n 番目の発生に対応する値をカンマで区切ったリスト。有効な値は、-1123、または 4 です。デフォルト値は 1 です。

たとえば、月の最後の週末を示すには、RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1 を使用します。

INTERVAL 繰り返し間隔。有効な値は、次のとおりです。
  • FREQ=DAILY の場合は、1999 の間の整数
  • FREQ=WEEKLY または FREQ=MONTHLY の場合は、199 の間の整数
  • FREQ=YEARLY の場合は、1
デフォルト値は 1 です。
UNTIL 繰り返しルールが停止する日時を UTC 形式で指定します。サポートされる形式は、yyyyMMddTHHmmssZ です。たとえば、20210419T083000Z のように指定します。

RRULE に UNTIL と COUNT の両方を含めることはできません。UNTIL または COUNT のいずれも指定されていない定期的な行動は、無期限に繰り返されます。

COUNT 出現数。使用できる値は 1 ~ 999 です。

RRULE に UNTIL と COUNT の両方を含めることはできません。UNTIL または COUNT のいずれも指定されていない定期的な行動は、無期限に繰り返されます。

BYWEEKNO 年間の週を示す値のリストのカンマ区切りリストを指定します。有効な値は、次のとおりです。
  • 153
  • -53-1

たとえば、年間の特定の週を示すには、次のようにします: RRULE: BYWEEKNO=20, -20

このルールパートは、FREQ ルールパートが YEARLY 以外に設定されている場合は使用できません。たとえば、3 は年内の 3 番目の週を表します。

注意: 月曜日から週を開始する場合は、53 週目が発生するのは 1 月 1 日が木曜日の場合か、うるう年で 1 月 1 日が水曜日の場合のみです。

BYYEARDAY 年間の日付を指す値のカンマ区切りリストを指定します。有効な値は、次のとおりです。
  • 1366
  • -366-1

たとえば、年間の特定の日付を示すには、次のようにします: 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

JunctionIdList を使用して行動を作成するため、関連取引先責任者から ID が取得され、行動と EventRelation レコードの両方が 1 つの API コールで作成されます。すべての処理が 1 回の API コールで行われるため、EventRelation に失敗した場合は、行動がロールバックされます。
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}

Lightning Sync による行動の同期

被招集者の状況 (「参加または未定」、「不参加」、または「無回答」) は Microsoft® Exchange または Google から Salesforce に同期されますが、Salesforce から Exchange または Google には同期されません。双方向に同期するように設定されたユーザの場合、Salesforce で被招集者の状況を更新する API フローの作成には注意してください。最終的に、Salesforce で加えられた更新は Exchange または Google の元の状況で上書きされます。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

EventChangeEvent (API バージョン 44.0)
このオブジェクトには変更イベントを利用できます。
EventFeed (API バージョン 20.0)
このオブジェクトにはフィード追跡を利用できます。