サブスクリプションを作成する
データが変更されたときに通知を受信するリスナー アプリケーションに登録します。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All |
アプリケーション | Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All |
HTTP 要求
POST /subscriptions
応答
成功した場合、このメソッドは 201 Created
応答コードと、応答本文に入った subscription オブジェクトを返します。
例
要求
ユーザーのドライブの内容が変更したときに通知を送信する要求の例を次に示します。
POST /subscriptions
Content-type: application/json
{
"changeType": "updated",
"notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
"resource": "/me/drive/root",
"expirationDateTime": "2018-01-01T11:23:00.000Z",
"clientState": "client-specific string"
}
応答
サブスクリプションを追加する場合、新たに作成されたサブスクリプション オブジェクトを含む 201 Created
応答が返されます。
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "1039149811asbc",
"resource": "/me/drive/root",
"changeType": "updated",
"clientState": "client-specific string",
"notificationUrl": "https://contoso.azurewebsites.net/api/webhook-receiver",
"expirationDateTime": "2016-01-01T11:23:00.000Z"
}
サブスクリプションの検証
新しいサブスクリプションを作成する前に、Microsoft Graph は新しいサブスクリプションを作成するために、要求で指定された URL に要求を送信します。 サービスは、検証キーを返すことで、この要求に応答する必要があります。
この方法でサービスが要求の検証に失敗した場合、サブスクリプションの作成は失敗します。
詳細については、「webhook 検証要求の処理」を参照してください。
エラー応答
エラーがどのように返されるかについては、「エラー応答」を参照してください。