このページは Cloud Translation API によって翻訳されました。

Freebusy: query

一連のカレンダーの空き時間情報を返します。実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/calendar/v3/freeBusy

承認

このリクエストにより、次のスコープのうち少なくとも 1 つによる承認が可能になります。

範囲
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`

詳細については、認証と承認のページをご覧ください。

リクエスト本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}

プロパティ名	値	説明
`timeMin`	`datetime`	クエリの開始間隔。RFC3339 の形式で指定します。
`timeMax`	`datetime`	RFC3339 形式のクエリ間隔の終わり。
`timeZone`	`string`	レスポンスで使用されるタイムゾーン。（省略可）デフォルト値は UTC です。
`groupExpansionMax`	`integer`	1 つのグループで使用できるカレンダー ID の最大数。（省略可）メンバー数がこの値よりも多いグループの場合は、エラーが返されます。最大値は 100 です。
`calendarExpansionMax`	`integer`	FreeBusy 情報を提供するカレンダーの最大数。（省略可）最大値は 50 です。
`items[]`	`list`	クエリを実行するカレンダーまたはグループのリスト。
`items[].id`	`string`	カレンダーまたはグループの ID。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "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
        }
      ]
    }
  }
}

プロパティ名	値	説明
`kind`	`string`	リソースのタイプ（「calendar#freeBusy」）。
`timeMin`	`datetime`	間隔の開始。
`timeMax`	`datetime`	間隔の終わり。
`groups`	`object`	グループの拡張。
`groups.(key)`	`nested object`	このグループのメンバーであるカレンダーのリスト。
`groups.(key).errors[]`	`list`	オプションエラー（グループの計算に失敗した場合）。
`groups.(key).errors[].domain`	`string`	エラーのドメインまたは部分一致のカテゴリ。
`groups.(key).errors[].reason`	`string`	エラーの具体的な理由です。有効な値は次のとおりです。「`groupTooBig`」 - 要求されたユーザーのグループが大きすぎるため、1 つのクエリには対処できません。「`tooManyCalendarsRequested`」- 1 つのクエリに対してリクエストされたカレンダーの数が多すぎます。「`notFound`」- リクエストされたリソースが見つかりませんでした。「`internalError`」- API サービスで内部エラーが発生しました。今後エラータイプが追加される可能性があるため、クライアントはこのリストに含まれていないエラーステータスを適切に処理する必要があります。
`groups.(key).calendars[]`	`list`	グループ内のカレンダーの ID のリスト。
`calendars`	`object`	カレンダーの空き時間情報のリスト
`calendars.(key)`	`nested object`	1 つのカレンダーの空き時間情報の拡張。
`calendars.(key).errors[]`	`list`	オプションのエラー（カレンダーの計算が失敗した場合）。
`calendars.(key).errors[].domain`	`string`	エラーのドメインまたは部分一致のカテゴリ。
`calendars.(key).errors[].reason`	`string`	エラーの具体的な理由です。有効な値は次のとおりです。「`groupTooBig`」 - 要求されたユーザーのグループが大きすぎるため、1 つのクエリには対処できません。「`tooManyCalendarsRequested`」- 1 つのクエリに対してリクエストされたカレンダーの数が多すぎます。「`notFound`」- リクエストされたリソースが見つかりませんでした。「`internalError`」- API サービスで内部エラーが発生しました。今後エラータイプが追加される可能性があるため、クライアントはこのリストに含まれていないエラーステータスを適切に処理する必要があります。
`calendars.(key).busy[]`	`list`	このカレンダーで予定があるとみなされる時間帯のリスト。
`calendars.(key).busy[].start`	`datetime`	期間の開始日です。
`calendars.(key).busy[].end`	`datetime`	期間の終了日です。

実習

以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。