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

PlatformEventSettings

プラットフォームイベントと変更データキャプチャイベントの設定を表します。

親種別およびマニフェストアクセス

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

パッケージマニフェストでは、「Settings」の名前を使用して組織のすべての設定メタデータ型にアクセスします。詳細は「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所

PlatformEventSettings の値は、settings フォルダの PlatformEvent.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

PlatformEventSettings コンポーネントは、API バージョン 58.0 以降で使用できます。

特別なアクセスルール

この種別に固有のアクセス要件は他にありません。

項目

項目名 説明
enableEnhancedUsageMetrics
項目の型
boolean
説明
PlatformEventUsageMetric に対して実行されるクエリで、拡張された利用状況総計値を有効にします。拡張された利用状況総計値では、クエリと詳細な時間区分の項目が追加で提供されます。詳細は、『プラットフォームイベント開発者ガイド』「拡張された利用状況総計値」を参照してください。デフォルト値は false です。

宣言的なメタデータの定義のサンプル

拡張された利用状況総計値機能を有効にする PlatformEventSettings コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableEnhancedUsageMetrics>true</enableEnhancedUsageMetrics>
4</PlatformEventSettings>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>PlatformEvent</members>
5        <name>Settings</name>
6    </types>
7    <version>58.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。