Excel でブック関数を使用する

  • [アーティクル]

Excel のブック関数と Microsoft Graph を使用すると、次の構文 POST /me/drive/root/workbook/functions/{function-name}を使用して任意のブック関数を呼び出すことができます。 JSON オブジェクトを使用して、本文に関数引数を指定します。 関数の結果としての value および任意の error 文字列が、関数の結果のオブジェクトに返されます。 null の error 値は、関数の実行が成功したことを示します。

サポートされている関数の完全な一覧については、「 Excel.Functions クラス」を参照してください。 特定のパラメーター名とデータ型については関数のシグネチャを参照してください。

重要

  • 範囲入力パラメーターは、範囲のアドレス文字列ではなく、range オブジェクトを使用して提供されます。
  • Index パラメーターは、API のほとんどで使用されている 0 オリジンとは異なり、1 オリジンのインデックス (添字が 1 から始まる) です。

例: vlookup

Excel スプレッドシートで、vlookup 関数は次の引数を取ります。

  • lookup_value (必須): 検索する値。

  • table_array (必須): 参照値が配置されているセルの範囲。 参照値は、 VLOOKUP が正しく機能する範囲の最初の列に常に存在する必要があります。 たとえば、参照値がセル C2 にある場合、範囲は C で始まる必要があります。

  • col_index_num (必須): 戻り値を含む範囲内の列番号。 たとえば、B2: D11 を範囲として指定すると、B を最初の列、C を 2 番目の列というようにカウントする必要があります。

  • range_lookup (省略可能): VLOOKUP で近似値と完全一致のどちらを検索するかを指定する論理値。 戻り値として近似一致を使用する場合は TRUE を指定し、完全一致を必要とする場合は FALSE を指定します。 何も指定しない場合、既定値は常に TRUE または近似一致になります。

セル内では、vlookup 関数は次のようになります。

=VLOOKUP(ルックアップ値、ルックアップ値を含む範囲、戻り値を含む範囲内の列番号、必要に応じて近似一致の場合は TRUE、完全一致の場合は FALSE を指定)

詳細については、 VLOOKUP Excel 関数のドキュメントを参照してください。

要求

次の例では、Excel REST API で vlookup 関数を呼び出し、これらのパラメーターを渡す方法を示しています。

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/vlookup
content-type: Application/Json
authorization: Bearer {access-token}
workbook-session-id: {session-id}

{
    "lookupValue": "Temperature",
    "tableArray": { "Address": "Sheet1!E1:G5" },
    "colIndexNum": 2,
    "rangeLookup": false
}

応答

HTTP code: 200 OK
content-type: application/json;odata.metadata

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
    "@odata.type": "#microsoft.graph.workbookFunctionResult",
    "@odata.id": "/users('f6d92604-4b76-4b70-9a4c-93dfbcc054d5')/drive/root/workbook/functions/vlookup()",
    "error": null,
    "value": "28.3"
}

例: median

Excel スプレッドシートでは、median 関数は 1 つ以上の入力範囲の配列を取ります。

セル内では、median 関数は次の例のようになります。

=MEDIAN(A2:A6)

詳細については、 MEDIAN Excel 関数のドキュメントを参照してください。

要求

次の例では、Excel REST API で median 関数と 1 つ以上の入力範囲を呼び出す方法を示しています。

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/median
content-type: Application/Json
authorization: Bearer {access-token}
workbook-session-id: {session-id}

{
"values" :  [
        { "address": "Sheet2!A1:A5" },
        { "address": "Sheet2!B1:B5" },
      ]
}

応答

HTTP code: 200 OK
content-type: application/json;odata.metadata

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
  "@odata.type": "#microsoft.graph.workbookFunctionResult",
  "@odata.id": "/users('2abcad6a-2fca-4b6e-9577-e358a757d77d')/drive/root/workbook/functions/median()",
  "error": null,
  "value": 30
}

関連コンテンツ