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

Event

カレンダーの行動を表します。ユーザインターフェースで、行動と ToDo レコードは活動として集合的に参照されます。
  • EventRelation オブジェクトは、下位行動に関連付けることはできません。また、下位行動には [招待者] 関連リストは含まれません。
  • API バージョン 25.0 以前では、複数の取引先責任者に関連する行動で、query()delete()、および update() は許可されません。

メモ

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

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 項目の値が Contact オブジェクトである場合、Salesforce はその取引先責任者の AccountId を使用します。組織で Shared Activities を使用する場合は、Salesforce は主取引先責任者の AccountId を使用します。

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

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

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 項目に表示されます。
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 になります。

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

警告

GroupEventType
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
参照のみ。API バージョン 19.0 以降で使用できます。
値は次のとおりです。
  • 0 (グループでな��行動) – 招待者がない行動。
  • 1 (グループの行動) — 招待者がある行動。
  • 2 (提案済み行動) — Salesforce ユーザインターフェースを使用して取引先責任者、リード、または個人取引先とのミーティングを要請する場合に作成される行動。ユーザがミーティングを確認すると、提案済み行動はグループの行動になります。API では提案済み行動を作成、編集または削除することはできません。

詳細は、Salesforce ヘルプの「Salesforce Classic での Cloud Scheduler のしくみ」を参照してください。

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
説明
行動が繰り返すようスケジュール指定されているか (true)、1 回だけ実行するか (false) を示します。これは、レコード作成時ではなく、更新時の参照のみの項目です。この項目の値が true である場合、RecurrenceEndDateOnlyRecurrenceStartDateTimeRecurrenceType、および指定された繰り返しタイプが関連付けられている繰り返しの項目には必ず値を入力します。表示ラベルは [定期的な行動を作成] です。
IsReminderSet
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
活動がアラームであるか (true)、否か (false) を示します。
IsVisibleInSelfService
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
オブジェクトに関連付けられた行動をカスタマーポータルで参照できるか (true)、否か (false) を示します。

組織でコミュニティが有効な場合、IsVisibleInSelfService とマークされた行動は、行動が作成されたレコードへのアクセス権を持つコミュニティ内の外部ユーザに表示されます。

この項目は、カスタマーポータルまたはパートナーポータルが有効になっているか、コミュニティが有効になっていて、カスタマーポータルまたはパートナーポータルライセンスを所有している場合に使用できます。

Location
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動の場所が含まれます。
OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
行動を所有するユーザの ID が含まれます。表示ラベルは [所有者 ID] です。
RecurrenceActivityId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
参照のみ。create には必須ではありません。定期的な行動の主要なレコードの ID が含まれます。後続の行動には、この項目の同じ値が指定されます。
RecurrenceDayOfMonth
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動を繰り返す日付を示します。
RecurrenceDayOfWeekMask
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動を繰り返す曜日を示します。この項目にはビットマスクが指定されます。値は次のようになります。
  • 日曜日 = 1
  • 月曜日 = 2
  • 火曜日 = 4
  • 水曜日 = 8
  • 木曜日 = 16
  • 金曜日 = 32
  • 土曜日 = 64
複数の日付は、それらの値の合計で示されます。たとえば、火曜日と木曜日 = 4 + 16 = 20 です。
RecurrenceEndDateOnly
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
行動を繰り返した最終日を示します。複数の日にわたる定期的な行動の場合、最後に行動が開始された日付となります。この項目には、協定世界時 (UTC) タイムゾーンの午前 0 時に常に設定されている日付項目があります。タイムゾーンの違いを考慮してタイムスタンプを変更しないでください。
RecurrenceInstance
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
行動の繰り返し頻度を示します。たとえば、2nd または 3rd です。
RecurrenceInterval
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
定期的な行動間の間隔を示します。
RecurrenceMonthOfYear
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
行動を繰り返す月を示します。
RecurrenceStartDateTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
定期的な行動が開始される日時を示します。値は RecurrenceEndDateOnly よりも前の日時にする必要があります。この項目は、関連する時間表示の通常の日付/時間項目です。時間の部分は、常に協定世界時 (UTC) に移行されます。必要に応じて、ユーザまたはアプリケーションのローカルタイムゾーンとの間で変換します。
RecurrenceTimeZoneSidKey
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
定期的な行動に関連付けられたタイムゾーンを示します。たとえば、太平洋標準時の「UTC-8:00」です。
RecurrenceType
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
行動を繰り返す頻度を示します。たとえば、毎日、毎週、または 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、Nillable、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] です。
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 が含まれます。

使用方法

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

行動のクエリと絞り込み

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

特定の期日を持つ行動にクエリを実行する場合、ActivityDateTime 項目および ActivityDate 項目を絞り込む必要があります。たとえば、期日が 2003 年 2 月 14 日の場合、次の 2 つの条件が必要です。
  • ActivityDate 項目が協定世界時 (UTC) タイムゾーンの 2003 年 2 月 14 日に等しい。
  • ActivityDateTime 項目がローカルタイムゾーンの 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 日を超えることができません。

定期的な行動

  • 定期的な行動はバージョン 7.0 以降で使用できます。
  • 行動が作成されると、定期的な行動から定期的でない行動に変更することはできません。その逆も同様です。
  • API を使用して定期的な行動を削除すると、過去および将来の行動がすべて削除されます。ただし、ユーザインターフェースで定期的な行動を削除しても、将来の行動だけが削除されます。
  • 定期的な行動を作成する場合、行動の時間は 24 時間以下である必要があります (DurationInMinutes の値または RecurrenceStartDateTimeEndDateTime の間が 24 時間を超えてはいけません)。定期的な行動を作成すると、複数日の行動が有効な場合は、個々の行動時間を 24 時間以上に延長できます。詳細は、複数日の行動を参照してください。
  • IsRecurrencetrue である場合、RecurrenceStartDateTimeRecurrenceEndDateOnlyRecurrenceType、および指定された定期的なタイプに関連付けられたプロパティ (次の表を参照) を入力する必要があります。
  • 定期的な行動を更新する際、定期的な行動オブジェクトの EventRelation と、個々の行動の EventRelation を同時に更新することはできません。

次の表には、定期的な ToDo で使用される項目が示されています。それぞれの繰り返しのタイプでは、すべてのプロパティが指定されている必要があります。未使用のプロパティはすべて 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 土曜日
JunctionIdList
JuncionIdList を使用して行動を作成するため、関連取引先責任者から 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}