Viva Engage

  • リファレンス

Viva Engage は、企業がよりスマートかつ迅速に仕事をこなすための主要なソーシャル ネットワークです。 Viva Engage に接続して、エンタープライズ ネットワークの会話にアクセスします。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate Standard 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps Standard 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
連絡先
件名 Microsoft
URL Microsoft LogicApps サポート
Microsoft Power Automate サポート
Microsoft Power Apps サポート
コネクタ メタデータ
公開元 Microsoft
Web サイト https://products.office.com/yammer/yammer-overview

既知の問題と制限事項

Viva Engage REST API の制限により、次のアクションとトリガーはすべてのメッセージを返すことを保証しません。

  • すべてのメッセージを取得する
  • グループでメッセージを取得する
  • スレッドでメッセージを取得する
  • 次のフィードからメッセージを取得します
  • グループに新しいメッセージがあるとき
  • フォローしているフィードに新しいメッセージがあるとき

Viva Engage REST API の制限により、以下のアクションは最大 100 グループを返します。

  • グループの取得

詳細については、Yammer REST API ドキュメントのバルク コンテンツの取得サブセクションを参照してください

注意

Viva Engage API は、メッセージの数を 20 に制限します。 この制限を回避するには、Microsoft Flow を使って Yammer グループの全てのメッセージを取得する方法を参照してください。 Viva Engage APIの制限についての詳細は、Yammer API レート制限にアクセスしてください。

また、Viva Engage REST API の制限により、次のアクションとトリガーはすべての会社グループでは機能しません。

  • グループでメッセージを取得する
  • グループでメッセージを取得する (V2)
  • グループに新しいメッセージがあるとき

サード パーティ アプリケーション機能は、Yammer 構成で有効にする必要があります。 「応答が JSON 形式ではありません」などのアクション応答は、通常、機能が無効になっていることを意味します。

以下のアクションでは、対応する詳細パラメータを設定した後、「タイトル」を持つ「お知らせ」投稿を作成できますが、この投稿は Viva Engage UI で編集することはできません。 Viva Engage はこの問題を認識しており、将来のアップデートでこの問題に対処する予定です。

  • PostMessage
  • PostMessageV2

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒
トリガー ポーリングの頻度 1 15 秒

アクション

すべてのメッセージを取得する (V2) [非推奨]

このアクションは非推奨になりました。 代わりにすべてのメッセージを取得 (V3) を使用してください。

この操作は、ログインしたユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。Viva Engage Web インターフェイスの「すべて」の会話に対応します。
すべてのメッセージを取得する (V3)

この操作は、ログインしているユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。 Viva Engage Web インターフェイスの「すべて」の会話に対応します。
すべてのメッセージを取得する [非推奨]

このアクションは非推奨になりました。 代わりにすべてのメッセージを取得 (V3) を使用してください。

この操作は、ログインしたユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。Yammer Web インターフェイスの「すべて」の会話に対応します。
グループでメッセージを取得する (V2) [非推奨]

このアクションは非推奨になりました。 代わりにグループでメッセージを取得 (V3) を使用してください。

この操作は、グループに投稿されたメッセージを返します。
グループでメッセージを取得する (V3)

この操作は、グループに投稿されたメッセージを返します。
グループでメッセージを取得する [非推奨]

このアクションは非推奨になりました。 代わりにグループでメッセージを取得 (V3) を使用してください。

この操作は、グループに投稿されたメッセージを返します。
グループの取得

すべてのグループを取得します。 mine = 1 の場合、ユーザーが属するグループのみを取得します
スレッドでメッセージを取得する (V2) [非推奨]

このアクションは非推奨になりました。 代わりにスレッドでメッセージを取得 (V3) を使用してください。

この操作は、スレッドに投稿されたメッセージを返します。
スレッドでメッセージを取得する (V3)

この操作は、スレッドに投稿されたメッセージを返します。
スレッドでメッセージを取得する [非推奨]

このアクションは非推奨になりました。 代わりにスレッドでメッセージを取得 (V3) を使用してください。

この操作は、スレッドに投稿されたメッセージを返します。
ネットワークを取得する

ユーザーが属するすべてのネットワークを取得します。
メッセージの投稿 (V2)

この操作は、グループまたは全社フィードにメッセージを投稿するために使用されます。 グループ ID が指定されている場合、メッセージは指定されたグループに投稿されます。それ以外の場合は、すべての会社のフィードに投稿されます。
メッセージの投稿 (非推奨)

この操作は、グループまたは全社フィードにメッセージを投稿するために使用されます。 グループ ID が指定されている場合、メッセージは指定されたグループに投稿されます。それ以外の場合は、すべての会社のフィードに投稿されます。
ユーザーの詳細を取得する

この操作は、ユーザー プロファイルの詳細を返します。
リンク メッセージ

この操作は、指定されたメッセージを高く評価するために使用されます。
次のフィードからメッセージを取得します (V3)

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。
次のフィードからメッセージを取得します [非推奨]

このアクションは非推奨になりました。 代わりに、次のフィードからメッセージを取得します (V3) を使用してください。

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。
次のフィードからメッセージを取得する (V2) [非推奨]

このアクションは非推奨になりました。 代わりに、次のフィードからメッセージを取得します (V3) を使用してください。

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。

すべてのメッセージを取得する (V2) [非推奨]

操作 ID:
GetAllMessagesV2

このアクションは非推奨になりました。 代わりにすべてのメッセージを取得 (V3) を使用してください。

この操作は、ログインしたユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。Viva Engage Web インターフェイスの「すべて」の会話に対応します。

パラメーター

名前 キー 必須 型 説明
ネットワークを表す一意識別子
 network_id string

ネットワーク ID
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
PageableMessageList

すべてのメッセージを取得する (V3)

操作 ID:
GetAllMessagesV3

この操作は、ログインしているユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。 Viva Engage Web インターフェイスの「すべて」の会話に対応します。

パラメーター

名前 キー 必須 型 説明
ネットワークを表す一意識別子
 network_id string

ネットワーク ID
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
PageableMessageListV2

すべてのメッセージを取得する [非推奨]

操作 ID:
GetAllMessages

このアクションは非推奨になりました。 代わりにすべてのメッセージを取得 (V3) を使用してください。

この操作は、ログインしたユーザーの Viva Engage ネットワーク内のすべてのパブリック メッセージを返します。Yammer Web インターフェイスの「すべて」の会話に対応します。

パラメーター

名前 キー 必須 型 説明
ネットワークを表す一意識別子
 network_id string

ネットワーク ID
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
制限
 limit integer

指定された数のメッセージのみを返します。
ページ
 page integer

指定されたページを取得します。 返されるデータが制限を超える場合は、このフィールドを使用して後続のページにアクセスできます

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
MessageList

グループでメッセージを取得する (V2) [非推奨]

操作 ID:
GetMessagesInGroupV2

このアクションは非推奨になりました。 代わりにグループでメッセージを取得 (V3) を使用してください。

この操作は、グループに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
グループ ID
 group_id True integer

グループを表す一意の識別子です。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
PageableMessageList

グループでメッセージを取得する (V3)

操作 ID:
GetMessagesInGroupV3

この操作は、グループに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
Network ID
 network_id string

ネットワークを表す一意識別子。
グループ ID
 group_id True integer

グループを表す一意の識別子です。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
PageableMessageListV2

グループでメッセージを取得する [非推奨]

操作 ID:
GetMessagesInGroup

このアクションは非推奨になりました。 代わりにグループでメッセージを取得 (V3) を使用してください。

この操作は、グループに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
グループ ID
 group_id True integer

グループを表す一意の識別子です。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
制限
 limit integer

指定された数のメッセージのみを返します。
ページ
 page integer

指定されたページを取得します。 返されるデータが制限を超える場合は、このフィールドを使用して後続のページにアクセスできます

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageList

グループの取得

操作 ID:
GetGroups

すべてのグループを取得します。 mine = 1 の場合、ユーザーが属するグループのみを取得します

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワーク ID
採掘
 mine integer

ユーザーが属しているグループを取得するために使用されます
すべての企業グループを表示
 showAllCompanyGroup integer

全社グループの表示に使用

戻り値

応答
array of YammmerEntity

スレッドでメッセージを取得する (V2) [非推奨]

操作 ID:
GetMessagesInThreadV2

このアクションは非推奨になりました。 代わりにスレッドでメッセージを取得 (V3) を使用してください。

この操作は、スレッドに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
スレッド ID
 thread_id True integer

スレッドを表す一意識別子です。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
PageableMessageList

スレッドでメッセージを取得する (V3)

操作 ID:
GetMessagesInThreadV3

この操作は、スレッドに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
スレッド ID
 thread_id True integer

スレッドを表す一意識別子です。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
PageableMessageListV2

スレッドでメッセージを取得する [非推奨]

操作 ID:
GetMessagesInThread

このアクションは非推奨になりました。 代わりにスレッドでメッセージを取得 (V3) を使用してください。

この操作は、スレッドに投稿されたメッセージを返します。

パラメーター

名前 キー 必須 型 説明
スレッド ID
 thread_id True integer

スレッドを表す一意識別子です。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageList

ネットワークを取得する

操作 ID:
GetNetworks

ユーザーが属するすべてのネットワークを取得します。

戻り値

応答
array of Network

メッセージの投稿 (V2)

操作 ID:
PostMessageV2

この操作は、グループまたは全社フィードにメッセージを投稿するために使用されます。 グループ ID が指定されている場合、メッセージは指定されたグループに投稿されます。それ以外の場合は、すべての会社のフィードに投稿されます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意の ID です。
グループ ID
 group_id True integer

メッセージを投稿するグループ (0 = すべての会社 / ネットワーク)。
メッセージ テキスト
 body True string

ネットワークに投稿されるメッセージ。
ID に返信
 replied_to_id integer

このメッセージが返信するメッセージ ID。
ID に直接
 direct_to_id integer

設定されている場合、プライベート メッセージは指定された ID を持つユーザーに直接送信されます。
配信
 broadcast boolean

グループ内のすべてのユーザーへのお知らせとしてメッセージを投稿します。
肩書き
 title string

投稿するメッセージのタイトル。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
MessageListV2

メッセージの投稿 (非推奨)

操作 ID:
PostMessage

この操作は、グループまたは全社フィードにメッセージを投稿するために使用されます。 グループ ID が指定されている場合、メッセージは指定されたグループに投稿されます。それ以外の場合は、すべての会社のフィードに投稿されます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意の ID です。
グループ ID
 group_id True integer

メッセージを投稿するグループ (0 = すべての会社 / ネットワーク)。
メッセージ テキスト
 body True string

ネットワークに投稿されるメッセージ。
ID に返信
 replied_to_id integer

このメッセージが返信するメッセージ ID。
ID に直接
 direct_to_id integer

設定されている場合、プライベート メッセージは指定された ID を持つユーザーに直接送信されます。
配信
 broadcast boolean

グループ内のすべてのユーザーへのお知らせとしてメッセージを投稿します。
敬称
 title string

投稿するメッセージのタイトル。
トピック 1
 topic1 string

メッセージに適用するトピック。
トピック 2
 topic2 string

メッセージに適用するトピック
トピック 3
 topic3 string

メッセージに適用するトピック。
トピック 4
 topic4 string

メッセージに適用するトピック
トピック 5
 topic5 string

メッセージに適用するトピック。
トピック 6
 topic6 string

メッセージに適用するトピック。
トピック 7
 topic7 string

メッセージに適用するトピック
トピック 8
 topic8 string

メッセージに適用するトピック。
トピック 9
 topic9 string

メッセージに適用するトピック。
トピック 10
 topic10 string

メッセージに適用するトピック。
トピック 11
 topic11 string

メッセージに適用するトピック。
トピック 12
 topic12 string

メッセージに適用するトピック。
トピック 13
 topic13 string

メッセージに適用するトピック。
トピック 14
 topic14 string

メッセージに適用するトピック。
トピック 15
 topic15 string

メッセージに適用するトピック。
トピック 16
 topic16 string

メッセージに適用するトピック。
トピック 17
 topic17 string

メッセージに適用するトピック。
トピック 18
 topic18 string

メッセージに適用するトピック。
トピック 19
 topic19 string

メッセージに適用するトピック。
トピック 20
 topic20 string

メッセージに適用するトピック。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
MessageList

ユーザーの詳細を取得する

操作 ID:
GetUserDetailsById

この操作は、ユーザー プロファイルの詳細を返します。

パラメーター

名前 キー 必須 型 説明
ユーザー ID
 user_id True integer

ユーザーの一意識別子。

戻り値

Viva Engage ユーザーのプロパティ。

User
User

リンク メッセージ

操作 ID:
LikeMessage

この操作は、指定されたメッセージを高く評価するために使用されます。

パラメーター

名前 キー 必須 型 説明
メッセージ ID
 message_id True string

メッセージを表す一意の ID。

次のフィードからメッセージを取得します (V3)

操作 ID:
GetMessagesFollowingV3

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
PageableMessageListV2

次のフィードからメッセージを取得します [非推奨]

操作 ID:
GetMessagesFollowing

このアクションは非推奨になりました。 代わりに、次のフィードからメッセージを取得します (V3) を使用してください。

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
制限
 limit integer

指定された数のメッセージのみを返します。
ページ
 page integer

指定されたページを取得します。 返されるデータが制限を超える場合は、このフィールドを使用して後続のページにアクセスできます

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageList

次のフィードからメッセージを取得する (V2) [非推奨]

操作 ID:
GetMessagesFollowingV2

このアクションは非推奨になりました。 代わりに、次のフィードからメッセージを取得します (V3) を使用してください。

この操作は、ユーザーがフォローしている人、グループ、トピックを含む会話であるフォロー フィードからのメッセージを返します。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
次より古い
 older_than integer

数値文字列として指定されたメッセージ ID より古いメッセージを返します。 これは、メッセージのページ付けに役立ちます。 たとえば、現在 20 個のメッセージを表示していて、最も古いメッセージが番号 2912 である場合、「?older_than=2912」をリクエストに追加して、表示される前に 20 個のメッセージを取得できます。
次より新しい
 newer_than integer

数値文字列として指定されたメッセージ ID より新しいメッセージを返します。 これは、新しいメッセージをポーリングするときに使用する必要があります。 メッセージを表示していて、返される最新のメッセージが 3516 である場合は、パラメーター「?newer_than=3516」を使用してリクエストを送信し、ページに既にあるメッセージの重複コピーを取得しないようにすることができます。
メッセージのスレッド タイプ
 threaded string

Threaded=true は、各スレッドのスレッド スターター (最初のメッセージ) のみを返します。 このパラメーターは、折りたたまれたメッセージ スレッドを表示する必要があるアプリを対象としています。 threaded=extended は、Viva Engage Web インターフェイスの既定のビューで表示されるため、スレッド スターター メッセージと最新の 2 つのメッセージをすべて活動順に返します。
制限
 limit integer

指定された数のメッセージのみを返します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
PageableMessageList

トリガー

グループに新しいメッセージがあるとき [非推奨]

このアクションは非推奨になりました。 代わりに、グループに新しいメッセージがあるとき (V2) を使用してください。

この操作は、新しいメッセージがグループに投稿されたときにトリガーされます。
グループに新しいメッセージがある場合 (V2)

この操作は、新しいメッセージがグループに投稿されたときにトリガーされます。
フォローしているフィードに新しいメッセージがあるとき [非推奨]

このアクションは非推奨になりました。 代わりに、フォローしているフィードに新しいメッセージがあるとき (V2) を使用してください。

この操作は、ネットワークに新しいメッセージがあり、その後にあなたが続く場合にトリガーされます。
自分がフォローしているフィードに新しいメッセージがあるとき (V2)

この操作は、ネットワークに新しいメッセージがあり、その後にあなたが続く場合にトリガーされます。

グループに新しいメッセージがあるとき [非推奨]

操作 ID:
OnNewMessagesInGroup

このアクションは非推奨になりました。 代わりに、グループに新しいメッセージがあるとき (V2) を使用してください。

この操作は、新しいメッセージがグループに投稿されたときにトリガーされます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
グループ ID
 group_id True integer

グループを表す一意の識別子です。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageList

グループに新しいメッセージがある場合 (V2)

操作 ID:
OnNewMessagesInGroupV2

この操作は、新しいメッセージがグループに投稿されたときにトリガーされます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを表す一意識別子。
グループ ID
 group_id True integer

グループを表す一意の識別子です。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageListV2

フォローしているフィードに新しいメッセージがあるとき [非推奨]

操作 ID:
OnNewMessagesFollowing

このアクションは非推奨になりました。 代わりに、フォローしているフィードに新しいメッセージがあるとき (V2) を使用してください。

この操作は、ネットワークに新しいメッセージがあり、その後にあなたが続く場合にトリガーされます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを選択します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージの一覧
MessageList

自分がフォローしているフィードに新しいメッセージがあるとき (V2)

操作 ID:
OnNewMessagesFollowingV2

この操作は、ネットワークに新しいメッセージがあり、その後にあなたが続く場合にトリガーされます。

パラメーター

名前 キー 必須 型 説明
ネットワーク ID
 network_id string

ネットワークを選択します。

戻り値

1 つまたは複数のメッセージのリスト。

メッセージ リスト
MessageListV2

定義

ユーザー

Viva Engage ユーザーのプロパティ。

名前 パス 型 説明
ユーザー名
 name string

ユーザー名。
役職
 job_title string

ユーザーの役職。
場所
 location string

ユーザーの場所。
氏名
 full_name string

ユーザーの氏名。
名
 first_name string

ユーザーの名。
姓
 last_name string

ユーザーの姓。
プロファイル URL
 web_url string

ユーザー プロファイルの URL。
電子メール
 email string

ユーザーのメール。
誕生日
 birth_date string

ユーザーの誕生日。
写真の URL
 mugshot_url string

ユーザーの写真の URL。

メッセージ

単一の Viva Engage メッセージのプロパティ。

名前 パス 型 説明
ID
 id integer

投稿に関連付けられている ID。
テキスト
 content_excerpt string

投稿のテキスト コンテンツです。
センダー
 sender_id integer

メッセージを投稿したユーザーの一意の ID。
次に返信
 replied_to_id integer

このメッセージが返信であるメッセージの ID。
作成場所
 created_at string

メッセージが作成された時刻。
ネットワーク
 network_id integer

ネットワーク メッセージの ID が関連付けられています。
タイプ
 message_type string

メッセージ タイプの説明。
送信者の種類
 sender_type string

送信者のタイプの説明。
URL
 url uri

投稿の API URL。
Web URL
 web_url uri

投稿の Web URL。
グループ ID
 group_id integer

メッセージを投稿したグループの一意の ID。
メッセージの本文
 body MessageBody

単一のメッセージに関連付けられたコンテンツ。
スレッド ID
 thread_id integer

スレッドを表す一意の ID です。
ダイレクト メッセージ
 direct_message boolean

投稿がダイレクト メッセージであるかどうかを指定するフラグ。
クライアント ID
 client_type string

クライアントの種類です。
クライアント URL
 client_url uri

クライアントの Web リンク。
言語
 language string

メッセージで使用されている言語。
タグ付きユーザー
 notified_user_ids array of integer

通知されたユーザーの詳細。
プライバシー​
 privacy string

メッセージに関連付けられているプライバシーの詳細。
liked_by
 liked_by LikedBy

次にいいねされている
システム メッセージですか
 system_message boolean

投稿がシステム生成メッセージであるかどうかを指定するフラグ。
Topics
 topics array of Topic

トピックの一覧。

MessageV2

単一の Viva Engage メッセージのプロパティ。

名前 パス 型 説明
ID
 id integer

投稿に関連付けられている ID。
テキスト
 content_excerpt string

投稿のテキスト コンテンツです。
センダー
 sender_id integer

メッセージを投稿したユーザーの一意の ID。
次に返信
 replied_to_id integer

このメッセージが返信であるメッセージの ID。
作成場所
 created_at string

メッセージが作成された時刻。
ネットワーク
 network_id integer

ネットワーク メッセージの ID が関連付けられています。
タイプ
 message_type string

メッセージ タイプの説明。
送信者の種類
 sender_type string

送信者のタイプの説明。
URL
 url uri

投稿の API URL。
Web URL
 web_url uri

投稿の Web URL。
グループ ID
 group_id integer

メッセージを投稿したグループの一意の ID。
メッセージの本文
 body MessageBody

単一のメッセージに関連付けられたコンテンツ。
スレッド ID
 thread_id integer

スレッドを表す一意の ID です。
ダイレクト メッセージ
 direct_message boolean

投稿がダイレクト メッセージであるかどうかを指定するフラグ。
クライアント ID
 client_type string

クライアントの種類です。
クライアント URL
 client_url uri

クライアントの Web リンク。
言語
 language string

メッセージで使用されている言語。
タグ付きユーザー
 notified_user_ids array of integer

通知されたユーザーの詳細。
プライバシー​
 privacy string

メッセージに関連付けられているプライバシーの詳細。
liked_by
 liked_by LikedBy

次にいいねされている
システム メッセージですか
 system_message boolean

投稿がシステム生成メッセージであるかどうかを指定するフラグ。

トピック

単一のトピックのプロパティ。

名前 パス 型 説明
ID
 id integer

トピックの一意識別子です。
件名
 name string

トピックの名前。

PageableMessageList

1 つまたは複数のメッセージのリスト。

名前 パス 型 説明
[メッセージ]
 value array of Message

PageableMessageListV2

1 つまたは複数のメッセージのリスト。

名前 パス 型 説明
[メッセージ]
 value array of MessageV2

MessageList

1 つまたは複数のメッセージのリスト。

名前 パス 型 説明
[メッセージ]
 messages array of Message

messages

MessageListV2

1 つまたは複数のメッセージのリスト。

名前 パス 型 説明
[メッセージ]
 messages array of MessageV2

messages

MessageBody

単一のメッセージに関連付けられたコンテンツ。

名前 パス 型 説明
テキスト
 parsed string

解析されたテキスト形式。
プレーン
 plain string

プレーン テキストの形式。
リッチ
 rich string

リッチ テキスト形式。

LikedBy

次にいいねされている

名前 パス 型 説明
カウント
 count integer

明確ないいねの数。
名前
 names array of object

投稿を気に入った人のリスト。
氏名
 names.full_name string

投稿を気に入った人の氏名。

ネットワーク

単一のネットワークのプロパティ。

名前 パス 型 説明
ID
 id string

ネットワークを表す一意識別子。
件名
 name string

ネットワークの概要です。
リンク
 permalink string

ネットワーク ページへの Web リンク。

YammmerEntity

単一の Viva Engage エンティティのプロパティ。

名前 パス 型 説明
Description
 type string

Viva Engage エンティティの詳細。
Group ID
 id integer

グループを表す一意の識別子です。
正式な名前
 full_name string

Viva Engage エンティティの名前です。