Microsoft Graph で Microsoft Bookings API を使用する

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

Microsoft Bookings では、エンタープライズ組織や小規模ビジネスのオーナーが最小限の設定で顧客の予約と情報を管理できます。 ビジネス オーナーは、一連のサービスを提供するビジネスを 1 つ以上作成できます。 オーナーはスタッフを設定し、各スタッフが実施するサービスを指定できます。 顧客は当該ビジネスの特定のサービスをオンラインまたはモバイル アプリから予約できます。 Bookings では、ビジネス、スタッフ、顧客に対し常に最新の予約情報が提供されます。

Bookings API の bookingBusiness は、プログラムで次のオブジェクトを使用します。

Bookings REST API を使用する

顧客の予約を初めて受け付ける前に、次の手順を行います。 対応する操作のための適切なアクセス トークンを提供していることを確認します。

  1. ビジネスで Microsoft 365 Business Premium サブスクリプションを購入していることを確認します。
  2. エンティティ セットに POST 操作を送信して新しい bookingBusiness を作成します。 最小限でも、顧客に対して表示される新しいビジネスの名前を指定してください。
POST https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Contoso"
}

POST 応答で返される新しい bookingBusinessid プロパティを使用して、ビジネス設定をカスタマイズし、ビジネスのスタッフとサービスを追加します。

  1. ビジネスの個々のスタッフを追加します。
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/staffMembers
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Dana Swope",
    "emailAddress": "danas@contoso.com",
    "role": "externalGuest"
}
  1. ビジネスで提供する各サービスを定義します。
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/services
Authorization: Bearer {access token}
Content-Type: application/json

{
    "displayName":"Bento"
}
  1. ビジネスのスケジュール ページを公開し、顧客とビジネス運営担当者が予約の受付を開始できるようにします。
POST https://graph.microsoft.com/beta/bookingBusinesses/{id}/publish
Authorization: Bearer {access token}

一般に、Microsoft 365 テナントの予約ビジネスをすべて一覧表示するには次のようにします。

GET https://graph.microsoft.com/beta/bookingBusinesses
Authorization: Bearer {access token}

一般的なユース ケース

次の表は、Bookings API でのビジネスの一般的な操作を示します。

ユース ケース REST リソース 関連項目
ビジネスの作成、取得、更新、または削除 bookingBusiness bookingBusiness のメソッド
スケジュール ポリシーの更新 bookingSchedulingPolicy bookingBusiness を更新する
スタッフの追加、取得、更新、または削除 bookingStaffMember bookingStaffMember のメソッド
サービスの追加、取得、更新、または削除 bookingService bookingService のメソッド
スケジュール ページの公開または公開の取り消し bookingBusiness publish
unpublish
予約の作成、取得、更新、削除、またはキャンセル bookingAppointment bookingAppointment のメソッド
日付範囲内の予約の取得 bookingBusiness List Bookings calendarView
通貨の取得 bookingCurrency bookingCurrency のメソッド