通知リソースの種類notification resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

指定したユーザーを対象とするアプリサーバーによって発行される通知を表します。Represents a notification that is published by an app server that targets a specified user. 通知は Microsoft Graph に格納され、ユーザーが所有する異なるデバイスエンドポイントに配布されます。The notification is stored in Microsoft Graph and is distributed to different device endpoints owned by the user.

通知は、Windows、Android、iOS のプラットフォームを含む、オペレーティングシステムによって解釈可能な視覚的な通知のペイロードである場合があります。A notification can be a visual notification payload that can be interpreted by the operating system, including Windows, Android, and iOS platforms. また、アプリクライアントによって配信および処理されるデータペイロードを使用して、各デバイスで対応するユーザーの動作を決定します。通常は、生成された元のデータペイロードのコンテンツに対応するビジュアル通知 UI を示します。マシン.It can also be a data payload that's delivered to and handled by app clients, which then determine the corresponding user experience on each device – usually, a visual notification UI that corresponds to the content in the original data payload that's generated locally.

ユーザーが視覚的な通知を処理すると、アプリクライアントはクライアント側のプロジェクトローマ SDK を使用して、通知を非表示としてマークするなど、Microsoft Graph で対応する通知フィードの状態を更新することができます。When a user acts on a visual notification, the app client can then use client-side Project Rome SDK to update the state of the corresponding notification feed in Microsoft Graph - for example, by marking a notification as dismissed. その後、その更新は他のすべてのアプリクライアントエンドポイントに配布され、クライアントは、ユーザーが冗長情報を表示できないようにするために、その変更をそれに応じて処理します。The update will then be distributed to all other app client endpoints, and the clients handle the change accordingly, for example by dismissing the notification to prevent the user from seeing redundant information. アプリクライアントは、 Project ローマ SDKを介して、通知履歴として、(非表示とマークされた後でも) 有効期限が切れる前に、後で同じ通知リソースにアクセスできます。App clients can access the same notification resource at a later time before it expires (even after it is marked as dismissed), as notification history, via the Project Rome SDK.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
通知の作成Create notification お知らせnotification 通知を作成し、送信します。Create and send a notification.

プロパティProperties

名前Name Type 説明Description
targetHostNametargetHostName StringString 指定されたユーザーについて、呼び出し元サービスが通知を投稿するアプリケーションのホスト名を表します。Represents the host name of the app to which the calling service wants to post the notification, for the given user.
appNotificationIdappNotificationId StringString 通知のアプリサーバーによって設定された一意の id。個別の通知を識別して対象にします。The unique id set by the app server of a notification that is used to identify and target an individual notification.
expirationDateTimeexpirationDateTime DateTimeOffsetDateTimeOffset ユーザー通知の UTC 有効期限を設定します。時間が経過すると、通知は Microsoft Graph 通知フィードストアから完全に削除され、通知履歴の一部ではなくなります。Sets a UTC expiration time on a user notification - when time is up, the notification is removed from the Microsoft Graph notification feed store completely and is no longer part of notification history. 最大値は30日です。Max value is 30 days.
payloadpayload Edm ComplexType、JSON オブジェクトEdm.ComplexType, JSON object これは、この通知を受信するアプリクライアントによって配信および消費される生または視覚的なユーザー通知のデータの内容です。This is the data content of a raw or visual user notification that will be delivered to and consumed by the app client receiving this notification.
ペイロードコンテンツpayload.rawContent StringString この通知を受信するアプリクライアントによって配信および消費される生のユーザー通知の通知の内容。The notification content of a raw user notification that will be delivered to and consumed by the app client receiving this notification. POST 通知要求に対しては、少なくとも1つの Content-type コンテンツとペイロードコンテンツが有効である必要があります。At least one of Payload.RawContent and Payload.VisualContent needs to be valid for a POST Notification request.
ペイロードpayload.visual Edm ComplexType、JSON オブジェクトEdm.ComplexType, JSON object 各モバイルプラットフォームの通知プラットフォームによって使用され、ユーザーに対してレンダリングされる、ビジュアルユーザー通知のビジュアルコンテンツ。The visual content of a visual user notification, which will be consumed by the notification platform on each mobile platform and rendered for the users. POST 通知要求に対して、少なくとも1つのコンテンツおよび VisualContent が有効である必要があります。At least one of Content and VisualContent needs to be valid for a POST Notification request.
ペイロードpayload.visual.title StringString ビジュアルユーザー通知のタイトル。The title of a visual user notification. Title または body のいずれかを指定する必要があります。Must have either title or body.
ペイロードpayload.visual.body StringString ビジュアルユーザー通知の本文。The body of a visual user notification. Title または body のいずれかを指定する必要があります。Must have either title or body.
displayTimeToLivedisplayTimeToLive IntInt この通知コンテンツを各プラットフォームの通知ビューアーに保持する時間 (秒単位) を設定します。Sets how long (in seconds) this notification content will stay in each platform’s notification viewer. たとえば、Windows デバイスに通知が配信されると、このプロパティの値が ToastNotification に渡されます。この値によって、トースト通知がユーザーの Windows アクションセンターに保持される期間が決まります。For example, when the notification is delivered to a Windows device, the value of this property is passed on to ToastNotification.ExpirationTime, which determines how long the toast notification will stay in the user’s Windows Action Center.
prioritypriority EnumTypeEnumType 生のユーザー通知の優先度を示します。Indicates the priority of a raw user notification. 既定では、視覚通知は高優先度で送信されます。Visual notifications are sent with high priority by default. 有効な値は High と Low です。Valid values are High and Low.
groupNamegroupName StringString この通知が属するグループの名前。The name of the group that this notification belongs to. これは、通知をグループ化するための開発者によって設定されます。It is set by the developer for the purpose of grouping notifications together.
targetPolicytargetPolicy Edm ComplexType、JSON オブジェクトEdm.ComplexType, JSON object ターゲットポリシーオブジェクトは、対象とする必要があるエンドポイントの種類 (Windows、iOS、および Android) と、対象とする必要がある特定のエンドポイント (サブスクリプション id で識別される) の2つの異なるレベルで通知配信ポリシーを処理します。Target policy object handles notification delivery policy at two different levels - endpoint types (Windows, iOS and Android) that should be targeted, and specific endpoints (identified by subscription ids) that should be targeted.
targetPolicy の種類targetPolicy.platformTypes Edm ComplexType、コレクション (EnumType)Edm.ComplexType, Collection (EnumType) 特定のプラットフォームまたはプラットフォームに対して通知配布をフィルター処理するために使用します。Use to filter the notification distribution to a specific platform or platforms. 既定では、すべてのプッシュエンドポイントの種類 (iOS、Windows、および Android) が有効になっています。By default, all push endpoint types (iOS, Windows, and Android) are enabled.

リレーションシップRelationships

なし。None.

JSON 表記JSON representation

次に示すのは、移行先のオペレーティングシステムに配信される直接の視覚的な通知を発行するときのリソースの JSON 表記です。The following is a JSON representation of the resource when you publish a direct visual notification that is delivered to the destination operating system.

{   
  "targetHostName": "String",
  "appNotificationId": "String",
  "expirationDateTime": "DateTimeOffset",
  "payload":  
  {
    "visualContent": 
    {
      "title": "String",
      "body": "String"
    },
  },
  "displayTimeToLive": "Int",
  "priority": "Enum",
  "groupName": "String",
  "targetPolicy":
  {
    "platformTypes": [ 
      "Enum"
    ]
  }
}

アプリクライアントに配信される生データ通知を発行するときの、リソースの JSON 表記を次に示します。The following is a JSON representation of the resource when you publish a raw data notification that is delivered to app clients.

{   
  "targetHostName": "String",
  "appNotificationId": "String",
  "expirationDateTime": "DateTimeOffset",
  "payload":  
  {
    "rawContent": "String"
  },
  "displayTimeToLive": "Int",
  "priority": "Enum",
  "groupName": "String",
  "targetPolicy":
  {
    "platformTypes": [ 
      "Enum"
    ]
  }
}