セッションを作成するCreate Session

この API を使用して、新しいブック セッションを作成します。Use this API to create a new workbook session.

2 つのモードのいずれかで、Excel API を呼び出すことができます。Excel APIs can be called in one of two modes:

  1. 永続セッション - ブックに加えられたすべての変更は永続化 (保存) されます。これは通常の操作モードです。Persistent session - All changes made to the workbook are persisted (saved). This is the usual mode of operation.
  2. 非永続セッション - API によって加えられた変更は元の場所に保存されません。代わりに、その特定の API セッション中に加えられた変更を反映するファイルの一時コピーが Excel のバックエンド サーバーに保持されます。Excel のセッションの有効期限が切れると、変更は失われます。分析を行ったり、計算の結果やグラフのイメージを取得したりする必要があるものの、ドキュメントの状態には影響を与えないアプリには、このモードが便利です。Non-persistent session - Changes made by the API are not saved to the source location. Instead, the Excel backend server keeps a temporary copy of the file that reflects the changes made during that particular API session. When the Excel session expires, the changes are lost. This mode is useful for apps that need to do analysis or obtain the results of a calculation or a chart image, but not affect the document state.

API でセッションを表すには、workbook-session-id: {session-id} ヘッダーを使用します。To represent the session in the API, use the workbook-session-id: {session-id} header.

注: セッション ヘッダーは Excel API が機能するために必要ではありません。しかし、パフォーマンスを向上させるためにセッション ヘッダーを使用することをお勧めします。セッション ヘッダーを使用しない場合は、API の呼び出し時に行われた変更がファイルに永続化_されます_。Note: The session header is not required for an Excel API to work. However, we recommend that you use the session header to improve performance. If you don't use a session header, changes made during the API call are persisted to the file.

エラー処理Error Handling

この要求に対して、504 HTTP エラーが表示されることがあります。This request might occasionally receive a 504 HTTP error. このエラーに対する適切な対応は、要求を繰り返すことです。The appropriate response to this error is to repeat the request.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Files.ReadWriteFiles.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication サポートされていません。Not supported.

HTTP 要求HTTP request

POST /workbook/createSession

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

要求本文で、WorkbookSessionInfo オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of WorkbookSessionInfo object.

応答Response

成功した場合、このメソッドは 201 Created 応答コードと、応答本文で WorkbookSessionInfo オブジェクトを返します。If successful, this method returns 201 Created response code and WorkbookSessionInfo object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/createSession
Content-type: application/json
Content-length: 52

{
  "persistChanges": true
}

要求本文で、WorkbookSessionInfo オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of WorkbookSessionInfo object.

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json
Content-length: 52

{
  "id": "id-value",
  "persistChanges": true
}