API Reference

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

リソースタイプ

  1. Acl
  2. CalendarList
  3. Calendars
  4. Channels
  5. Colors
  6. Events
  7. Freebusy
  8. Settings

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

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

メソッド HTTP リクエスト 説明
特に記載のない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。
clear 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

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

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

Events

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 を使用して予定を取得するには、events.list メソッドを iCalUID パラメータ を使用して呼び出します。
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 指定したカレンダーの予定を返します。
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 予定を更新します。このメソッドはパッチ セマンティクスをサポートしておらず、常に予定リソース全体を更新します。部分的な更新を行うには、get の後に update を実行し、etags を使用してアトミック性を確保します。
watch POST  /calendars/calendarId/events/watch Events リソースの変更を監視します。

Freebusy

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

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

Settings

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 Settings リソースの変更を監視します。