Gmail API v1（Java）を使用して、
Goolgeフォームの変更監視中のリストを取得する方法
についてご紹介します。
APIを利用する環境の準備から始める場合や、コードを実行する際は、
⧉[Google Forms API(V1)] JavaでForms APIを使う
を参照ください。
| No | 目次 | |
|---|---|---|
| 1 | 監視中リストの取得 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 |
1. 監視中リストの取得
監視中のリストを取得します。
1.1. スコープ
このAPIを実行するには、以下のいずれかのスコープを指定してください。
FormsScopes.DRIVE
FormsScopes.DRIVE_FILE
FormsScopes.DRIVE_READONLY
FormsScopes.FORMS_BODY
FormsScopes.FORMS_BODY_READONLY
FormsScopes.FORMS_RESPONSES_READONLY
⧉[Google Forms API(V1)] JavaでForms APIを使う(2.2 Gmailインスタンスを取得)
でスコープを指定してください。
1.2. 実行
public static void main(String[] args) throws Exception{
Forms forms = getForms();
FormsOperations op = forms.forms();
FormsOperations.Watches watches = op.watches();
FormsOperations.Watches.List list = watches.list("フォームID");
ListWatchesResponse res = list.execute();
System.out.println(res);
}
1.2.1. HTTPリクエスト
GET: https://forms.googleapis.com/v1/forms/{フォームID}/watches
が実行されます。
1.2.2. クエリパラメータ
クエリパラメータはありません。
1.3. レスポンスの内容
ListWatchesResponse
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getWatches | List<Watch> | 監視情報リスト |
Watch
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getId | String | ウォッチID |
| getTarget | WatchTarget | 通知の送信先 |
| getEventType | EventType(enum) | 監視するイベントタイプ |
| getCreateTime | String | 作成された時点のタイムスタンプ |
| getExpireTime | String | 有効期限を示すタイムスタンプ |
| getErrorType | ErrorType(enum) | 試行された配信に対する最新のエラータイプ |
| getState | State(enum) | ウォッチの現在の状態 |
WatchTarget
| メソッド | 引数 | 説明 |
|---|---|---|
| getTopic | CloudPubsubTopic | Pub/Subの設定 |
CloudPubsubTopic
| メソッド | 引数 | 説明 |
|---|---|---|
| getTopicName | String | Pub/Subのトピック名 |
EventType
| 定義値 | 説明 |
|---|---|
| EVENT_TYPE_UNSPECIFIED | 未指定 |
| SCHEMA | コンテンツ設定の変更を通知 |
| RESPONSES | フォームの回答が送信されると通知 |
ErrorType
| 定義値 | 説明 |
|---|---|
| ERROR_TYPE_UNSPECIFIED | 未指定 |
| PROJECT_NOT_AUTHORIZED | 監視対象フォームへのアクセス権がない |
| NO_USER_ACCESS | 監視対象フォームにアクセスできなくなった |
| OTHER_ERRORS | 別のタイプのエラー |
State
| 定義値 | 説明 |
|---|---|
| STATE_UNSPECIFIED | 未指定 |
| ACTIVE | アクティブ |
| SUSPENDED | 停止中(解決可能なエラー発生中) |
おしまい。。