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
    }
  ],
  "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 です。
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 経由で会議に参加します。会議では、video のエントリ ポイントを 1 つまたは 1 つ設定できます。
  • "phone" - 電話番号をダイヤルして会議に参加する。会議では、phone のエントリ ポイントを 0 個以上設定できます。
  • "sip" - SIP 経由で会議に参加します。会議には 0 個または 1 個の sip エントリ ポイントを設定できます。
  • "more" - 追加の会議参加手順（追加の電話番号など）。会議には 0 個または 1 個の more エントリ ポイントを設定できます。エントリ ポイントが more しかない会議は、有効な会議ではありません。
conferenceData.entryPoints[].label string URI のラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 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 時間を指定するタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
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 で定義されているイベントの一意の識別子。カレンダー システム間でイベントを一意に識別するために使用され、import メソッドでイベントをインポートするときに指定する必要があります。

iCalUID と id は同一ではないため、イベントの作成時にどちらか一方だけ指定する必要があります。セマンティクスの違いの一つは、定期的なイベントでは、1 つのイベントのすべての発生に異なる id があり、すべて同じ iCalUID を共有することです。iCalUID を使用してイベントを取得するには、iCalUID パラメータを使用して events.list メソッドを呼び出します。id を使用してイベントを取得するには、events.get メソッドを呼び出します。
id string イベントの不透明な識別子。ID は、1 回限りの予定または定期的な予定を新規作成する際に指定できます。指定する 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 に設定されます。主催者を変更するには、move オペレーションを使用します。読み取り専用。ただし、イベントをインポートする場合は除きます。 書き込み可能
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 時間を指定するタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
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 時間を指定するタイムゾーン。（形式は「Europe/Zurich」などの IANA タイムゾーン データベース名になります）。定期的な予定の場合、このフィールドは必須です。展開されるタイムゾーンのタイムゾーンを指定します。単一のイベントの場合、このフィールドは省略可能で、イベントの開始と終了のカスタム タイムゾーンを示します。 書き込み可能
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（省略可）。組織のリソース データベースにあるビルディング ID を参照する必要があります。 書き込み可能
workingLocationProperties.officeLocation.deskId string デスク ID（省略可）。 書き込み可能
workingLocationProperties.officeLocation.floorId string オプションの階 ID。 書き込み可能
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 を実行し、アトミック性を確保します。
スマートウォッチ
イベント リソースの変更を監視する。