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

ReportMetadata クラス

表形式レポート、サマリーレポート、マトリックスレポートのレポートメタデータが含まれます。

名前空間

使用方法

レポートメタデータは、レポートに保存されるレポートタイプ、レポート形式、集計項目、行グルーピングまたは列グルーピング、検索条件などの、レポート全体についての情報を提供します。ReportMetadata クラスを使用して、レポートメタデータを取得し、使用可能なメタデータを設定してレポートを絞り込むことができます。

ReportMetadata のメソッド

ReportMetadata のメソッドは次のとおりです。すべてインスタンスメソッドです。

getAggregates()

レポートの集計項目またはカスタム集計項目の一意の識別子を返します。

構文

public LIST<String> getAggregates()

戻り値

型: List<String>

使用方法

次に例を示します。

a!Amount は、[金額] 列の平均を表します。
s!Amount は、[金額] 列の合計を表します。
m!Amount は、[金額] 列の最小値を表します。
x!Amount は、[金額] 列の最大値を表します。
s!<customfieldID> は、カスタム項目列の合計を表します。カスタム項目およ��カスタムレポートタイプの場合、識別子は集計種別と項目 ID の組み合わせになります。

getBuckets()

レポート内のバケット項目のリストを返します。

署名

public List<Reports.BucketField> getBuckets()

戻り値

型: List<Reports.BucketField>

getCrossFilters()

レポートに適用されているクロス条件に関する情報を返します。

署名

public Reports.CrossFilter getCrossFilters()

戻り値

型: List<Reports.CrossFilter>

getCurrencyCode()

マルチ通貨が有効になっている組織のレポートの通貨 (USD、EUR、または GBP など) を返します。組織でマルチ通貨が有効になっていない場合、値は null になります。

構文

public String getCurrencyCode()

戻り値

型: String

getCustomSummaryFormula()

レポートのカスタム集計項目に関する情報を返します。

署名

public Map<String,Reports.ReportCsf> getCustomSummaryFormula()

戻り値

型: Map<String,Reports.ReportCsf>

getDescription()

レポートの説明を返します。

署名

public String getDescription()

戻り値

型: String

getDetailColumns()

詳細データを含む項目の一意の API 名 (列名) を返します。たとえば、このメソッドは「OPPORTUNITY_NAME, TYPE, LEAD_SOURCE, AMOUNT」という値を返します。

構文

public LIST<String> getDetailColumns()

戻り値

型: List<String>

getDeveloperName()

レポートの API 名を返します。たとえば、このメソッドは「Closed_Sales_This_Quarter」という値を返します。

構文

public String getDeveloperName()

戻り値

型: String

getDivision()

レポートで指定されたディビジョンを返します。

標準の検索条件を使用しているレポート (「私のケース」、「私のチームの取引先」など) には、すべてのディビジョンのレコードが表示されます。これらのレポートは、特定のディビジョンに制限することはできません。

メモ

署名

public String getDivision()

戻り値

型: String

getGroupingsAcross()

レポートの列のグルーピングを返します。

構文

public LIST<Reports.GroupingInfo> getGroupingsAcross()

戻り値

型: List<Reports.GroupingInfo>

使用方法

識別子は次のようになります。

サマリー形式のレポートの空の配列 (サマリーレポートには列のグルーピングが含まれないため)
バケット項目の BucketField_(ID)
カスタム項目の ID (列のグルーピングにカスタム項目が使用されている場合)

getGroupingsDown()

レポートの行のグルーピングを返します。

構文

public LIST<Reports.GroupingInfo> getGroupingsDown()

戻り値

型: List<Reports.GroupingInfo>

使用方法

識別子は次のようになります。

バケット項目の BucketField_(ID)
カスタム項目の ID (グルーピングにカスタム項目が使用されている場合)

getHasDetailRows()

レポートに詳細行があるかどうかを示します。

署名

public Boolean getHasDetailRows()

戻り値

型: Boolean

getHasRecordCount()

レポートにレコードの合計数を表示するかどうかを示します。

署名

public Boolean getHasRecordCount()

戻り値

型: Boolean

getHistoricalSnapshotDates()

履歴スナップショット日のリストを返します。

構文

public LIST<String> getHistoricalSnapshotDates()

戻り値

型: List<String>

getId()

一意のレポート ID を返します。

構文

public Id getId()

戻り値

型: Id

getName()

レポート名を返します。

構文

public String getName()

戻り値

型: String

getReportBooleanFilter()

カスタム項目検索条件を解析するためのロジックを返します。検索条件ロジックが指定されていない場合、値は null になります。

構文

public String getReportBooleanFilter()

戻り値

型: String

getReportFilters()

項目名、検索条件の演算子、および検索条件値と共にレポートの各カスタム検索条件のリストを返します。

構文

public LIST<Reports.ReportFilter> getReportFilters()

戻り値

型: List<Reports.ReportFilter>

getReportFormat()

レポートの形式を返します。

構文

public Reports.ReportFormat getReportFormat()

戻り値

型: Reports.ReportFormat

使用方法

この値は、次のようになります。

TABULAR
SUMMARY
MATRIX

getReportType()

レポートタイプの一意の API 名と表示名を返します。

構文

public Reports.ReportType getReportType()

戻り値

型: Reports.ReportType

getScope()

レポートに定義された範囲の API 名を返します。範囲の値はレポートタイプに応じて異なります。

署名

public String getScope()

戻り値

型: String

getShowGrandTotal()

レポートに総計を表示するかどうかを示します。

署名

public Boolean getShowGrandTotal()

戻り値

型: Boolean

getShowSubtotals()

列の合計や行の合計など、レポートに小計を表示するかどうかを示します。

署名

public Boolean getShowSubtotals()

戻り値

型: Boolean

getSortBy()

レポートを並べ替える列のリストを返します。現在は 1 つの列のみに基づいて並べ替えることができます。

署名

public List<Reports.SortColumn> getSortBy()

戻り値

型: List<Reports.SortColumn>

getStandardDateFilter()

開始日、終了日、日付範囲、日付項目の API 名など、レポートの標準の日付検索条件に関する情報を返します。

署名

public Reports.StandardDateFilter getStandardDateFilter()

戻り値

型: Reports.StandardDateFilter

getStandardFilters()

レポートの標準の検索条件のリストを返します。

署名

public List<Reports.StandardFilter> getStandardFilters()

戻り値

型: List<Reports.StandardFilter>

getTopRows()

返される行数と並べ替え順など、行制限の検索条件に関する情報を返します。

署名

public Reports.TopRows getTopRows()

戻り値

型: Reports.TopRows

setAggregates(aggregates)

レポートの標準またはカスタムの集計項目に一意の識別子を設定します。

署名

public void setAggregates(List<String> aggregates)

パラメーター

aggregates: 型: List<String>

戻り値

型: void

setBuckets(buckets)

レポートにバケット項目を作成します。

署名

public void setBuckets(List<Reports.BucketField> buckets)

パラメーター

buckets: 型: List<Reports.BucketField>

戻り値

型: void

setCrossFilters(crossFilters)

レポートにクロス条件を適用します。

署名

public void setCrossFilters(List<Reports.CrossFilter> crossFilters)

パラメーター

crossFilter: 型: List<Reports.CrossFilter>

戻り値

型: void

setCurrencyCode(currencyCode)

マルチ通貨が有効になっている組織のレポート集計項目の通貨 (USD、EUR、GBP など) を設定します。

署名

public void setCurrencyCode(String currencyCode)

パラメーター

currencyCode: 型: String

戻り値

型: void

setCustomSummaryFormula(customSummaryFormula)

カスタム集計項目をレポートに追加します。

署名

public void setCustomSummaryFormula(MAP<String,Reports.ReportCsf> customSummaryFormula)

パラメーター

customSummaryFormula: 型: Map<String,Reports.ReportCsf>

戻り値

型: void

setDescription(description)

レポートの説明を設定します。

署名

public void setDescription(String description)

パラメーター

description: 型: String

戻り値

型: void

setDetailColumns(detailColumns)

詳細データを含む項目の一意の API 名 (OPPORTUNITY_NAME、TYPE、LEAD_SOURCE、AMOUNT など) を設定します。

署名

public void setDetailColumns(List<String> detailColumns)

パラメーター

detailColumns: 型: List<String>

戻り値

型: void

setDeveloperName(developerName)

レポートの API 名 (Closed_Sales_This_Quarter など) を返します。

署名

public void setDeveloperName(String developerName)

パラメーター

developerName: 型: String

戻り値

型: void

setDivision(division)

レポートのディビジョンを設定します。

メモ

署名

public void setDivision(String division)

パラメーター

division: 型: String

戻り値

型: void

setGroupingsAcross(groupingInfo)

レポートの列のグルーピングを設定します。

署名

public void setGroupingsAcross(List<Reports.GroupingInfo> groupingInfo)

パラメーター

groupingInfo: 型: List<Reports.GroupingInfo>

戻り値

型: void

setGroupingsDown(groupingInfo)

レポートの行のグルーピングを設定します。

署名

public void setGroupingsDown(List<Reports.GroupingInfo> groupingInfo)

パラメーター

groupingInfo: 型: List<Reports.GroupingInfo>

戻り値

型: void

setHasDetailRows(hasDetailRows)

レポートに詳細行を設定するかどうかを指定します。

署名

public void setHasDetailRows(Boolean hasDetailRows)

パラメーター

hasDetailRows: 型: Boolean

戻り値

型: void

setHasRecordCount(hasRecordCount)

レポートにレコードの合計数の表示を設定するかどうかを指定します。

署名

public void setHasRecordCount(Boolean hasRecordCount)

パラメーター

hasRecordCount: 型: Boolean

戻り値

型: void

setHistoricalSnapshotDates(historicalSnapshot)

履歴スナップショット日のリストを設定します。

構文

public Void setHistoricalSnapshotDates(LIST<String> historicalSnapshot)

パラメーター

historicalSnapshot: 型: List<String>

戻り値

型: Void

setId(id)

一意のレポート ID を設定します。

署名

public void setId(Id id)

パラメーター

id: 型: Id

戻り値

型: void

setName(name)

レポート名を設定します。

署名

public void setName(String name)

パラメーター

name: 型: String

戻り値

型: void

setReportBooleanFilter(reportBooleanFilter)

カスタム項目検索条件を解析するためのロジックを設定します。

構文

public Void setReportBooleanFilter(String reportBooleanFilter)

パラメーター

reportBooleanFilter: 型: String

戻り値

型: Void

setReportFilters(reportFilters)

項目名、検索条件の演算子、および検索条件値と共にレポートの各カスタム検索条件のリストを設定します。

構文

public Void setReportFilters(LIST<Reports.ReportFilter> reportFilters)

パラメーター

reportFilters: 型: List<Reports.ReportFilter>

戻り値

型: Void

setReportFormat(format)

レポートの形式を設定します。

署名

public void setReportFormat(Reports.ReportFormat format)

パラメーター

format: 型: Reports.ReportFormat

戻り値

型: void

setReportType(reportType)

レポートタイプの一意の API 名および表示名を設定します。

署名

public void setReportType(Reports.ReportType reportType)

パラメーター

reportType: 型: Reports.ReportType

戻り値

型: void

setScope(scopeName)

レポートに定義された範囲の API 名を設定します。範囲の値はレポートタイプに応じて異なります。

署名

public void setScope(String scopeName)

パラメーター

scopeName: 型: String

戻り値

型: void

setShowGrandTotal(showGrandTotal)

レポートに総計を表示するかどうかを指定します。

署名

public void setShowGrandTotal(Boolean showGrandTotal)

パラメーター

showGrandTotal: 型: Boolean

戻り値

型: void

setShowSubtotals(showSubtotals)

列の合計や行の合計など、レポートに小計を表示するかどうかを指定します。

署名

public void setShowSubtotals(Boolean showSubtotals)

パラメーター

showSubtotals: 型: Boolean

戻り値

型: void

setSortBy(column)

レポートを並べ替える列のリストを設定します。現在は 1 つの列のみに基づいて並べ替えることができます。

署名

public void setSortBy(List<Reports.SortColumn> column)

パラメーター

column: 型: List<Reports.SortColumn>

戻り値

型: void

setStandardDateFilter(dateFilter)

開始日、終了日、日付範囲、日付項目の API 名など、レポートの標準の日付検索条件を設定します。

署名

public void setStandardDateFilter(Reports.StandardDateFilter dateFilter)

パラメーター

dateFilter: 型: Reports.StandardDateFilter

戻り値

型: void

setStandardFilters(filters)

レポートの標準の検索条件を設定します。

署名

public void setStandardFilters(List<Reports.StandardFilter> filters)

パラメーター

filters: 型: List<Reports.StandardFilter>

戻り値

型: void

setTopRows(topRows)

行制限の検索条件をレポートに適用します。

署名

public Reports.TopRows setTopRows(Reports.TopRows topRows)

パラメーター

topRows: 型: Reports.TopRows

戻り値

型: void

Apex 開発者ガイド

ReportMetadata クラス

名前空間

使用方法

ReportMetadata のメソッド

getAggregates()

構文

戻り値

使用方法

getBuckets()

署名

戻り値

getCrossFilters()

署名

戻り値

getCurrencyCode()

構文

戻り値

getCustomSummaryFormula()

署名

戻り値

getDescription()

署名

戻り値

getDetailColumns()

構文

戻り値

getDeveloperName()

構文

戻り値

getDivision()

署名

戻り値

getGroupingsAcross()

構文

戻り値

使用方法

getGroupingsDown()

構文

戻り値

使用方法

getHasDetailRows()

署名

戻り値

getHasRecordCount()

署名

戻り値

getHistoricalSnapshotDates()

構文

戻り値

getId()

構文

戻り値

getName()

構文

戻り値

getReportBooleanFilter()

構文

戻り値

getReportFilters()

構文

戻り値

getReportFormat()

構文

戻り値

使用方法

getReportType()

構文

戻り値

getScope()

署名

戻り値

getShowGrandTotal()

署名

戻り値

getShowSubtotals()

署名

戻り値

getSortBy()

署名