Advanced Google Workspace Events サービスを使用すると、Apps Script で Google Workspace Events API を使用できます。この API を使用すると、関心のある関連イベントを受信できるように、Google Workspace リソースに登録できます。イベントは、リソースの作成、更新、削除など、リソースに対する変更を表します。
前提条件
- Apps Script によって自動的に作成されるデフォルトのプロジェクトではなく、標準の Google Cloud プロジェクトを使用する Apps Script プロジェクト。
- サブスクリプション イベントを受信するために同じ Google Cloud プロジェクトに作成された Pub/Sub トピック。Pub/Sub トピックを作成するには、Pub/Sub トピックを作成してサブスクライブするをご覧ください。
- Chat イベントに登録するには、Google Cloud コンソールの Chat API 構成ページで Google Chat アプリが構成されている必要があります。Google Chat アプリを作成するには、Apps Script を使用して Google Chat アプリを作成するをご覧ください。
Apps Script プロジェクトの
appsscript.json
ファイルに追加された必要な承認スコープ。必要なスコープは、サブスクリプションのターゲット リソースとイベントのタイプによって異なります。詳しくは、Google Workspace Events API スコープを選択するをご覧ください。次に例を示します。"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
リファレンス
このサービスの詳細については、Google Workspace Events API のリファレンス ドキュメントをご覧ください。Apps Script のすべての拡張サービスと同様に、Google Workspace イベント サービスでも公開 API と同じオブジェクト、メソッド、パラメータが使用されます。
サンプルコード
これらのサンプルは、拡張サービスを使用して、一般的な Google Workspace Events API アクションを実行する方法を示しています。
サブスクリプションを作成する
Google Workspace リソースのサブスクリプションを作成するには、次の関数を Apps Script プロジェクトのコードに追加します。
サブスクリプションの一覧表示
イベントタイプとターゲット リソースでフィルタされたサブスクリプションを一覧表示するには、次の関数を Apps Script プロジェクトのコードに追加します。
サブスクリプションの取得
サブスクリプションに関する情報を取得するには、次の関数を Apps Script プロジェクトのコードに追加します。
サブスクリプションを更新
サブスクリプションを更新または更新するには、次の関数を Apps Script プロジェクトのコードに追加します。
定期購入を再開する
サブスクリプションを再度有効にするには、次の関数を Apps Script プロジェクトのコードに追加します。
サブスクリプションの削除
サブスクリプションを削除するには、次の関数を Apps Script プロジェクトのコードに追加します。
オペレーションの取得
ほとんどの Google Workspace Events API メソッドは、長時間実行オペレーションを返します。オペレーションのステータスを確認するには、operations.get()
メソッドを使用します。
オペレーションに関する情報を取得するには、次の関数を Apps Script プロジェクトのコードに追加します。
オペレーションの名前を取得するには、Google Workspace Events API メソッド(subscriptions.create()
や subscriptions.patch()
など)のいずれかから返された name
フィールドの値を使用します。