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

PushTopic

組織のレコードへの変更をリスナーに通知するための基礎となるクエリを表します。これは、API バージョン 21.0 以降で使用できます。

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

REST: DELETE、GET、PATCH、POST (クエリ要求は URI で指定)

SOAP: create()delete()describe()describeSObjects()query()retrieve()update()

特別なアクセスルール

  • このオブジェクトは、組織でストリーミング API が有効になっている場合にのみ使用できます。
  • 「作成」権限を持つユーザのみがこのレコードを作成できます。

項目

項目 データ型 説明
ApiVersion double 必須。Query で指定されるクエリを実行するために使用する API バージョン。API バージョンは 20.0 以降である必要があります。クエリがパッケージからのカスタムオブジェクトに適用される場合、この値がパッケージの ApiVersion に一致する必要があります。

例の値: 40.0

項目プロパティ: CreateFilterSortUpdate

Description string PushTopic の説明。最大 400 文字です。

項目プロパティ: Create、Filter、Sort、Update

ID ID システム項目: レコードを識別するグローバルに一意の文字列。

項目プロパティ: Default on create、Filter、Group、idLookup、Sort

isActive boolean レコードが組織の上限に対して現在カウントされているかどうかを示す。

項目プロパティ: Create、Default on create、Filter、Group、Sort、Update

IsDeleted boolean システム項目: レコードがごみ箱に移動されたか (true)、否か (false) を示す。

項目プロパティ: Default on create、Filter、Group、Sort

Name string 必須。MyNewCasesTeamUpdatedContacts などの PushTopic の内容を説明する名前。最大 25 文字です。この値ではチャネルを特定します。値は一意である必要があります。

項目プロパティ: Create、Filter、Group、Sort、Update

NotifyForFields picklist 通知を生成するために評価される項目を指定します。
有効な値は次のとおりです。
  • All
  • Referenced (デフォルト)
  • Select
  • Where

項目プロパティ: Create、Filter、Sort、Update

NotifyForOperations picklist 通知を生成できるレコードイベントを指定します。
有効な値は次のとおりです。
  • All (デフォルト)
  • Create
  • Extended
  • Update

API バージョン 28.0 以前の項目プロパティ: Create、Filter、Sort、Update

API バージョン 29.0 以降の項目プロパティ: Filter、Sort

API バージョン 29.0 以降では、この項目は参照のみであり、イベントの削除および復元に関する情報は含まれません。通知を生成するレコードイベントを指定するには、NotifyForOperationCreateNotifyForOperationDeleteNotifyForOperationUndeleteNotifyForOperationUpdate を使用します。

Extended の値は、作成操作と更新操作のいずれもイベントを生成するように設定されていないことを示します。

NotifyForOperationCreate boolean 作成操作で通知を生成する場合は true、それ以外の場合は falseデフォルトは true です。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationDelete boolean 削除操作で通知を生成する場合は true、それ以外の場合は falseデフォルトは true です。削除および復元イベント通知を取得するには、クライアントは cometd/29.0 (またはそれ以降) の ストリーミング API エンドポイントを使用して接続する必要があります。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationUndelete boolean 復元操作で通知を生成する場合は true、それ以外の場合は falseデフォルトは true です。削除および復元イベント通知を取得するには、クライアントは cometd/29.0 (またはそれ以降) の ストリーミング API エンドポイントを使用して接続する必要があります。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationUpdate boolean 更新操作で通知を生成する場合は true、それ以外の場合は falseデフォルトは true です。この項目は、API バージョン 29.0 以降で使用できます。
Query string 必須。イベントのチャネルへの送信をトリガするレコードへの変更を特定する SOQL クエリステートメント。

最大 1,300 文字です。

項目プロパティ: Create、Filter、Sort、Update

PushTopic と通知

PushTopic は、いつチャネル内で通知を生成するかを定��します。これを指定するには、次の PushTopic 項目を設定します。