v1 APIは、このウェブサイトから各ジョブを開始するのではなく、独自のコード(アプリケーション、スクリプト、バックオフィスのパイプラインなど)から抽出を実行したい開発者向けです。スプレッドシートのユースケースに対応するGoogle Sheets アドオンとは異なるインターフェースです。このページでは、APIを使用できるユーザーとドキュメントの場所について説明します。APIリファレンス自体は別の場所にあります。
APIの対象者
抽出したデータをスプレッドシートやダウンロードしたファイルではなく、独自のシステムに取り込む必要がある場合は、APIを使用してください。APIを使用すると、プログラムがドキュメントを送信し、処理を開始し、結果を収集できます。バッチごとに人がウェブアプリを操作する必要はありません。すでに使用しているシートに抽出した行を入れるだけでよい場合は、Sheets アドオンの方が簡単です。
開始前に必要なもの
APIは有料プランでのみ利用可能で、Freeプランでは利用できません。Freeアカウントは拒否されます。有効なキーを使用しても、有料プランが必要であるというメッセージが返されます。対象となるプランは次のとおりです。
- Basic、Pro、Max — 個人向け有料プラン。
- Growth、Scale、Enterprise — チームプラン。チームメンバーはチーム所有者のプランの対象となるため、有料チームのメンバーはそのプランを通じてAPIアクセスを利用できます。
アクセスはすべての呼び出しでチェックされ、アクティブなアカウントに属さないキーは拒否されます。
キー自体はアカウントの認証情報であり、プロフィールページから作成および再発行できます。キーの場所と再生成方法については、APIキー管理を参照してください。API用に別のキーは必要ありません。同じキーがGoogle Sheets アドオンの接続にも使用されます。
完全なドキュメントの場所
アクセス以外のすべては、ここではなく開発者ドキュメントサイトにあります。リクエストとレスポンスの形式、エンドポイント、各エンドポイントが受け付けるパラメータ、および実践的な例が含まれています。まずは以下から始めてください。
- API概要 — APIの対象範囲と構成。
- APIクイックスタート — キーから最初の結果までの最短ルート。
このページでは、その内容を意図的に繰り返していません。