この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。
リソースタイプ
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 を基準とします。 | ||
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 リソースの詳細については、リソース表現ページをご覧ください。
メソッド | 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 メソッドを呼び出します。 |
import |
POST /calendars/calendarId/events/import
|
イベントをインポートします。このオペレーションは、既存の予定の非公開コピーをカレンダーに追加するために使用します。インポートできるのは、eventType が 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 イベントは移動できません。
必須のクエリ パラメータ:
|
patch |
PATCH /calendars/calendarId/events/eventId
|
イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値が既存の値に置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされます。これにより、以前の配列要素は破棄されます。 |
quickAdd |
POST /calendars/calendarId/events/quickAdd
|
単純なテキスト文字列に基づいてイベントを作成します。
必須のクエリ パラメータ:
|
update |
PUT /calendars/calendarId/events/eventId
|
イベントを更新します。このメソッドはパッチのセマンティクスをサポートしておらず、常にイベント リソース全体を更新します。部分更新を行うには、get を実行してから、etags を使用して update を実行し、アトミック性を保証します。 |
watch |
POST /calendars/calendarId/events/watch
|
Events リソースの変更を監視します。 |
予定の有無
Freebusy リソースの詳細については、リソース表現ページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
特に明記されていない限り、URI は https://www.googleapis.com/calendar/v3 を基準とします。 | ||
query |
POST /freeBusy
|
一連のカレンダーの予定の有無に関する情報を返します。 |
設定
Settings リソースの詳細については、リソース表現ページをご覧ください。