メタデータ 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>StandardVolume</eventType>
5 <fields>
6 <fullName>Ink_Percentage__c</fullName>
7 <externalId>false</externalId>
8 <isFilteringDisabled>false</isFilteringDisabled>
9 <isNameField>false</isNameField>
10 <isSortingDisabled>false</isSortingDisabled>
11 <label>Ink Percentage</label>
12 <precision>18</precision>
13 <required>false</required>
14 <scale>2</scale>
15 <type>Number</type>
16 <unique>false</unique>
17 </fields>
18 <fields>
19 <fullName>Printer_Model__c</fullName>
20 <externalId>false</externalId>
21 <isFilteringDisabled>false</isFilteringDisabled>
22 <isNameField>false</isNameField>
23 <isSortingDisabled>false</isSortingDisabled>
24 <label>Printer Model</label>
25 <length>20</length>
26 <required>false</required>
27 <type>Text</type>
28 <unique>false</unique>
29 </fields>
30 <fields>
31 <fullName>Serial_Number__c</fullName>
32 <externalId>false</externalId>
33 <isFilteringDisabled>false</isFilteringDisabled>
34 <isNameField>false</isNameField>
35 <isSortingDisabled>false</isSortingDisabled>
36 <label>Serial Number</label>
37 <length>20</length>
38 <required>false</required>
39 <type>Text</type>
40 <unique>false</unique>
41 </fields>
42 <label>Low Ink</label>
43 <pluralLabel>Low Ink</pluralLabel>
44</CustomObject>この 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>44.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>44.0</version>
8</Package>プラットフォームイベントに関連付けられたトリガを取得またはリリースするには、ApexTrigger メタデータ型を使用します。メタデータ API とその型の使用方法の詳細は、『Metadata API 開発者ガイド』を参照してください。