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"(非推奨。既存の予定にはこの会議ソリューション タイプが表示されることがありますが、新しい会議は作成できません)
  • Google Meet(http://meet.google.com)の "hangoutsMeet"
  • サードパーティの会議プロバイダの "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"(非推奨。既存の予定にはこの会議ソリューション タイプが表示されることがありますが、新しい会議は作成できません)
  • Google Meet(http://meet.google.com)の "hangoutsMeet"
  • サードパーティの会議プロバイダの "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 文字です。

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

省略可。

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 のラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 512 文字です。

例:

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

省略可。

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

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

省略可。

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

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

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

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

省略可。

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

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

省略可。

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

形式:

  • videohttp:https: スキーマが必要です。
  • phone の場合、tel: スキーマが必要です。URI には、ダイヤル シーケンス全体を含める必要があります(例: tel:+12345678900,,,123456789;1234)。
  • sip の場合、sip: スキーマ(sip:12345678@myprovider.com など)が必要です。
  • morehttp: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」 - 年単位の繰り返しがある特別な終日イベント。
  • 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 サイレント モードの予定のイベントデータ。eventTypefocusTime の場合に使用されます。 書き込み可能
focusTimeProperties.autoDeclineMode string サイレント モードの予定と重複する会議への招待を辞退するかどうか。有効な値は declineNone(会議の招待を辞退しない)、declineAllConflictingInvitations(予定と競合する会議の招待をすべて辞退する)、declineOnlyNewConflictingInvitations(フォーカス タイムの予定がある間に届いた競合する新しい会議の招待のみを辞退する)です。
focusTimeProperties.chatStatus string チャットや関連サービスでユーザーをマークするステータス。値は 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 メソッドでイベントをインポートする際に指定する必要があります。

iCalUIDid は同一ではなく、イベント作成時にいずれか一方のみを指定する必要があります。セマンティクスの違いの 1 つは、定期的な予定では、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 を指定しない場合、サーバーによって自動的に生成されます。

icalUIDid は同一ではなく、イベント作成時にいずれか一方のみを指定する必要があります。セマンティクスの違いの 1 つは、定期的な予定では、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 不在の予定のデータ。eventTypeoutOfOffice の場合に使用されます。 書き込み可能
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. キャンセルされていない定期的な予定の例外がキャンセルされた場合、このインスタンスはユーザーに表示されなくなります。クライアントは、親の定期的な予定の存続期間中、これらの予定を保存する必要があります。

      キャンセルされた例外では、idrecurringEventIdoriginalStartTime フィールドの値のみが入力されることが保証されます。他のフィールドは空の場合があります。

    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 を参照する必要があります。 書き込み可能
workingLocationProperties.officeLocation.deskId string デスクの識別子(省略可)。 書き込み可能
workingLocationProperties.officeLocation.floorId string 省略可能なフロア識別子。 書き込み可能
workingLocationProperties.officeLocation.floorSectionId string フロア セクションの識別子(省略可)。 書き込み可能
workingLocationProperties.officeLocation.label string カレンダーのウェブ クライアントとモバイル クライアントに表示されるオフィスの名前。組織のリソース データベースで建物名を参照することをおすすめします。 書き込み可能
workingLocationProperties.type string 勤務地のタイプ。指定できる値は次のとおりです。
  • homeOffice」- ユーザーが自宅で仕事をしている。
  • officeLocation」 - ユーザーはオフィスで勤務しています。
  • customLocation」 - ユーザーはカスタムの場所で勤務しています。
詳細は指定された名前のサブフィールドで指定されますが、空の場合はこのフィールドがないことがあります。他のフィールドはすべて無視されます。

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

書き込み可能

メソッド

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

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

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