Google Tasks API V1(Java)を使用して、
タスクを作成・更新・削除する方法
についてご紹介します。
APIを利用する環境の準備から始める場合や、コードを実行する際は、
⧉[Google Tasks API(V1)] JavaでTasks APIを使う
を参照ください。
| No | 目次 | |
|---|---|---|
| 1 | タスクを作成 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 | |
| 2 | タスクを上書き | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 | |
| 3 | タスクを更新 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 | |
| 4 | タスクを削除 | |
| 1 | スコープ | |
| 2 | 実行 | |
| 3 | レスポンスの内容 |
1. タスクを作成
指定したタスクリストに新しいタスクに追加します。
1.1. スコープ
このAPIを実行するには、以下のスコープを指定してください。
TasksScopes.TASKS
⧉[Google Tasks API(V1)] JavaでTasks APIを使う(2.2 Tasksインスタンスを取得)
でスコープを指定してください。
1.2. 実行
public static void main(String[] args) throws Exception{
Tasks tasks = getTasks();
Tasks.TasksOperations op = tasks.tasks();
Task content = new Task();
Tasks.TasksOperations.Insert insert = op.insert("タスクリストID",content);
Task res = insert.execute();
System.out.println(res);
}
1.2.1. HTTPリクエスト
POST: https://tasks.googleapis.com/tasks/v1/lists/{タスクリストID}/tasks
が実行されます。
1.2.2. クエリパラメータ
Tasks.TasksOperations.Insertのsetメソッドにより、クエリパラメータを追加できます。
| メソッド | 引数 | 説明 |
|---|---|---|
| setParent | String | 親のタスクID |
| setPrevious | String | 前の兄弟タスクID |
1.2.3. リクエストボディ
Taskのsetメソッドにより、リクエストボディを追加できます。
| メソッド | 引数 | 説明 |
|---|---|---|
| setTitle | String | タスクのタイトル |
| setNotes | String | タスクについてのメモ |
| setStatus | String | タスクのステータス "needsAction"、"completed" |
| setDue | String | タスクの期限 |
| setCompleted | String | タスクの完了日 |
| setDeleted | Boolean | タスクが削除されたか |
1.3. レスポンスの内容
Task
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getKind | String | リソースの種類 固定文字列:"tasks#task" |
| getId | String | タスクID |
| getEtag | String | Eタグ |
| getTitle | String | タスクのタイトル |
| getUpdated | String | タスクの最終更新日時 |
| getSelfLink | String | このタスクを指すURL |
| getParent | String | 親のタスクID |
| getPosition | String | 同じ親タスクの下または最上位にある兄弟タスク間のタスクの位置 |
| getNotes | String | タスクについてのメモ |
| getStatus | String | タスクのステータス "needsAction"、"completed" |
| getDue | String | タスクの期限 |
| getCompleted | String | タスクの完了日 |
| getDeleted | Boolean | タスクが削除されたか |
| getHidden | Boolean | タスクが非表示か |
| getLinks | List<Linkes | リンク情報 |
| getWebViewLink | String | GoogleToDoリストのタスクURL |
Linkes
| メソッド | 戻り値 | 説明 |
|---|---|---|
| getType | String | リンクの種類 |
| getDescription | String | 説明文(HTML) |
| link | String | URL |
2. タスクを上書き
指定したタスクを上書きします。
2.2.3. リクエストボディ(Task)のsetId()は必須です。
タスクIDを2度指定することになりますが、指定がないと例外になります。
3. タスクを更新と違うところは、
指定した存在するタスクをタスクに置き換えます。
2.1. スコープ
このAPIを実行するには、以下のスコープを指定してください。
TasksScopes.TASKS
⧉[Google Tasks API(V1)] JavaでTasks APIを使う(2.2 Tasksインスタンスを取得)
でスコープを指定してください。
2.2. 実行
public static void main(String[] args) throws Exception{
Tasks tasks = getTasks();
Tasks.TasksOperations op = tasks.tasks();
Task content = new Task();
content.setId("タスクID");
Tasks.TasksOperations.Update update = op.update("タスクリストID","タスクID",content);
Task res = update.execute();
System.out.println(res);
}
2.2.1. HTTPリクエスト
PUT: https://tasks.googleapis.com/tasks/v1/lists/{タスクリストID}/tasks/{タスクID}
が実行されます。
2.2.2. クエリパラメータ
クエリパラメータはありません。
2.2.3. リクエストボディ
Taskのsetメソッドにより、リクエストボディを追加できます。
1.2.3. リクエストボディと同じです。
2.3. レスポンスの内容
Task
1.3. レスポンスの内容(Task)と同じです。
3. タスクを更新
指定したタスクを更新します。
2. タスクを上書きと違うところは、
指定した存在するタスクリストを更新します。
3.1. スコープ
このAPIを実行するには、以下のスコープを指定してください。
TasksScopes.TASKS
⧉[Google Tasks API(V1)] JavaでTasks APIを使う(2.2 Tasksインスタンスを取得)
でスコープを指定してください。
3.2. 実行
public static void main(String[] args) throws Exception{
Tasks tasks = getTasks();
Tasks.TasksOperations op = tasks.tasks();
Task content = new Task();
Tasks.TasksOperations.Patch patch = op.patch("タスクリストID","タスクID",content);
Task res = patch.execute();
System.out.println(res);
}
3.2.1. HTTPリクエスト
PATCH: https://tasks.googleapis.com/tasks/v1/lists/{タスクリストID}/tasks/{タスクID}
が実行されます。
3.2.2. クエリパラメータ
クエリパラメータはありません。
3.2.3. リクエストボディ
Taskのsetメソッドにより、リクエストボディを追加できます。
1.2.3. リクエストボディと同じです。
3.3. レスポンスの内容
Task
1.3. レスポンスの内容(Task)と同じです。
4. タスクを削除
指定したタスクを削除します。
4.1. スコープ
このAPIを実行するには、以下のスコープを指定してください。
TasksScopes.TASKS
⧉[Google Tasks API(V1)] JavaでTasks APIを使う(2.2 Tasksインスタンスを取得)
でスコープを指定してください。
4.2. 実行
public static void main(String[] args) throws Exception{
Tasks tasks = getTasks();
Tasks.TasksOperations op = tasks.tasks();
Tasks.TasksOperations.Delete delete = op.delete("タスクリストID","タスクID");
delete.execute();
}
4.2.1. HTTPリクエスト
DELETE: https://tasks.googleapis.com/tasks/v1/lists/{タスクリストID}/tasks/{タスクID}
が実行されます。
4.2.2. クエリパラメータ
クエリパラメータはありません。
4.2.3. リクエストボディ
リクエスボディはありません。
4.3. レスポンスの内容
レスポンスはありません。
削除に失敗した場合、例外が発生します。
おしまい。。