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 に設定する必要があります。

1 件の予定に添付できる添付ファイルは 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": 一般ユーザー向けのハングアウト（サポート終了。既存のイベントにはこの会議ソリューション タイプが表示されることがありますが、新しい会議は作成できません）
  • "eventNamedHangout": Google Workspace ユーザー向けの従来のハングアウトの場合（サポート終了。既存の予定にはこの会議ソリューション タイプが表示されることがありますが、新しい会議を作成することはできません）
  • "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": 一般ユーザー向けのハングアウト（サポート終了。既存のイベントにはこの会議ソリューション タイプが表示されることがありますが、新しい会議は作成できません）
  • "eventNamedHangout": Google Workspace ユーザー向けの従来のハングアウトの場合（サポート終了。既存の予定にはこの会議ソリューション タイプが表示されることがありますが、新しい会議を作成することはできません）
  • "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" - 電話番号をダイヤルして会議に参加します。1 つの会議に 0 個以上の phone エントリ ポイントを設定できます。
  • "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 時刻が指定されたタイムゾーン。（IANA タイムゾーン データベース名の形式（「Europe/Zurich」など）。定期的な予定の場合、このフィールドは必須です。定期的な予定を展開するタイムゾーンを指定します。単一のイベントの場合、このフィールドはオプションであり、イベントの開始時と終了時のカスタム タイムゾーンを示します。 書き込み可能
endTimeUnspecified boolean 終了時間が実際に指定されていないかどうか。この属性が True に設定されていても、互換性上の理由から終了時間が提供されます。デフォルトは False です。
etag etag リソースの ETag。
eventType string イベントの特定のタイプ。イベントの作成後にこれを変更することはできません。有効な値は次のとおりです。
  • 「default」 - 通常のイベント、または指定されていないイベント。
  • 「outOfOffice」 - 不在の予定。
  • 「focusTime」 - サイレント モードの予定。
  • 「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 を指定できます。指定する ID は次のルールに従う必要があります。
  • ID に使用できる文字は、base32hex エンコードで使用されている文字です。つまり、小文字の a ～ v と数字の 0 ～ 9 を使用します。RFC2938 のセクション 3.1.2 をご覧ください。
  • ID の長さは 5 ～ 1,024 文字にする必要があります
  • ID はカレンダーごとに一意である必要があります。
システムはグローバルに分散しているため、イベント作成時に ID の競合が検出されるとは限りません。衝突のリスクを最小限に抑えるため、RFC4122 で記述されているような確立された UUID アルゴリズムを使用することをおすすめします。

ID を指定しない場合、サーバーによって自動的に生成されます。

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

 書き込み可能
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 タイムゾーン データベース名の形式（「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 認証済みユーザーに対する予定のリマインダーに関する情報。
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 に設定された増分同期リクエストでは、これらの詳細は返されません。

    予定の主催者が（移動操作などで）変更され、元の主催者が参加者リストにない場合、その予定はキャンセルされ、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」 - ユーザーはカスタムの場所を使用して作業しています。
指定された名前のサブフィールドにすべての詳細が指定されていますが、このフィールドが空の場合は存在しない可能性があります。その他のフィールドは無視されます。

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

 書き込み可能

Methods

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

非推奨の動作: default 以外のイベントをインポートすると、そのイベントが default に変更され、イベントタイプに固有のプロパティはすべて破棄されます。

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