ブックのリソースの種類

[アーティクル]
03/15/2023

名前空間: microsoft.graph

ワークシート、テーブル、範囲などに関連するブックオブジェクトが含まれる最上位オブジェクトです。

メソッド

メソッド	戻り値の型	説明
セッションを作成する	workbookSessionInfo	永続または非永続セッションを開始するために、ブックセッションを作成します。
セッションを閉じる	なし	既存のセッションを終了します。
セッションを最新の情報に更新	なし	既存のセッションを更新します。

プロパティ

なし

リレーションシップ

リレーションシップ	型	説明
comments	workbookComment コレクション	ブック内のコメントのコレクションを表します。
names	WorkbookNamedItem コレクション	名前付き項目 (名前付き範囲と定数) をスコープとするブックのコレクションを表します。読み取り専用です。
操作	workbookOperation コレクション	ブックの操作の状態です。操作のコレクションを取得することはサポートされていませんが、応答で `Location` ヘッダーが返される場合には、長時間実行処理の状態を取得できます。読み取り専用です。
テーブル	WorkbookTable コレクション	ブックに関連付けられているテーブルのコレクションを表します。読み取り専用。
worksheets	WorkbookWorksheet コレクション	ブックに関連付けられているワークシートのコレクションを表します。読み取り専用です。

関数

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

サポートされている関数の完全な一覧は、こちらです。特定のパラメーター名とデータ型については関数のシグネチャを参照してください。

重要な注意点:

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

例: vlookup

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

参照値とも呼ばれる、検索対象の値。
参照値が所在する範囲。参照値が正しく動作するには、常に VLOOKUP の範囲で参照値が最初の列にある必要があることに留意してください。たとえば、参照値がセル C2 にある場合、範囲は C 列から始まる必要があります。
戻り値を含む範囲の列番号。たとえば、B2: D11 を範囲として指定すると、B を最初の列、C を 2 番目の列というようにカウントする必要があります。
また、戻り値の近似一致を使用する場合は 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
}

JSON 表記

{
  "names": [{"@odata.type": "microsoft.graph.workbookNamedItem"}],
  "tables": [{"@odata.type": "microsoft.graph.workbookTable"}],
  "worksheets": [{"@odata.type": "microsoft.graph.workbookWorksheet"}]
}