Events

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
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
プロパティ名 値 説明 メモ
anyoneCanAddSelf boolean 誰でもイベントに自分自身を招待できるかどうか（非推奨）。省略可。デフォルトは False です。 書き込み可能
attachments[] list イベントのファイル添付。

添付ファイルを変更するには、supportsAttachments リクエスト パラメータを true に設定する必要があります。

イベントごとに添付できるファイルは 25 個までです。
attachments[].fileId string 添付ファイルの ID。読み取り専用。

Google ドライブ ファイルの場合、これは Drive API 内の対応する Files リソース エントリの ID です。
attachments[].fileUrl string 添付ファイルへの URL リンク。

Google ドライブのファイルの添付ファイルを追加する場合は、Drive API の Files リソースの alternateLink プロパティと同じ形式を使用します。

添付ファイルを追加する際に必要です。

 書き込み可能
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 参加者の回答ステータス。指定できる値は次のとおりです。
  • 「needsAction」 - 参加者が招待にまだ返信していません（新しい予定の場合に推奨）。
  • 「declined」 - 参加者が招待を辞退しました。
  • 「tentative」- 参加者が招待を仮承諾しています。
  • 「accepted」- 参加者が招待を承諾しました。
 書き込み可能
attendees[].self boolean このエントリが、この予定のコピーが表示されるカレンダーを表すかどうか。読み取り専用。デフォルトは False です。
birthdayProperties nested object 誕生日や特別なイベントのデータ。eventType が "birthday" の場合に使用されます。変更できません。 書き込み可能
birthdayProperties.contact string この誕生日イベントがリンクされている連絡先のリソース名。これを使用して、People API から連絡先の詳細を取得できます。形式: "people/c12345"。読み取り専用です。
birthdayProperties.customTypeName string このイベントに指定されたカスタム タイプラベル。birthdayProperties.type が "custom" に設定されている場合に入力されます。読み取り専用です。
birthdayProperties.type string 誕生日や特別なイベントの種類。有効な値は次のとおりです。
  • "anniversary" - 誕生日以外の記念日。常に contact がある。
  • "birthday" - 誕生日イベント。これがデフォルト値です。
  • "custom" - ラベルが customTypeName フィールドでさらに指定される特別な日付。常に contact があります。
  • "other" - 他のカテゴリに該当せず、カスタムラベルもない特別な日付。常に contact があります。
  • "self" - カレンダーのオーナー自身の誕生日。contact は使用できません。
Calendar API は、タイプ "birthday" の予定の作成のみをサポートしています。イベントの作成後にタイプを変更することはできません。		 書き込み可能
colorId string イベントの色。これは、色定義の event セクションのエントリを参照する ID です（ 色エンドポイントをご覧ください）。省略可。 書き込み可能
conferenceData nested object Google Meet 会議の詳細など、会議関連情報。新しい会議の詳細を作成するには、createRequest フィールドを使用します。変更を保持するには、すべてのイベント変更リクエストで conferenceDataVersion リクエスト パラメータを 1 に設定してください。 書き込み可能
conferenceData.conferenceId string 会議の ID。

デベロッパーが会議を追跡するために使用できます。ユーザーには表示しないでください。

ID 値の形式は、会議ソリューションのタイプごとに異なります。

  • eventHangout: ID は設定されていません。（この会議タイプは非推奨です）。
  • eventNamedHangout: ID はハングアウトの名前です。（この会議タイプは非推奨です）。
  • hangoutsMeet: ID は 10 文字の会議コードです（例: aaa-bbbb-ccc）。
  • addOn: ID はサードパーティ プロバイダによって定義されます。
省略可。
conferenceData.conferenceSolution nested object 会議ソリューション（Google Meet など）。

作成リクエストが失敗した会議では設定解除されます。

conferenceSolution と少なくとも 1 つの entryPoint、または createRequest のいずれかが必要です。
conferenceData.conferenceSolution.iconUri string このソリューションのユーザーに表示されるアイコン。
conferenceData.conferenceSolution.key nested object このイベントの会議ソリューションを一意に識別できるキー。
conferenceData.conferenceSolution.key.type string 会議ソリューションのタイプ。

クライアントで認識できないタイプや空のタイプが返されても、エントリ ポイントを表示できるようにする必要があります。ただし、変更は禁止する必要があります。

使用できる値は次のとおりです。

  • 一般ユーザー向けハングアウトの"eventHangout"（非推奨。既存のイベントにはこの会議ソリューション タイプが表示されますが、新しい会議を作成できません）
  • Google Workspace ユーザー向け従来のハングアウト: "eventNamedHangout"（非推奨。既存の予定にはこの会議ソリューション タイプが表示される場合がありますが、新しい会議を作成することはできません）
  • "hangoutsMeet"（Google Meet（http://meet.google.com）用）
  • "addOn"（サードパーティの会議プロバイダの場合）
conferenceData.conferenceSolution.name string このソリューションのユーザーに表示される名前。ローカライズされていません。
conferenceData.createRequest nested object 新しいカンファレンスを生成してイベントに関連付けるリクエスト。データは非同期で生成されます。データが存在するかどうかを確認するには、status フィールドを確認します。

conferenceSolution と少なくとも 1 つの entryPoint、または createRequest が必要です。
conferenceData.createRequest.conferenceSolutionKey nested object 会議ソリューション（ハングアウト、Google Meet など）。
conferenceData.createRequest.conferenceSolutionKey.type string 会議ソリューションのタイプ。

クライアントで認識できないタイプや空のタイプが返されても、エントリ ポイントを表示できるようにする必要があります。ただし、変更は禁止する必要があります。

使用できる値は次のとおりです。

  • 一般ユーザー向けハングアウトの"eventHangout"（非推奨。既存のイベントにはこの会議ソリューション タイプが表示されますが、新しい会議を作成できません）
  • Google Workspace ユーザー向け従来のハングアウト: "eventNamedHangout"（非推奨。既存の予定にはこの会議ソリューション タイプが表示される場合がありますが、新しい会議を作成することはできません）
  • "hangoutsMeet"（Google Meet（http://meet.google.com）用）
  • "addOn": サードパーティの会議プロバイダ
conferenceData.createRequest.requestId string このリクエストのクライアント生成の一意の ID。

クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、リクエストは無視されます。
conferenceData.createRequest.status nested object 会議作成リクエストのステータス。
conferenceData.createRequest.status.statusCode string 会議作成リクエストの現在のステータス。読み取り専用。

使用できる値は次のとおりです。

  • "pending": 会議の作成リクエストはまだ処理中です。
  • "success": 会議作成リクエストが成功し、エントリ ポイントが入力されました。
  • "failure": 会議作成リクエストが失敗しました。エントリ ポイントはありません。
conferenceData.entryPoints[] list 個々の会議のエントリ ポイントに関する情報（URL、電話番号など）。

これらはすべて同じ会議に属している必要があります。

conferenceSolution と少なくとも 1 つの entryPoint、または createRequest のいずれかが必要です。
conferenceData.entryPoints[].accessCode string 会議にアクセスするためのアクセス コード。最大長は 128 文字です。

新しい会議データを作成する場合は、会議プロバイダが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。

省略可。
conferenceData.entryPoints[].entryPointType string 会議のエントリ ポイントのタイプ。

有効な値は次のとおりです:

  • "video" - HTTP 経由で会議に参加します。会議には 0 個または 1 個の video エントリ ポイントを設定できます。
  • "phone" - 電話番号をダイヤルして会議に参加する。会議には 0 個以上の phone エントリ ポイントを含めることができます。
  • "sip" - SIP 経由で会議に参加します。会議には 0 個または 1 個の sip エントリ ポイントを設定できます。
  • "more" - 追加の電話番号など、会議への参加に関するその他の手順。会議には 0 個または 1 個の more エントリ ポイントを設定できます。more エントリ ポイントのみのカンファレンスは有効なカンファレンスではありません。
conferenceData.entryPoints[].label string URI のラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は全角 206（半角 512）文字です。

例:

  • video: meet.google.com/aaa-bbbb-ccc
  • phone の場合: +1 123 268 2601
  • sip の場合: 12345678@altostrat.com
  • more の場合: 入力しないでください。

省略可。
conferenceData.entryPoints[].meetingCode string 会議にアクセスするための会議コード。最大長は 128 文字です。

新しい会議データを作成する場合は、会議プロバイダが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。

省略可。
conferenceData.entryPoints[].passcode string 会議にアクセスするためのパスコード。最大長は 128 文字です。

新しい会議データを作成するときは、会議プロバイダが使用する用語と一致する {meetingCode, accessCode, passcode, password, pin} フィールドのサブセットのみに値を入力してください。入力されているフィールドのみが表示されます。
conferenceData.entryPoints[].password string 会議にアクセスするためのパスワード。最大長は 128 文字です。

新しい会議データを作成する場合は、会議プロバイダが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。

省略可。
conferenceData.entryPoints[].pin string 会議にアクセスするための PIN。最大長は 128 文字です。

新しい会議データを作成する場合は、会議プロバイダが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。

省略可。
conferenceData.entryPoints[].uri string エントリ ポイントの URI。最大で 1,300 文字です。

形式:

  • video、http:、または https: のスキーマが必要です。
  • phone の場合、tel: スキーマが必要です。URI には、ダイヤル シーケンス全体を含める必要があります（例: tel:+12345678900,,,123456789;1234）。
  • sip の場合、sip: スキーマが必要です（例: sip:12345678@myprovider.com）。
  • more、http:、または https: のスキーマが必要です。
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 タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
endTimeUnspecified boolean 終了時間が実際に指定されていないかどうか。この属性が True に設定されている場合でも、互換性の理由から終了時刻は提供されます。デフォルトは False です。
etag etag リソースの ETag。
eventType string イベントの特定のタイプ。イベントの作成後に変更することはできません。有効な値は次のとおりです。
  • 「birthday」 - 年に 1 回繰り返される特別な終日の予定。
  • 「default」 - 通常のイベント、または詳細が指定されていないイベント。
  • 「focusTime」 - サイレント モードの予定。
  • 「fromGmail」- Gmail の予定。このタイプのイベントは作成できません。
  • 「outOfOffice」- 不在の予定。
  • 「workingLocation」- 勤務場所のイベント。
 書き込み可能
extendedProperties object イベントの拡張プロパティ。
extendedProperties.private object このカレンダーに表示される予定のコピーのみに適用されるプロパティ。 書き込み可能
extendedProperties.private.(key) string プライベート プロパティの名前と対応する値。
extendedProperties.shared object 他の参加者のカレンダーの予定のコピー間で共有されるプロパティ。 書き込み可能
extendedProperties.shared.(key) string 共有プロパティの名前と対応する値。
focusTimeProperties nested object サイレント モードの予定データ。eventType が focusTime の場合に使用されます。 書き込み可能
focusTimeProperties.autoDeclineMode string サイレント モードの予定と重複する会議への招待を辞退するかどうか。有効な値は、declineNone（会議の招待を拒否しない）、declineAllConflictingInvitations（予定と競合する会議の招待をすべて拒否する）、declineOnlyNewConflictingInvitations（集中タイムの予定中に届いた新しい会議の招待のみを拒否する）です。
focusTimeProperties.chatStatus string Chat と関連プロダクトでユーザーをマークするステータス。値は available または doNotDisturb です。
focusTimeProperties.declineMessage string 既存の予定または新しい招待状がカレンダーによって自動的に辞退された場合に設定するレスポンス メッセージ。
gadget object このイベントを拡張するガジェット。ガジェットは非推奨となりました。この構造は、誕生日カレンダーのメタデータを返すためだけに使用されます。
gadget.display string ガジェットの表示モード。非推奨です。指定できる値は次のとおりです。
  • 「icon」 - カレンダー ビューの予定のタイトルの横にガジェットが表示されます。
  • 「chip」 - イベントがクリックされたときにガジェットが表示されます。
 書き込み可能
gadget.height integer ガジェットの高さ（ピクセル単位）。高さには 0 より大きい整数を指定してください。省略可。サポート終了。 書き込み可能
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 です。 書き込み可能
iCalUID string RFC5545 で定義されているイベントの一意の ID。カレンダー システム間でイベントを一意に識別するために使用され、import メソッドでイベントをインポートするときに指定する必要があります。

iCalUID と id は同じではなく、イベントの作成時に指定するのはどちらか一方のみです。セマンティクスの違いの一つは、繰り返しイベントでは、1 つのイベントのすべての発生に異なる id が割り当てられる一方で、同じ iCalUID が共有されることです。iCalUID を使用してイベントを取得するには、iCalUID パラメータを使用して events.list メソッドを呼び出します。id を使用してイベントを取得するには、events.get メソッドを呼び出します。
id string イベントのオペーク識別子。新しい単発イベントまたは繰り返しイベントを作成するときに、ID を指定できます。指定する ID は、次のルールに従っている必要があります。
  • ID に使用できる文字は、base32hex エンコードで使用される文字です。つまり、小文字の a ～ v と数字の 0 ～ 9 です。RFC2938 のセクション 3.1.2 をご覧ください。
  • ID の長さは 5 ～ 1,024 文字にする必要があります
  • ID はカレンダーごとに一意である必要があります
システムはグローバルに分散されているため、イベントの作成時に ID の競合が検出されるかどうかを保証することはできません。衝突のリスクを最小限に抑えるために、RFC4122 に記載されているような確立された UUID アルゴリズムを使用することをおすすめします。

ID を指定しない場合、ID はサーバーが自動的に生成します。

icalUID と id は同一ではないため、イベントの作成時にどちらか一方だけ指定する必要があります。セマンティクスの違いの一つは、定期的なイベントでは、1 つのイベントのすべての発生に異なる id があり、すべて同じ icalUID を共有することです。

 書き込み可能
kind string リソースのタイプ（「calendar#event」）。
location string イベントの地理的位置（自由形式のテキスト）。省略可。 書き込み可能
locked boolean メインイベント フィールドの [summary]、[description]、[location]、[start]、[end]、[recurrence] を変更できない、ロックされたイベントのコピーであるかどうか。デフォルトは False です。読み取り専用。
organizer object イベントの主催者。主催者が参加者でもある場合は、attendees に別のエントリが追加され、organizer フィールドが True に設定されます。主催者を変更するには、移動オペレーションを使用します。読み取り専用。ただし、イベントをインポートする場合は除きます。 書き込み可能
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 タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
outOfOfficeProperties nested object 不在の予定データ。eventType が outOfOffice の場合に使用されます。 書き込み可能
outOfOfficeProperties.autoDeclineMode string 不在の予定と重複する会議への招待を辞退するかどうか。有効な値は、declineNone（会議の招待状が拒否されないこと）、declineAllConflictingInvitations（この予定と競合する会議への招待がすべて拒否される）、declineOnlyNewConflictingInvitations（不在の予定がある間に届いた、競合する新しい会議への招待のみ拒否する）です。
outOfOfficeProperties.declineMessage string 既存の予定または新しい招待状がカレンダーによって自動的に辞退された場合に設定するレスポンス メッセージ。
privateCopy boolean true に設定すると、イベント伝播が無効になります。これは非公開イベントのプロパティとは異なります。省略可。変更不可。デフォルトは False です。
recurrence[] list RFC5545 で指定されている、繰り返しイベントの RRULE、EXRULE、RDATE、EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は使用できません。イベントの開始時間と終了時間は start フィールドと end フィールドで指定します。単一の予定または定期的な予定の場合、このフィールドは省略されます。 書き込み可能
recurringEventId string 定期的な予定のインスタンスの場合、これはこのインスタンスが属する定期的な予定の id です。変更できません。
reminders object 認証されたユーザー向けの予定のリマインダーに関する情報。リマインダーを変更しても、そのイベントを囲むイベントの updated プロパティは変更されないことに注意してください。
reminders.overrides[] list イベントでデフォルトのリマインダーを使用していない場合は、イベントに固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことを示します。オーバーライド リマインダーの最大数は 5 つです。 書き込み可能
reminders.overrides[].method string このリマインダーで使用されているメソッド。指定できる値は次のとおりです。
  • 「email」- リマインダーはメールで送信されます。
  • 「popup」- リマインダーは UI ポップアップを介して送信されます。

リマインダーを追加する際に必須です。

 書き込み可能
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 タイムゾーン データベース名の形式で指定します。例: Europe/Zurich）。繰り返しイベントの場合は必須のフィールドで、繰り返しが適用されるタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能です。イベントの開始時刻と終了時刻のカスタム タイムゾーンを指定します。 書き込み可能
status string イベントのステータス。省略可。指定できる値は次のとおりです。
  • 「confirmed」 - イベントが確定しています。これがデフォルトのステータスです。
  • 「tentative」- イベントが暫定的に確定しています。
  • 「cancelled」 - 予定はキャンセル（削除）されました。list メソッドは、増分同期（syncToken または updatedMin が指定されている場合）または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。get メソッドは常にそれらを返します。

    キャンセル済みステータスは、イベントの種類に応じて 2 つの異なる状態を表します。

    1. キャンセルされていない定期的な予定の例外をキャンセルすると、このインスタンスはユーザーに表示されなくなります。クライアントは、親の定期的なイベントの存続期間中、これらのイベントを保存する必要があります。

      キャンセルされた例外では、id、recurringEventId、originalStartTime フィールドの値のみが確実に入力されます。他のフィールドは空の場合があります。

    2. その他のキャンセルされたイベントは、削除されたイベントを表します。クライアントは、ローカルに同期したコピーを削除する必要があります。キャンセルされたイベントは、最終的に表示されなくなります。無期限に利用できるとは限りません。

      削除されたイベントでは、id フィールドにのみ値が入力されます。

    主催者のカレンダーには、キャンセルされた予定の詳細（概要、場所など）が引き続き表示されるので、その予定を復元（削除を取り消す）することができます。同様に、ユーザーが招待されたイベントで、ユーザーが手動で削除したイベントでも、詳細は引き続き表示されます。ただし、showDeleted が false に設定された増分同期リクエストでは、これらの詳細は返されません。

    予定の主催者が変更されたときに（move 操作などにより）、元の主催者が参加者リストに含まれていなかった場合、その予定はキャンセルされ、id フィールドのみに値が入力されることが保証されます。

 書き込み可能
summary string イベントのタイトル。 書き込み可能
transparency string その予定によってカレンダーの時間がブロックされるかどうか。省略可。指定できる値は次のとおりです。
  • 「opaque」- デフォルト値。予定はカレンダーで時間帯をブロックします。これは、カレンダー UI で [表示名] を [予定あり] に設定するのと同じです。
  • 「transparent」 - この予定によってカレンダーの時間はブロックされません。これは、カレンダーの UI で [表示名] を [空き時間] に設定するのと同じです。
 書き込み可能
updated datetime メインイベント データの最終更新日時（RFC3339 タイムスタンプ形式）。予定の通知を更新しても、これは変更されません。読み取り専用です。
visibility string イベントの公開設定。省略可。指定できる値は次のとおりです。
  • 「default」 - カレンダーの予定のデフォルトの公開設定を使用します。これがデフォルト値です。
  • 「public」- 予定は公開され、カレンダーのすべての閲覧者に予定の詳細が表示されます。
  • 「private」 - イベントは非公開で、イベントの参加者のみイベントの詳細を表示できます。
  • 「confidential」 - イベントは非公開です。この値は互換性を確保するために提供されています。
 書き込み可能
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 オプションの階のセクション ID。 書き込み可能
workingLocationProperties.officeLocation.label string カレンダーのウェブ クライアントとモバイル クライアントに表示されるオフィス名。組織のリソース データベースにあるビルディング名を参照することをおすすめします。 書き込み可能
workingLocationProperties.type string 勤務地のタイプ。有効な値は次のとおりです。
  • 「homeOffice」- ユーザーが自宅で勤務している。
  • 「officeLocation」- ユーザーがオフィスで勤務している。
  • 「customLocation」- ユーザーがカスタムの場所で勤務している。
詳細は、指定された名前のサブフィールドで指定されますが、このフィールドが空の場合は省略されることがあります。他のフィールドはすべて無視されます。

勤務場所のプロパティを追加する場合に必須です。

 書き込み可能

メソッド

delete
イベントを削除します。
get
Google カレンダー ID に基づいて予定を返します。iCalendar ID を使用してイベントを取得するには、iCalUID パラメータを使用して events.list メソッドを呼び出します。
import
イベントをインポートします。この操作は、既存の予定の限定公開コピーをカレンダーに追加するために使用されます。インポートできるのは、eventType が default のイベントのみです。

非推奨の動作: default 以外のイベントがインポートされた場合、そのタイプは default に変更され、イベントタイプ固有のプロパティはすべて削除されます。

insert
イベントを作成します。
インスタンス
指定した定期的な予定のインスタンスを返します。
list
指定したカレンダーの予定を返します。
move
予定を別のカレンダーに移動する（予定の主催者を変更するなど）。移動できるのは default イベントのみです。birthday、focusTime、fromGmail、outOfOffice、workingLocation イベントは移動できません。
patch
イベントを更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を使用することをおすすめします。指定したフィールド値によって、既存の値が置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドが指定されている場合、既存の配列が上書きされます。これにより、以前の配列要素は破棄されます。
quickAdd
単純なテキスト文字列に基づいてイベントを作成します。
update
イベントを更新します。このメソッドはパッチのセマンティクスをサポートしておらず、常にイベント リソース全体を更新します。部分更新を行うには、get を実行してから、etags を使用して update を実行し、アトミック性を確保します。
watch
イベント リソースの変更を監視します。