API Reference

この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。

リソースタイプ

  1. ACL
  2. CalendarList
  3. カレンダー
  4. チャンネル
  5. 色
  6. イベント
  7. 予定の有無
  8. 設定

ACL

ACL リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
delete DELETE  /calendars/calendarId/acl/ruleId アクセス制御ルールを削除します。
get GET  /calendars/calendarId/acl/ruleId アクセス制御ルールを返します。
insert POST  /calendars/calendarId/acl アクセス制御ルールを作成します。
list GET  /calendars/calendarId/acl カレンダーのアクセス制御リスト内のルールを返します。
patch PATCH  /calendars/calendarId/acl/ruleId アクセス制御ルールを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値により、既存の値が置き換えられます。リクエストで指定していないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。
update PUT  /calendars/calendarId/acl/ruleId アクセス制御ルールを更新します。
スマートウォッチ POST  /calendars/calendarId/acl/watch ACL リソースの変更に注意してください。

CalendarList

CalendarList リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
delete DELETE  /users/me/calendarList/calendarId ユーザーのカレンダー リストからカレンダーを削除します。
get GET  /users/me/calendarList/calendarId ユーザーのカレンダー リストからカレンダーを返します。
insert POST  /users/me/calendarList 既存のカレンダーをユーザーのカレンダー リストに挿入します。
list GET  /users/me/calendarList ユーザーのカレンダー リストのカレンダーを返します。
patch PATCH  /users/me/calendarList/calendarId ユーザーのカレンダー リストにある既存のカレンダーを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値により、既存の値が置き換えられます。リクエストで指定していないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。
update PUT  /users/me/calendarList/calendarId ユーザーのカレンダー リストにある既存のカレンダーを更新します。
スマートウォッチ POST  /users/me/calendarList/watch CalendarList リソースの変更を監視します。

カレンダー

Calendars リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
クリア POST  /calendars/calendarId/clear メイン カレンダーを消去します。これにより、アカウントのメイン カレンダーに関連付けられているすべての予定が削除されます。
delete DELETE  /calendars/calendarId 予備カレンダーを削除します。メイン カレンダーの予定をすべて消去するには、calendar.clear を使用します。
get GET  /calendars/calendarId カレンダーのメタデータを返します。
insert POST  /calendars 予備カレンダーを作成します。
patch PATCH  /calendars/calendarId カレンダーのメタデータを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値により、既存の値が置き換えられます。リクエストで指定していないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。
update PUT  /calendars/calendarId カレンダーのメタデータを更新します。

チャンネル

Channels リソースの詳細については、リソースの表記をご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
停止 POST  /channels/stop このチャンネルのリソースの視聴を停止します。

色

Colors リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
get GET  /colors カレンダーと予定の色の定義を返します。

イベント

イベント リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
delete DELETE  /calendars/calendarId/events/eventId 予定を削除します。
get GET  /calendars/calendarId/events/eventId Google カレンダー ID に基づいて予定を返します。iCalendar ID を使用してイベントを取得するには、iCalUID パラメータを使用して events.list メソッドを呼び出します。
import POST  /calendars/calendarId/events/import イベントをインポートします。この操作は、既存の予定の限定公開コピーをカレンダーに追加するために使用します。インポートできるのは、eventType が default のイベントのみです。

非推奨の動作: default 以外のイベントをインポートすると、そのイベントが default に変更され、イベントタイプに固有のプロパティはすべて破棄されます。
insert POST  /calendars/calendarId/events イベントを作成します。
instances GET  /calendars/calendarId/events/eventId/instances 指定した定期的な予定のインスタンスを返します。
list GET  /calendars/calendarId/events 指定したカレンダーの予定を返します。
移動 POST  /calendars/calendarId/events/eventId/move 予定を別のカレンダーに移動する（予定の主催者を変更する）。移動できるのは default イベントのみです。outOfOffice、focusTime、workingLocation、fromGmail イベントは移動できません。

必須のクエリ パラメータ: destination
patch PATCH  /calendars/calendarId/events/eventId 予定を更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値により、既存の値が置き換えられます。リクエストで指定していないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。
quickAdd POST  /calendars/calendarId/events/quickAdd 単純なテキスト文字列に基づいてイベントを作成します。

必須のクエリ パラメータ: text
update PUT  /calendars/calendarId/events/eventId 予定を更新します。このメソッドはパッチのセマンティクスをサポートしておらず、常にイベント リソース全体を更新します。部分更新を行うには、アトミック性を確保するために、ETag を使用して get の後に update を実行します。
スマートウォッチ POST  /calendars/calendarId/events/watch イベント リソースの変更を監視します。

予定の有無

Freebusy リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
query POST  /freeBusy 一連のカレンダーの空き時間情報を返します。

設定

Settings リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
get GET  /users/me/settings/setting 単一のユーザー設定を返します。
list GET  /users/me/settings 認証されたユーザーのすべてのユーザー設定を返します。
スマートウォッチ POST  /users/me/settings/watch 設定リソースの変更に注意します。