通知リソースの種類 (非推奨)

名前空間: microsoft.graph

重要

Microsoft Graph 通知 API は非推奨になり、2022 年 1 月末までにデータの返送を停止します。 別の通知エクスペリエンスについては、Microsoft Azure Notification Hubs を参照してください。詳細については、このブログ投稿を参照してください。

指定したユーザーを対象とするアプリ サーバーによって発行される通知を表します。 通知は Microsoft Graphに保存され、ユーザーが所有する別のデバイス エンドポイントに配布されます。

通知には、オペレーティング システム (android、Android、および iOS プラットフォームWindows解釈できる視覚的な通知ペイロードを指定できます。 また、アプリ クライアント (Web を含む) に配信および処理されるデータ ペイロード (rawContent) を使用して、各デバイスで対応するユーザー エクスペリエンスを決定することもできます。 これは通常、ローカルで生成される視覚的な通知 UI で、元のデータ ペイロード内のコンテンツに対応します。

ユーザーが視覚的な通知を実行すると、アプリ クライアントはクライアント側の通知 SDK を使用して、Microsoft Graph で対応する通知フィードの状態を更新できます 。たとえば、通知を却下としてマークします。 その後、更新プログラムは他のすべてのアプリ クライアント エンドポイントに配布され、クライアントは、通知を却下して、ユーザーが冗長な情報を見るのを防ぐなどして、変更を処理します。 アプリ クライアントは、通知 SDK を介して通知履歴として、有効期限が切れる前に (却下済みとしてマークされた後でも) 後で同じ通知リソースに アクセスできます。

注意

通知状態の更新 (読み取りや却下など) は、Web エンドポイントにファンアウトされません。 これは、さまざまなブラウザーで Web プッシュを行う場合、ユーザーに対して視覚的なトースト通知を表示する必要があるためです。 状態の変更には対応するビジュアル コンテンツが存在しないので、これらの変更は、Windows、iOS、または Android プラットフォームを対象とする通知にのみ表示されます。

メソッド

メソッド	戻り値の型	説明
通知の作成	通知	通知を作成して送信します。

プロパティ

プロパティ	型	説明
targetHostName	String	呼び出し元サービスが通知を投稿するアプリのホスト名を、指定したユーザーに対して表します。 Web エンドポイントを対象とする場合 ( targetPolicy.platformTypes を参照)、 targetHostName がアプリケーション JSON プロパティ内でクライアント側でサブスクリプションを作成するときに使用される名前と同じことを確認します。
appNotificationId	String	個々の通知を識別してターゲットに設定するために使用される通知のアプリ サーバーによって設定された一意の ID。
groupName	String	この通知が属するグループの名前。 これは、通知をグループ化する目的で開発者によって設定されます。
targetPolicy	targetPolicyEndpoints	ターゲット ポリシー オブジェクトは、特定のユーザーを対象とするエンドポイントの種類 (Windows、iOS、Android、WebPush) の通知配信ポリシーを処理します。
payload	payloadTypes	これは、この通知を受け取るアプリ クライアントに配信され、使用される生または視覚的なユーザー通知のデータコンテンツです。
displayTimeToLive	Int32	この通知コンテンツが各プラットフォームの通知ビューアーに残る時間 (秒) を設定します。 たとえば、通知が Windows デバイスに配信される場合、このプロパティの値は ToastNotification.ExpirationTime に渡され、トースト通知がユーザーの Windows アクション センターに残る期間を決定します。
expirationDateTime	DateTimeOffset	ISO 8601 形式を使用してユーザー通知に UTC の有効期限と時刻を設定します (たとえば、2019 '2019-01-01T00:00:00Z'年 1 月 1 日の午前 0 時の UTC は次のようになります)。 時刻が上がると、通知は Microsoft Graphから完全に削除され、通知履歴の一部ではなくなりました。 最大値は 30 日です。
priority	string	生のユーザー通知の優先度を示します。 既定では、ビジュアル通知は優先度が高い状態で送信されます。 有効な値は、None、High、Low です。
フォールバックPolicy	フォールバックポリシー	オプションのフォールバック ポリシー オブジェクトは、iOS エンドポイントの通知フォールバック ポリシーのみを処理し、プラットフォーム固有の制限 (バッテリー セーバー モードなど) のためにデバイスに配信されない可能性がある優先度の高い生の通知に使用するように設計されています。

リレーションシップ

なし。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "targetHostName": "String",
  "appNotificationid": "String (identifier)",
  "groupName": "String", 
  "targetPolicy": {"@odata.type": "microsoft.graph.targetPolicyEndpoints"},
  "payload": {"@odata.type": "microsoft.graph.payloadTypes"},
  "displayTimeToLive": 1024,
  "expirationDateTime": "String (timestamp)",
  "priority": "string",
  "fallbackPolicy": {"@odata.type": "microsoft.graph.fallbackpolicy"} 
}