プラットフォームイベント開発者ガイド
jメタデータ API によるプラットフォームイベント定義の移行
アプリケーションの開発ライフサイクルの一環として Sandbox 組織および本番組織からプラットフォームイベント定義をリリースおよび取得します。
CustomObject メタデータ型はプラットフォームイベントを表します。
プラットフォームイベント名には __e が追加されます。プラットフォームイベント定義が含まれるファイルにはサフィックス .object があります。プラットフォームイベントは objects フォルダに保存されます。
例
1 つの数値項目と 2 つのテキスト項目を使用するプラットフォームイベントの定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <deploymentStatus>Deployed</deploymentStatus>
4 <eventType>HighVolume</eventType>
5 <publishBehavior>PublishAfterCommit</publishBehavior>
6 <fields>
7 <fullName>Ink_Percentage__c</fullName>
8 <externalId>false</externalId>
9 <isFilteringDisabled>false</isFilteringDisabled>
10 <isNameField>false</isNameField>
11 <isSortingDisabled>false</isSortingDisabled>
12 <label>Ink Percentage</label>
13 <precision>18</precision>
14 <required>false</required>
15 <scale>2</scale>
16 <type>Number</type>
17 <unique>false</unique>
18 </fields>
19 <fields>
20 <fullName>Printer_Model__c</fullName>
21 <externalId>false</externalId>
22 <isFilteringDisabled>false</isFilteringDisabled>
23 <isNameField>false</isNameField>
24 <isSortingDisabled>false</isSortingDisabled>
25 <label>Printer Model</label>
26 <length>20</length>
27 <required>false</required>
28 <type>Text</type>
29 <unique>false</unique>
30 </fields>
31 <fields>
32 <fullName>Serial_Number__c</fullName>
33 <externalId>false</externalId>
34 <isFilteringDisabled>false</isFilteringDisabled>
35 <isNameField>false</isNameField>
36 <isSortingDisabled>false</isSortingDisabled>
37 <label>Serial Number</label>
38 <length>20</length>
39 <required>false</required>
40 <type>Text</type>
41 <unique>false</unique>
42 </fields>
43 <label>Low Ink</label>
44 <pluralLabel>Low Ink</pluralLabel>
45</CustomObject>eventType 項目は、プラットフォームイベントの量を指定します。HighVolume 値のみがサポートされています。StandardVolume 値は廃止されています。StandardVolume イベント種別でプラットフォームイベントを作成した場合、エラーが表示されます。
この package.xml マニフェストファイルは、以前のイベント定義を参照します。参照先のイベントの名前は Low_Ink__e です。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Low_Ink__e</members>
5 <name>CustomObject</name>
6 </types>
7 <version>57.0</version>
8</Package>プラットフォームイベントの取得
組織で定義したカスタムオブジェクトに加えて、すべてのプラットフォームイベントを取得するには、次のように <members> 要素でワイルドカード文字 (*) を使用します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>CustomObject</name>
6 </types>
7 <version>57.0</version>
8</Package>プラットフォームイベントに関連付けられたトリガを取得またはリリースするには、ApexTrigger メタデータ型を使用します。メタデータ API とその型の使用方法の詳細は、『メタデータ API 開発者ガイド』を参照してください。