イベントを一覧表示するList events

ユーザーのメールボックス内のイベント オブジェクトの一覧を取得します。一覧には、単一インスタンスの会議と定期的なマスターが含まれています。Get a list of event objects in the user's mailbox. The list contains single instance meetings and series masters.

拡張イベントのインスタンスを取得すると、予定表ビューを取得するまたはイベントのインスタンスを取得することができます。To get expanded event instances, you can get the calendar view, or get the instances of an event.

現在、この操作によって返されるイベントの本文は HTML 形式のみです。Currently, this operation returns event bodies in only HTML format.

アプリが別のユーザーの予定表のイベントを取得できるシナリオが 2 つあります。There are two scenarios where an app can get events in another user's calendar:

  • アプリにアプリケーションのアクセス許可がある場合。またはIf the app has application permissions, or,
  • アプリに「あるユーザーから適切に委任されたアクセス許可」があり、別のユーザーがそのユーザーと予定表を共有しているか、そのユーザーに委任されたアクセスを付与している場合。If the app has the appropriate delegated permissions from one user, and another user has shared a calendar with that user, or, has given delegated access to that user. 詳細と例を参照してください。See details and an example.

さまざまなタイム ゾーンをサポートします。Support various time zones

イベントを返す GET 操作の場合は、すべての操作で Prefer: outlook.timezone ヘッダーを使用して、応答のイベントの開始時刻と終了時刻のタイム ゾーンを指定できます。For all GET operations that return events, you can use the Prefer: outlook.timezone header to specify the time zone for the event start and end times in the response.

たとえば、次の Prefer: outlook.timezone ヘッダーは、応答の開始時刻と終了時刻を東部標準時に設定します。For example, the following Prefer: outlook.timezone header sets the start and end times in the response to Eastern Standard Time.

Prefer: outlook.timezone="Eastern Standard Time"

イベントが別のタイム ゾーンで作成された場合は、開始時刻と終了時刻は Prefer ヘッダーで指定したタイム ゾーンに合わせて調整されます。サポートされているタイム ゾーン名については、この一覧を参照してください。Prefer: outlook.timezone ヘッダーを指定しない場合、開始時刻と終了時刻は UTC で返されます。If the event was created in a different time zone, the start and end times will be adjusted to the time zone specified in that Prefer header. See this list for the supported time zone names. If the Prefer: outlook.timezone header is not specified, the start and end times are returned in UTC.

イベントリソース上で OriginalStartTimeZone プロパティと OriginalEndTimeZone プロパティを使用して、イベント作成時に使用されたタイム ゾーンを検索できます。You can use the OriginalStartTimeZone and OriginalEndTimeZone properties on the event resource to find out the time zone used when the event was created.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
アプリケーションApplication Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

HTTP 要求HTTP request

GET /me/events
GET /users/{id | userPrincipalName}/events

GET /me/calendar/events
GET /users/{id | userPrincipalName}/calendar/events

GET /me/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendars/{id}/events

GET /me/calendargroup/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendargroup/calendars/{id}/events

GET /me/calendargroups/{id}/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

要求ヘッダーRequest headers

名前Name Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.
優先: outlook.timezonePrefer: outlook.timezone stringstring これを使用して、応答内の開始および終了時刻のタイム ゾーンを指定します。Use this to specify the time zone for start and end times in the response. 指定しない場合、これらの時刻値は UTC で返されます。If not specified, those time values are returned in UTC. 省略可能。Optional.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type stringstring body プロパティが返されるときの形式です。The format of the body property to be returned in. 値は、"text" または "html" になります。Values can be "text" or "html". この Prefer ヘッダーが指定されている場合、Preference-Applied ヘッダーが確認として返されます。A Preference-Applied header is returned as confirmation if this Prefer header is specified. このヘッダーが指定されていない場合は、body プロパティが HTML 形式で返されます。If the header is not specified, the body property is returned in HTML format. 省略可能。Optional.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で event オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and collection of event objects in the response body.

Example

要求Request

以下は、要求の例です。以下のものを指定します。Here is an example of the request. It specifies the following:

  • 太平洋標準時で返される日時の値を取得するための Prefer: outlook.timezone ヘッダー。A Prefer: outlook.timezone header to get date time values returned in Pacific Standard Time.
  • 特定のプロパティを返すための $select クエリ パラメーター。$select パラメーターがない場合には、すべてのイベント プロパティが返されます。A $select query parameter to return specific properties. Without a $select parameter, all of the event properties will be returned.
GET https://graph.microsoft.com/v1.0/me/events?$select=subject,body,bodyPreview,organizer,attendees,start,end,location
Prefer: outlook.timezone="Pacific Standard Time"
応答Response

以下は、応答の例です。body プロパティが既定の HTML 形式で返されます。Here is an example of the response. The body property is returned in the default HTML format.

HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.timezone="Pacific Standard Time"
Content-length: 1932

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview,organizer,attendees,start,end,location)",
    "value":[
        {
            "@odata.etag":"W/\"ZlnW4RIAV06KYYwlrfNZvQAAKGWwbw==\"",
            "id":"AAMkAGIAAAoZDOFAAA=",
            "subject":"Orientation ",
            "bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
            "body":{
                "contentType":"html",
                "content":"<html><head></head><body><p>Dana, this is the time you selected for our orientation. Please bring the notes I sent you.</p></body></html>"
            },
            "start":{
                "dateTime":"2017-04-21T10:00:00.0000000",
                "timeZone":"Pacific Standard Time"
            },
            "end":{
                "dateTime":"2017-04-21T12:00:00.0000000",
                "timeZone":"Pacific Standard Time"
            },
            "location": {
                "displayName": "Assembly Hall",
                "locationType": "default",
                "uniqueId": "Assembly Hall",
                "uniqueIdType": "private"
            },
            "locations": [
                {
                    "displayName": "Assembly Hall",
                    "locationType": "default",
                    "uniqueIdType": "unknown"
                }
            ],
            "attendees":[
                {
                    "type":"required",
                    "status":{
                        "response":"none",
                        "time":"0001-01-01T00:00:00Z"
                    },
                    "emailAddress":{
                        "name":"Samantha Booth",
                        "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
                    }
                },
                {
                    "type":"required",
                    "status":{
                        "response":"none",
                        "time":"0001-01-01T00:00:00Z"
                    },
                    "emailAddress":{
                        "name":"Dana Swope",
                        "address":"danas@a830edad905084922E17020313.onmicrosoft.com"
                    }
                }
            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
                }
            }
        }
    ]
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var events = await graphClient.Me.Events
    .Request()
    .Header("Prefer","outlook.timezone="Pacific Standard Time"")
    .Select( e => new {
             e.Subject,
             e.Body,
             e.BodyPreview,
             e.Organizer,
             e.Attendees,
             e.Start,
             e.End,
             e.Location 
             })
    .GetAsync();

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.