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"(サポート終了。既存のイベントではこのカンファレンス ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
  • 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 文字です。

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

省略可。

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

以下のステータスがあります。

  • "video" - HTTP 経由で会議に参加します。1 つの会議に 0 個または 1 個の video エントリ ポイントを設定できます。
  • "phone" - 電話番号をダイヤルして会議に参加する。会議には 0 個以上の phone エントリ ポイントを設定できます。
  • "sip" - SIP を介した会議に参加。1 つの会議に 0 個または 1 個の sip エントリ ポイントを設定できます。
  • "more" - 追加の会議参加手順(追加の電話番号など)。1 つの会議に 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 イベントの特定のタイプ。イベントの作成後にこれを変更することはできません。有効な値は次のとおりです。
  • default」 - 通常のイベント、または指定されていないイベント。
  • outOfOffice」 - 不在の予定。
  • focusTime」 - サイレント モードの予定。
  • workingLocation」 - 勤務場所の予定。
現在、API を使用して作成できるのは「default」イベントと「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 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 メソッドを使ってイベントをインポートするときに指定する必要があります。

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

書き込み可能
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 フィールドで指定します。1 つの予定または定期的な予定のインスタンスでは省略されます。 書き込み可能
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. キャンセルされていない定期的なイベントの例外がキャンセルされた場合は、このインスタンスがユーザーに表示されなくなることを示します。クライアントは、親の定期イベントの存続期間中、これらのイベントを保存する必要があります。

      キャンセルされた例外では、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 デスク 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
イベントをインポートします。この操作は、既存の予定の個人用コピーをカレンダーに追加するために使用します。
挿入
イベントを作成します。
instances
指定された定期的なイベントのインスタンスを返します。
list
指定されたカレンダーの予定を返します。
移動
予定を別のカレンダーに移動する(予定の主催者を変更する)。移動できるのは default のみです。outOfOfficefocusTimeworkingLocation のイベントは移動できません。
パッチ
予定を更新します。このメソッドは、パッチ セマンティクスをサポートしています。各パッチ リクエストは 3 つの割り当てユニットを消費します。get の後に update を続けることをおすすめします。指定したフィールド値によって既存の値が置き換えられます。リクエストで指定しないフィールドは変更されません。配列フィールドを指定すると、既存の配列が上書きされます。以前の配列要素は破棄されます。
quickAdd
単純なテキスト文字列に基づいてイベントを作成します。
update
予定を更新します。このメソッドはパッチのセマンティクスをサポートせず、常にイベント リソース全体を更新します。部分更新を行うには、アトミック性を確保するために、get の後に ETag を使用して update を実行します。
スマートウォッチ
イベント リソースの変更を監視します。