イベントを一覧表示する

[アーティクル]
12/06/2021

名前空間: microsoft.graph

予定表のイベント一覧を取得します。予定表には、ユーザーの予定表、または Microsoft 365 グループの既定の予定表のいずれかを指定できます。イベントの一覧には、単一インスタンスの会議と定期的なマスターが含まれています。

拡張イベントのインスタンスを取得すると、予定表ビューを取得するまたはイベントのインスタンスを取得することができます。

アクセス許可

イベントが含まれている予定表の種類および要求されたアクセス許可の種類 (委任またはアプリケーション) に応じて、この API を呼び出すには、次のいずれかの権限が必要です。アクセス許可の選択方法など、くわしくは「アクセス許可」を参照してください。

予定表	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
ユーザーの予定表	Calendars.Read、Calendars.ReadWrite	Calendars.Read、Calendars.ReadWrite	Calendars.Read、Calendars.ReadWrite
グループ予定表	Group.Read.All、Group.ReadWrite.All	サポートされていません。	サポートされていません。

HTTP 要求

ユーザーまたはグループの既定の予定表。

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

既定の calendarGroup のユーザーの予定表。

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

指定の calendarGroup のユーザーの予定表。

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

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

このメソッドは、応答をカスタマイズするための OData クエリパラメーターをサポートします。

要求ヘッダー

名前	型	説明
Authorization	string	ベアラー {token}。必須。
優先: outlook.timezone	string	これを使用して、応答内の開始および終了時刻のタイムゾーンを指定します。指定しなかった場合、時刻の値は UTC で返されます。オプション。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で Event オブジェクトのコレクションを返します。

例

例 1: 予定表イベントの一覧表示

要求

以下は、要求の例です。

GET https://graph.microsoft.com/v1.0/me/calendar/events


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var events = await graphClient.Me.Calendar.Events
    .Request()
    .Filter("startsWith(subject,'All')")
    .GetAsync();


const options = {
    authProvider,
};

const client = Client.init(options);

let events = await client.api('/me/calendar/events')
    .filter('startsWith(subject,\'All\')')
    .get();


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/calendar/events?$filter=startsWith(subject,'All')"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphEvent *event = [[MSGraphEvent alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EventCollectionPage events = graphClient.me().calendar().events()
    .buildRequest()
    .filter("startsWith(subject,'All')")
    .get();


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &msgraphsdk.EventsRequestBuilderGetQueryParameters{
    Filter: "startsWith(subject,'All')",
}
options := &msgraphsdk.EventsRequestBuilderGetRequestConfiguration{
    QueryParameters: requestParameters,
}
result, err := graphClient.Me().Calendar().Events().GetWithRequestConfigurationAndResponseHandler(options, nil)

応答

以下に応答の例を示します。注: ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}

例 2: subject プロパティをフィルター処理してイベントを取得する

この例では、"All" で始まる件名をフィルター処理して、ユーザーのプライマリカレンダーのイベントを取得します。

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/me/calendar/events?$filter=startsWith(subject,'All')


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var events = await graphClient.Me.Calendar.Events
    .Request()
    .Filter("startsWith(subject,'All')")
    .GetAsync();


const options = {
    authProvider,
};

const client = Client.init(options);

let events = await client.api('/me/calendar/events')
    .filter('startsWith(subject,\'All\')')
    .get();


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/calendar/events?$filter=startsWith(subject,'All')"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphEvent *event = [[MSGraphEvent alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EventCollectionPage events = graphClient.me().calendar().events()
    .buildRequest()
    .filter("startsWith(subject,'All')")
    .get();


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &msgraphsdk.EventsRequestBuilderGetQueryParameters{
    Filter: "startsWith(subject,'All')",
}
options := &msgraphsdk.EventsRequestBuilderGetRequestConfiguration{
    QueryParameters: requestParameters,
}
result, err := graphClient.Me().Calendar().Events().GetWithRequestConfigurationAndResponseHandler(options, nil)

応答