RecordAggregationDefinition | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

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

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

RecordAggregationDefinition コンポーネントは .RecordAggregationDefinition のサフィックスを持ち、RecordAggregationDefinitions フォルダーに保存されます。

バージョン

RecordAggregationDefinition コンポーネントは、API バージョン 59.0 以降で利用できます。

特別なアクセスルール

RecordAggregationDefinition メタデータ型にアクセスするには、「レコード集計」権限セットライセンスと「レコード集計アクセス」権限が必要です。

項目

項目名	説明
aggregateFromObject	項目の型 string 説明必須。データの集計元オブジェクトの API 参照名。
aggregateToObject	項目の型 string 説明必須。データの集計先オブジェクトの API 参照名。
aggregationType	項目の型 RecordAggregationDefinitionAggregationType (string 型の列挙) 説明必須。データ集計のタイプ。有効な値は次のとおりです。 `Record`
batchProcessingDefinition	項目の型 string 説明あるレコードのデータを別のレコードで集計するデータ処理エンジン定義。
description	項目の型 string 説明このレコード集計定義の説明。
displayName	項目の型 string 説明必須。レコードページに表示されたレコード集計定義の名前。
recordAggregationObject	項目の型 RecordAggregationObject[] 説明レコード集計を結合する順序に含まれるレコード集計オブジェクトのリスト。
status	項目の型 RecordAggregationDefinitionStatus (string 型の列挙) 説明必須。このレコード集計定義の状況。値は次のとおりです。 `Active` `Draft` `Inactive`

RecordAggregationObject

レコード集計を結合する順序に含まれるオブジェクトを表します。

項目名	説明
associatedObject	項目の型 string 説明必須。このレコード集計オブジェクトに関連付けられているオブジェクトの API 参照名。
developerName	項目の型 string 説明レコード集計オブジェクトの API 参照名。アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
filterLogic	項目の型 string 説明このレコード集計オブジェクトに関連付けられたレコード集計オブジェクトフィルターが、関連付けられたオブジェクトのレコードに適用される論理順序。2 つ以上のレコード集計オブジェクト検索条件を定義したが、検索条件を適用するシーケンスを指定しなかった場合、検索条件は論理 AND 式を使用して適用されます。 API バージョン 60.0 以降で利用できます。
masterLabel	項目の型 string 説明必須。 RecordAggregationDefinition のわかりやすい名前であり、RecordAggregationDefinition の作成時に定義します。
recordAggregationJoinCondition	項目の型 RecordAggregationJoinCondition[] 説明このレコード集計オブジェクトに適用される結合条件のリスト。
recordAggregationObjectFilter	項目の型 RecordAggregationObjectFilter[] 説明このレコード集計オブジェクトのレコードに適用される検索条件のリスト。 API バージョン 60.0 以降で利用できます。

RecordAggregationJoinCondition

2 つのレコード集計オブジェクト間の結合における条件を表します。

項目名	説明
joinField	項目の型 string 説明必須。結合条件で使用される、レコード集計オブジェクトに関連付けられたオブジェクトの項目の API 参照名。
navigationSequenceNumber	項目の型 int 説明必須。データの集計先オブジェクトから、集計されるデータを含んだオブジェクトへの結合の順序において、この結合に対応する連番。
relatedJoinField	項目の型 string 説明必須。関連レコード集計オブジェクトに関連付けられた、結合条件で使用されるオブジェクトの項目の API 参照名。
relatedRecordAggregationObject	項目の型 string 説明必須。結合条件での 2 番目のレコード集計オブジェクト。
type	項目の型 RecordAggregationJoinConditionType (string 型の列挙) 説明必須。データの集計先オブジェクトから、集計されるデータを含んだオブジェクトへの結合パスにおける、このレコード集計結合のタイプ。有効な値は、次のとおりです。 `AggregateFrom` `AggregateTo` `Intermediate`

RecordAggregationObjectFilter

レコード集計を結合するシーケンスのオブジェクトのレコードに適用される検索条件を表します。API バージョン 60.0 以降で利用できます。

項目名	説明
associatedObjectField	項目の型 string 説明必須。関連付けられたオブジェクトの項目の API 名。オブジェクトのレコードを絞り込むために値が使用されます。関連付けられたオブジェクトは、レコード集計オブジェクトで指定されます。
operator	項目の型 RecordAggregationObjectFilterOperator (string 型の列挙) 説明必須。検索条件式で使用される演算子。値は次のとおりです。 `Contains` `Equals` `GreaterThan` `GreaterThanOrEquals` `In` `LessThan` `LessThanOrEquals` `NotEquals` `NotIn`
sequenceNumber	項目の型 int 説明必須。このレコード集計オブジェクト検索条件のシーケンス番号。
value	項目の型 string 説明必須。検索条件が関連付けられたオブジェクトのレコードに適用されるときに、指定項目の値が比較される参照値。

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

RecordAggregationDefinition コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<RecordAggregationDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <aggregateToObject>PartyRelationshipGroup</aggregateToObject>
4    <aggregateFromObject>PartyIncome</aggregateFromObject>
5    <status>Active</status>
6    <aggregationType>Record</aggregationType>
7    <description>Aggregate head of household's income to household</description>
8    <displayName>Party Income to Party Relationship Group</displayName>
9    <recordAggregationObject>
10        <associatedObject>PartyRelationshipGroup</associatedObject>
11        <masterLabel>Party Relationship Group Object</masterLabel>
12        <developerName>PartyRelationshipGroupObject</developerName>
13        <recordAggregationJoinCondition>
14            <joinField>Account</joinField>
15            <navigationSequenceNumber>1</navigationSequenceNumber>
16            <relatedJoinField>Account</relatedJoinField>
17            <relatedRecordAggregationObject>AccountContactrelationObject</relatedRecordAggregationObject>
18            <type>Intermediate</type>
19        </recordAggregationJoinCondition>
20        <recordAggregationObjectFilter>
21          <associatedObjectField>Type</associatedObjectField>
22          <operator>Equals</operator>
23          <value>Household</value>
24          <sequenceNumber>1</sequenceNumber>
25        </recordAggregationObjectFilter>
26    </recordAggregationObject>
27    <recordAggregationObject>
28        <associatedObject>AccountContactRelation</associatedObject>
29        <masterLabel>Account Contact Relation Object</masterLabel>
30        <developerName>AccountContactRelationObject</developerName>
31        <recordAggregationJoinCondition>
32            <joinField>Contact</joinField>
33            <navigationSequenceNumber>2</navigationSequenceNumber>
34            <relatedJoinField>Party</relatedJoinField>
35            <relatedRecordAggregationObject>PartyIncomeObject</relatedRecordAggregationObject>
36            <type>Intermediate</type>
37        </recordAggregationJoinCondition>
38        <recordAggregationObjectFilter>
39          <associatedObjectField>IsPrimaryMember</associatedObjectField>
40          <operator>Equals</operator>
41          <value>true</value>
42          <sequenceNumber>1</sequenceNumber>
43        </recordAggregationObjectFilter>
44    </recordAggregationObject>
45    <recordAggregationObject>
46        <associatedObject>PartyIncome</associatedObject>
47        <masterLabel>Party Income Object</masterLabel>
48        <developerName>PartyIncomeObject</developerName>
49        <filterLogic>1 AND 2</filterLogic>
50        <recordAggregationObjectFilter>
51          <associatedObjectField>IncomeFrequency</associatedObjectField>
52          <operator>Equals</operator>
53          <value>Monthly</value>
54          <sequenceNumber>1</sequenceNumber>
55        </recordAggregationObjectFilter>
56        <recordAggregationObjectFilter>
57          <associatedObjectField>IncomeStatus</associatedObjectField>
58          <operator>Equals</operator>
59          <value>Active</value>
60          <sequenceNumber>2</sequenceNumber>
61        </recordAggregationObjectFilter>
62    </recordAggregationObject>
63</RecordAggregationDefinition>

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

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>RecordAggregationDefinition</name>
6    </types>
7    <version>60.0</version>
8</Package>

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

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。