リクエスト
HTTP リクエスト
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
calendarId |
string |
カレンダー ID。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのメイン カレンダーにアクセスするには、「primary 」キーワードを使用します。
|
省略可能なクエリ パラメータ | ||
conferenceDataVersion |
integer |
API クライアントでサポートされている会議データのバージョン番号。バージョン 0 では、会議データのサポートがないと想定され、イベントの本文内の会議データは無視されます。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用して新しい会議の作成がサポートされています。デフォルトは 0 です。有効な値は 0 以上 1 以下です。
|
maxAttendees |
integer |
レスポンスに含める参加者の最大数。指定した人数を超える場合は、参加者のみが返されます。省略可能。 |
sendNotifications |
boolean |
非推奨です。代わりに sendUpdates を使用してください。 新しいイベントの作成に関する通知を送信するかどうか。なお、この値を false に設定しても、一部のメールは送信されることがあります。デフォルトは false です。 |
sendUpdates |
string |
新しいイベントの作成に関する通知を送信するかどうか。なお、一部のメールについては引き続き送信される場合があります。デフォルトは false です。有効な値は次のとおりです。
|
supportsAttachments |
boolean |
オペレーションを実行する API クライアントがイベント アタッチメントをサポートしているかどうか。省略可。デフォルトは False です。 |
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
範囲 |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
リクエストの本文には、以下のプロパティを使用して Events リソースを指定します。
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
必須プロパティ | |||
end |
nested object |
イベントの終了時刻(終了時間は含まない)。繰り返しの予定の場合は、最初のインスタンスの終了時間です。 | |
start |
nested object |
イベントの開始時間(両端を含む)。定期的な予定の場合、これは最初のインスタンスの開始時間です。 | |
省略可能なプロパティ | |||
anyoneCanAddSelf |
boolean |
誰でもイベントに自分自身を招待できるかどうか(非推奨)。省略可。デフォルトは False です。 | 書き込み可能 |
attachments[].fileUrl |
string |
添付ファイルへの URL リンク。 Google ドライブのファイル添付ファイルを追加する場合は、Drive API の 添付ファイルを追加する際に必要です。 |
書き込み可能 |
attendees[] |
list |
イベントの参加者。他のカレンダー ユーザーとの予定のスケジュール設定について詳しくは、参加者がいる予定のガイドをご覧ください。参加者リストを追加するには、サービス アカウントがドメイン全体の権限の委任を使用する必要があります。 | 書き込み可能 |
attendees[].additionalGuests |
integer |
追加のゲストの人数。省略可。デフォルトは 0 です。 | 書き込み可能 |
attendees[].comment |
string |
参加者の回答コメント。省略可。 | 書き込み可能 |
attendees[].displayName |
string |
参加者の名前(該当する場合)。省略可。 | 書き込み可能 |
attendees[].email |
string |
参加者のメールアドレス(利用可能な場合)。このフィールドは、参加者を追加する際に指定する必要があります。RFC5322 に準拠した有効なメールアドレスにする必要があります。 参加者を追加する際に必要です。 |
書き込み可能 |
attendees[].optional |
boolean |
参加者が任意かどうか。省略可。デフォルトは False です。 | 書き込み可能 |
attendees[].resource |
boolean |
参加者がリソースかどうか。参加者がイベントに初めて追加されたときにのみ設定できます。その後の変更は無視されます。省略可。デフォルトは False です。 | 書き込み可能 |
attendees[].responseStatus |
string |
参加者のレスポンス ステータス。指定できる値は次のとおりです。
|
書き込み可能 |
birthdayProperties |
nested object |
誕生日や特別なイベントのデータ。eventType が "birthday" の場合に使用されます。変更できません。 |
書き込み可能 |
birthdayProperties.type |
string |
誕生日や特別なイベントの種類。有効な値は次のとおりです。
"birthday" の予定の作成のみをサポートしています。イベントの作成後にタイプを変更することはできません。 |
書き込み可能 |
colorId |
string |
イベントの色。これは、色定義の event セクションのエントリを参照する ID です( 色エンドポイントをご覧ください)。省略可。 |
書き込み可能 |
conferenceData |
nested object |
Google Meet 会議の詳細など、会議関連の情報。新しい会議の詳細を作成するには、createRequest フィールドを使用します。変更を保持するには、すべてのイベント変更リクエストで conferenceDataVersion リクエスト パラメータを 1 に設定してください。 |
書き込み可能 |
description |
string |
イベントの説明。HTML を含めることができます。省略可。 | 書き込み可能 |
end.date |
date |
終日イベントの場合は、「yyyy-mm-dd」形式の日付。 | 書き込み可能 |
end.dateTime |
datetime |
日時を組み合わせた値(RFC3339 に従ってフォーマット)。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
end.timeZone |
string |
時間を指定するタイムゾーン。(IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich)。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 | 書き込み可能 |
eventType |
string |
イベントの特定のタイプ。イベントの作成後に変更することはできません。有効な値は次のとおりです。
|
書き込み可能 |
extendedProperties.private |
object |
このカレンダーに表示される予定のコピーに固有のプロパティ。 | 書き込み可能 |
extendedProperties.shared |
object |
他の参加者のカレンダーの予定のコピー間で共有されるプロパティ。 | 書き込み可能 |
focusTimeProperties |
nested object |
サイレント モードのイベントデータ。eventType が focusTime の場合に使用されます。 |
書き込み可能 |
gadget.display |
string |
ガジェットの表示モード。非推奨です。指定できる値は次のとおりです。
|
書き込み可能 |
gadget.height |
integer |
ガジェットの高さ(ピクセル単位)。高さには 0 より大きい整数を指定してください。省略可。サポート終了。 | 書き込み可能 |
gadget.iconLink |
string |
ガジェットのアイコンの URL。URL スキームは HTTPS にする必要があります。サポート終了。 | 書き込み可能 |
gadget.link |
string |
ガジェットの URL。URL スキームは HTTPS にする必要があります。サポート終了。 | 書き込み可能 |
gadget.preferences |
object |
設定] をクリックします。 | 書き込み可能 |
gadget.title |
string |
ガジェットのタイトル。サポート終了。 | 書き込み可能 |
gadget.type |
string |
ガジェットのタイプ。サポート終了。 | 書き込み可能 |
gadget.width |
integer |
ガジェットの幅(ピクセル単位)。幅には 0 より大きい整数を指定してください。省略可。サポート終了。 | 書き込み可能 |
guestsCanInviteOthers |
boolean |
主催者以外の参加者がイベントに他のユーザーを招待できるかどうか。省略可。デフォルトは True です。 | 書き込み可能 |
guestsCanModify |
boolean |
主催者以外の参加者がイベントを変更できるかどうか。省略可。デフォルトは False です。 | 書き込み可能 |
guestsCanSeeOtherGuests |
boolean |
主催者以外の参加者がイベントの参加者を確認できるかどうか。省略可。デフォルトは True です。 | 書き込み可能 |
id |
string |
イベントのオペーク識別子。新しい単発イベントまたは繰り返しイベントを作成するときに、ID を指定できます。指定する ID は、次のルールに従っている必要があります。
ID を指定しない場合、ID はサーバーによって自動的に生成されます。
|
書き込み可能 |
location |
string |
イベントの地理的位置(自由形式のテキスト)。省略可。 | 書き込み可能 |
originalStartTime.date |
date |
終日イベントの場合は、「yyyy-mm-dd」形式の日付。 | 書き込み可能 |
originalStartTime.dateTime |
datetime |
日時を組み合わせた値(RFC3339 に従ってフォーマット)。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
originalStartTime.timeZone |
string |
時間を指定するタイムゾーン。(IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich)。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 | 書き込み可能 |
outOfOfficeProperties |
nested object |
不在の予定データ。eventType が outOfOffice の場合に使用されます。 |
書き込み可能 |
recurrence[] |
list |
RFC5545 で指定されている、繰り返しイベントの RRULE、EXRULE、RDATE、EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は使用できません。イベントの開始時間と終了時間は start フィールドと end フィールドで指定します。単一の予定または定期的な予定の場合、このフィールドは省略されます。 |
書き込み可能 |
reminders.overrides[] |
list |
イベントでデフォルトのリマインダーを使用していない場合は、イベントに固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことを示します。オーバーライド リマインダーの最大数は 5 つです。 | 書き込み可能 |
reminders.overrides[].method |
string |
このリマインダーで使用されるメソッド。指定できる値は次のとおりです。
リマインダーを追加する場合に必須です。 |
書き込み可能 |
reminders.overrides[].minutes |
integer |
リマインダーを通知するイベントの開始までの分数。有効な値は 0 ~ 40320(4 週間分)です。 リマインダーを追加する場合に必須です。 |
書き込み可能 |
reminders.useDefault |
boolean |
カレンダーのデフォルトのリマインダーを予定に適用するかどうか。 | 書き込み可能 |
sequence |
integer |
iCalendar のシーケンス番号。 | 書き込み可能 |
source.title |
string |
ソースのタイトル(ウェブページのタイトルやメールの件名など)。 | 書き込み可能 |
source.url |
string |
リソースを参照するソースの URL。URL スキームは HTTP または HTTPS にする必要があります。 | 書き込み可能 |
start.date |
date |
終日イベントの場合は、「yyyy-mm-dd」形式の日付。 | 書き込み可能 |
start.dateTime |
datetime |
結合された日時の値で表される時刻(RFC3339 の形式)。タイムゾーンが timeZone で明示的に指定されていない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
start.timeZone |
string |
時間を指定するタイムゾーン。(IANA タイムゾーン データベース名の形式で指定します。例: Europe/Zurich)。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 | 書き込み可能 |
status |
string |
イベントのステータス。省略可。指定できる値は次のとおりです。
|
書き込み可能 |
summary |
string |
イベントのタイトル。 | 書き込み可能 |
transparency |
string |
予定がカレンダーで時間をブロックするかどうか。省略可。有効な値は次のとおりです。
|
書き込み可能 |
visibility |
string |
イベントの公開設定。省略可。有効な値は次のとおりです。
|
書き込み可能 |
workingLocationProperties |
nested object |
勤務場所のイベントデータ。 | 書き込み可能 |
workingLocationProperties.customLocation |
object |
これが存在する場合は、ユーザーがカスタムの場所で作業していることを指定します。 | 書き込み可能 |
workingLocationProperties.customLocation.label |
string |
追加情報のためのオプションの追加ラベル。 | 書き込み可能 |
workingLocationProperties.homeOffice |
any value |
指定されている場合、ユーザーが在宅勤務中であることを指定します。 | 書き込み可能 |
workingLocationProperties.officeLocation |
object |
これが存在する場合は、ユーザーがオフィスで勤務していることを指定します。 | 書き込み可能 |
workingLocationProperties.officeLocation.buildingId |
string |
建物の識別子(省略可)。これは、組織のリソース データベース内のビルディング ID を参照する必要があります。 | 書き込み可能 |
workingLocationProperties.officeLocation.deskId |
string |
デスクの識別子(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorId |
string |
フロア識別子(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorSectionId |
string |
フロア セクションの識別子(省略可)。 | 書き込み可能 |
workingLocationProperties.officeLocation.label |
string |
カレンダーのウェブ クライアントとモバイル クライアントに表示されるオフィス名。組織のリソース データベース内の建物名を参照することをおすすめします。 | 書き込み可能 |
workingLocationProperties.type |
string |
勤務地のタイプ。指定できる値は次のとおりです。
勤務場所のプロパティを追加する場合は必須です。 |
書き込み可能 |
レスポンス
成功すると、このメソッドはレスポンスの本文で Events リソースを返します。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
// Refer to the Java quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/java // Change the scope to CalendarScopes.CALENDAR and delete any stored // credentials. Event event = new Event() .setSummary("Google I/O 2015") .setLocation("800 Howard St., San Francisco, CA 94103") .setDescription("A chance to hear more about Google's developer products."); DateTime startDateTime = new DateTime("2015-05-28T09:00:00-07:00"); EventDateTime start = new EventDateTime() .setDateTime(startDateTime) .setTimeZone("America/Los_Angeles"); event.setStart(start); DateTime endDateTime = new DateTime("2015-05-28T17:00:00-07:00"); EventDateTime end = new EventDateTime() .setDateTime(endDateTime) .setTimeZone("America/Los_Angeles"); event.setEnd(end); String[] recurrence = new String[] {"RRULE:FREQ=DAILY;COUNT=2"}; event.setRecurrence(Arrays.asList(recurrence)); EventAttendee[] attendees = new EventAttendee[] { new EventAttendee().setEmail("lpage@example.com"), new EventAttendee().setEmail("sbrin@example.com"), }; event.setAttendees(Arrays.asList(attendees)); EventReminder[] reminderOverrides = new EventReminder[] { new EventReminder().setMethod("email").setMinutes(24 * 60), new EventReminder().setMethod("popup").setMinutes(10), }; Event.Reminders reminders = new Event.Reminders() .setUseDefault(false) .setOverrides(Arrays.asList(reminderOverrides)); event.setReminders(reminders); String calendarId = "primary"; event = service.events().insert(calendarId, event).execute(); System.out.printf("Event created: %s\n", event.getHtmlLink());
Python
Python クライアント ライブラリを使用します。
# Refer to the Python quickstart on how to setup the environment: # https://developers.google.com/calendar/quickstart/python # Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any # stored credentials. event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': False, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, } event = service.events().insert(calendarId='primary', body=event).execute() print 'Event created: %s' % (event.get('htmlLink'))
PHP
PHP クライアント ライブラリを使用します。
// Refer to the PHP quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/php // Change the scope to Google_Service_Calendar::CALENDAR and delete any stored // credentials. $event = new Google_Service_Calendar_Event(array( 'summary' => 'Google I/O 2015', 'location' => '800 Howard St., San Francisco, CA 94103', 'description' => 'A chance to hear more about Google\'s developer products.', 'start' => array( 'dateTime' => '2015-05-28T09:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'end' => array( 'dateTime' => '2015-05-28T17:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'recurrence' => array( 'RRULE:FREQ=DAILY;COUNT=2' ), 'attendees' => array( array('email' => 'lpage@example.com'), array('email' => 'sbrin@example.com'), ), 'reminders' => array( 'useDefault' => FALSE, 'overrides' => array( array('method' => 'email', 'minutes' => 24 * 60), array('method' => 'popup', 'minutes' => 10), ), ), )); $calendarId = 'primary'; $event = $service->events->insert($calendarId, $event); printf('Event created: %s\n', $event->htmlLink);
Ruby
Ruby クライアント ライブラリを使用します。
event = Google::Apis::CalendarV3::Event.new( summary: 'Google I/O 2015', location: '800 Howard St., San Francisco, CA 94103', description: 'A chance to hear more about Google\'s developer products.', start: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T09:00:00-07:00', time_zone: 'America/Los_Angeles' ), end: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T17:00:00-07:00', time_zone: 'America/Los_Angeles' ), recurrence: [ 'RRULE:FREQ=DAILY;COUNT=2' ], attendees: [ Google::Apis::CalendarV3::EventAttendee.new( email: 'lpage@example.com' ), Google::Apis::CalendarV3::EventAttendee.new( email: 'sbrin@example.com' ) ], reminders: Google::Apis::CalendarV3::Event::Reminders.new( use_default: false, overrides: [ Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'email', minutes: 24 * 60 ), Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'popup', minutes: 10 ) ] ) ) result = client.insert_event('primary', event) puts "Event created: #{result.html_link}"
.NET
.NET クライアント ライブラリを使用します。
// Refer to the .NET quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/dotnet // Change the scope to CalendarService.Scope.Calendar and delete any stored // credentials. Event newEvent = new Event() { Summary = "Google I/O 2015", Location = "800 Howard St., San Francisco, CA 94103", Description = "A chance to hear more about Google's developer products.", Start = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T09:00:00-07:00"), TimeZone = "America/Los_Angeles", }, End = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T17:00:00-07:00"), TimeZone = "America/Los_Angeles", }, Recurrence = new String[] { "RRULE:FREQ=DAILY;COUNT=2" }, Attendees = new EventAttendee[] { new EventAttendee() { Email = "lpage@example.com" }, new EventAttendee() { Email = "sbrin@example.com" }, }, Reminders = new Event.RemindersData() { UseDefault = false, Overrides = new EventReminder[] { new EventReminder() { Method = "email", Minutes = 24 * 60 }, new EventReminder() { Method = "sms", Minutes = 10 }, } } }; String calendarId = "primary"; EventsResource.InsertRequest request = service.Events.Insert(newEvent, calendarId); Event createdEvent = request.Execute(); Console.WriteLine("Event created: {0}", createdEvent.HtmlLink);
Go
Go クライアント ライブラリを使用します。
// Refer to the Go quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/go // Change the scope to calendar.CalendarScope and delete any stored credentials. event := &calendar.Event{ Summary: "Google I/O 2015", Location: "800 Howard St., San Francisco, CA 94103", Description: "A chance to hear more about Google's developer products.", Start: &calendar.EventDateTime{ DateTime: "2015-05-28T09:00:00-07:00", TimeZone: "America/Los_Angeles", }, End: &calendar.EventDateTime{ DateTime: "2015-05-28T17:00:00-07:00", TimeZone: "America/Los_Angeles", }, Recurrence: []string{"RRULE:FREQ=DAILY;COUNT=2"}, Attendees: []*calendar.EventAttendee{ &calendar.EventAttendee{Email:"lpage@example.com"}, &calendar.EventAttendee{Email:"sbrin@example.com"}, }, } calendarId := "primary" event, err = srv.Events.Insert(calendarId, event).Do() if err != nil { log.Fatalf("Unable to create event. %v\n", err) } fmt.Printf("Event created: %s\n", event.HtmlLink)
JavaScript
JavaScript クライアント ライブラリを使用します。
// Refer to the JavaScript quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/js // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'} ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10} ] } }; var request = gapi.client.calendar.events.insert({ 'calendarId': 'primary', 'resource': event }); request.execute(function(event) { appendPre('Event created: ' + event.htmlLink); });
Node.js
Node.js クライアント ライブラリを使用します。
// Refer to the Node.js quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/node // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, }; calendar.events.insert({ auth: auth, calendarId: 'primary', resource: event, }, function(err, event) { if (err) { console.log('There was an error contacting the Calendar service: ' + err); return; } console.log('Event created: %s', event.htmlLink); });
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。