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

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

重要

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

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

カスタムレポートタイプ定義のファイルサフィックスは .reportType です。カスタムレポートタイプごとに 1 つのファイルがあります。レポートタイプは、対応するパッケージディレクトリの reportTypes ディレクトリに保存されます。

バージョン

カスタムレポートタイプは、API バージョン 14.0 以降で使用できます。

項目

項目名	項目の型	説明
autogenerated	boolean	エンティティで履歴トレンドが有効になった場合にレポートタイプが自動的に生成されることを示します。 API バージョン 29 以降で利用できます。
baseObject	string	必須。カスタムレポートタイプの主オブジェクト。たとえば、Account などです。カスタムオブジェクトや外部オブジェクトを含むすべてのオブジェクトがサポートされます。初回作成後にこの項目を編集することはできません。外部オブジェクトは、API バージョン 38.0 以降でサポートされています。
category	ReportTypeCategory (string 型の列挙)	必須。この項目は、レポートのカテゴリを制御します。有効な値は、次のとおりです。 `accounts` `opportunities` `forecasts` `cases` `leads` `campaigns` `activities` `busop` `products` `admin` `territory` `territory2` (この値は API バージョン 31.0 以降で使用できます)。 `usage_entitlement` `wdc` (この値は API バージョン 29.0 以降で使用できます)。 `calibration` (この値は API バージョン 29.0 以降で使用できます)。 `other` `content` `quotes` `individual` (この値は API バージョン 45.0 以降で使用できます)。
deployed	boolean	必須。レポートタイプをユーザーが使用できるか (`true`)、まだ開発中か (`false`) を示します。
description	string	カスタムレポートタイプの説明。
fullName	string	API アクセスの一意の識別子として使用される、レポートタイプの開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
join	ObjectRelationship	baseObject に結合されたオブジェクト。たとえば、Contact が主オブジェクトの Account に結合されている場合があります。
label	string	必須。レポートタイプの表示ラベル。
sections	ReportLayoutSection[]	レポートタイプに使用できる列のグループ。列は厳密には必須ではありませんが、レポートでは列を使用したほうが便利です。

ObjectRelationship

ObjectRelationship は、別のオブジェクトへの結合を表します。

項目名	項目の型	説明
join	ObjectRelationship	この項目は、3 つ以上のオブジェクトを結合できるようにする再帰的参照です。最大 4 つのオブジェクトを、カスタムレポートタイプ内で結合できます。3 つ以上のオブジェクトを結合する場合、結合の順序で内部結合より前に外部結合があると、その内部結合は許可されません。baseObject は、relationship で指定されたオブジェクトに最初に結合されます。その結果のデータセットがこの項目で指定された任意のオブジェクトと結合されます。
outerJoin	boolean	必須。これが外部結合であるか (`true`)、否か (`false`) を示します。外部結合は、結合されたテーブルの結合列に一致する値が含まれていなくても行を返します。
relationship	string	必須。主オブジェクトに結合されたオブジェクト。たとえば、Contact などです。

ReportLayoutSection

ReportLayoutSection は、カスタムレポートタイプで使用される列のグループを表します。

項目名	項目の型	説明
columns	ReportTypeColumn[]	このカスタムレポートタイプで定義された、クエリから返される列のリスト。
masterLabel	string	必須。レポートウィザードでのこの列のグループの表示ラベル。

ReportTypeColumn

ReportTypeColumn は、カスタムレポートタイプ内の列を表します。

項目名	項目の型	説明
checkedByDefault	boolean	必須。この列がデフォルトで選択されるか (`true`)、否か (`false`) を示します。
displayNameOverride	string	カスタマイズされた列名 (省略可能)。
field	string	必須。レポート列に関連付けられた項目名。
table	string	必須。項目に関連付けられたテーブル。たとえば、Account などがあります。

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

カスタムレポートタイプの定義を次の例に示します。Account が Contact に結合され、その結果のデータセットが Asset に結合されます。

1<?xml version="1.0" encoding="UTF-8"?>
2<ReportType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <baseObject>Account</baseObject>
4    <category>accounts</category>
5    <deployed>true</deployed>
6    <description>Account linked to Contacts and Assets</description>
7    <join>
8        <join>
9            <outerJoin>false</outerJoin>
10            <relationship>Assets</relationship>
11        </join>
12        <outerJoin>false</outerJoin>
13        <relationship>Contacts</relationship>
14    </join>
15    <label>Account Contacts and Assets</label>
16    <sections>
17        <columns>
18            <checkedByDefault>true</checkedByDefault>
19            <field>obj_lookup__c.Id</field>
20            <table>Account</table>
21        </columns>
22        <columns>
23            <checkedByDefault>false</checkedByDefault>
24            <field>obj_lookup__c.Name</field>
25            <table>Account</table>
26        </columns>
27        <columns>
28            <checkedByDefault>false</checkedByDefault>
29            <field>Opportunity__c.Amount</field>
30            <table>Account</table>
31        </columns>
32        <columns>
33            <checkedByDefault>false</checkedByDefault>
34            <field>Owner.IsActive</field>
35            <table>Account</table>
36        </columns>
37        <masterLabel>Accounts</masterLabel>
38    </sections>
39    <sections>
40        <columns>
41            <checkedByDefault>false</checkedByDefault>
42            <field>Owner.Email</field>
43            <table>Account.Contacts</table>
44        </columns>
45        <columns>
46            <checkedByDefault>false</checkedByDefault>
47            <field>byr__c</field>
48            <table>Account.Contacts</table>
49        </columns>
50        <columns>
51            <checkedByDefault>true</checkedByDefault>
52            <field>ReportsTo.CreatedBy.Contact.Owner.MobilePhone</field>
53            <table>Account.Contacts</table>
54        </columns>
55        <masterLabel>Contacts</masterLabel>
56    </sections>
57</ReportType>

使用方法

カスタムレポートタイプは、API 名を使用して項目を参照します。履歴項目 (trackTrending が true に設定されている項目) の場合、Field2__c_hst のように API 名に hst が含まれます。

1<sections>
2    <columns>
3        <checkedByDefault>false</checkedByDefault>
4        <field>Field2__c_hst</field>
5        <table>CustomTrendedObject__c.CustomTrendedObject__c_hst</table>
6    </columns>
7    <masterLabel>History</masterLabel>
8</sections>

詳細は、「trackTrending」を参照してください。

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

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