Calendar API には、さまざまな種類の予定リソースが用意されています。詳細については、予定についてをご覧ください。
このリソースのメソッドの一覧は、このページの最後に掲載されています。
リソースの表記
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
anyoneCanAddSelf |
boolean |
自分を予定に招待できるかどうか(サポート終了)。(省略可)デフォルトは False です。 | 書き込み可能 |
attachments[] |
list |
予定の添付ファイル。 添付ファイルを変更するには、 イベントあたりの最大アタッチメント数は 25 個です。 |
|
attachments[].fileId |
string |
添付ファイルの ID。読み取り専用です。 Google ドライブ ファイルの場合、これは Drive API 内の対応する |
|
attachments[].fileUrl |
string |
添付ファイルの URL リンク。 Google ドライブのファイルを追加する場合、Drive API の 添付ファイルを追加する場合に必要です。 |
書き込み可能 |
attachments[].iconLink |
string |
添付ファイルのアイコンへの URL リンク。このフィールドは、カスタムのサードパーティ製添付ファイルでのみ変更できます。 | |
attachments[].mimeType |
string |
添付ファイルのインターネット メディアタイプ(MIME タイプ)。 | |
attachments[].title |
string |
添付ファイルのタイトル。 | |
attendeesOmitted |
boolean |
参加者が出席者から除外されている可能性があるかどうか。イベントを取得する際に、maxAttendee クエリ パラメータで指定された制限が原因である可能性があります。イベントを更新するときにこれを使用して、参加者の返答のみを更新できます。(省略可)デフォルトは False です。 |
書き込み可能 |
attendees[] |
list |
イベントの参加者。他のカレンダー ユーザーとの予定作成について詳しくは、参加者の予定のガイドをご覧ください。サービス アカウントは、出席者リストに入力するために、ドメイン全体の権限を委任する必要があります。 | 書き込み可能 |
attendees[].additionalGuests |
integer |
追加の宿泊客の数。(省略可)デフォルトは 0 です。 | 書き込み可能 |
attendees[].comment |
string |
参加者からのコメント。省略可。 | 書き込み可能 |
attendees[].displayName |
string |
参加者の名前(該当する場合)。省略可。 | 書き込み可能 |
attendees[].email |
string |
参加者のメールアドレス(該当する場合)。参加者を追加するときに、この項目が存在している必要があります。RFC5322 に基づく有効なメールアドレスを入力してください。 参加者を追加するときに必要です。 |
書き込み可能 |
attendees[].id |
string |
参加者のプロフィール ID(ある場合)。 | |
attendees[].optional |
boolean |
オプションの参加者かどうか。(省略可)デフォルトは False です。 | 書き込み可能 |
attendees[].organizer |
boolean |
参加者が予定の主催者かどうか。読み取り専用。デフォルトは False です。 | |
attendees[].resource |
boolean |
参加者がリソースであるかどうか。参加者を予定に初めて追加するときのみ設定できます。それ以降に変更を加えても無視されます。(省略可)デフォルトは False です。 | 書き込み可能 |
attendees[].responseStatus |
string |
参加者の返答ステータス。有効な値は次のとおりです。
|
書き込み可能 |
attendees[].self |
boolean |
このエントリが予定のコピーが表示されているカレンダーを表しているかどうか。読み取り専用。デフォルトは False です。 | |
colorId |
string |
予定の色。色定義の event セクションのエントリを参照する ID(カラー エンドポイントを参照)。省略可。 |
書き込み可能 |
conferenceData |
nested object |
Google Meet の会議の詳細など、会議に関する情報。新しい会議の詳細を作成するには、createRequest フィールドを使用します。変更を保持するには、すべてのイベント変更リクエストで conferenceDataVersion リクエスト パラメータを 1 に設定してください。 |
書き込み可能 |
conferenceData.conferenceId |
string |
会議の ID。 カンファレンスを記録するためにデベロッパーが使用できます。ユーザーに表示しないでください。 ID 値は、会議ソリューションのタイプごとに異なります。
|
|
conferenceData.conferenceSolution |
nested object |
Google Meet などの会議用ソリューション。 作成リクエストに失敗した会議で未設定。
|
|
conferenceData.conferenceSolution.iconUri |
string |
ユーザーに表示される、このソリューションのアイコン。 | |
conferenceData.conferenceSolution.key |
nested object |
このイベントの会議ソリューションを一意に識別できるキー。 | |
conferenceData.conferenceSolution.key.type |
string |
カンファレンスのソリューションの種類です。 クライアントが、よく知られていない型や空の型に遭遇した場合でも、エントリ ポイントを表示できます。ただし、変更を禁止する必要があります。 有効な値は次のとおりです。
|
|
conferenceData.conferenceSolution.name |
string |
このソリューションのユーザーに表示される名前。ローカライズされていません。 | |
conferenceData.createRequest |
nested object |
新しい会議を作成して予定に添付するリクエストです。データは非同期で生成されます。データが存在するかどうかを確認するには、status フィールドを確認します。
|
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
ハングアウトや Google Meet などの会議ソリューション。 | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
カンファレンスのソリューションの種類です。 クライアントが、よく知られていない型や空の型に遭遇した場合でも、エントリ ポイントを表示できます。ただし、変更を禁止する必要があります。 有効な値は次のとおりです。
|
|
conferenceData.createRequest.requestId |
string |
このリクエスト用にクライアントが生成した一意の ID。 クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、そのリクエストは無視されます。 |
|
conferenceData.createRequest.status |
nested object |
会議の作成リクエストのステータス。 | |
conferenceData.createRequest.status.statusCode |
string |
会議の作成リクエストの現在のステータス。読み取り専用です。 有効な値は次のとおりです。
|
|
conferenceData.entryPoints[] |
list |
URL や電話番号など、個々の会議のエントリ ポイントに関する情報。 すべて同じ会議に属している必要があります。
|
|
conferenceData.entryPoints[].accessCode |
string |
会議にアクセスするためのアクセスコード。最大 128 文字です。 新しい会議データを作成するときは、会議プロバイダが使用する用語に一致する { 省略可。 |
|
conferenceData.entryPoints[].entryPointType |
string |
会議のエントリ ポイントのタイプ。 以下のステータスがあります。
|
|
conferenceData.entryPoints[].label |
string |
URI のラベル。エンドユーザーに表示されます。ローカライズされていません。最大文字数は 512 文字です。 例:
省略可。 |
|
conferenceData.entryPoints[].meetingCode |
string |
会議にアクセスするための会議コード。最大 128 文字です。 新しい会議データを作成するときは、会議プロバイダが使用する用語に一致する { 省略可。 |
|
conferenceData.entryPoints[].passcode |
string |
会議にアクセスするためのパスコード。最大 128 文字です。 新しい会議データを作成するときは、会議プロバイダが使用する用語に一致する { |
|
conferenceData.entryPoints[].password |
string |
会議にアクセスするためのパスワード。最大 128 文字です。 新しい会議データを作成するときは、会議プロバイダが使用する用語に一致する { 省略可。 |
|
conferenceData.entryPoints[].pin |
string |
会議にアクセスする PIN。最大 128 文字です。 新しい会議データを作成するときは、会議プロバイダが使用する用語に一致する { 省略可。 |
|
conferenceData.entryPoints[].uri |
string |
エントリ ポイントの URI。最大長は 1,300 文字です。 形式:
|
|
conferenceData.notes |
string |
ユーザーに表示される追加情報(ドメイン管理者の手順、法的通知など)。HTML を含めることができます。最大文字数は 2,048 文字です。省略可。 | |
conferenceData.signature |
string |
会議データの署名。 サーバー側で生成されます。 作成リクエストに失敗した会議で未設定。 保留中の作成リクエストがある会議では省略可能です。 |
|
created |
datetime |
イベントの作成時刻(RFC3339 タイムスタンプとして)。読み取り専用です。 | |
creator |
object |
イベントの作成者。読み取り専用です。 | |
creator.displayName |
string |
クリエイターの名前(該当する場合)。 | |
creator.email |
string |
クリエイターのメールアドレス(該当する場合)。 | |
creator.id |
string |
クリエイターのプロフィール ID(ある場合)。 | |
creator.self |
boolean |
作成者が、予定のこのコピーが表示されているカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。 | |
description |
string |
イベントの説明。HTML を含めることができます。省略可。 | 書き込み可能 |
end |
nested object |
イベントの(独占的な)終了時間。定期的な予定の場合は、最初のインスタンスの終了時間です。 | |
end.date |
date |
日付を「yyyy-mm-dd」の形式で表す(終日の予定の場合)。 | 書き込み可能 |
end.dateTime |
datetime |
日時を合算した日時(RFC3339 に基づく形式)。timeZone でタイムゾーンを明示的に指定しない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
end.timeZone |
string |
時刻が指定されたタイムゾーン。(IANA タイムゾーン データベース名の形式、例: 「ヨーロッパ/チューリッヒ」)。定期的な予定の場合は、この項目は必須であり、定期的な予定が拡大されるタイムゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイムゾーンを示します。 | 書き込み可能 |
endTimeUnspecified |
boolean |
終了時間が実際に指定されていないかどうかを指定します。この属性を True に設定しても、互換性の理由から終了時間は指定されます。デフォルトは False です。 | |
etag |
etag |
リソースの ETag。 | |
eventType |
string |
イベントの特定のタイプ。読み取り専用。有効な値は次のとおりです。
|
|
extendedProperties |
object |
イベントの拡張プロパティ。 | |
extendedProperties.private |
object |
このカレンダーに表示される予定のコピーのみを公開しているプロパティです。 | 書き込み可能 |
extendedProperties.private.(key) |
string |
プライベート プロパティの名前と対応する値。 | |
extendedProperties.shared |
object |
他の参加者のカレンダーの予定のコピー間で共有されるプロパティ。 | 書き込み可能 |
extendedProperties.shared.(key) |
string |
共有プロパティの名前とそれに対応する値。 | |
gadget |
object |
このイベントを拡張するガジェット。ガジェットはサポート終了となりました。この構造は、誕生日カレンダー メタデータを返す場合にのみ使用されます。 | |
gadget.display |
string |
ガジェットの表示モード。非推奨です。有効な値は次のとおりです。
|
書き込み可能 |
gadget.height |
integer |
ガジェットの高さ(ピクセル単位)。高さには 0 より大きい整数を指定してください。(省略可)廃止されました。 | 書き込み可能 |
gadget.iconLink |
string |
ガジェットのアイコンの URL。URL スキームは HTTPS にする必要があります。廃止されました。 | 書き込み可能 |
gadget.link |
string |
ガジェットの URL。URL スキームは HTTPS にする必要があります。廃止されました。 | 書き込み可能 |
gadget.preferences |
object |
設定] をタップします。 | 書き込み可能 |
gadget.preferences.(key) |
string |
設定名とそれに対応する値。 | |
gadget.title |
string |
ガジェットのタイトル。廃止されました。 | 書き込み可能 |
gadget.type |
string |
ガジェットのタイプ。廃止されました。 | 書き込み可能 |
gadget.width |
integer |
ガジェットの幅(ピクセル単位)。幅には 0 より大きい整数を指定してください。(省略可)廃止されました。 | 書き込み可能 |
guestsCanInviteOthers |
boolean |
主催者以外の参加者が予定に他のユーザーを招待できるかどうか。(省略可)デフォルトは True です。 | 書き込み可能 |
guestsCanModify |
boolean |
主催者以外の参加者が予定を変更できるかどうか。(省略可)デフォルトは False です。 | 書き込み可能 |
guestsCanSeeOtherGuests |
boolean |
主催者以外の参加者に、その予定の参加者が表示されます。(省略可)デフォルトは True です。 | 書き込み可能 |
hangoutLink |
string |
このイベントに関連付けられた Google ハングアウトの絶対リンクです。読み取り専用です。 | |
htmlLink |
string |
Google カレンダーのウェブ UI でのこのイベントへの絶対リンクです。読み取り専用です。 | |
iCalUID |
string |
RFC5545 で定義されているイベントの一意の識別子。これは、カレンダー システム全体の予定を一意に識別するために使用されます。import メソッドで予定を読み込むときに指定する必要があります。
|
|
id |
string |
イベントの不透明識別子。新しい予定や定期的な予定を作成する際に、予定の ID を指定できます。指定する ID は次のルールに従う必要があります:
ID を指定しない場合は、サーバーによって自動的に生成されます。
|
書き込み可能 |
kind |
string |
リソースのタイプ(「calendar#event 」)。 |
|
location |
string |
自由形式のテキストでイベントが発生した場所。省略可。 | 書き込み可能 |
locked |
boolean |
これがロックされたイベントのコピーで、メインのイベント フィールドの「summary」、「description」、「location」、「start」、「end」、「recurrence」に変更を加えられないかどうか。デフォルトは False です。読み取り専用です。 | |
organizer |
object |
イベントの主催者。主催者も参加者である場合は、organizer フィールドを True に設定した attendees の別のエントリで示されます。主催者を変更するには、移動操作を使用します。読み取り専用です(イベントのインポート時を除く)。 |
書き込み可能 |
organizer.displayName |
string |
主催者の名前(該当する場合)。 | 書き込み可能 |
organizer.email |
string |
主催者のメールアドレス(該当する場合)。RFC5322 に基づく有効なメールアドレスを入力してください。 | 書き込み可能 |
organizer.id |
string |
主催者のプロフィール ID(プロフィールがある場合)。 | |
organizer.self |
boolean |
主催者が、予定のこのコピーが表示されているカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。 | |
originalStartTime |
nested object |
定期的な予定の場合、この日時は recurringEventId で特定された定期的なイベントの繰り返しデータに従って開始されます。このインスタンスは、インスタンスが別の時間に移動された場合でも、定期的なイベント シリーズ内でインスタンスを一意に識別します。変更できません。 | |
originalStartTime.date |
date |
日付を「yyyy-mm-dd」の形式で表す(終日の予定の場合)。 | 書き込み可能 |
originalStartTime.dateTime |
datetime |
日時を合算した日時(RFC3339 に基づく形式)。timeZone でタイムゾーンを明示的に指定しない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
originalStartTime.timeZone |
string |
時刻が指定されたタイムゾーン。(IANA タイムゾーン データベース名の形式、例: 「ヨーロッパ/チューリッヒ」)。定期的な予定の場合は、この項目は必須であり、定期的な予定が拡大されるタイムゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイムゾーンを示します。 | 書き込み可能 |
privateCopy |
boolean |
True に設定すると、イベントの伝播が無効になります。なお、これはプライベート イベントのプロパティとは異なります。(省略可)不変。デフォルトは False です。 | |
recurrence[] |
list |
定期的な予定について、RFC5545 で指定されている RRULE、EXRULE、RDATE、EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行を使用できません。イベントの開始時刻と終了時刻は start フィールドと end フィールドに指定します。1 件の予定または定期的な予定の一部の回では、このフィールドを省略します。 |
書き込み可能 |
recurringEventId |
string |
繰り返しイベントのインスタンスの場合、これは、このインスタンスが属す繰り返しイベントの id です。変更できません。 |
|
reminders |
object |
認証済みユーザーの予定のリマインダーに関する情報。 | |
reminders.overrides[] |
list |
予定でデフォルトのリマインダーが使用されていなければ、その予定に固有のリマインダーが表示されます。設定されていない場合、そのイベント向けのリマインダーは設定されていません。オーバーライド通知は 5 件までです。 | 書き込み可能 |
reminders.overrides[].method |
string |
このリマインダーで使用されるメソッド。有効な値は次のとおりです。
リマインダーを追加する際に必要です。 |
書き込み可能 |
reminders.overrides[].minutes |
integer |
予定の開始時刻の何分前であれば通知するか。有効な値は 0 ~ 40320(4 週間分)です。 リマインダーを追加する際に必要です。 |
書き込み可能 |
reminders.useDefault |
boolean |
カレンダーのデフォルトのリマインダーが予定に適用されるかどうか。 | 書き込み可能 |
sequence |
integer |
iCalendar に基づくシーケンス番号。 | 書き込み可能 |
source |
object |
イベントの作成元。(例: ウェブページ、メール、HTTP または HTTPS スキームによる URL で識別可能なあらゆるドキュメント)。予定の作成者のみが表示、変更できます。 | |
source.title |
string |
ソースのタイトル(ウェブページのタイトル、メールの件名など)。 | 書き込み可能 |
source.url |
string |
リソースを指すソースの URL。URL スキームは HTTP または HTTPS にする必要があります。 | 書き込み可能 |
start |
nested object |
イベントの開始時刻(この時間を含む)。定期的な予定の場合は、最初のインスタンスの開始時刻です。 | |
start.date |
date |
日付を「yyyy-mm-dd」の形式で表す(終日の予定の場合)。 | 書き込み可能 |
start.dateTime |
datetime |
日時を合算した日時(RFC3339 に基づく形式)。timeZone でタイムゾーンを明示的に指定しない限り、タイムゾーン オフセットが必要です。 |
書き込み可能 |
start.timeZone |
string |
時刻が指定されたタイムゾーン。(IANA タイムゾーン データベース名の形式、例: 「ヨーロッパ/チューリッヒ」)。定期的な予定の場合は、この項目は必須であり、定期的な予定が拡大されるタイムゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイムゾーンを示します。 | 書き込み可能 |
status |
string |
イベントのステータス。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
summary |
string |
イベントのタイトル。 | 書き込み可能 |
transparency |
string |
予定でカレンダー上の時間枠がブロックされるかどうか。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
updated |
datetime |
イベントの最終変更時間(RFC3339 タイムスタンプとして)。読み取り専用です。 | |
visibility |
string |
イベントの公開設定。(省略可)有効な値は次のとおりです。
|
書き込み可能 |
Methods
- delete
- イベントを削除します。
- get
- Google カレンダー ID に基づいてイベントを返します。iCalendar ID を使用してイベントを取得するには、
iCalUID
パラメータを使用して events.list メソッドを呼び出します。 - インポート
- イベントをインポートします。このオペレーションは、既存の予定の非公開コピーをカレンダーに追加するために使用します。
- 挿入
- イベントを作成します。
- instances
- 指定した定期的な予定のインスタンスを返します。
- list
- 指定したカレンダーの予定を返します。
- 移動
- 予定を別のカレンダーに移動する(予定の主催者を変更する)。
- パッチ
- イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。
get
の後にupdate
を続けて使用することをおすすめします。指定したフィールド値は既存の値に置き換わります。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。 - クイック追加
- 単純なテキスト文字列に基づいてイベントを作成します。
- update
- イベントを更新します。
- 時計
- イベント リソースの変更に注意してください。