Freebusy: query
Returns free/busy information for a set of calendars. Try it now. 一連のカレンダーの空き時間情報を返します。今すぐ試してください。
Request要求
HTTP requestHTTPリクエスト
POST https://www.googleapis.com/calendar/v3/freeBusy
Request bodyリクエストボディ
In the request body, supply data with the following structure:リクエストボディには、次の構造を持つデータを入力します。
{ "timeMin": datetime, "timeMax": datetime, "timeZone": string, "groupExpansionMax": integer, "calendarExpansionMax": integer, "items": [ { "id": string } ] }
Property nameプロパティ名 | Value値 | Description説明 | Notesノート |
---|---|---|---|
timeMin |
datetime |
The start of the interval for the query formatted as per RFC3339.RFC3339に従って フォーマットされたクエリの間隔の開始。 | |
timeMax |
datetime |
The end of the interval for the query formatted as per RFC3339.RFC3339に従って フォーマットされた照会の間隔の終わり。 | |
timeZone |
string |
Time zone used in the response. Optional. The default is UTC.応答に使用されたタイムゾーン。オプションです。デフォルトはUTCです。 | |
groupExpansionMax |
integer |
Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.単一グループに提供されるカレンダ識別子の最大数。オプションです。この値よりも多くのメンバーを持つグループに対してはエラーが返されます。最大値は100です。 | |
calendarExpansionMax |
integer |
Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.FreeBusy情報が提供される予定の最大カレンダー数。オプションです。最大値は50です。 | |
items[] |
list |
List of calendars and/or groups to query.照会するカレンダーやグループのリスト。 | |
items[].id |
string |
The identifier of a calendar or a group.カレンダーまたはグループの識別子。 |
Response応答
If successful, this method returns a response body with the following structure:成功した場合、このメソッドは以下の構造を持つレスポンスボディを返します。
{ "kind": "calendar#freeBusy", "timeMin": datetime, "timeMax": datetime, "groups": { (key): { "errors": [ { "domain": string, "reason": string } ], "calendars": [ string ] } }, "calendars": { (key): { "errors": [ { "domain": string, "reason": string } ], "busy": [ { "start": datetime, "end": datetime } ] } } }
Property nameプロパティ名 | Value値 | Description説明 | Notesノート |
---|---|---|---|
kind |
string |
Type of the resource ("calendar#freeBusy").リソースの種類( "calendar#freeBusy")。 | |
timeMin |
datetime |
The start of the interval.間隔の始まり。 | |
timeMax |
datetime |
The end of the interval.間隔の終わり | |
groups |
object |
Expansion of groups.グループの拡大 | |
groups.(key) |
nested object |
List of calendars that are members of this group.このグループのメンバーであるカレンダーのリスト。 | |
groups.(key).errors[] |
list |
Optional error(s) (if computation for the group failed).オプションのエラー(グループの計算に失敗した場合)。 | |
groups.(key).errors[].domain |
string |
Domain, or broad category, of the error.エラーのドメイン、または広いカテゴリ。 | |
groups.(key).errors[].reason |
string |
Specific reason for the error. Some of the possible values are:
|
|
groups.(key).calendars[] |
list |
List of calendars' identifiers within a group.グループ内のカレンダーの識別子のリスト。 | |
calendars |
object |
List of free/busy information for calendars.カレンダーの空き時間情報のリスト。 | |
calendars.(key) |
nested object |
Free/busy expansions for a single calendar.単一カレンダーの空き時間情報の拡張 | |
calendars.(key).errors[] |
list |
Optional error(s) (if computation for the calendar failed).オプションのエラー(カレンダーの計算に失敗した場合)。 | |
calendars.(key).errors[].domain |
string |
Domain, or broad category, of the error.エラーのドメイン、または広いカテゴリ。 | |
calendars.(key).errors[].reason |
string |
Specific reason for the error. Some of the possible values are:
|
|
calendars.(key).busy[] |
list |
List of time ranges during which this calendar should be regarded as busy.このカレンダーが話中と見なされる期間のリスト。 | |
calendars.(key).busy[].start |
datetime |
The (inclusive) start of the time period.期間の(両端を含む)開始。 | |
calendars.(key).busy[].end |
datetime |
The (exclusive) end of the time period.期間の(排他的な)終わり。 |
Try it!それを試してみてください!
Use the APIs Explorer below to call this method on live data and see the response. 以下のAPI Explorerを使用して、ライブデータに対してこのメ??ソッドを呼び出して応答を確認してください。
スポンサーリンク