event リソースの種類event resource type
名前空間: microsoft.graphNamespace: microsoft.graph
ユーザーの予定表か、Microsoft 365 グループの既定の予定表のイベントです。An event in a user calendar, or the default calendar of a Microsoft 365 group.
イベント に含まれる参加者の最大数、および Exchange Online メールボックスから送信される eventMessage の受信者の最大数は 500 です。The maximum number of attendees included in an event, and the maximum number of recipients in an eventMessage sent from an Exchange Online mailbox is 500. 詳細については、「送信の制限」を参照してください。For more information, see sending limits.
このリソースは以下をサポートしています。This resource supports:
- 拡張機能として、カスタム プロパティに独自のデータを追加します。Adding your own data to custom properties as extensions.
- 変更通知を受信します。Subscribing to change notifications.
- デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。Using delta query to track incremental additions, deletions, and updates, by providing a delta function.
注: ユーザーの予定表とグループの予定表、およびそのイベントの操作方法には、わずかな相違点がいくつかあります。Note: There are a few minor differences in the way you can interact with user calendars, group calendars, and their events:
- calendarGroup にはユーザーの予定表のみを整理できます。You can organize only user calendars in a calendarGroup.
- 添付ファイル オブジェクトは、ユーザーの予定表のイベントのみに追加できます。しかし、グループの予定表のイベントには追加できません。You can add attachment objects to events in only user calendars, but not to events in group calendars.
- Outlook はグループの代わりにすべての会議出席依頼を自動的に受け入れます。Outlook automatically accepts all meeting requests on behalf of groups. ユーザー の予定表の会議出席依頼のみを 承諾、仮承諾、または 辞退できます。You can accept, tentatively accept, or decline meeting requests for user calendars only.
- Outlook はグループ イベントのアラームをサポートしていません。Outlook doesn't support reminders for group events. ユーザー の予定表についてのみ、リマインダーを 再起動または 無視できます。You can snooze or dismiss a reminder for user calendars only.
メソッドMethods
| メソッドMethod | 戻り値の型Return Type | 説明Description |
|---|---|---|
| イベントを一覧表示するList events | event コレクションevent collection | ユーザーのメールボックス内のイベント オブジェクトの一覧を取得します。一覧には、単一インスタンスの会議と定期的なマスターが含まれています。Retrieve a list of event objects in the user's mailbox. The list contains single instance meetings and series masters. |
| イベントを作成するCreate event | eventevent | インスタンス コレクションへの投稿により、新しいイベントを作成します。Create a new event by posting to the instances collection. |
| イベントの取得Get event | eventevent | event オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of event object. |
| 更新するUpdate | eventevent | イベント オブジェクトを更新します。Update event object. |
| 削除Delete | なしNone | event オブジェクトを削除します。Delete event object. |
| 差分delta | event コレクションevent collection | ユーザーの標準として設定されている予定表の calendarView において追加、削除、更新された一連のイベント (さまざまなイベント) を取得します。Get a set of events that have been added, deleted, or updated in a calendarView (a range of events) of the user's primary calendar. |
| forwardforward | なしNone | 会議のイベントの開催者または出席者が、新しい受信者に会議出席依頼を転送します。Lets the organizer or attendee of a meeting event forward the meeting request to a new recipient. |
| 取り消すcancel | なしNone | 開催者からの取り消しメッセージをすべての出席者に送信し、指定の会議を取り消します。Send cancellation message from the organizer to all the attendees and cancel the specified meeting. |
| 承諾するaccept | なしNone | ユーザーの予定表の指定のイベントを承諾します。Accept the specified event in a user calendar. |
| 仮承諾するtentativelyAccept | なしNone | ユーザーの予定表の指定のイベントを仮承諾します。Tentatively accept the specified event in a user calendar. |
| 辞退するdecline | なしNone | ユーザーの予定表の指定のイベントに対する詳細を辞退します。Decline invitation to the specified event in a user calendar. |
| dismissReminderdismissReminder | なしNone | ユーザーの予定表の指定したイベントのリマインダーを無視します。Dismiss the reminder for the specified event in a user calendar. |
| リマインダーを再起動するsnoozeReminder | なしNone | ユーザーの予定表の指定したイベントのリマインダーを新しい時刻まで延期します。Postpone a reminder for the specified event in a user calendar until a new time. |
| インスタンスを一覧表示するList instances | event コレクションevent collection | 指定した時間範囲のイベントのインスタンス (発生) を取得します。イベントが SeriesMaster タイプである場合、これは指定した時間範囲内のイベントの発生と例外を返します。Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range. |
| 添付ファイルAttachments | ||
| 添付ファイルを一覧表示するList attachments | attachment コレクションattachment collection | イベントのすべての添付ファイルを取得します。Get all attachments on an event. |
| 添付ファイルを追加するAdd attachment | attachmentattachment | 添付ファイル コレクションへの投稿により、イベントに新しい添付ファイルを追加します。Add a new attachment to an event by posting to the attachments collection. |
| オープン拡張機能Open extensions | ||
| オープン拡張機能を作成するCreate open extension | openTypeExtensionopenTypeExtension | オープン拡張機能を作成し、リソースの新規または既存のインスタンスのカスタム プロパティを追加します。Create an open extension and add custom properties in a new or existing instance of a resource. |
| オープン拡張機能を取得するGet open extension | openTypeExtension コレクションopenTypeExtension collection | 名前や完全修飾名によって識別されたオープン拡張機能オブジェクトを 1 つまたは複数取得します。Get an open extension object or objects identified by name or fully qualified name. |
| 拡張プロパティExtended properties | ||
| 単一値の拡張プロパティを作成するCreate single-value extended property | eventevent | 新規または既存のイベントに、1 つ以上の単一値の拡張プロパティを作成します。Create one or more single-value extended properties in a new or existing event. |
| 単一値の拡張プロパティを持つイベントの取得Get event with single-value extended property | eventevent | $expand または $filter を使用して、単一値の拡張プロパティを含むイベントを取得します。Get events that contain a single-value extended property by using $expand or $filter. |
| 複数値の拡張プロパティを作成するCreate multi-value extended property | eventevent | 新規または既存のイベントに、1 つ以上の複数値の拡張プロパティを作成します。Create one or more multi-value extended properties in a new or existing event. |
| 複数値の拡張プロパティを持つイベントの取得Get event with multi-value extended property | eventevent | $expand を使用して、複数値の拡張プロパティを含むイベントを取得します。Get an event that contains a multi-value extended property by using $expand. |
プロパティProperties
| プロパティProperty | 型Type | 説明Description |
|---|---|---|
| allowNewTimeProposalsallowNewTimeProposals | BooleanBoolean | 会議の開催者が、返信するときに新しい日時を提案することができる場合は True、それ以外の場合 false です。True if the meeting organizer allows invitees to propose a new time when responding, false otherwise. 省略可能です。Optional. 既定値は true です。Default is true. |
| attendeesattendees | attendee コレクションattendee collection | イベントの出席者のコレクション。The collection of attendees for the event. |
| bodybody | itemBodyitemBody | イベントに関連付けられたメッセージの本文。HTML 形式またはテキスト形式にできます。The body of the message associated with the event. It can be in HTML or text format. |
| bodyPreviewbodyPreview | StringString | イベントに関連付けられたメッセージのプレビュー。テキスト形式です。The preview of the message associated with the event. It is in text format. |
| categoriescategories | String collectionString collection | イベントに関連付けられたカテゴリ。The categories associated with the event. |
| changeKeychangeKey | StringString | イベント オブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
| createdDateTimecreatedDateTime | DateTimeOffsetDateTimeOffset | Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z' |
| endend | dateTimeTimeZonedateTimeTimeZone | イベントが終了する日付、時刻、タイムゾーンThe date, time, and time zone that the event ends. 既定で、終了時刻は UTC 単位です。By default, the end time is in UTC. |
| hasAttachmentshasAttachments | BooleanBoolean | イベントに添付ファイルが含まれている場合、true に設定します。Set to true if the event has attachments. |
| hideAttendeeshideAttendees | BooleanBoolean | true に設定すると、各出席者は会議出席依頼と会議の 管理 リストにのみ表示されます。When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. 既定値は false です。Default is false. |
| iCalUIdiCalUId | StringString | 予定表全体のイベントの固有識別子。A unique identifier for an event across calendars. この ID は、定期的なアイテムの出現ごとに異なります。This ID is different for each occurrence in a recurring series. 読み取り専用。Read-only. |
| idid | StringString | 読み取り専用です。Read-only. |
| importanceimportance | 重要度importance | イベントの重要度。The importance of the event. 使用可能な値: low、normal、high。The possible values are: low, normal, high. |
| isAllDayisAllDay | BooleanBoolean | イベントが一日中続く場合に、true に設定します。Set to true if the event lasts all day. |
| isCancelledisCancelled | BooleanBoolean | イベントがキャンセルされた場合に、true に設定します。Set to true if the event has been canceled. |
| isDraftisDraft | BooleanBoolean | ユーザーが Outlook で会議を更新したが、出席者に更新を送信していない場合は、true に設定します。Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. すべての変更が送信されている場合、またはイベントが出席者のいない予定の場合は、false に設定します。Set to false if all changes have been sent, or if the event is an appointment without any attendees. |
| isOnlineMeetingisOnlineMeeting | BooleanBoolean | このイベントにオンライン会議情報がある場合は True、そうでない場合は false。True if this event has online meeting information, false otherwise. 既定値は false です。Default is false. 省略可能です。Optional. |
| isOrganizerisOrganizer | BooleanBoolean | 予定表の所有者 (calendar の owner プロパティで指定) がイベントの主催者 (event の organizer プロパティで指定) の場合、true に設定されます。Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). 代理人が所有者の代わりにイベントを主催した場合にも適用されます。This also applies if a delegate organized the event on behalf of the owner. |
| isReminderOnisReminderOn | BooleanBoolean | ユーザーにイベントを通知するアラートを設定する場合は、true に設定します。Set to true if an alert is set to remind the user of the event. |
| lastModifiedDateTimelastModifiedDateTime | DateTimeOffsetDateTimeOffset | Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z' |
| locationlocation | locationlocation | イベントの場所。The location of the event. |
| locationslocations | location コレクションlocation collection | イベントを開催する場所、または参加者がいる場所。The locations where the event is held or attended from. location プロパティと locations プロパティは常に互いに一致します。The location and locations properties always correspond with each other. location プロパティを更新すると、locations コレクションに含まれる既存のすべての場所が削除されて、location の新しい値に置き換えられます。If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value. |
| onlineMeetingonlineMeeting | OnlineMeetingInfoOnlineMeetingInfo | 参加者がオンラインで会議に参加するための詳細。Details for an attendee to join the meeting online. 読み取り専用です。Read-only. |
| onlineMeetingProvideronlineMeetingProvider | onlineMeetingProviderTypeonlineMeetingProviderType | オンライン会議のサービス プロバイダーを表します。Represents the online meeting service provider. 使用可能な値は teamsForBusiness、skypeForBusiness、および skypeForConsumer。The possible values are teamsForBusiness, skypeForBusiness, and skypeForConsumer. 省略可能です。Optional. |
| onlineMeetingUrlonlineMeetingUrl | StringString | オンライン会議の URL。A URL for an online meeting. このプロパティは、開催者が Skype 会議などのオンライン会議としてイベントを指定する場合にのみ設定します。The property is set only when an organizer specifies an event as an online meeting such as a Skype meeting. 読み取り専用です。Read-only. |
| 構成内容変更organizer | recipientrecipient | イベントの開催者。The organizer of the event. |
| originalEndTimeZoneoriginalEndTimeZone | StringString | イベントの作成時に設定された終了タイム ゾーン。The end time zone that was set when the event was created. 値 tzone://Microsoft/Custom は、デスクトップの Outlook で、従来のカスタム タイム ゾーンが設定されていることを示します。A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. |
| originalStartoriginalStart | DateTimeOffsetDateTimeOffset | Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z' |
| originalStartTimeZoneoriginalStartTimeZone | StringString | イベントが作成されたときに設定された開始タイム ゾーン。値 tzone://Microsoft/Custom は、デスクトップの Outlook で、従来のカスタム タイム ゾーンが設定されていることを示します。The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. |
| recurrencerecurrence | patternedRecurrencepatternedRecurrence | イベントの繰り返しパターン。The recurrence pattern for the event. |
| reminderMinutesBeforeStartreminderMinutesBeforeStart | Int32Int32 | アラーム通知を行う、イベント開始時間前の分数。The number of minutes before the event start time that the reminder alert occurs. |
| responseRequestedresponseRequested | BooleanBoolean | 既定値は true なので、開催者は招待者にイベントに返信するように求めます。Default is true, which represents the organizer would like an invitee to send a response to the event. |
| responseStatusresponseStatus | responseStatusresponseStatus | イベント メッセージへの応答で送信される応答のタイプを識別します。Indicates the type of response sent in response to an event message. |
| sensitivitysensitivity | sensitivitysensitivity | 使用可能な値: normal、personal、private、confidential。The possible values are: normal, personal, private, confidential. |
| seriesMasterIdseriesMasterId | StringString | 対象イベントが定期的なアイテムの一部である場合、定期的なアイテムのマスター アイテムの ID。The ID for the recurring series master item, if this event is part of a recurring series. |
| showAsshowAs | freeBusyStatusfreeBusyStatus | 表示するステータス。The status to show. 使用可能な値: free、tentative、busy、oof、workingElsewhere、unknown。The possible values are: free, tentative, busy, oof, workingElsewhere, unknown. |
| 開始start | dateTimeTimeZonedateTimeTimeZone | イベントが開始する日付、時刻、タイムゾーン。The date, time, and time zone that the event starts. 既定で、開始時刻は UTC 単位です。By default, the start time is in UTC. |
| subjectsubject | StringString | イベントの件名行のテキスト。The text of the event's subject line. |
| transactionIdtransactionId | StringString | クライアント アプリケーションによって指定されたカスタム ID で、クライアントによって同じイベントの作成が再試行された場合に、冗長な POST 操作を回避できます。A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. これは、ネットワーク接続が低いと、クライアントが以前のイベント作成要求に対するサーバーからの応答を受信する前にタイムアウトする場合に役立ちます。This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. イベントの作成時に transactionId を設定した後、後続の更新で transactionId を変更することはできません。After you set transactionId when creating an event, you cannot change transactionId in a subsequent update. このプロパティは、アプリで設定されている場合にのみ、応答ペイロードで返されます。This property is only returned in a response payload if an app has set it. 省略可能です。Optional. |
| 型type | eventTypeeventType | イベントの種類。The event type. 使用可能な値: singleInstance、occurrence、exception、seriesMaster。The possible values are: singleInstance, occurrence, exception, seriesMaster. 読み取り専用です。Read-only. |
| webLinkwebLink | StringString | Web 上の Outlook でイベントを開く URL。The URL to open the event in Outlook on the web. Outlook on the web は、メールボックスにサインインしている場合、ブラウザーでイベントを開きます。Outlook on the web opens the event in the browser if you are signed in to your mailbox. それ以外の場合は、Outlook on the web はサインインするように求めます。Otherwise, Outlook on the web prompts you to sign in. この URL には、iFrame 内からアクセスできません。This URL cannot be accessed from within an iFrame. |
注意
webLink プロパティでは、Outlook on the web の以前のバージョンでのみイベントを開く URL を指定します。The webLink property specifies a URL that opens the event in only earlier versions of Outlook on the web. 以下はその URL 形式で、{event-id} は id プロパティの URL エンコード 値です。The following are the URL formats, with {event-id} being the URL-encoded value of the id property:
職場または学校のアカウントの場合:
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemFor work or school accounts:https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemMicrosoft アカウントの場合:
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemFor Microsoft accounts:https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Outlook on the web の現在のバージョンで URL を開くには、URL を次の形式のいずれかに変換し、その URL を使用してイベントを開きます。To open the event in a current version of Outlook on the web, convert the URL to one of the following formats, and use that URL to open the event:
職場または学校のアカウントの場合:
https://outlook.office365.com/calendar/item/{event-id}For work or school accounts:https://outlook.office365.com/calendar/item/{event-id}Microsoft アカウントの場合:
https://outlook.live.com/calendar/item/{event-id}For Microsoft accounts:https://outlook.live.com/calendar/item/{event-id}
リレーションシップRelationships
| リレーションシップRelationship | 型Type | 説明Description |
|---|---|---|
| attachmentsattachments | attachment コレクションattachment collection | イベントの fileAttachment 添付ファイルと itemAttachment 添付ファイルのコレクション。ナビゲーション プロパティ。読み取り専用。Null 許容型。The collection of fileAttachment and itemAttachment attachments for the event. Navigation property. Read-only. Nullable. |
| 予定表calendar | calendarcalendar | イベントを含む予定表。ナビゲーション プロパティ。読み取り専用。The calendar that contains the event. Navigation property. Read-only. |
| extensionsextensions | Extension コレクションExtension collection | イベントに対して定義されているオープン拡張機能のコレクション。読み取り専用。Null 許容型。The collection of open extensions defined for the event. Read-only. Nullable. |
| インスタンスinstances | event コレクションevent collection | イベントのインスタンス。ナビゲーション プロパティ。読み取り専用。Null 許容型。The instances of the event. Navigation property. Read-only. Nullable. |
| multiValueExtendedPropertiesmultiValueExtendedProperties | multiValueLegacyExtendedProperty collectionmultiValueLegacyExtendedProperty collection | イベントに対して定義された、複数値の拡張プロパティのコレクション。読み取り専用。Null 許容型。The collection of multi-value extended properties defined for the event. Read-only. Nullable. |
| singleValueExtendedPropertiessingleValueExtendedProperties | singleValueLegacyExtendedProperty collectionsingleValueLegacyExtendedProperty collection | イベントに対して定義された、単一値の拡張プロパティのコレクションです。読み取り専用。Null 許容型。The collection of single-value extended properties defined for the event. Read-only. Nullable. |
JSON 表記JSON representation
以下は、リソースの JSON 表記ですHere is a JSON representation of the resource
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"hasAttachments": true,
"hideAttendees": false,
"iCalUId": "string",
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"transactionId": "string",
"type": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}
関連項目See also
- デルタ クエリを使用して、Microsoft Graph データの変更を追跡するUse delta query to track changes in Microsoft Graph data
- フォルダー内のイベントへの増分の変更を取得するGet incremental changes to events in a folder
- 拡張機能を使用してカスタム データをリソースに追加するAdd custom data to resources using extensions
- オープン拡張機能を使用してカスタム データをユーザーに追加するAdd custom data to users using open extensions
- スキーマ拡張機能を使用したグループへのカスタム データの追加Add custom data to groups using schema extensions