Salesforce プラットフォームのオブジェクトリファレンス
jStandardObjectNameChangeEvent
ChangeEvent オブジェクトは、変更データキャプチャをサポートする各オブジェクトで利用できます。変更データキャプチャを使用して変更イベントのストリームを登録し、Salesforce のレコードの変更に関連するデータを受け取ることができます。変更には、レコードの作成、既存のレコードの更新、レコードの削除、レコードの復元が含まれます。変更イベントは Salesforce オブジェクトではありません。このため CRUD 操作やクエリをサポートしていません。変更イベントは、オブジェクトリファレンスに含まれているため、どの Salesforce オブジェクトが変更イベントをサポートしているのかを確認できます。
サポートされているコール
describeSObjects()
特別なアクセスルール
- すべてのオブジェクトが組織で使用できるわけではありません。一部のオブジェクトでは、特定の機能の設定や権限が有効になっている必要があります。
- 特殊なアクセス権のルールが存在する場合には、標準オブジェクトのドキュメントを参照してください。たとえば、AccountChangeEvent の場合は、Account への特別なアクセスルールについて参照してください。
変更イベントのサポート
変更イベントは、すべてのカスタムオブジェクト、および標準オブジェクトのサブセットで使用できます。カスタム設定に対応する変更イベントは、部分的にサポートされています。Apex トリガーではサポートされていませんが、他のサブスクライバーの種別ではサポートされています。標準オブジェクトのサポートについての詳細は、以下の「変更イベントをサポートするオブジェクト」セクションを参照してください。
変更イベント名
変更イベントの名前は、変更を捉える対象オブジェクトの名前に基づきます。
- 標準オブジェクトの変更イベント名
-
- 例: AccountChangeEvent
- カスタムオブジェクトの変更イベント名
-
- 例: MyCustomObject__ChangeEvent
変更イベント項目
変更イベントに含めることができる項目は、いくつかの例外を除いて、関連する親の Salesforce オブジェクトの項目に対応しています。たとえば、AccountChangeEvent 項目は取引先についての項目に対応します。
変更イベントに含まれない項目は、次のとおりです。
- IsDeleted システム項目。
- SystemModStamp システム項目。
- 項目の値がレコードになく、その項目が他のレコードまたは数式から派生している場合は、変更イベントに含まれます (積み上げ集計項目を除く)。これには、数式項目があります。派生値を持つ項目の例としては、LastActivityDate や PhotoUrl などがあります。
各変更イベントにはヘッダー項目も含まれます。ヘッダー項目は ChangeEventHeader 項目の中に含まれます。ヘッダー項目には、変更が更新または削除のどちらであるかや、オブジェクトの名前 (取引先など) など、イベントに関する情報が含まれます。
イベントペイロードに加えて、イベントスキーマ ID が schema 項目に含まれています。また、イベント固有の項目である replayId も含まれており、これは過去のイベントを検索するために使用されます。
イベントメッセージの例
次の例は、新規取引先レコード作成のイベントメッセージを JSON 形式で表したものです。
API バージョンとスキーマ
変更イベントを登録すると、登録には最新の API バージョンが使用され、受信するイベントメッセージには最新の項目定義が反映されます。詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』の「API Version and Event Schema (API バージョンとイベントスキーマ)」を参照してください。
使用方法
変更データキャプチャについての詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』を参照してください。
変更イベントをサポートするオブジェクト
次のオブジェクトには、関連する ChangeEvent オブジェクトがあります。
- Account (個人取引先を含む)
- AccountContactRole
- ActionCadence
- ActionCadenceStep
- ActionCadenceStepTracker
- ActionCadenceTracker
- AdOrderLineAdTarget
- AdProductTargetCategory
- AdQuoteLineAdTarget
- AdTargetCategory
- AdTargetCategorySegment
- AppExtension
- Asset
- AssetWarranty
- AssignedResource
- AuthorizationFormConsent
- BriefcaseAssignment
- BriefcaseDefinition
- BroadcastTopicNetwork
- CallTemplate
- Campaign
- CampaignMember
- CampaignMemberStatus
- CartDeliveryGroup
- CartItem
- CartItemPriceAdjustment
- CartTax
- CartValidationOutput
- Case
- CaseRelatedIssue
- ChangeRequest
- ChangeRequestRelatedIssue
- ChangeRequestRelatedItem
- CommerceEntitlementBuyerGroup
- CommerceEntitlementPolicy
- CommerceEntitlementProduct
- CommSubscriptionConsent
- Contact
- ContentDocument
- ContentDocumentLink
- ContactPointAddress
- ContactPointConsent
- ContactPointEmail
- ContactPointPhone
- ContactPointTypeConsent
- ContentVersion
- Contract
- ContractLineItem
- EmailMessage
- EmailTemplate
- EngagementAttendee
- EngagementInteraction
- EngagementTopic
- Entitlement
- Event
- EventRelation
- Expense
- ExternalClientAppSettings
- FieldServiceMobileSettings
- FlowRecordVersion
- Health Cloud.一部のオブジェクトがサポートされています。『Salesforce Health Cloud Developer Guide (Salesforce Health Cloud 開発者ガイド)』の「StandardObjectNameChangeEvent」を参照してください。
- 障害関連項目
- Individual
- LandingPage
- Lead
- ListEmail
- LiveChatTranscript
- Location
- LoyaltyLedger。『Loyalty Management Developer Guide (ロイヤルティ管理開発者ガイド)』の「LoyaltyLedger」を参照してください。
- Macro
- MacroInstruction
- MaintenanceAsset
- MaintenancePlan
- MarketingForm
- MarketingLink
- 住宅ローンの申込人と申込対象。『Financial Services Cloud システム管理者ガイド』の「エクスペリエンスビルダーテンプレートの標準のコンポーネントおよびページでサポートされる住宅ローンオブジェクト」を参照してください。
- OperatingHours
- Opportunity
- OpportunityContactRole
- OpportunityLineItem
- OpportunitySplit
- Order
- OrderItem
- PartyConsent
- Pricebook2
- PricebookEntry
- ProblemIncident
- ProblemRelatedItem
- ProcessInstance
- ProcessInstanceStep
- Product2
- ProductConsumed
- ProductItem
- ProductMedia
- ProductRequest
- ProductRequestLineItem
- ProductTransfer
- 公共セクターソリューション一部のオブジェクトがサポートされています。『Public Sector Solutions Developer Guide (公共セクターソリューション開発者ガイド)』の「StandardObjectNameChangeEvent」を参照してください。
- QuickText
- Quote
- QuoteLineItem
- Recommendation
- RecordSetFilterCriteria
- RecordSetFilterCriteriaRule
- ResourceAbsence
- ResourcePreference
- ReturnOrder
- ReturnOrderLineItem
- ServiceAppointment
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServiceResource
- ServiceResourceCapacity
- ServiceResourceSkill
- ServiceReport
- ServiceReportLayout
- ServiceTerritory
- ServiceTerritoryLocation
- ServiceTerritoryMember
- Shift
- ShiftPattern
- ShiftPatternEntry
- Shipment
- SkillRequirement
- SocialPost
- TenantSecurityAlertRuleSelectedTenant
- TenantSecurityApiAnomaly
- TenantSecurityConnectedApp
- TenantSecurityCredentialStuffing
- TenantSecurityFeature
- TenantSecurityHealthCheckBaselineTrend
- TenantSecurityHealthCheckData
- TenantSecurityHealthCheckTrend
- TenantSecurityTenantInfo
- TenantSecurityLicense
- TenantSecurityLogin
- TenantSecurityLoginIpRangeTrend
- TenantSecurityMobilePolicyTrend
- TenantSecurityMonitorMetric
- TenantSecurityNotification
- TenantSecurityNotificationRule
- TenantSecurityPackage
- TenantSecurityPolicy
- TenantSecurityPolicyDeployment
- TenantSecurityPolicySelectedTenant
- TenantSecurityReportAnomaly
- TenantSecuritySessionHijacking
- TenantSecurityTransactionPolicyTrend
- TenantSecurityTrustedIpRangeTrend
- TenantSecurityUserAcitivity
- TenantSecurityUserPerm
- Territory2AlignmentLog
- TimeSheet
- TimeSheetEntry
- TimeSlot
- Task
- TaskRelation
- TransactionJournal。『Loyalty Management Developer Guide (ロイヤルティ管理開発者ガイド)』の「TransactionJournal」を参照してください。
- User (パートナーユーザーを含む)
- VideoCall
- VideoCallRecording
- VoiceCall
- VoiceCallRecording
- WarrantyTerm
- WebCart
- WebCartAdjustmentBasis
- WebCartAdjustmentGroup
- WebStore
- WebStoreBuyerGroup
- WorkOrder
- WorkOrderLineItem
- WorkType