Apps Script の高度なサービスを使用すると、経験豊富なデベロッパーは、HTTP インターフェースを使用する場合よりも少ない設定で、特定の公開 Google API に接続できます。拡張サービスは、基本的にこれらの Google API をラップしたものです。これらのサービスは、Apps Script の組み込みサービスとよく似ています。たとえば、自動入力が提供され、Apps Script が認可フローを自動的に処理します。ただし、スクリプトで拡張サービスを使用できるようにするには、拡張サービスを有効にする必要があります。
拡張サービスとして利用可能な Google API を確認するには、リファレンスの Google 拡張サービスのセクションをご覧ください。上級者向けサービスとして利用できない Google API を使用する場合は、他の外部 API と同様に接続します。
高度なサービスと HTTP のどちらですか?
各 Google 拡張サービスは、公開 Google API に関連付けられています。Apps Script では、これらの API にアクセスするには、拡張サービスを使用するか、UrlFetch
を使用して API リクエストを直接送信します。
高度なサービス メソッドを使用する場合、Apps Script は承認フローを処理し、自動入力をサポートします。ただし、使用する前に拡張サービスを有効にする必要があります。また、一部の高度なサービスでは、API で利用可能な機能のサブセットのみが提供されます。
UrlFetch
メソッドを使用して API に直接アクセスする場合は、基本的に Google API を外部 API として扱います。この方法では、API のすべての側面を使用できます。ただし、API の認可はご自身で処理する必要があります。また、必要なヘッダーを作成して API レスポンスを解析する必要があります。
一般的に、可能な限り拡張サービスを使用し、拡張サービスで必要な機能が提供されない場合にのみ UrlFetch
メソッドを使用するのが最も簡単です。
要件
高度なサービスを使用するには、次の要件を満たす必要があります。
- スクリプト プロジェクトで拡張サービスを有効にする必要があります。
スクリプトで使用する Cloud Platform(GCP)プロジェクトで、高度なサービスに対応する API が有効になっていることを確認する必要があります。
スクリプト プロジェクトで 2019 年 4 月 8 日以降に作成されたデフォルトの GCP プロジェクトを使用している場合、拡張サービスを有効にしてスクリプト プロジェクトを保存すると、API が自動的に有効になります。まだ同意していない場合は、Google Cloud と Google APIs の利用規約に同意するよう求められることもあります。
スクリプト プロジェクトで 標準の GCP プロジェクトまたは古いデフォルトの GCP プロジェクトを使用している場合は、GCP プロジェクトで高度なサービスの対応する API を有効にする必要があります。この変更を行うには、GCP プロジェクトに対する編集権限が必要です。
詳細については、Cloud Platform プロジェクトをご覧ください。
高度なサービスを有効にする
高度な Google サービスを利用する手順は次のとおりです。
- Apps Script プロジェクトを開きます。
- 左側の [エディタ] をクリックします。
- 左側の [サービス] の横にある [サービスを追加] をクリックします。
- 高度な Google サービスを選択し、[追加] をクリックします。
高度なサービスを有効にすると、そのサービスが自動入力で使用できるようになります。
メソッド シグネチャの決定方法
高度なサービスは通常、対応する公開 API と同じオブジェクト、メソッド名、パラメータを使用しますが、メソッド シグネチャは Apps Script で使用するために変換されます。通常、スクリプト エディタの自動補完機能には、開始に必要な情報が十分に含まれていますが、以下のルールでは、Apps Script が公開 Google API からメソッド シグネチャを生成する方法について説明します。
Google API へのリクエストでは、パスパラメータ、クエリ パラメータ、リクエスト本文、メディア アップロード アタッチメントなど、さまざまな種類のデータを受け付けることができます。一部の高度なサービスでは、特定の HTTP リクエスト ヘッダーを受け入れることもできます(カレンダーの高度なサービスなど)。
Google Apps Script の対応するメソッド シグネチャには、次の引数があります。
- リクエスト本文(通常はリソース)を JavaScript オブジェクトとして指定します。
- パスまたは必須パラメータ(個別の引数として)。
- メディア アップロード アタッチメント(
Blob
引数)。 - オプション パラメータ(パラメータ名を値にマッピングする JavaScript オブジェクト)。
- HTTP リクエスト ヘッダー(ヘッダー名をヘッダー値にマッピングする JavaScript オブジェクト)。
メソッドに特定のカテゴリの項目がない場合、その部分はシグネチャから省略されます。
ただし、次のような特別な例外があります。
- メディア アップロードを受け入れることができるメソッドの場合、パラメータ
uploadType
は自動的に設定されます。 - Google API で
delete
という名前の関数は、JavaScript の予約語であるため、Apps Script ではremove
という名前になります。delete
- 高度なサービスが HTTP リクエスト ヘッダーを受け入れるように構成されていて、リクエスト ヘッダーの JavaScript オブジェクトを設定している場合は、オプション パラメータの JavaScript オブジェクトも設定する必要があります(オプション パラメータを使用していない場合は空のオブジェクトに設定します)。
高度なサービスのサポート
拡張サービスは、Apps Script 内で Google API を使用できるようにするシンラッパーにすぎません。そのため、使用中に発生する問題は通常、Apps Script 自体の問題ではなく、基盤となる API の問題です。
上級者向けサービスを使用しているときに問題が発生した場合は、基盤となる API のサポート手順に沿って報告する必要があります。これらのサポート手順へのリンクは、Apps Script のリファレンス セクションの各拡張サービス ガイドに記載されています。