> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 概要

> セル検索、範囲ロックなどの機能を提供し、データ同期、レポート生成、オフィス自動化などのシーンに適しています。

スプレッドシート OpenAPI は、RESTful スタイルのインターフェースを提供しており、開発者はプログラムから DingTalk スプレッドシートドキュメントを操作できます。これらのインターフェースを使用することで、データの自動読み書き、ワークシート管理、セル検索、範囲ロックなどの機能を実装でき、データ同期、レポート生成、オフィス自動化などのシーンに適しています。

## オープン概要

スプレッドシートは豊富なオープン API を提供しており、開発者はビジネスに応じて選択できます。

### ワークシート

| **API**                                                       | **API 説明**                                | **API バージョン** |
| ------------------------------------------------------------- | ----------------------------------------- | ------------- |
| [ワークシートを作成](/ja/open/development/create-a-worksheet)          | スプレッドシートドキュメント内に新しいワークシートを作成します。          | 新バージョン        |
| [ワークシートを削除](/ja/open/development/delete-classic-workbooks)    | スプレッドシート内の特定のワークシートを削除します。                | 新バージョン        |
| [ワークシートを取得](/ja/open/development/obtain-worksheet-properties) | 特定のワークシートの属性を取得します。                       | 新バージョン        |
| [ワークシートを更新](/ja/open/development/update-worksheet)            | DingTalk スプレッドシート内の指定したワークシートのメタ属性を変更します。 | 新バージョン        |
| [すべてのワークシートを取得](/ja/open/development/obtain-all-worksheets)   | 指定したスプレッドシート内のすべてのワークシート情報を取得します。         | 新バージョン        |

### 行と列

| **API**                                                          | **API 説明**                                                         | **API バージョン** |
| ---------------------------------------------------------------- | ------------------------------------------------------------------ | ------------- |
| [行を削除](/ja/open/development/delete-row)                          | 指定した行を削除します。                                                       | 新バージョン        |
| [列を削除](/ja/open/development/delete-column)                       | 指定した列を削除します。                                                       | 新バージョン        |
| [行の高さを自動設定](/ja/open/development/set-row-height-automatically)   | 指定したフォントサイズに基づいて、DingTalk スプレッドシート内の指定した行の高さを自動調整し、コンテンツを完全に表示します。 | 新バージョン        |
| [列幅を一括設定](/ja/open/development/api-setcolumnswidth)              | DingTalk スプレッドシート内の指定した列から始まる連続する複数列の幅を一度に設定します。                   | 新バージョン        |
| [行の高さを一括設定](/ja/open/development/api-setrowsheight)              | DingTalk スプレッドシート内の指定した行から始まる連続する複数行の高さを一度に設定します。                  | 新バージョン        |
| [ワークシートに行を追加](/ja/open/development/append-line)                  | ワークシートの既存データの末尾に複数行のデータを追加します。                                     | 新バージョン        |
| [行の非表示または表示を設定](/ja/open/development/set-row-visibility)         | 行の非表示または通常表示を設定します。                                                | 新バージョン        |
| [列の非表示または表示を設定](/ja/open/development/set-column-visibility)      | 列の非表示または通常表示を設定します。                                                | 新バージョン        |
| [指定行の上に複数行を挿入](/ja/open/development/insert-rows-before-rows)     | 指定した行の上に複数行を挿入します。                                                 | 新バージョン        |
| [指定列の左に複数列を挿入](/ja/open/development/insert-column-before-column) | 指定した列の左に複数列を挿入します。                                                 | 新バージョン        |

### セル範囲

| **API**                                                           | **API 説明**                                            | **API バージョン** |
| ----------------------------------------------------------------- | ----------------------------------------------------- | ------------- |
| [セルの結合](/ja/open/development/merge-cells)                         | DingTalk スプレッドシート内の指定範囲にある複数のセルを 1 つに結合します。           | 新バージョン        |
| [ドロップダウンリストを挿入](/ja/open/development/insert-drop-down-list)       | DingTalk スプレッドシート内の指定したセル範囲にドロップダウンリストの選択肢を設定します。     | 新バージョン        |
| [ドロップダウンリストを削除](/ja/open/development/delete-drop-down-list)       | DingTalk スプレッドシート内の指定したセル範囲に設定されたドロップダウンリストの設定を削除します。 | 新バージョン        |
| [セル範囲を取得](/ja/open/development/get-cell-properties)               | セルの属性を取得します。                                          | 新バージョン        |
| [セル範囲を更新](/ja/open/development/update-cell-properties)            | セル情報を更新します。                                           | 新バージョン        |
| [ワークシート内のセルを検索](/ja/open/development/find-the-next-eligible-cell) | 指定した条件に基づいて、与えられた文字列に一致する次のセルを検索します。                  | 新バージョン        |
| [条件に一致するすべてのセルを検索](/ja/open/development/find-all-matching-cells)  | 指定したワークシート内で対象テキストを含むセルを検索し、一致するセルの位置情報リストを返します。      | 新バージョン        |
| [セル範囲内のデータをクリア](/ja/open/development/clear-cell-data)             | セル範囲内のデータをクリアします。書式は含みません。                            | 新バージョン        |
| [セル範囲内のすべてのコンテンツをクリア](/ja/open/development/clear-all)             | セル範囲内のすべてのコンテンツ（書式を含む）をクリアします。                        | 新バージョン        |

### 条件付き書式

| **API**                                                                  | **API 説明**                                     | **API バージョン** |
| ------------------------------------------------------------------------ | ---------------------------------------------- | ------------- |
| [条件付き書式ルールを作成](/ja/open/development/create-conditional-formatting-rules) | DingTalk スプレッドシートの指定したワークシート内に条件付き書式ルールを作成します。 | 新バージョン        |

### 絞り込み

| **API**                                                  | **API 説明**                                                | **API バージョン** |
| -------------------------------------------------------- | --------------------------------------------------------- | ------------- |
| [絞り込みを作成](/ja/open/development/api-createfilter)         | DingTalk スプレッドシートの指定したワークシート上にグローバル絞り込みを作成し、絞り込み範囲を指定します。 | 新バージョン        |
| [絞り込みを更新](/ja/open/development/api-updatefilter)         | グローバル絞り込み内の複数列のフィルターを一度に一括更新します。                          | 新バージョン        |
| [絞り込みを削除](/ja/open/development/api-deletefilter)         | 指定したワークシート上のグローバル絞り込みを削除し、フィルターによって非表示になっていたすべての行を再表示します。 | 新バージョン        |
| [絞り込みを取得](/ja/open/development/api-getfilter)            | 指定したワークシート上で現在有効なグローバル絞り込み情報を取得します。                       | 新バージョン        |
| [絞り込みの並び替え](/ja/open/development/api-sortfilter)         | グローバル絞り込み範囲内のデータを指定列で昇順または降順に並び替えます。                      | 新バージョン        |
| [フィルターを設定](/ja/open/development/api-setfiltercriteria)   | グローバル絞り込み内の指定列に対してフィルターを設定または更新します。                       | 新バージョン        |
| [フィルターを削除](/ja/open/development/api-clearfiltercriteria) | グローバル絞り込み内の指定列のフィルターをクリアし、その列を絞り込み計算から除外します。              | 新バージョン        |

### 絞り込みビュー

| **API**                                                              | **API 説明**                                                   | **API バージョン** |
| -------------------------------------------------------------------- | ------------------------------------------------------------ | ------------- |
| [絞り込みビューを作成](/ja/open/development/api-createfilterview)              | DingTalk スプレッドシートの指定したワークシート上に絞り込みビューを作成し、ビュー名と絞り込み範囲を指定します。 | 新バージョン        |
| [絞り込みビューを更新](/ja/open/development/api-updatefilterview)              | 指定した絞り込みビューの名前、範囲、またはフィルターを更新します。                            | 新バージョン        |
| [絞り込みビューを削除](/ja/open/development/api-deletefilterview)              | 指定したワークシート上の特定の絞り込みビューおよびそのすべてのフィルターを削除します。                  | 新バージョン        |
| [絞り込みビューリストを取得](/ja/open/development/api-getfilterviews)             | 指定したワークシート上のすべての絞り込みビューのリストを取得します。                           | 新バージョン        |
| [絞り込みビューのフィルターを設定](/ja/open/development/api-setfilterviewcriteria)   | 指定した絞り込みビュー内の特定列に対してフィルターを設定または更新します。                        | 新バージョン        |
| [絞り込みビューのフィルターを削除](/ja/open/development/api-clearfilterviewcriteria) | 指定した絞り込みビュー内の特定列のフィルターをクリアし、その列を絞り込み計算から除外します。               | 新バージョン        |

### フローティング画像

| **API**                                                   | **API 説明**                                               | **API バージョン** |
| --------------------------------------------------------- | -------------------------------------------------------- | ------------- |
| [フローティング画像を作成](/ja/open/development/api-createfloatimage) | DingTalk スプレッドシートの指定したワークシート内のすべてのフローティング画像のリスト情報を取得します。 | 新バージョン        |
| [フローティング画像を更新](/ja/open/development/api-updatefloatimage) | DingTalk スプレッドシート内の既存のフローティング画像の属性を更新します。                | 新バージョン        |
| [フローティング画像を削除](/ja/open/development/api-deletefloatimage) | DingTalk スプレッドシートの指定したワークシート内のフローティング画像を 1 枚削除します。       | 新バージョン        |

## 用語解説

### workbookId

スプレッドシートファイルの一意の識別子です。ナレッジベース API が返す `nodeId`（`dentryUuid`）であり、スプレッドシートの URL から取得することもできます。取得方法は以下のとおりです。

* **方法 1**：スプレッドシートの URL から取得します。

* **方法 2**：ドキュメント情報から取得します。

* **方法 3**：ナレッジベース API を通じて取得します。

  [ノードを取得](/ja/open/development/get-knowledge-base-acquisition-node)または[ナレッジベースドキュメントを作成](/ja/open/development/create-team-space-document)インターフェースを呼び出すと、返される `nodeId`（`dentryUuid`）が `workbookId` となります。

### sheetId

ワークシートの ID または名前です。[すべてのワークシートを取得](/ja/open/development/obtain-all-worksheets)インターフェースで取得するか、ワークシートのタイトルを直接指定できます。

### rangeAddress

セル範囲のアドレスです。A1 表記を使用します。

### operatorId

操作者の `unionId` です。操作を実行するユーザーの身元と権限の検証に使用されます。
