Report
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
レポートは、対応するパッケージディレクトリの reports ディレクトリに保存されます。ファイル名はレポートタイトルに一致し、拡張子は .report です。
レポートの取得
package.xml ではレポートにワイルドカード (*) 記号を使用できません。明示的な名前を package.xml に入力するためにレポートのリストを取得するには、listMetadata() をコールし、ReportFolder をデータ型として渡します。ReportFolder は describeMetadata() ではデータ型として返されません。レポートは、inFolder の関連付けられている属性が true に設定された describeMetadata() から返されます。この属性が true に設定されている場合は、ReportFolder など、「Folder」という単語を含むコンポーネント名を使用してデータ型を作成できます。
次の例では、package.xml 内のフォルダを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>MyDBFolder/MyDBName</members>
5 <name>Dashboard</name>
6 </types>
7 <types>
8 <members>MyDocumentFolder/MyDocumentName</members>
9 <name>Document</name>
10 </types>
11 <types>
12 <members>unfiled$public/MarketingProductInquiryResponse</members>
13 <members>unfiled$public/SalesNewCustomerEmail</members>
14 <name>EmailTemplate</name>
15 </types>
16 <types>
17 <members>MyReportFolder/MyReportName</members>
18 <name>Report</name>
19 </types>
20 <version>58.0</version>
21</Package>バージョン
Report コンポーネントは、API バージョン 14.0 以降で使用できます。
項目
次の情報は、レポートの作成と実行を十分に理解していることを前提としています。これらの項目についての詳細は、Salesforce オンラインヘルプの「レポートの作成」を参照してください。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregates | ReportAggregate[] | サマリーレポート、マトリックスレポート、および結合レポートのカスタム集計項目を定義するリスト。 |
| block | Report[] | すべてのブロックのレポートタイプが異なる可能性がある結合レポートの各ブロックを表します。 |
| blockInfo | ReportBlockInfo | 結合レポートの各ブロックの属性を定義します。 |
| buckets | ReportBucketField[] | レポートに使用されるバケット項目を定義します。この項目は、API バージョン 24.0 以降で使用できます。 |
| chart | ReportChart | サマリーレポートとマトリックスレポートのグラフを定義します。 |
| colorRanges | ReportColorRange[] | レポートサマリーデータの条件付き強調表示を指定するリスト。Salesforce Classic のみ。 |
| columns | ReportColumn[] | レポートに表示される項目を指定するリスト。項目がレポートに表示される順序は、メタデータ API ファイルに表示される順序と同じです。 |
| crossFilters | ReportCrossFilter[] | クロス条件のオブジェクト、関連オブジェクト、条件 (「含む」または「含まない」) を定義します。この項目は、API バージョン 58.0 以降で使用できます。 |
| currency | CurrencyIsoCode (string 型の列挙) | マルチ通貨を使用する場合、一部のレポートでは、適切な列を表示対象として選択すると、換算された金額を表示できます。たとえば、商談レポートでは、[金額] (換算値) 列をレポートに含めることができます。この項目は、換算額を表示する通貨を定義する string 型の列挙です。有効値: USD、GBP、SLE、JPY など、ISO 4217 標準で定義された有効な英字 3 文字の ISO 通貨コードである必要があります。 |
| dataCategoryFilters | string | データカテゴリに基づく検索条件を指定します。 |
| description | string | レポート名と一緒に表示される一般情報を指定します。最大文字数は 255 文字です。 |
| division | string |
組織がディビジョンを使用してデータを分類しており、「ディビジョンの使用」権限を持っている場合は、レポート内のレコードはこのディビジョンと一致する必要があります。 この項目は、API バージョン 17.0 以降で使用できます。 |
| filter | ReportFilter | レポートの結果を、特定のデータを持つレコードに制限します。たとえば、次のようにレポートの結果を金額が 1,000 ドルを超える商談に制限できます。 |
| folderName | string |
レポートが保存されるフォルダの名前。 この項目は、API バージョン 35.0 以降で使用できます。 |
| format | ReportFormat (string 型の列挙) | レポート形式を定義します。たとえば、小計のない単純なデータリストの場合は Tabular を使用します。 |
| formattingRules | ReportFormattingRule[] (string 型の列挙) | レポートデータの条件付き強調表示を指定するリスト。Lightning Experience のみ。 |
| groupingsAcross | ReportGrouping[] | マトリックスレポートでデータのグループ化と小計の基準となる項目を定義するリスト (行ヘッダー)。日付項目でグループ化する場合は、日、週、または月などの特定の期間を使用してデータをさらにグループ化できます。最大項目数は 2 です。 |
| groupingsDown | ReportGrouping[] | サマリーレポートとマトリックスレポートの場合でグループ化と小計の基準となる項目を定義するリスト。サマリーレポートでは、複数の並び替え項目を選択してデータを並び替えできます。マトリックスレポートでは、列ヘッダーとなる集計項目を指定します。日付項目でグループ化する場合は、日、週、または月などの特定の期間を使用してデータをさらにグループ化できます。マトリックスレポートの最大値は 2 です。サマリーレポートの最大値は 3 です。 |
| historicalSelector | ReportHistoricalSelector |
履歴トレンドレポートデータを取得する日付範囲を定義します。デフォルトは「任意の履歴日付」です。 API バージョン 29.0 以降で利用できます。 |
| name | string | 必須。レポート名。たとえば、Opportunity Pipeline のように設定します。 |
| numSubscriptions | int |
Lightning Experience でユーザがこのレポートに登録したか (1)、登録していないか (0) を示します。コンテキストユーザに関連付けられます。 この項目は、API バージョン 38.0 以降で使用できます。 |
| params | ReportParam[] | 各レポートタイプに固有の設定、特にレポートを絞り込んで役に立つサブセットを取得できるようにするオプションを指定するリスト。たとえば、活動レポートタイプを使用すると、活動予定、完了した活動、またはその両方を表示するかどうかや、ToDo、行動、またはその両方を表示するかどうかを指定できます。有効な値はレポートタイプに応じて異なります。 |
| reportCustomDetailFormula | CustomDetailFormulas | 行レベルの数式をレポートに適用できるようにします。 |
| reportType | string | 必須。レポート内のデータの型を定義します。たとえば、商談データのレポートを作成するには、Opportunity を指定します。 |
| roleHierarchyFilter | string |
レポートドリルダウンのロール名。商談レポートや活動レポートなどの一部のレポートには [階層] リンクが表示され、そこからロール階層に基づいてさまざまなデータセットにドリルダウンできます。 この項目は、API バージョン 17.0 以降で使用できます。 |
| rowLimit | int | レポートで返すことができる最大行数を定義します。 |
| scope | string | レポートの実行対象となるデータの範囲を定義します。たとえば、すべての商談、自分が所有する商談、所属するチームが所有する商談に対してレポートを実行するかどうかなどです。有効な値は、reportType によって異なります。たとえば、Account レポートの場合、次の値になります。
|
| showCurrentDate | boolean |
マトリックス形式の履歴トレンドレポートの場合、true に設定できます。 API バージョン 29.0 以降で利用できます。 |
| showDetails | boolean | false を指定すると、ヘッダー、小計、合計のみのレポートの折りたたみビューが表示されます。デフォルト: true |
| showGrandTotal | boolean | true を指定すると、レポート全体の算出合計が表示されます。 |
| showSubTotals | boolean | true を指定すると、レポートのセクションの算出小計が表示されます。 |
| sortColumn | string | レポートのデータの並び替え対象となる項目を指定します。並び替え順を指定するには、sortOrder を使用します。 |
| sortOrder | SortOrder (string 型の列挙) | 並び替え順を指定します。並び替え対象となる項目を指定するには、sortColumn を使用します。 |
| territoryHierarchyFilter | string |
レポートドリルダウンのテリトリー名。組織がテリトリー管理を使用している場合、一部のレポートには [階層] リンクが表示され、そこからテリトリー階層に基づいてさまざまなデータセットにドリルダウンできます。 この項目は、API バージョン 17.0 以降で使用できます。 |
| timeFrameFilter | ReportTimeFrameFilter | レポートの結果を、指定した期間内のレコードに制限します。 |
| userFilter | string |
レポートドリルダウンのユーザ名。商談レポートや活動レポートなどの一部のレポートには [階層] リンクが表示され、そこからユーザ階層に基づいてさまざまなデータセットにドリルダウンできます。 この項目は、API バージョン 17.0 以降で使用できます。 |
ReportAggregate
ReportAggregate は、サマリーレポート、マトリックスレポート、および結合レポートのカスタム集計項目を定義します。これらの項目についての詳細は、Salesforce オンラインヘルプの「レポートへの集計項目列の追加」を参照してください。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| acrossGroupingContext | string | カスタム集計項目を表示する行のグルーピングレベルを定義します。これは、API バージョン 15.0 の新項目です。 |
| calculatedFormula | string | 必須。カスタム集計項目。たとえば、AMOUNT:SUM + OPP_QUANTITY:SUM のようになります。 |
| datatype | ReportAggregateDatatype (string 型の列挙) | 必須。カスタム集計項目の結果の書式設定および表示用のデータ型を指定します。 |
| description | string | カスタム集計項目の説明。最大 255 文字です。 |
| developerName | string | 必須。カスタム集計項目の内部開発名。たとえば、FORMULA1 などです。これは、条件付き強調表示など、他のレポートコンポーネントからカスタム集計項目を参照するために使用されます。 |
| downGroupingContext | string | カスタム集計項目を表示する列のグルーピングレベルを定義します。この項目は、API バージョン 15.0 以降で使用できます。 |
| isActive | boolean | 必須。true であれば、数式の結果をレポートに表示します。false であれば、数式の結果をレポートに表示しません。 |
| isCrossBlock | boolean |
カスタム集計項目が、結合レポートで使用できるクロスブロック集計項目であるかどうかを決定します。true は、クロスブロックカスタム集計項目を示します。false は、標準カスタム集計項目を示します。 この項目は、API バージョン 25.0 以降で使用できます。 |
| masterLabel | string | 必須。カスタム集計項目の表示ラベル (名前)。 |
| reportType | string | 結合レポートでは必須。aggregate を追加できるブロックの reportType を指定します。 |
| scale | int | 数式の結果は、指定された小数点以下の桁数に計算されます。有効な値は 0 ~ 18 です。 |
ReportBlockInfo
ReportBlockInfo は、結合レポートのブロックを定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregateReferences | ReportAggregateReference[] | 結合レポートブロックで使用されるカスタム集計項目を表す aggregates をリストします。 |
| blockId | string |
必須。blockId は、各集計項目を含むブロックを識別するために、クロスブロックカスタム集計項目と結合レポートのグラフで使用されます。blockId は、自動的に割り当てられます。有効な値は、B1 から B5 です。 この項目は、API バージョン 25.0 以降で使用できます。 |
| joinTable | string | 必須。結合レポートのブロックの結合に使用されるエンティティを参照します。このエンティティによって、複数のブロックにまたがってグローバルにグルーピング可能な項目のリストが提供されます。 |
ReportBucketField
ReportBucketField は、レポートで使用されるバケットを定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| bucketType | ReportBucketFieldType (string 型の列挙) | 必須。バケットの種別を指定します。有効な値は次のとおりです。
|
| developerName | string | 必須。列リストやその他のレポートコンポーネント (並び替え、検索条件、リスト、グループ、グラフなど) にバケット項目を表示するために <field> 値として使用される一意の名前。BucketField_name の形式にする必要があります。たとえば、BucketField_BusinessSize です。 |
| masterLabel | string | 必須。バケット項目の表示ラベル。最大 40 文字です。表示ラベルの先頭と末尾にある改行、タブ、複数の空白はすべて削除されます。表示ラベル内にあるこれらの文字は 1 文字の空白に変換されます。 |
| nullTreatment | ReportBucketFieldNullTreatment (string 型の列挙) | 数値バケット項目のみが対象。空の値を 0 として扱うか (z)、否か (n) を指定します。 |
| otherBucketLabel | string | バケット化が解除された値のコンテナの表示ラベル。 |
| sourceColumnName | string | 必須。バケットが適用される受信元項目。たとえば、SALES または INDUSTRY です。 |
| values | ReportBucketFieldValue (string 型の列挙) | バケット項目で使用される 1 つのバケット値を定義します。 |
ReportBucketFieldValue
ReportBucketFieldValue は、バケット項目で使用されるバケット値を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| sourceValues | ReportBucketFieldSourceValue (string 型の列挙) | バケット項目内のバケットの値。有効な値は次のとおりです。
数値バケットでは、最初の値には to のみ、最後の値には from のみが設定されている必要があります。それ以外のすべての値は、to と from の両方が設定されている必要があります。 |
| value | string | 必須。バケット項目内の特定のバケット値の名前。 |
ReportGrouping
ReportGrouping は、サマリーレポート、マトリックスレポート、および結合レポートでのデータのグルーピング、小計算出、および並び替えの方法を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregateType | ReportAggrType (string 型の列挙) |
並び替え基準になる集計値の種別。有効な値は、次のとおりです。
|
| dateGranularity | UserDateGranularity (string 型の列挙) | 日付項目でグループ化する場合、グルーピングの基準となる期間。 |
| field | string | 必須。データの集計の基準となる項目。たとえば、CAMPAIGN_SOURCE のようになります。 |
| sortByName | string | グルーピングの並び替えに使用する列、集計項目、またはカスタム集計項目の API 名。 |
| sortOrder | SortOrder | 必須。データを英数字の昇順と降順のどちらで並び替えるかを示します。 |
| sortType | ReportSortType (string 型の列挙) |
グルーピングが列、集計項目、カスタム集計項目のどれを基準に並び替えられるかを示します。有効な値は、次のとおりです。
|
ReportHistoricalSelector
ReportHistoricalSelector は、履歴データの日付の範囲を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| snapshot | string | 履歴条件に適用する相対 (N_DAYS_AGO:2 形式) または絶対 (yyyy-MM-dd 形式) 日付値を表します。指定されていない場合、ユーザに表示されるすべての列に条件が適用されるとみなされます。 API バージョン 29.0 以降で利用できます。 |
CustomDetailFormulas
CustomDetailFormulas は、レポートの行レベルの数式を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| calculatedFormula | string | 必須。カスタム数式。たとえば、AMOUNT:SUM + OPP_QUANTITY:SUM です。 |
| datatype | ReportCustomDetailFormulaDatatype (string 型の列挙) | 必須。数式の結果の書式設定および表示用のデータ型を指定します。 |
| description | string | 数式の説明。最大 255 文字です。 |
| developerName | string | 必須。数式の内部開発名。たとえば、FORMULA1 などです。これは、条件付き強調表示など、他のレポートコンポーネントからカスタム数式を参照するために使用されます。 |
| label | string | 必須。この数式を識別するための名前。 |
| scale | int | 数式の結果は、指定された小数点以下の桁数に計算されます。有効な値は 0 ~ 18 です。 |
ReportCustomDetailFormulaDatatype
行レベル数式の結果の書式設定および表示用のデータ型を指定する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 |
|---|
| Double |
| DateOnly |
| DateTime |
| Text |
SortOrder
レポート項目でのデータの並び替え順序を定義する string 型の列挙です。有効な値は次のとおりです。
| 項目 | 説明 |
|---|---|
| Asc | データを英数字の昇順に並び替えます。 |
| Desc | データを英数字の降順に並び替えます。 |
UserDateGranularity
データのグルーピングの基準となる期間を定義する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 | 説明 |
|---|---|
| None | 日付によるグルーピングなし |
| Day | 日別 |
| Week | 週別 |
| Month | 月別 |
| Quarter | 四半期別 |
| Year | 年別 |
| FiscalQuarter | 会計四半期別。組織の四半期年度を設定できます。Salesforce オンラインヘルプの「会計年度の設定」を参照してください。 |
| FiscalYear | 会計年度別 |
| MonthInYear | カレンダー月別 |
| DayInMonth | カレンダー日別 |
| FiscalPeriod | 会計期間別 (カスタム会計年度が有効な場合) |
| FiscalWeek | 会計週別 (カスタム会計年度が有効な場合) |
ReportSummaryType
レポート項目の集計方法を定義する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 | 説明 |
|---|---|
| Sum | 合計 |
| Average | 平均 |
| Maximum | 最大値 |
| Minimum | 最小値 |
| Unique | 一意の値 |
| None | この項目は集計されません。 |
ReportColorRange
ReportColorRange は、レポートサマリーデータの条件付き強調表示を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregate | ReportSummaryType (string 型の列挙) | 必須。columnName で指定された項目の集計方法を定義します。たとえば、Sum です。 |
| columnName | string | 必須。値の範囲を背景色で表現する項目を指定します。 |
| highBreakpoint | double | 必須。ミドルレンジの色をミドルレンジの色と分割する数値を指定します。 |
| highColor | string | 必須。ハイレンジの数値として分類されたデータを表す色を指定します (HTML 形式)。この色は、highBreakpoint を超える値に対応します。 |
| lowBreakpoint | double | 必須。ローレンジの色をハイレンジの色と分割する数値を指定します。 |
| lowColor | string | 必須。ローレンジの値 (lowBreakpoint 値未満) として分類されたデータを表す色を指定します (HTML 形式)。 |
| midColor | string | 必須。ミドルレンジの値として分類されたデータを表す色を指定します (HTML 形式)。 |
ReportColumn
ReportColumn は、レポート内での項目 (列) の表示方法を定義します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregateTypes | ReportSummaryType[] (string 型の列挙) | 各レポート項目が集計されるかどうか、および集計方法を定義するリスト。 |
| field | string | 必須。項目名。たとえば、AGE または OPPORTUNITY_NAME などです。 |
| reverseColors | boolean |
履歴トレンドレポートの日付値と金額値が増加している場合、デフォルトの色をそれぞれ緑と赤に置き換えて表示します。 API バージョン 29.0 以降で利用できます。 |
| showChanges | boolean |
履歴トレンドレポートに、現在と履歴の日付値と金額値の差を表示する列を追加します。 API バージョン 29.0 以降で利用できます。 |
ReportFilter
ReportFilter は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| booleanFilter | string | 検索条件ロジックの条件を指定します。 |
| criteriaItems | ReportFilterItem | レポートデータの絞り込み条件 (履歴値の比較または日付の範囲の適用のいずれか)。 |
| language | Language (string 型の列挙) | レポートで演算子 contains または startsWith を使用して選択リスト値を絞り込むときに使用される言語。有効な言語の値の一覧は、「言語」を参照してください。 |
ReportFilterItem
ReportFilterItem は、指定された項目に基づいてデータを絞り込み、レポートの結果を制限します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| column | string | 必須。データの絞り込み対象となる項目。たとえば、AMOUNT のようになります。 |
| columnToColumn | boolean |
条件が列間 (項目間) の条件であるかどうかを示します。 履歴トレンドレポートの場合、API バージョン 29.0 以降で利用できます。一般レポートの場合、API バージョン 48.0 以降で利用できます。 |
| isUnlocked | boolean | 省略可能。レポート検索条件がロック解除されているか (true)、ロックされているか (false) を示します。Lightning Experience のレポート実行ページで、ロック解除されている検索条件を編集できます。指定されていない場合、デフォルト値は false です。 API バージョン 38.0 以降で利用できます。 |
| operator | FilterOperation (string 型の列挙) | 必須。データの絞り込みに使用する演算子 (greaterThan など) を定義する string 型の列挙。有効な値は、次のとおりです。
|
| snapshot | string | 相対 (N_DAYS_AGO:2 形式) または絶対 (yyyy-MM-dd 形式) 日付値を表します。 API バージョン 29.0 以降で利用できます。 |
| value | string | データの絞り込みに使用する値。たとえば、1000 などです。メタデータ API 検索条件値は、レポートウィザードに入力した検索条件値と一致しない場合があります。たとえば、メタデータ API では日付は常に米国の日付形式に変換され、非英語言語で入力された値は標準の米国英語の同等の形式に変換される可能性があります。 |
ReportFormat
レポート形式を定義する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 | 説明 |
|---|---|
| Matrix | データをグリッドに集計します。関連する合計を比較するために使用します。 |
| Summary | データをリスト、並び替え、および小計します。 |
| Tabular | 並び替えや小計なしでデータをリストします。 |
| Joined | 各レポートのデータをそれぞれのブロックに保存しているさまざまなレポートタイプからデータを結合します。 |
ReportFormattingRule
レポートサマリーデータの条件付き強調表示を定義します。書式設定ルールは、1 レポートにつき 5 個まで指定できます。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregate | ReportFormattingSummaryType (string 型の列挙) | columnName で指定された項目の集計方法を定義します。たとえば、Sum です。 |
| columnName | string | 必須。値の範囲を色で表現する項目を指定します。 |
| values | ReportFormattingRuleValue (string 型の列挙) | 必須。書式設定されたデータ値の背景色と関連付けられた範囲を指定します。 |
ReportFormattingSummaryType
レポート項目の集計方法を定義する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 | 説明 |
|---|---|
| Sum | 合計 |
| Average | 平均 |
| Maximum | 最大値 |
| Minimum | 最小値 |
| Unique | 一意の値 |
ReportFormattingRuleValue
書式設定されたデータ値の背景色と関連付けられた範囲を指定します。最大 3 つの背景色と 0 ~ 3 つの範囲上限を指定できます。有効な値は次のとおりです。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| backgroundColor | string | (必須) columnName の項目の強調表示色を指定します。#54C254 のような有効な 16 進数の色コードを指定する必要があります。少なくとも 1 色は必須です。rangeUpperBound で決定される 3 つの範囲にそれぞれ別の色を指定することもできます。特定の範囲の色を指定しないと、その範囲の背景は透明になります。 |
| rangeUpperBound | double | 背景色を適用する範囲を指定します。特定の範囲の上限を指定しないと、その範囲の上限は正の無限大となります。次の例では、[売上] 列の背景色を、売上集計値が 100 以下の場合は #B50E03、100 ~ 1000 の場合は背景色なし、1000 以上の場合は #006714 に設定しています。 |
ReportParam
ReportParam は、レポートタイプに固有の設定、特に、レポートを特定の便利なサブセットに絞り込めるようにするオプションを表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。固有の reportType 設定を指定します。 |
| value | string | 必須。設定値。 |
ReportAggregateDatatype
カスタム集計項目結果の書式設定および表示用のデータ型を指定する string 型の列挙です。有効な値は次のとおりです。
| 列挙値 |
|---|
| currency |
| number |
| percent |
ReportChart
ReportChart は、サマリーレポート、マトリックスレポート、および結合レポートのグラフを表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| backgroundColor1 | string | 背景のグラデーションの開始色を指定します (HTML 形式)。 |
| backgroundColor2 | string | 背景のグラデーションの終了色を指定します (HTML 形式)。 |
| backgroundFadeDir | ChartBackgroundDirection (string 型の列挙) | 背景のグラデーションの色の方向を指定します。グラデーションデザインの開始色を指定する backgroundColor1、および終了色を指定する backgroundColor2 と一緒に使用します。背景のデザインが必要ない場合は、両方に白を選択します。有効な値は次のとおりです。
|
| chartSummaries | ChartSummary[] | グラフに使用する集計を指定します。無効な集計は、通知なしで無視されます。有効な集計がない場合、デフォルトで RowCount が軸の値に使用されます。この項目は、API バージョン 17.0 以降で使用できます。 |
| chartType | ChartType (string 型の列挙) | 必須。グラフの種類を指定します。使用可能なグラフの種類は、レポートタイプに応じて異なります。 |
| enableHoverLabels | boolean | グラフにマウスを重ねたとき、値、表示ラベル、およびパーセントを表示するかどうかを指定します。詳細のフロート表示はグラフの種類によって異なります。パーセントは、円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。この項目は、API バージョン 17.0 以降で使用できます。 |
| expandOthers | boolean | 合計の 3% 以下のグループをすべて 1 つの「その他」系列または区分グループにまとめるかどうかを指定します。円グラフ、ドーナツグラフ、およびじょうごグラフのみに適用されます。グラフにすべての値を個別に表示する場合は true を設定し、小さなグループを「その他」にまとめるには false に設定します。この項目は、API バージョン 17.0 以降で使用できます。 |
| groupingColumn | string | データのグルーピングの基準となる項目を指定します。このデータは、縦棒グラフの場合は X 軸に、横棒グラフの場合は Y 軸に表示されます。 |
| legendPosition | ChartLegendPosition (string 型の列挙) | 必須。 グラフに対する凡例の位置。有効な値は、次のとおりです。
|
| location | ChartPosition (string 型の列挙) | 必須。グラフをレポートの上部に表示するか、または下部に表示するかを指定します。 |
| secondaryGroupingColumn | string | データのグルーピングの基準となる項目を指定します (グループ化されるグラフの種類の場合に指定可能)。 |
| showAxisLabels | boolean | グラフに各軸の名前を表示するかどうかを指定します (棒グラフと折れ線グラフの場合に指定可能)。 |
| showPercentage | boolean | 円グラフ、ドーナツグラフ、およびじょうごグラフの系列および区分のパーセント値とゲージのパーセント値を表示するか (true)、否か (false) を示します。 |
| showTotal | boolean | ドーナツグラフとゲージの合計を表示するか (true)、否か (false) を示します。 |
| showValues | boolean | グラフの個々のレコードまたはグループの値が表示されるか (true)、否か (false) を示します。 |
| size | ReportChartSize (string 型の列挙) | 必須。グラフのサイズを指定します。 |
| summaryAggregate | ReportSummaryType (string 型の列挙) | グラフデータの集計方法を定義します。たとえば、Sum です。API バージョン 17.0 以降ではサポートされません。「chartSummaries」を参照してください。 |
| summaryAxisManualRangeEnd | double | 終了値を定義します (手動で軸範囲を指定する場合に指定可能)。 |
| summaryAxisManualRangeStart | double | 開始値を定義します (手動で軸範囲を指定する場合に指定可能)。 |
| summaryAxisRange | ChartRangeType (string 型の列挙) | 必須。軸範囲を手動と自動のどちらで指定するかを定義します (���棒グラフ、折れ線グラフ、縦棒グラフの場合に指定可能)。 |
| summaryColumn | string | 必須。グラフデータの集計の基準となる項目を指定します。通常、この項目は Y 軸に表示されます。API バージョン 17.0 以降ではサポートされません。「chartSummaries」を参照してください。 |
| textColor | string | グラフのテキストと表示ラベルの色 (HTML 形式)。 |
| textSize | int | グラフのテキストと表示ラベルのサイズ。有効な値は次のとおりです。
最大サイズは 18 です。18 より大きい値は 18 ポイントで表示されます。 |
| title | string | グラフのタイトル。最大 255 文字です。 |
| titleColor | string | タイトルテキストの色 (HTML 形式)。 |
| titleSize | int | タイトルテキストのサイズ。有効な値は次のとおりです。
最大サイズは 18 です。18 より大きい値は 18 ポイントで表示されます。 |
ChartType
グラフの種類を定義する string 型の列挙です。これらのグラフの種類の詳細は、Salesforce オンラインヘルプの「グラフの種類」を参照してください。有効な値は次のとおりです。
ChartSummary
ChartSummary は、グラフのデータの集計方法を定義します。有効な値は次のとおりです。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregate | ReportSummaryType | 集計値の集計方法 (Sum、Average、Min、Max など) を指定します。集計に使用される集計値を指定するには、column 項目を使用します。RowCount またはカスタム集計項目にはこの項目を指定する必要はありません。 |
| axisBinding | ChartAxis | グラフで使用する軸を指定します。軸に使用される集計値を指定するには、column 項目を使用します。 |
| column | string | 必須。グラフデータの集計項目を指定します。すべての列が無効な場合、デフォルトで RowCount が軸の値に使用されます。縦棒と横棒の組み合わせグラフの場合、最大 4 つの値を指定できます。 |
ReportTimeFrameFilter
ReportTimeFrameFilter は、レポートの期間を表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| dateColumn | string | 必須。データの絞り込み対象となる日付項目。たとえば、CLOSE_DATE のようになります。 |
| endDate | date | interval が INTERVAL_CUSTOM の場合、カスタム期間の終了日を指定します。 |
| interval | UserDateInterval (string 型の列挙) | 必須。期間を指定します。 |
| startDate | date | interval が INTERVAL_CUSTOM の場合、カスタム期間の開始日を指定します。 |
ReportCrossFilter
ReportCrossFilter は、レポート内のクロス条件機能を表します。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| criteriaItems | ReportFilterItem | クロス条件のサブ条件を表します。最大 5 つのサブ条件を指定できます。この項目には次の属性が必要です。
|
| operation | ObjectFilterOperator (string 型の列挙) | オブジェクトを含めるか、除外するかを示すアクション。有効値: with および without。 |
| primaryTableColumn | string | クロス条件に使用する親オブジェクト。 |
| relatedTable | string | クロス条件に使用する子オブジェクト。 |
| relatedTableJoinColumn | string | 親を結合するために使用する子オブジェクトの項目。 |
宣言的なメタデータの定義のサンプル
クロス条件を使用してケース状況がクローズではないケースの Account レポートを作成するサンプル XML スニペット。
1<crossFilters>
2 <criteriaItems>
3 <column>Status</column>
4 <operator>notequal</operator>
5 <value>Closed</value>
6 </criteriaItems>
7 <operation>with</operation>
8 <primaryTableColumn>ACCOUNT_ID</primaryTableColumn>
9 <relatedTable>Case</relatedTable>
10 <relatedTableJoinColumn>Account</relatedTableJoinColumn>
11 </crossFilters>UserDateInterval
期間を定義する string 型の列挙です。有効な値は次のとおりです。
宣言的なメタデータの定義のサンプル
サンプル XML レポート定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Report xmlns="http://soap.sforce.com/2006/04/metadata">
3 <aggregates>
4 <acrossGroupingContext>CRT_Object__c$Id</acrossGroupingContext>
5 <calculatedFormula>PREVGROUPVAL(CRT_Object__c.Currency__c:AVG, CRT_Object__c.Id) *
6 PARENTGROUPVAL(CRT_Object__c.Number__c:MAX, CRT_Object__c.CreatedBy.Name,
7 COLUMN_GRAND_SUMMARY)/RowCount</calculatedFormula>
8 <datatype>number</datatype>
9 <developerName>FORMULA1</developerName>
10 <downGroupingContext>CRT_Object__c$CreatedBy</downGroupingContext>
11 <isActive>true</isActive>
12 <masterLabel>CurrCSF</masterLabel>
13 <scale>2</scale>
14 </aggregates>
15 <aggregates>
16 <acrossGroupingContext>CRT_Object__c$LastModifiedDate</acrossGroupingContext>
17 <calculatedFormula>IF(RowCount>10,
18 BLANKVALUE(ROUND(PREVGROUPVAL(CRT_Object__c.Currency__c:SUM,
19 CRT_Object__c.LastModifiedDate),3),
20 PARENTGROUPVAL(CRT_Object__c.Number__c:SUM, ROW_GRAND_SUMMARY,
21 CRT_Object__c.Id)) , 1000)</calculatedFormula>
22 <datatype>number</datatype>
23 <developerName>FORMULA2</developerName>
24 <downGroupingContext>GRAND_SUMMARY</downGroupingContext>
25 <isActive>true</isActive>
26 <masterLabel>numCSF</masterLabel>
27 <scale>2</scale>
28 </aggregates>
29 <buckets>
30 <bucketType>number</bucketType>
31 <developerName>BucketField_BusinessSize</developerName>
32 <masterLabel>NumericBucket</masterLabel>
33 <nullTreatment>z</nullTreatment>
34 <sourceColumnName>SALES</sourceColumnName>
35 <values>
36 <sourceValues>
37 <to>10000</to>
38 </sourceValues>
39 <value>low</value>
40 </values>
41 <values>
42 <sourceValues>
43 <from>10000</from>
44 <to>25000</to>
45 </sourceValues>
46 <value>mid</value>
47 </values>
48 <values>
49 <sourceValues>
50 <from>25000</from>
51 </sourceValues>
52 <value>high</value>
53 </values>
54 </buckets>
55 <buckets>
56 <bucketType>text</bucketType>
57 <developerName>BucketField_Region</developerName>
58 <masterLabel>TextBucket</masterLabel>
59 <nullTreatment>n</nullTreatment>
60 <otherBucketLabel>Other</otherBucketLabel>
61 <sourceColumnName>ADDRESS1_STATE</sourceColumnName>
62 <values>
63 <sourceValues>
64 <sourceValue>CA</sourceValue>
65 </sourceValues>
66 <value>west</value>
67 </values>
68 <values>
69 <sourceValues>
70 <sourceValue>NY</sourceValue>
71 </sourceValues>
72 <sourceValues>
73 <sourceValue>Ontario</sourceValue>
74 </sourceValues>
75 <value>east</value>
76 </values>
77 </buckets>
78 <chart>
79 <backgroundColor1>#FFFFFF</backgroundColor1>
80 <backgroundColor2>#FFFFFF</backgroundColor2>
81 <backgroundFadeDir>Diagonal</backgroundFadeDir>
82 <chartSummaries>
83 <axisBinding>y</axisBinding>
84 <column>FORMULA1</column>
85 </chartSummaries>
86 <chartSummaries>
87 <axisBinding>y</axisBinding>
88 <column>FORMULA2</column>
89 </chartSummaries>
90 <chartSummaries>
91 <aggregate>Maximum</aggregate>
92 <axisBinding>y</axisBinding>
93 <column>CRT_Object__c$Number__c</column>
94 </chartSummaries>
95 <chartSummaries>
96 <axisBinding>y</axisBinding>
97 <column>RowCount</column>
98 </chartSummaries>
99 <chartType>VerticalColumn</chartType>
100 <groupingColumn>CRT_Object__c$LastModifiedDate</groupingColumn>
101 <legendPosition>Right</legendPosition>
102 <location>CHART_TOP</location>
103 <size>Medium</size>
104 <summaryAxisRange>Auto</summaryAxisRange>
105 <textColor>#000000</textColor>
106 <textSize>12</textSize>
107 <titleColor>#000000</titleColor>
108 <titleSize>18</titleSize>
109 </chart>
110 <columns>
111 <field>CRT_Object__c$Name</field>
112 </columns>
113 <columns>
114 <aggregateTypes>Average</aggregateTypes>
115 <field>CRT_Object__c$Currency__c</field>
116 </columns>
117 <columns>
118 <aggregateTypes>Maximum</aggregateTypes>
119 <field>CRT_Object__c$Number__c</field>
120 </columns>
121 <columns>
122 <field>BucketField__Region</field>
123 </columns>
124 <format>Matrix</format>
125 <groupingsAcross>
126 <dateGranularity>Day</dateGranularity>
127 <field>CRT_Object__c$Id</field>
128 <sortOrder>Asc</sortOrder>
129 </groupingsAcross>
130 <groupingsAcross>
131 <dateGranularity>Year</dateGranularity>
132 <field>CRT_Object__c$LastModifiedDate</field>
133 <sortOrder>Asc</sortOrder>
134 </groupingsAcross>
135 <groupingsDown>
136 <dateGranularity>Day</dateGranularity>
137 <field>CRT_Object__c$CreatedBy</field>
138 <sortOrder>Asc</sortOrder>
139 </groupingsDown>
140 <groupingsDown>
141 <dateGranularity>Day</dateGranularity>
142 <field>CRT_Object__c$Currency__c</field>
143 <sortOrder>Desc</sortOrder>
144 </groupingsDown>
145 <name>CrtMMVC</name>
146 <reportType>CRT1__c</reportType>
147 <scope>organization</scope>
148 <showDetails>false</showDetails>
149 <timeFrameFilter>
150 <dateColumn>CRT_Object__c$CreatedDate</dateColumn>
151 <interval>INTERVAL_CUSTOM</interval>
152 </timeFrameFilter>
153</Report>結合レポートの宣言的なメタデータの定義のサンプル
サンプル XML レポート定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Report xmlns="http://soap.sforce.com/2006/04/metadata">
3<!-- This is a cross-block custom summary formula. Note that the calculated formula reference for a blocks reference uses the BlockId#Aggregate. -->
4 <aggregates>
5 <calculatedFormula>B1#AMOUNT:SUM+B2#EMPLOYEES:SUM</calculatedFormula>
6 <datatype>number</datatype>
7 <developerName>FORMULA</developerName>
8 <isActive>true</isActive>
9 <isCrossBlock>true</isCrossBlock>
10 <masterLabel>Cross-Block CSF Example</masterLabel>
11 <scale>2</scale>
12 </aggregates>
13<!-- This is a standard custom summary formula. Note that the calculated formula reference does not have block reference but just the aggregate name of the report type associated (Opportunity).-->
14 <aggregates>
15 <calculatedFormula>AMOUNT:SUM</calculatedFormula>
16 <developerName>FORMULA2</developerName>
17 <isActive>true</isActive>
18 <isCrossBlock>false</isCrossBlock>
19 <masterLabel>Standard CSF Example</masterLabel>
20 <reportType>Opportunity</reportType>
21 <scale>2</scale>
22 </aggregates>
23 <block>
24 <blockInfo>
25<!-- This is how the block defines that the custom summary formula should be referenced. In this example, it’s the in standard FORMULA 2 defined above. This block report has blockID B1.-->
26 <aggregateReferences>
27 <aggregate>FORMULA2</aggregate>
28 </aggregateReference>
29 <blockId>B1</blockId>
30 <joinTable>a</joinTable>
31 </blockInfo>
32 <columns>
33 <field>TYPE</field>
34 </columns>
35 <format>Summary</format>
36 <name>Opportunities BLock 3</name>
37 <params>
38 <name>role_territory</name>
39 <value>role</value>
40 </params>
41 <params>
42 <name>terr</name>
43 <value>all</value>
44 </params>
45 <params>
46 <name>open</name>
47 <value>all</value>
48 </params>
49 <params>
50 <name>probability</name>
51 <value>0</value>
52 </params>
53 <params>
54 <name>co</name>
55 <value>1</value>
56 </params>
57 <reportType>Opportunity</reportType>
58 <scope>organization</scope>
59 <timeFrameFilter>
60 <dateColumn>CLOSE_DATE</dateColumn>
61 <interval>INTERVAL_CUSTOM</interval>
62 </timeFrameFilter>
63 </block>
64 <block>
65 <blockInfo>
66<!-- This is how the block defines that the custom summary formula should be referenced. In this example, it’s the cross-block custom summary formula FORMULA 1 defined above. This block report has blockId B2.-->
67 <aggregateReferences>
68 <aggregate>FORMULA1</aggregate>
69 </aggregateReferences>
70 <blockId>B2</blockId>
71 <joinTable>a</joinTable>
72 </blockInfo>
73 <columns>
74 <field>USERS.NAME</field>
75 </columns>
76 <columns>
77 <field>TYPE</field>
78 </columns>
79 <columns>
80 <field>DUE_DATE</field>
81 </columns>
82 <columns>
83 <field>LAST_UPDATE</field>
84 </columns>
85 <columns>
86 <field>ADDRESS1_STATE</field>
87 </columns>
88 <format>Summary</format
89 <name>Accounts block 5</name>
90 <params>
91 <name>terr</name>
92 <value>all</value>
93 </params>
94 <params>
95 <name>co</name>
96 <value>1</value>
97 </params>
98 <reportType>AccountList</reportType>
99 <scope>organization</scope>
100 <timeFrameFilter>
101 <dateColumn>CREATED_DATE</dateColumn>
102 <interval>INTERVAL_CUSTOM</interval>
103 </timeFrameFilter>
104 </block>
105 <blockInfo>
106 <blockId xsi:nil="true"/>
107 <joinTable>a</joinTable>
108 </blockInfo>
109<chart>
110 <backgroundColor1>#FFFFFF</backgroundColor1>
111 <backgroundColor2>#FFFFFF</backgroundColor2>
112 <backgroundFadeDir>Diagonal</backgroundFadeDir>
113 <chartSummaries>
114 <axisBinding>y</axisBinding>
115<!-- This is how chart aggregates are designed in multiblock. We're using RowCount from Block 1.-->
116 <column>B1#RowCount</column>
117 </chartSummaries>
118 <chartType>HorizontalBar</chartType>
119 <enableHoverLabels>false</enableHoverLabels>
120 <expandOthers>true</expandOthers>
121 <groupingColumn>ACCOUNT_NAME</groupingColumn>
122 <location>CHART_TOP</location>
123 <showAxisLabels>true</showAxisLabels>
124 <showPercentage>false</showPercentage>
125 <showTotal>false</showTotal>
126 <showValues>false</showValues>
127 <size>Medium</size>
128 <summaryAxisRange>Auto</summaryAxisRange>
129 <textColor>#000000</textColor>
130 <textSize>12</textSize>
131 <titleColor>#000000</titleColor>
132 <titleSize>18</titleSize>
133 </chart>
134 <format>MultiBlock</format>
135 <groupingsDown>
136 <dateGranularity>Day</dateGranularity>
137 <field>ACCOUNT_NAME</field>
138 <sortOrder>Asc</sortOrder>
139 </groupingsDown>
140 <name>mb_mbapi</name>
141 <reportType>Opportunity</reportType>
142 <showDetails>true</showDetails>
143</Report>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。