メタデータ API 開発者ガイド
jAnalyticSnapshot
レポート作成スナップショットを表します。レポート作成スナップショットにより、履歴データに関するレポートを作成できます。承認されたユーザは、表形式のレポートやサマリーレポートの結果をカスタムオブジェクトの項目に保存することができ、それらの項目を対象オブジェクト上の対応する項目に割り当てることができます。その上で、レポートをいつ実行してそのカスタムオブジェクトの項目にレポートのデータを読み込むかをスケジューリングできます。レポート作成スナップショットでは、Salesforce での他のレコード操作と同様にレポートデータを操作できます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
Lightning プラットフォームの AnalyticSnapshot コンポーネントは、対応するパッケージディレクトリの analyticSnapshots ディレクトリに保存されます。ファイル名は、レポート作成スナップショットの一意の名前に一致し、拡張子は .snapshot です。
バージョン
Lightning プラットフォームの AnalyticSnapshot コンポーネントは、API バージョン 16.0 以降で使用できます。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| description | string | レポート作成スナップショットの説明。 |
| fullName | string | API アクセスに使用するレポート作成スナップショット名。名前には文字とアンダースコア (_) 文字のみを含めることができます。文字で始まる必要があり、末尾をアンダースコアにしたり、アンダースコア文字を 2 つ続けて使用したりできません。この項目は、Metadata コンポーネントから継承されています。 |
| groupColumn | string | ソースレポートからのデータ抽出レベルを指定する列。サマリーレポートのみに適用されます。 |
| mappings | AnalyticSnapshotMapping[] | レポート作成スナップショットの対応付けのリスト。有効な値については、「AnalyticSnapshotMapping」を参照してください。 |
| name | string | 必須。レポート作成スナップショットの表示名。 |
| runningUser | string | レポート作成スナップショットを実行するために使用されるロールと共有設定を所有するユーザのユーザ名。 |
| sourceReport | string | 必須。データの抽出元であるレポート。 |
| targetObject | string | 必須。データの挿入先であるカスタムオブジェクト。 |
AnalyticSnapshotMapping
AnalyticSnapshotMapping は、レポート作成スナップショットの対応付けを定義します。有効な値は、次のとおりです。
| 項目 | 項目の型 | 説明 |
|---|---|---|
| aggregateType | ReportSummaryType[] (string 型の列挙) | 各レポート項目が集計されるかどうか、および集計方法を定義するリスト。有効な値については、「ReportSummaryType」を参照してください。 |
| sourceField | string | sourceField は、次のいずれかです。
注意: sourceField は、指定する sourceType に対応している必要があります。 |
| sourceType | ReportJobSourceTypes[] (string 型の列挙) | レポート作成スナップショットのレポート形式を定義するリスト。有効な値については、「ReportJobSourceTypes」を参照してください。 |
| targetField | string | この特定の sourceField の挿入先である targetObject の項目。 |
ReportJobSourceTypes
レポート作成スナップショットのレポート形式を定義する string 型の列挙。有効な値は、次のとおりです。
| 列挙値 | 説明 |
|---|---|
| snapshot | sourceField に JobName、RunningUser、または ExecutionTime などのスナップショット固有の情報が含まれる場合は、このオプションを使用します。 |
| summary | sourceReport の項目の集計 (合計、平均、最小、最大) を参照する場合は、このオプションを使用します。 |
| tabular | sourceReport から使用可能な列を参照する場合は、このオプションを使用します。 |
宣言的なメタデータの定義のサンプル
次に、レポート作成スナップショットの XML 定義のサンプルを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticSnapshot xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>my description</description>
4 <groupColumn>INDUSTRY</groupColumn>
5 <mappings>
6 <aggregateType>Average</aggregateType>
7 <sourceField>SALES</sourceField>
8 <sourceType>summary</sourceType>
9 <targetField> myObject __c.Name</targetField>
10 </mappings>
11 <mappings>
12 <sourceField>ExecutionTime</sourceField>
13 <sourceType>snapshot</sourceType>
14 <targetField> myObject __c.field3__c</targetField>
15 </mappings>
16 <mappings>
17 <sourceField>INDUSTRY</sourceField>
18 <sourceType>tabular</sourceType>
19 <targetField>testObject__c.Name</targetField>
20 </mappings>
21 <name>my snapshot</name >
22 <runningUser>user@salesforce.com</runningUser>
23 <sourceReport>myFolder/mytSummaryReport</sourceReport>
24 <targetObject>myObject__c</targetObject>
25</AnalyticSnapshot>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。