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

Force.com Apex コード開発���ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

ReportMetadata クラス

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

名前空間

Reports

使用方法

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

ReportMetadata メソッド

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

getAggregates()

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

構文

public LIST<String> getAggregates()

戻り値

型: List<String>

使用方法

次に例を示します。

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

getCurrencyCode()

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

構文

public String getCurrencyCode()

戻り値

型: 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

getGroupingsAcross()

レポートの各列のグルーピングの一意の識別子を返します。

構文

public LIST<Reports.GroupingInfo> getGroupingsAcross()

戻り値

型: List<Reports.GroupingInfo>

使用方法

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

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

getGroupingsDown()

レポートの各行のグルーピングの一意の識別子を返します。

構文

public LIST<Reports.GroupingInfo> getGroupingsDown()

戻り値

型: List<Reports.GroupingInfo>

使用方法

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

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

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

setHistoricalSnapshotDates(LIST<String>)

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

構文

public Void setHistoricalSnapshotDates(LIST<String> historicalSnapshot)

パラメータ

historicalSnapshot
型: List<String>

戻り値

型: Void

setReportBooleanFilter(String)

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

構文

public Void setReportBooleanFilter(String reportBooleanFilter)

パラメータ

reportBooleanFilter
型: String

戻り値

型: Void

setReportFilters(LIST<Reports.ReportFilter>)

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

構文

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

パラメータ

reportFilters
型: List<Reports.ReportFilter>

戻り値

型: Void