リクエスト
HTTP リクエスト
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events
パラメータ
| パラメータ名 | 値 | 説明 |
|---|---|---|
| パスパラメータ | ||
calendarId |
string |
カレンダーの識別子。カレンダー 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 |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
リクエストの本文には、以下のプロパティを使用してイベント リソースを指定します。
| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
| 必須プロパティ | |||
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 |
参加者の返答ステータス。有効な値は次のとおりです。
|
書き込み可能 |
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 を指定しない場合、サーバーによって自動的に生成されます。
|
書き込み可能 |
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（省略可）。これは、組織のリソース データベースのビルディング ID を参照している必要があります。 | 書き込み可能 |
workingLocationProperties.officeLocation.deskId |
string |
デスク ID（省略可）。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorId |
string |
階数 ID（省略可）。 | 書き込み可能 |
workingLocationProperties.officeLocation.floorSectionId |
string |
階のセクション ID（省略可）。 | 書き込み可能 |
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 を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。