サンプル

このセクションでは、Google Sheets API に慣れるために使用できる Codelabを紹介します。また、Google スプレッドシートの目的のアクションを API リクエストに変換する方法を示す「レシピ」の例も用意されています。

多くの場合、API を使用して特定のタスクを完了する方法は複数あります。タスクへのアプローチ方法を決定する際は、次の点に注意してください。

  • セルの値を読み書きする必要がある場合は、 spreadsheets コレクションよりも spreadsheets.values コレクションを使用することをおすすめします。前者のインターフェースは、単純な読み取り/書き込みオペレーションで使いやすくなっています。

  • 可能な限り、バッチメソッド (spreadsheet.batchUpdate, spreadsheet.values.batchGet, および spreadsheet.values.batchUpdate) を使用して、複数のリクエストを 1 つのメソッド呼び出しにまとめます。これらのバッチメソッドを使用すると、次のような理由で効率が向上します。

    • クライアントの HTTP オーバーヘッドが削減されます。
    • クエリの数が減ります。
    • ドキュメントのリビジョンの数が減ります。
    • バッチ内のすべての変更のアトミック性が確保されます。

レシピ

このセクションに記載されている例では、スプレッドシートの一般的なアクションを Sheets API v4 リクエストとして表現する方法を示します。

これらの例は、言語に依存しない HTTP リクエストの形式で示されています。Google API クライアント ライブラリを使用して、特定の言語で Sheets API リクエスト プロトコルを実装する方法については、セルの値を読み書きするガイドとスプレッドシートを更新するガイドをご覧ください。

このセクションのレシピは、次のカテゴリに分類されています。