PlaidXL カスタム関数
PlaidXL は、PlaidCloud のデータをセルに直接読み込む関数を Excel に追加します。セルに =PLAIDXL. と入力すると、Excel のオートコンプリートに各関数が一覧表示され、各引数の短い説明も表示されます。タスクペインの Formulas タブでも数式を作成できます。タスクペインから数式を挿入するをご覧ください。
| グループ | 関数 | 用途 |
|---|---|---|
| 一覧 | LIST_PROJECTS、TABLE.TBL_LIST、TABLE.GET_COLUMNS、DIMENSION.DIM_LIST |
利用できるものを確認する |
| テーブル | TABLE.GET_TABLE |
テーブル全体を範囲に読み込む |
| 階層 | DIMENSION.GET_DIMENSION、DRILL |
ディメンションのノードをレポートの行としてレイアウトする |
| 値 | CELL、CELLS |
ノードの任意の組み合わせについて集計値を計算する |
| メトリック | METRIC、METRIC_BREAKDOWN |
ダッシュボードに表示されるとおりに、管理されたビジネスメトリックを読み取る |
| 構成要素 | REPR.TABLE_REPR、REPR.MEASURE、REPR.MEASURES、REPR.MEASURE_TYPE、REPR.DIMENSION_REPR、REPR.DRILL_KEY |
CELL、CELLS、DRILL が使うテーブル、メジャー、集計方法、ノード、ドリルの深さを記述する |
レポートを作成するでは、これらを組み合わせて使う例を紹介しています。
関数の仕組み
Section titled “関数の仕組み”- まずサインインします。 関数は、あなたの PlaidCloud サインインと権限で読み取るため、使用する前にタスクペインからサインインしてください。
- ワークブックのプロジェクトから読み取ります。 すべての関数は、タスクペインでワークブックにリンクされたプロジェクトから読み取ります。
GET_TABLE、TBL_LIST、DIM_LISTは、リンクを変えずに別のプロジェクトを読み取るための、省略可能なプロジェクト ID も受け取ります。ワークブックごとに独自のプロジェクトを持つため、開いている 2 つのワークブックが別々のプロジェクトから読み取ることもできます。 - 結果はスピルします。 リストやテーブルを返す関数は、その下(または右)のセルを埋めます。結果のための余白を空けておいてください。何かが邪魔をしていると、Excel に
#SPILL!エラーが表示されます。 - 変更を反映するには再計算します。 PlaidXL の数式は、引数のいずれかが変わると再び取得します。PlaidCloud の新しいデータや、タスクペインでリンクした別のプロジェクトを反映するには、リボンの更新メニューを使います。Recalculate PlaidXL formulas はワークブック内のすべての PlaidXL 数式を再計算し、Refresh this sheet と Refresh selection は、それぞれが対象とする数式を再計算します。Refresh all tables は取得したテーブルを更新するもので、数式は更新しません。更新をご覧ください。
- 正確な名前を使います。 テーブル、列、ディメンション、ノードの名前は、PlaidCloud に表示されるとおりに入力します。
角かっこで囲まれた引数は省略可能です。
LIST_PROJECTS
Section titled “LIST_PROJECTS”=PLAIDXL.LIST_PROJECTS([horizontal])
開けるプロジェクトの名前を、名前順に一覧表示します。
horizontal—TRUEにすると行方向に一覧表示します。デフォルトはFALSEで、列方向です。
TBL_LIST
Section titled “TBL_LIST”=PLAIDXL.TABLE.TBL_LIST([project_id], [horizontal])
プロジェクト内のテーブルの名前を、名前順に一覧表示します。
project_id— 読み取るプロジェクト。デフォルトはワークブックのプロジェクトです。horizontal—TRUEにすると行方向に一覧表示します。デフォルトはFALSEで、列方向です。
GET_COLUMNS
Section titled “GET_COLUMNS”=PLAIDXL.TABLE.GET_COLUMNS(table_name, [column_filter], [orientation])
選択したプロジェクト内のテーブルの列名を一覧表示します。
table_name— PlaidCloud でのテーブル名。column_filter—"text"などのデータ型を指定すると、その型の列だけを一覧表示します。省略するとすべての列を一覧表示します。orientation—"vertical"(デフォルト)は列方向、"horizontal"は行方向です。
DIM_LIST
Section titled “DIM_LIST”=PLAIDXL.DIMENSION.DIM_LIST([project_id], [horizontal])
プロジェクト内のディメンションの名前を一覧表示します。
project_id— 読み取るプロジェクト。デフォルトはワークブックのプロジェクトです。horizontal—TRUEにすると行方向に一覧表示します。デフォルトはFALSEで、列方向です。
GET_TABLE
Section titled “GET_TABLE”=PLAIDXL.TABLE.GET_TABLE(table_name, [project_id], [limit])
テーブルの行をヘッダー行付きで返し、数式のセルからスピルします。空の値は空白のセルとして返されます。
table_name— PlaidCloud でのテーブル名。project_id— 読み取るプロジェクト。デフォルトはワークブックのプロジェクトです。limit— 返す行の最大数。デフォルトは 1,048,575 で、これはワークシートがヘッダー行の下に保持できる最大数です。
GET_TABLE はすべての列を返します。列を選択したり行をフィルターしたりするには、代わりにタスクペインからテーブルを取得してください。
GET_DIMENSION
Section titled “GET_DIMENSION”=PLAIDXL.DIMENSION.GET_DIMENSION(dimension_name, start_node, [hierarchy], [orientation], [generation_limit])
start_node から始めて、その子孫まで下にたどり、ディメンションのノードをレイアウトします。各世代は親より 4 スペース多くインデントされ、Excel のアウトライングループにより各レベルを折りたたんだり展開したりできます。
dimension_name— ディメンションの名前、またはプロジェクト内のパス。start_node— 開始するノード(ディメンションのルートなど)。hierarchy— たどる代替階層。デフォルトは"main"です。orientation—"vertical"(デフォルト)はノードを列方向に、"horizontal"は行方向に一覧表示します。generation_limit— 返す世代数。start_nodeを最初の世代として数えます。2は開始ノードとその子を返します。省略するとすべての世代を返します。
=PLAIDXL.DRILL(dimension_name, start_node, drill_key, [hierarchy], [exclude], [expand], [orientation])
start_node と、drill_key が求めるその下のノードを返し、世代ごとにインデントして Excel のアウトラインでグループ化します。
dimension_name— ディメンションの名前、またはプロジェクト内のパス。start_node— ドリルを開始するノード。空("")にすると、ディメンションの最上位ノードから開始します。ディメンション自体はドリルキーの世代 0 として数えられ、一覧には表示されないため、最上位ノードは世代 1 です。>[1]は最上位ノードだけを一覧表示し、>[0]は何も一覧表示しません。drill_key— どこまでドリルするか。DRILL_KEYで指定します。すべての子孫、リーフのみ、レベル数、または世代の範囲を指定できます。hierarchy— たどる代替階層。デフォルトは"main"です。exclude— 除外するノード(その下のすべてを含む)。ノード、リスト、またはセルの範囲で指定します。開始ノードは除外されません。expand—drill_keyが求める深さより下であっても、子も表示するノード。ノード、リスト、またはセルの範囲で指定します。ドリルが表示するノードだけが開かれるため、孫を開くには、その親も一覧に含めます。orientation—"vertical"(デフォルト)はノードを列方向に一覧表示します。"horizontal"はインデントなしで、列ごとにグループ化して行方向に一覧表示します。それ以外の値はエラーになります。
exclude と expand は、テキストまたは数値としてのノード ID を受け取ります。範囲内の空のセルとエラーは無視されます。引数をスキップするには、=PLAIDXL.DRILL("Period", "FY2026", PLAIDXL.REPR.DRILL_KEY("1 level"), "main", "", "", "horizontal") のように空("")にします。
たとえば、=PLAIDXL.DRILL("Region", "Total", PLAIDXL.REPR.DRILL_KEY("leaves")) は、合計と、その下にあるすべてのリーフ地域を一覧表示します。
ドリルコマンドは DRILL 数式を作成して編集します。ノードを選択して、ドリルダウン、ドリルアップ、ノードの保持や削除を行えます。
CELL と CELLS は、メジャー(テーブルの数値列)を、1 つ以上のディメンションで選択したノードに集計して計算します。それぞれの呼び出しは、レポートの 1 つの交点だと考えてください。たとえば、FY2026 における EMEA の収益です。
交点は、下記の構成要素関数で記述します。通常は別々のセルに置き、それらのセルを CELL または CELLS に任意の順序で渡します。
| 引数 | 作成に使うもの | 必須 |
|---|---|---|
| 読み取るテーブル | TABLE_REPR |
ちょうど 1 つ |
| 集計する列 | CELL には MEASURE、CELLS には MEASURES または複数の MEASURE セル |
はい |
| 集計方法 | MEASURE_TYPE |
いいえ — デフォルトは sum |
| 列に対するフィルター | DIMENSION_REPR |
少なくとも 1 つ、列ごとに 1 つ |
各フィルターは、テーブルの列と値を指定します。その列が PlaidCloud でディメンションにリンクされている場合、値はノードになり、フィルターには、ディメンションのメイン階層(または指定した階層)でそのノードに集計されるすべてが含まれます。地理ディメンションにリンクされた地域列では、ノード EMEA がその下のすべての国を対象にします。ディメンションにリンクされていない列では、フィルターは値と完全に一致するものに一致します。
このページの例では、Region 列と Period 列がディメンションにリンクされているテーブルを使用しています。実際には、ご自身のテーブルの列名を使用してください。
=PLAIDXL.CELL(table, measure, [measure_type], node, [node], ...)
1 つの数値を返します。渡したすべてのノードの下にある行にわたって集計したメジャーです。
A1 =PLAIDXL.REPR.TABLE_REPR("Sales")A2 =PLAIDXL.REPR.MEASURE("revenue")A3 =PLAIDXL.REPR.MEASURE_TYPE("sum")A4 =PLAIDXL.REPR.DIMENSION_REPR("Region", "EMEA")A5 =PLAIDXL.REPR.DIMENSION_REPR("Period", "FY2026")B1 =PLAIDXL.CELL(A1, A2, A3, A4, A5)B1 には、FY2026 の EMEA の収益の合計が表示されます。
CELL に数値を上書き入力すると、PlaidCloud に書き込まれます。PlaidCloud に値を入力するをご覧ください。
CELL 数式が多数あるシートでも高速に計算されます。まとめて計算される CELL 数式は、1 回のリクエストで最大 10,000 件ずつ PlaidCloud に送信され、PlaidXL はテーブルの列の詳細を、セルごとに取得するのではなく 30 秒間再利用します。値を計算できない場合、セルには #VALUE! が表示され、その上にカーソルを置くと、PlaidCloud が報告した理由(テーブルにないフィルター列、メンバーのないノードなど)が表示されます。CELLS は、結果全体について最初の理由を表示します。
一致する行がない場合、sum は 0 です。それ以外の集計方法(mean、median、min、max、std、var)は返す値がないため、CELL には #VALUE! が表示され、カーソルを置くと集計方法、メンバー、メジャーとともに No value for と表示されます。CELLS の要素は空白のままになります。AVERAGE などの Excel 関数は空白の CELLS 要素をスキップし、説明でも同じ理由が表示されます。
=PLAIDXL.CELLS(table, measures, [measure_type], node, [node], ...)
CELL と同様ですが、複数のメジャーを一度に扱います。指定した順に、メジャーごとに 1 つの数値を列方向に返します。
D1:F1 revenue | cost | unitsD2 =PLAIDXL.REPR.MEASURES(D1:F1)B2 =PLAIDXL.CELLS(A1, D2#, A3, A4, A5)D2# は、MEASURES のスピル結果全体を渡します。B2:B4 には、FY2026 の EMEA の収益、コスト、数量が表示されます。
METRIC と METRIC_BREAKDOWN は、ワークブックのプロジェクトからメトリック定義を読み取ります。これは、純収益のように、計算方法が合意されて PlaidCloud に記録されているビジネス上の数値です。値はダッシュボードに表示されるものと同じで、あなた自身の行アクセスのもとで計算されます。リボンの Metric… は、プロジェクトのメトリックを現在の値とともに一覧表示し、数式を作成します。メトリックを挿入するをご覧ください。
フィルターは、CELL と同じ DIMENSION_REPR の値ですが、最初の引数にはメトリックを分解できる列を指定します。ノードには、その下のすべてが含まれます。単一のフィルター、またはフィルターの範囲やリストを渡せます。空のフィルターは無視されます。1 つの数式で、複数の代替階層のフィルターを使用できます。また、代替階層のメンバーを他のディメンションのメンバーと組み合わせることもできます。
METRIC
Section titled “METRIC”=PLAIDXL.METRIC(name, [filter], ...)
1 つの数値を返します。渡したすべてのフィルターに該当する行についてのメトリックです。
name— メトリックの名前、その同義語、またはその ID。大文字と小文字は区別されません。filter—DIMENSION_REPRフィルター。必要な数だけ渡せます。
=PLAIDXL.METRIC("Net Revenue", PLAIDXL.REPR.DIMENSION_REPR("Region", "EMEA"))一致する行がない場合、METRIC は 0 を返します。メトリックに値がない場合、セルは空白になります。
METRIC_BREAKDOWN
Section titled “METRIC_BREAKDOWN”=PLAIDXL.METRIC_BREAKDOWN(name, breakdown, [filter], ...)
メトリックを 1 つの列で分割して返します。2 列で、breakdown の各メンバーとその値が並び、値の大きい順で、ヘッダー行はありません。
name— メトリックの名前、その同義語、またはその ID。breakdown— メトリックを分解する列。メトリックが分解できるものを指定します。filter—DIMENSION_REPRフィルター。必要な数だけ渡せます。
=PLAIDXL.METRIC_BREAKDOWN("Net Revenue", "Region")値のないメンバーは、値を空白にして最後に表示されます。一致する行がない場合は、空のメンバーと 0 の 1 行を返します。
メトリックのエラー
Section titled “メトリックのエラー”計算できないメトリックは #VALUE! を表示します。セルにカーソルを置くと理由が表示されます。
| メッセージ | 対応 |
|---|---|
| 不明なメトリック、または不明な列 | 名前を確認してください。近い候補がある場合は、Did you mean の後にメッセージが一覧表示します。 |
| 名前が複数のメトリックに一致する | メトリックの正式名称または ID を使用してください。 |
| Your PlaidCloud role doesn’t allow reading metrics in this project. | プロジェクトのオーナーにアクセスを依頼してください。 |
| This PlaidCloud workspace doesn’t serve metrics to Excel yet. | 管理者にワークスペースの更新を依頼してください。 |
| PlaidCloud is busy; try again in 秒数 | PlaidXL はすでに再試行しています。表示された時間が経過してから再計算してください。 |
| Choose a project in the PlaidXL pane first. | ワークブックをプロジェクトにリンクしてください。 |
| この PlaidCloud ワークスペースでは、代替階層を他のメンバーと組み合わせることはまだできません。管理者にワークスペースの更新を依頼してください。 | 管理者にワークスペースの更新を依頼してください。同じ再計算内の他のセルは引き続き値を返します。 |
これらの関数自体はデータを読み取りません。それぞれが、計算の一部を記述する短いテキストを返し、CELL、CELLS、DRILL に渡せる状態になっています。参照するセルに置いておくと、たとえば期間を 1 つ変更するだけで、それを使うすべての数式が更新されます。
TABLE_REPR
Section titled “TABLE_REPR”=PLAIDXL.REPR.TABLE_REPR(table_name)
CELL と CELLS が読み取るテーブルを、選択したプロジェクト内の名前で指定します。
MEASURE
Section titled “MEASURE”=PLAIDXL.REPR.MEASURE(column_name)
CELL が集計する数値列です。
MEASURES
Section titled “MEASURES”=PLAIDXL.REPR.MEASURES(column_names)
CELLS 用の複数のメジャー列で、列名が入ったセルの範囲から作成します。結果は列ごとに 1 セルずつスピルします。D2# のようなスピル演算子で CELLS に渡します。
MEASURE_TYPE
Section titled “MEASURE_TYPE”=PLAIDXL.REPR.MEASURE_TYPE(agg_function)
メジャーの集計方法です。agg_function は次のいずれかで、小文字で指定します。
| 値 | 返す値 |
|---|---|
sum |
合計(集計方法を渡さない場合のデフォルト) |
mean |
平均 |
median |
中央値 |
min |
最小値 |
max |
最大値 |
std |
標準偏差 |
var |
分散 |
DIMENSION_REPR
Section titled “DIMENSION_REPR”=PLAIDXL.REPR.DIMENSION_REPR(dimension_name, start_node, [hierarchy])
CELL、CELLS、METRIC、METRIC_BREAKDOWN のフィルターです。フィルターをかけたい列ごとに 1 つ渡します。
dimension_name— テーブルの列の名前で、"Region"のようにディメンションの値を保持する列です。列名と完全に一致している必要があります。テーブルにない列を指定するとエラーが返されます。start_node— 集計先のノード("EMEA"など)。ディメンションにリンクされていない列では、一致させる値です。hierarchy— ノードを集計する代替階層。デフォルトは"main"です。
ノードにセルを参照すると、グリッドを作成できます。=PLAIDXL.REPR.DIMENSION_REPR("Region", $A7) のようにします。前後のスペースは無視されるため、DRILL がレイアウトするインデント付きのノード名を指すこともできます。
DRILL_KEY
Section titled “DRILL_KEY”=PLAIDXL.REPR.DRILL_KEY(d_key)
DRILL が開始ノードの下をどこまで掘り下げるかを指定します。d_key はプレーンテキストで、言葉の形式、または書き出したドリルキーのいずれかです。
d_key |
ドリルの範囲 |
|---|---|
"all" |
すべての子孫 |
"leaves" |
リーフ(その下に何もないノード)のみ |
"1 level"、"2 levels"、… |
その世代数だけ下 |
">[...]" |
次の表のように書き出したドリルキー |
数は数字で書きます。"two levels" ではなく "2 levels" です。先頭の drill は無視されるため、"drill 2 levels" も使えます。
書き出したキーは、開始ノードから下に向かって世代を数えます。開始ノードは世代 0 で、常に含まれます。負の数は各ブランチのリーフから上に向かって数えるため、不揃いな階層でも期待どおりに動作します。
| キー | 含まれるもの |
|---|---|
>[*] または >[:] |
すべてのノード |
>[] または >[-1] |
リーフのみ |
>[n] |
開始ノードと、その下の n 世代。>[0] は開始ノードのみ。 |
>[a:] |
開始ノード、続いて世代 a とその下のすべて |
>[a:b] |
開始ノード、続いて世代 a から b - 1 まで |
>[0:-k] |
開始ノードと、その下に少なくとも k 世代あるすべてのノード。つまり、各ブランチの最後の k 世代は除外されます。>[0:-1] はリーフを除くすべてのノードです。 |
>[a:-k] |
同じ内容で、世代 a から開始 |
階層 A に子 B、C、D があり、B に B1 と B2、C に C1 がある場合:
| キー | 結果 |
|---|---|
>[1] |
A、B、C、D |
>[2] |
A、B、B1、B2、C、C1、D |
>[] |
A、B1、B2、C1、D |
>[0:-1] |
A、B、C |
>[2:] |
A、B1、B2、C1 |
ノードは階層の順に、それぞれ自分の親の下に一覧表示され、Excel のアウトライングループも同じ順序に従います。キー内のスペースは無視されます。これらの形式のいずれにも一致しないキーはエラーを返し、有効な形式が一覧表示されます。
タスクペインから数式を挿入する
Section titled “タスクペインから数式を挿入する”タスクペインの Formulas タブは、数式を作成します。タスクペインから開くか、リボンの Formula… から開くか、PlaidXL の右クリックメニューの Insert formula here… から開きます。What do you want in the cell? の下で、次のいずれかを選択します。
- A whole table(
GET_TABLE) — テーブルを選択または入力し、必要に応じて最大行数を指定します。 - One number(
CELL) — テーブルを選択または入力し、Column to total と How to combine the values を選びます。 - A list of dimension nodes(
DRILL) — ディメンションと開始ノードを選択または入力し、ドリルの範囲を選びます。必要に応じて、Alternate hierarchy、除外するノード、開くノードも指定できます。行数には、ドリルが一覧表示するノードのプレビューが表示されます。カスタムドリルをご覧ください。 - A business metric(
METRIC) — メトリックを挿入するをご覧ください。
Formula のプレビューには、フィールドを入力するたびに結果が表示されます。Insert in active cell をクリックするか Ctrl+Enter を押すと、選択したセルに入力されます。コピーをクリックすると、自分で貼り付けられます。テーブルタブでテーブルを選択するか、ディメンションタブでディメンションを選択すると、対応するフィールドが入力されます。
メトリックを挿入する
Section titled “メトリックを挿入する”リボンの挿入グループで Metric… をクリックするか、Formulas タブで A business metric を選択します。
- Metric に、メトリック名または同義語の一部(
revenueなど)を入力します。一致した各項目に、現在の値と説明が表示されます。 - 矢印キーまたはクリックで、メトリックを選択します。
- 必要に応じて、フィルターを追加します。Dimension を選び、Node を入力して、フィルターを追加をクリックします。
- 必要に応じて、Breakdown by (optional) で列を選択すると、単一の数値ではなく
METRIC_BREAKDOWNが書き込まれます。 - Insert in active cell またはコピーをクリックします。
- レポートを作成する — 左側に階層、上部に値を配置
- テーブルとディメンションを操作する — 関数が読み取るプロジェクトを選択する
- ディメンションの使用 — メイン階層と代替階層、およびノードの集計の仕組み
- ディメンション階層を設計する — レポートが集計される階層を作成する