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

[アーティクル]
03/26/2023

名前空間: microsoft.graph

重要

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

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

通知には、オペレーティングシステム (Windows、Android、iOS プラットフォーム) によって解釈できる視覚的な通知ペイロードを指定できます。また、アプリクライアント (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 年 1 月 1 日の午前 0 時 UTC は次のようになります)。 `'2019-01-01T00:00:00Z'` 時間が経過すると、通知は Microsoft Graph 通知フィードストアから完全に削除され、通知履歴の一部ではなくなります。最大値は 30 日です。
priority	string	生のユーザー通知の優先順位を示します。既定では、ビジュアル通知は優先度の高い状態で送信されます。有効な値は、`None`、`High`、`Low` です。
fallbackPolicy	fallbackpolicy	オプションのフォールバックポリシーオブジェクトは、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"} 
}