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 アクセス制御ルールを更新します。
watch 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 ユーザーのカレンダー リストにある既存のカレンダーを更新します。
watch POST  /users/me/calendarList/watch CalendarList リソースの変更を監視します。

カレンダー

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

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
クリア POST  /calendars/calendarId/clear メイン カレンダーをクリアします。このオペレーションは、アカウントのメイン カレンダーに関連付けられているすべての予定を削除します。
delete DELETE  /calendars/calendarId 予備カレンダーを削除します。メイン カレンダーのすべての予定を消去するには、calendars.clear を使用します。
get GET  /calendars/calendarId カレンダーのメタデータを返します。
insert POST  /calendars セカンダリ カレンダーを作成します。

リクエストの認証済みユーザーが、新しいカレンダーのデータオーナーになります。
patch PATCH  /calendars/calendarId カレンダーのメタデータを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値は、既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされ、以前の配列要素はすべて破棄されます。
update PUT  /calendars/calendarId カレンダーのメタデータを更新します。

Channels

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

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

色

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

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

イベント

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

メソッド 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 メソッドを呼び出します。
インポート POST  /calendars/calendarId/events/import イベントをインポートします。このオペレーションは、既存の予定の非公開コピーをカレンダーに追加するために使用されます。eventType が default のイベントのみをインポートできます。

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

必須のクエリ パラメータ: 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 を実行します。
watch POST  /calendars/calendarId/events/watch Events リソースの変更を監視します。

Freebusy

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 認証されたユーザーのすべてのユーザー設定を返します。
watch POST  /users/me/settings/watch 設定リソースの変更を監視します。