サンプル

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

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

  • セル値の読み取りまたは書き込みが必要な場合は、spreadsheets コレクションよりも spreadsheets.values コレクションの方が適しています。前者のインターフェースは、単純な読み取り/書き込みオペレーションに適しています。

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

    • クライアントの HTTP オーバーヘッドを削減します。
    • クエリの数を減らします。
    • ドキュメントの変更履歴の数を減らします。
    • バッチ内のすべての変更のアトミック性を確保します。

レシピ

このセクションの例では、Sheets の一般的なアクションを Sheets API v4 リクエストとして表現する方法を示します。

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

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