Excel でセッションと永続化を管理する

アプリケーションで Microsoft Graph で Excel API を複数呼び出す必要がある場合は、セッションを作成し、各要求でセッション ID を渡します。要求にセッション ID が存在すると、可能な限り最も効率的な方法で Excel API を使用できるようになります。

Excel API は、次の 3 つのモードのいずれかで呼び出すことができます。

永続的なセッション: ブックに加えられたすべての変更は、ブックに保存 (保存) されます。これは、最も効率的でパフォーマンスの高い Excel API の使用方法です。
非永続的セッション: API によって行われた変更は、ソースの場所には保存されません。代わりに、その特定の API セッション中に加えられた変更を反映するファイルの一時コピーが Excel のバックエンドサーバーに保持されます。 Excel のセッションの有効期限が切れると、変更は失われます。分析を行ったり、計算の結果やグラフのイメージを取得したりする必要があるが、ドキュメントの状態に影響を与える必要がないアプリでは、このモードが便利です。
セッションレス： API 呼び出しはセッション ID を渡しません。 Excel サーバーは、各操作のブックのサーバーのコピーを見つける必要があります。これは、効率的な Excel API の呼び出し方法ではありませんが、ある種の独立した要求を行うのに適しています。

API でセッションを表すには、workbook-session-id: {session-id} ヘッダーを使用します。

注:

Excel API を機能させるには、セッションヘッダーは必要ありません。しかし、パフォーマンスを向上させるためにセッションヘッダーを使用することをお勧めします。セッションヘッダーを使用しない場合は、API の呼び出し時に行われた変更がファイルに永続化されます。

要求の種類

Excel API の推奨されるエラー処理は、要求の種類、エラーコード、および状態コードに基づいています。要求の種類を次に示します。

CreateSession 要求: 永続的セッションまたは非永続的セッションを作成するために使用されます。成功した応答では、応答本文の id プロパティにセッション ID が返されます。詳細については、「セッションの作成」を参照してください。
セッションフル要求: CreateSession 要求に続く後続の要求。通常、ヘッダーが workbook-session-id: {session-id} 含まれます。例外は、実行時間の長い操作パターンを使用するポーリング状態要求です。詳細については、「完了するまでに時間がかかる API の操作」を参照してください。
セッションレス要求: セッションレスモードで使用されます。これらの要求にはヘッダーがありません workbook-session-id: {session-id} 。

セッションの作成方法と使用方法については、セッション作成のリファレンストピックを参照してください。