Dynamic Signal (プレビュー)

Dynamic Signal は、組織が信頼している従業員のコミュニケーションおよびエンゲージメントのプラットフォームであり、従業員を結び付け、調整し、連携させます。 Dynamic Signal に接続して、投稿とユーザーを作成および管理します。

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

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
コネクタ メタデータ
公開元 Dynamic Signal

接続の作成

コネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
ベアラー トークン securestring この API のベアラー トークン
Dynamic Signal URL 文字列 Dynamic Signal にアクセスする URL。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

URL を通して投稿に画像を追加する

URL を通して投稿画像を設定します。

アップロードを介して投稿に画像を追加する

バイナリ アップロードを介して投稿画像を設定します。

カテゴリを取得する

認証されたユーザーに表示されるカテゴリの一覧を取得します

ターゲットを取得する

コミュニティのターゲットとターゲット定義の一覧を取得します

ドキュメントを投稿にアップロード

バイナリ アップロードを介してドキュメントを投稿にアップロードします

ユーザー タグを取得する

システムで定義されたユーザー タグの一覧を取得します

ユーザーを事前登録する

事前登録された状態で新しいユーザーを作成します

投稿の作成

投稿を作成します。

投稿の更新

既存の投稿を編集します。

投稿の管理

サーバー認証された呼び出しが、1 つのリクエストで複数の投稿のプロパティを更新できるようにします

投稿を取得する

ID で特定の投稿を取得します

投稿タグを取得する

システムで定義された投稿タグを取得します

画像のアップロード

バイナリ アップロードを介して画像をアップロードします

部門を取得する

部門の一覧を取得します

電子メールでユーザーを取得する

電子メール アドレスでユーザーを取得します

URL を通して投稿に画像を追加する

URL を通して投稿画像を設定します。

パラメーター

名前 キー 必須 説明
ID
id True uuid

投稿 ID、必須: true

URL
url True string

HTTP または HTTPS URL

戻り値

アクションが正常に実行されたことを示す簡単な応答

アップロードを介して投稿に画像を追加する

バイナリ アップロードを介して投稿画像を設定します。

パラメーター

名前 キー 必須 説明
ID
id True uuid

投稿 ID

ファイル
File True binary

アップロードするファイル

image/jpg、image/pjpeg、image/png、image/x-png、image/gif などのコンテンツ タイプ
Content-Type True string

ファイルのコンテンツ タイプ

戻り値

アクションが正常に実行されたことを示す簡単な応答

カテゴリを取得する

認証されたユーザーに表示されるカテゴリの一覧を取得します

戻り値

カテゴリに関連する詳細情報

ターゲットを取得する

コミュニティのターゲットとターゲット定義の一覧を取得します

戻り値

コミュニティのターゲット定義と関連するターゲットの一覧です。

ドキュメントを投稿にアップロード

バイナリ アップロードを介してドキュメントを投稿にアップロードします

パラメーター

名前 キー 必須 説明
ファイル名
fileName True string

ドキュメントが優先する拡張子付きのファイル名です

ID
id True uuid

投稿 ID

ファイル
File True binary

アップロードするファイル

image/jpg、image/pjpeg、image/png、image/x-png、image/gif などのコンテンツ タイプ
Content-Type True string

ファイルのコンテンツ タイプ

戻り値

添付ドキュメントに関連する情報

ユーザー タグを取得する

システムで定義されたユーザー タグの一覧を取得します

戻り値

システムで定義されたユーザー タグの一覧

ユーザーを事前登録する

事前登録された状態で新しいユーザーを作成します

パラメーター

名前 キー 必須 説明
電子メール
email string

ユーザーの電子メール アドレス

外部 SSO ユーザー ID
externalSsoUserId string

SSO ID プロバイダーによって管理される外部システム上のユーザー ID

Handle
handle string

ユーザーのハンドル

firstName string

ユーザーの名。

lastName string

ユーザーの姓。

部門 ID
divisionIds array of integer

ユーザーに割り当てられる部門の一覧。

ターゲット ID
targetIds array of integer

ユーザーに割り当てるターゲットの一覧。

件名
name string

タグまたは属性の名前

value string

オプション値

招待メールの送信
sendInvitationEmail boolean

ユーザーに招待メールを送信するかどうかを決定します。

招待メッセージ
invitationMessage string

招待メールに含めるオプションのプレーン テキスト メッセージ。

既定の通知
notificationsDefault string

ユーザーが電子メール通知をいつから受信するかを制御する設定。

投稿共有可能
canSharePosts boolean

ユーザーが投稿を共有できるかどうかを示します

投稿にコメント可能
canCommentPosts boolean

ユーザーが投稿にコメントしたり 「いいね!」を付けたりできるかを示します

投稿送信可能
canSubmitPosts boolean

ユーザーが投稿を送信できるかどうかを示します

組織の管理が可能
canManageOrganization boolean

ユーザーがコミュニティ内の直接および間接のレポートにアクセスできるかどうかを示します

戻り値

投稿の作成

投稿を作成します。

パラメーター

名前 キー 必須 説明
内容
description string

投稿の簡単な説明

タグ ライン
tagLine string

投稿のタグ ライン

内容
content string

投稿の本文

作成者のコメント
creatorComments string

投稿に関連するメッセージ

パーマ リンク
permaLink string

投稿により参照される外部 URL

社内ディスカッションが有効
internalDiscussionsEnabled boolean

メンバーが同様のアクションを実行し、内部で投稿にコメントを追加することを許可されているかどうか

敬称
title True string

投稿のタイトル

メンバー ビデオの URL
memberVideoUrl string

投稿により参照されるビデオ URL

投稿の種類
postType string

投稿の基本的な種類

承認状態
approvalState string

投稿の承認状態。 既定は作成者の状態確認設定です。

表示モード
displayMode string

内部または外部の場所への投稿のリダイレクトを示します

共有可能
sharable boolean

VoiceStorm プラットフォームとウィジェットで投稿の共有が可能かどうか

開始日
startDate date-time

投稿を閲覧できるようになる日付

終了日
endDate date-time

投稿が閲覧できなくなる日付

推奨共有テキスト
suggestedShareText string

投稿の推奨共有テキスト

短い推奨共有テキスト
shortSuggestedShareText string

ショート メッセージ プロバイダー向けの投稿の推奨共有テキスト

共有ポイント
sharePoints integer

ユーザーが投稿を共有したときに付与されるポイント数

クリック ポイント
clickPoints integer

投稿への共有リンクをクリックしたときに付与されるポイント数

画像の共有
shareWithImages boolean

ショート メッセージ サービス (Twitter など) に共有される投稿に画像を共有するかどうかを制御します

画像のみを共有
shareImagesOnly boolean

特定のサービスに共有されている投稿を、画像/写真のみの更新として扱うかどうかを制御します

件名
name string

タグの名前

言語
language string

投稿コンテンツの言語

ドキュメント​
documents array of uuid

この投稿に添付するドキュメント ID の一覧

作成者 ID
creatorId integer

投稿を作成しているユーザー。このプロパティは、現時点ではサーバー認証リクエストでのみ使用できます。 他のすべての投稿は、認証されたユーザーに自動的に設定されます。

表示作成者
displayCreator boolean

作成者情報を投稿と共に表示するかどうかを制御します。このプロパティは、現時点ではサーバー認証リクエストでのみ使用できます。

カテゴリ ID
categoryIds array of integer

投稿に割り当てられたカテゴリ ID の一覧

ターゲット ID
targetIds array of integer

投稿に割り当てられたターゲット ID の一覧

戻り値

投稿

応答
postResponse

投稿の更新

既存の投稿を編集します。

パラメーター

名前 キー 必須 説明
ID
id True uuid

投稿 ID

敬称
title string

投稿のタイトル

内容
description string

投稿の簡単な説明

タグ ライン
tagLine string

投稿のタグ ライン

内容
content string

投稿の本文

作成者のコメント
creatorComments string

投稿に関連するメッセージ

パーマ リンク
permaLink string

投稿により参照される外部 URL

社内ディスカッションが有効
internalDiscussionsEnabled boolean

メンバーが同様のアクションを実行し、内部で投稿にコメントを追加することを許可されているかどうか

戻り値

投稿

応答
postResponse

投稿の管理

サーバー認証された呼び出しが、1 つのリクエストで複数の投稿のプロパティを更新できるようにします

パラメーター

名前 キー 必須 説明
投稿 ID
postIds True array of uuid

変更される投稿

タグ
tags array of string

投稿に適用できるタグ名のコレクション

部門 ID
divisionIds array of integer

投稿が属する部門 ID

カテゴリ ID
categoryIds array of integer

投稿が属するカテゴリの ID

ターゲット ID
targetIds array of integer

投稿が属するターゲットの ID

承認状態
approvalState string

投稿の承認状態 (これは DELETE 要求の影響を受けません)

戻り値

アクションが正常に実行されたことを示す簡単な応答

投稿を取得する

ID で特定の投稿を取得します

パラメーター

名前 キー 必須 説明
ID
id True uuid

投稿 ID。投稿を表す一意識別子。

ユーザー ID
userId integer

投稿を表示しているユーザー。 ID が指定されていない場合、ログインしたユーザーが使用されます

戻り値

投稿

応答
postResponse

投稿タグを取得する

システムで定義された投稿タグを取得します

戻り値

システムで定義された投稿タグの一覧

画像のアップロード

バイナリ アップロードを介して画像をアップロードします

パラメーター

名前 キー 必須 説明
ファイル
File True binary

アップロードするファイル

image/jpg、image/pjpeg、image/png、image/x-png、image/gif などのコンテンツ タイプ
Content-Type True string

ファイルのコンテンツ タイプ

戻り値

部門を取得する

部門の一覧を取得します

戻り値

システムで定義された部門

電子メールでユーザーを取得する

電子メール アドレスでユーザーを取得します

パラメーター

名前 キー 必須 説明
電子メール
email True string

ユーザーの電子メール

参照項目
include array of string

ユーザーに返すオプションのデータを指定します。

戻り値

定義

successResponse

アクションが正常に実行されたことを示す簡単な応答

名前 パス 説明
コード
code string

「成功」の値は、操作が成功したことを示します

targetDefinitionsInfoResponse

コミュニティのターゲット定義と関連するターゲットの一覧です。

名前 パス 説明
定義
definitions array of targetDefinitionInfoResponse

targetDefinitionInfoResponse

特定のターゲット定義とそれに関連するターゲットの詳細情報

名前 パス 説明
ID
id integer

ターゲット定義の ID

件名
name string

ターゲット定義の名前

ユーザー確認を取得する
getUserConfirmation boolean

ユーザーが自分の設定を確認/選択するように求められるかどうかを決定します

複数の選択を許可
allowMultipleSelections boolean

複数のターゲットを選択できるかどうかを決定します

選択する必要があります
selectionRequired boolean

この定義での選択が必要かどうかを決定します

ターゲット選択プロンプト
targetSelectionPrompt string

ユーザーに基本設定を選択するように促すカスタマイズされたラベル

childTargets
childTargets array of targetInfoResponse

targetInfoResponse

特定のターゲットの詳細情報。

名前 パス 説明
ID
id integer

ターゲット ID

件名
name string

ターゲットの名前

内容
description string

ターゲットの説明

定義 ID
definitionId integer

ターゲットが属するターゲット定義の ID

親 ID
parentId integer

ターゲットの親の ID (存在する場合)

登録済み
isSubscribed boolean

ユーザーが特定のターゲットに登録しているかどうか

childTargets
childTargets array of targetInfoResponse1

managePostTagsResponse

システムで定義された投稿タグの一覧

名前 パス 説明
タグ
tags array of managePostTagResponse

managePostTagResponse

特定の投稿タグの詳細情報

名前 パス 説明
ID
id integer

タグ ID

件名
name string

タグの名前

メンバーは利用可能
isAvailableToMembers boolean

タグがメンバー向けの投稿送信ページで使用できるかどうかを指定します (有効な場合)

manageUserTagsResponse

システムで定義されたユーザー タグの一覧

名前 パス 説明
タグ
tags array of manageUserTagResponse

manageUserTagResponse

特定のユーザー タグの詳細情報

名前 パス 説明
ID
id integer

タグ ID

件名
name string

タグの名前

種類
type string
acceptedValues
acceptedValues array of string

categoriesResponse

カテゴリに関連する詳細情報

名前 パス 説明
カテゴリ
categories array of categoryResponse
サブスクリプション プロンプト
subscriptionPrompt string

メンバーにカテゴリ サブスクリプションの選択を促すラベル

カテゴリ サブスクリプションを有効にする
enableCategorySubscription boolean

メンバーがカテゴリ サブスクリプションを変更できるかどうか

サブスクリプション選択が必要
requireSubscriptionSelection boolean

メンバーがオンボード中にカテゴリ サブスクリプションを選択する必要があるかどうか

ランディング ページの既定カテゴリ
landingPageDefaultCategory integer

ニュース フィード情報を読み込むときに表示される既定のコンテンツ

categoryResponse

名前 パス 説明
ID
id integer

カテゴリ ID

件名
name string

カテゴリの名前

内容
description string

カテゴリの説明

表示順序
displayOrder integer

カテゴリを表示する順序

ピン留め済み
isPinned boolean

カテゴリが管理者によってピン留めされているかどうか

強制
isForced boolean

認証されたユーザーが特定のカテゴリに強制的に登録されているかどうか

登録済み
isSubscribed boolean

認証されたユーザーが特定のカテゴリに登録されているかどうか

非表示
isHidden boolean

カテゴリが管理者によって非表示にされているかどうか

ユーザーが選択可能か
isUserSelectable boolean

ユーザーが送信された投稿のカテゴリを選択できるかどうか

親カテゴリ ID
parentCategoryId integer

親カテゴリ ID

childCategories
childCategories array of categoryResponse1

postResponse

投稿

名前 パス 説明
投稿 ID
postId uuid

投稿 ID

投稿ソース ID
postSourceId integer

ソース ID

敬称
title string

投稿のタイトル

内容
description string

投稿の簡単な説明

タグ ライン
tagLine string

投稿のタグ ライン

内容
content string

投稿の本文

生コンテンツ
rawContent string

すべての HTML を含む投稿の本文 (Content と RawContent の両方が含まれている場合)

作成者のコメント
creatorComments string

投稿に関連するメッセージ

creatorInfo userOverviewResponse

ユーザーについての概要情報

場所
location string

投稿に関連する地理的位置

プロパティ​​
properties object

投稿のその他のプロパティ。 すべての投稿の種類で使用できるわけではありません

パーマ リンク
permaLink string

投稿により参照される外部 URL

クリーン パーマ リンク
cleanPermaLink string

パーマリンク (問題のあるスペースと改行を除く)

postType
postType string
postSourceType
postSourceType string
postBylineType
postBylineType string
プロバイダー
provider string

投稿発信元のソーシャル プロバイダー (Facebook、Twitter など)。

approvalState
approvalState string
displayMode
displayMode string
状態
status string
ユーザー編集可能
userEditable boolean
ユーザー共有可能
userShareable boolean

現在のユーザーが投稿を共有できるかどうかを示します。 現在のユーザーがいない場合、既定で true になります。

ユーザー コメント可能
userCommentable boolean

現在のユーザーが投稿に関するディスカッションに参加できるかどうかを示します。 現在のユーザーがいない場合、既定で false になります。

共有可能
sharable boolean

プラットフォームとウィジェットで投稿の共有が可能かどうか

配信
broadcasted boolean

投稿が共有のためにユーザーに配信されているかどうか

ピン留め済み
pinned boolean

投稿がストリームでの優先表示用に設定されているかどうか

公開日
publishDate date-time

ユーザーが送信したコンテンツの場合は、投稿送信の日付。外部ソースからインポートされたコンテンツの場合は、ソースに応じた公開日

開始日
startDate date-time

投稿を閲覧できるようになる日付

終了日
endDate date-time

投稿が閲覧できなくなる日付

イベント開始日
eventStartDate date-time

イベントの開始日 (イベント タイプの投稿の場合)

イベント終了日
eventEndDate date-time

イベントの終了日 (イベント タイプの投稿の場合)

プロバイダー タイム スタンプ
providerTimeStamp date-time

プロバイダーの観点からの投稿の日付。つまり、ソーシャル プロバイダーに最初に投稿された日付

公開ポイント獲得
receivedPublishPoints boolean

投稿を送信したユーザーが投稿の公開時にポイントを獲得したかどうか

推奨共有テキスト
suggestedShareText string

投稿の推奨共有テキスト

短い推奨共有テキスト
shortSuggestedShareText string

ショート メッセージ プロバイダー向けの投稿の推奨共有テキスト

suggestedShareTextList
suggestedShareTextList array of string
shortSuggestedShareTextList
shortSuggestedShareTextList array of string
共有ポイント
sharePoints integer

ユーザーが投稿を共有したときに付与されるポイント数

クリック ポイント
clickPoints integer

投稿への共有リンクをクリックしたときに付与されるポイント数

プロバイダー投稿 ID
providerPostId string

プロバイダー ネットワーク上の投稿の元の ID

URL 置換フィールド
urlSlug string

投稿へのパブリック リンクを配置する SEO テキスト

分類
classification string

プロバイダー ネットワーク上の投稿の種類。

画像の共有
shareWithImages boolean

ショート メッセージ サービス (Twitter など) に共有される投稿に画像を共有するかどうかを制御します

画像のみを共有
shareImagesOnly boolean

特定のサービスに共有されている投稿を、画像/写真のみの更新として扱うかどうかを制御します

アクション​​
actions string

投稿と URL のアクション アイテムの一覧を含む JSON BLOB

メンション
mentions string

JSON BLOB として保存されたメンション (ユーザー、ハッシュ タグなど)。

statistics postStatisticsResponse
userShareInfo postUserShareInfoResponse
author postAuthorRequestResponse
リンク
links array of postLinkRequestResponse
タグ
tags array of postTagRequestResponse
メディア
media array of postMediaRequestResponse
画像
images object
candidateImages
candidateImages array of postCandidateImageResponse
Visible
visible boolean

投稿が現在表示されているかどうか

shareDisclosures
shareDisclosures array of postShareDisclosureResponse
shareCommentRules
shareCommentRules array of postShareCommentRulesResponse
言語
language string

投稿コンテンツの言語

ユーザー非表示
userHidden boolean

ユーザーが 1 つ以上のストリームから投稿を非表示にしたかどうか

ユーザーに表示されているか
isViewedByUser boolean

投稿が現在のユーザーに表示されているかどうか。

ユーザーにディスカッションが表示されているか
isDiscussionViewedByUser boolean

投稿ディスカッションのスレッドが現在のユーザーに表示されているかどうか

ユーザーに評価されているか
isLikedByUser boolean

投稿が現在のユーザーに内部で評価されているかどうか。

ユーザーにコメントされているか
isCommentedByUser boolean

現在のユーザーが投稿にコメントしているかどうか。

ユーザーに共有されているか
isSharedByUser boolean

投稿が現在のユーザーに以前評価されていたかどうか

対象
targets array of targetOverviewResponse
カテゴリ
categories array of categoryOverviewResponse
現在時刻
currentTime date-time

サーバーの現在の時刻。

categoryOverviewResponse

基本カテゴリ情報

名前 パス 説明
ID
id integer

カテゴリ ID

件名
name string

カテゴリの名前

親カテゴリ ID
parentCategoryId integer

親カテゴリ ID

targetOverviewResponse

ターゲット名、ID、およびそれが属するターゲット定義の ID で構成されるライトウェイト ターゲット応答

名前 パス 説明
件名
name string

ターゲット名

ID
id integer

ターゲット ID

定義 ID
definitionId integer

ターゲットが属するターゲット定義の ID

postShareCommentRulesResponse

名前 パス 説明
プロバイダー
provider string
最大文字数制限を共有する
shareMaxCharacterLimit integer

このプロバイダーの共有でのユーザー コメントの最大長。

postShareDisclosureResponse

名前 パス 説明
プロバイダー
provider string
プロバイダーの表示名
providerDisplayName string

プロバイダーの表示名

開示テキストの共有
shareDisclosureText string

各共有に追加された開示テキスト

postCandidateImageResponse

名前 パス 説明
URL
url string

画像の URL

width integer

画像の幅

高さ
height integer

画像の高さ

MIME の種類
mimeType string

画像の MIME の種類

SSL URL
sslUrl string

画像の安全な URL

postMediaRequestResponse

名前 パス 説明
件名
name string

メディア オブジェクトの名前

width integer

メディア オブジェクトのピクセル単位の幅

高さ
height integer

メディア オブジェクトのピクセル単位の高さ

MIME の種類
mimeType string

メディア オブジェクトの MIME の種類

Html
html string

メディア オブジェクトの表示に使用できる HTML

URL
url string

メディア オブジェクトへの URL

origin string

可能な場合は、メディア オブジェクトの元の場所を指定します

プロバイダー
provider string

ソーシャル プロバイダー名

役割
role string

メディアの種類 (特定されている場合)

時間
duration integer

ビデオの長さ (ミリ秒)

内容
description string

ビデオ形式の説明

ビデオの URL あり
hasVideoUrl boolean

このメディアに "WatchVideo" インクルードを使用して署名する必要のあるビデオ URL があることを示します

postTagRequestResponse

名前 パス 説明
件名
name string

タグの名前

postLinkRequestResponse

名前 パス 説明
URL
url string

投稿の URL

展開済み URL
expandedUrl string

展開された URL (存在する場合)

敬称
title string

投稿のタイトル

ドメイン
domain string

リンク ドメイン

ファビコンの URL
faviconUrl string

リンクのファビコン URL

件名
name string

ソーシャル プロバイダーによって割り当てられたリンクの名前

キャプション
caption string

リンクの短いキャプション (リンク下のテキスト)

内容
description string

リンクの説明 (キャプション下の長いテキスト)

変更日
modifiedDate date-time
作成日
createdDate date-time

postAuthorRequestResponse

名前 パス 説明
作成者
author string

作成者として表示する保存されたテキスト。

プロファイル イメージ URL
profileImageUrl string

ソーシャル ネットワーク上の作成者のプロファイル画像

プロバイダー ユーザー ID
providerUserId string

ソーシャル ネットワーク上の作成者の ID

プロバイダーのユーザー名
providerUserName string

ソーシャル ネットワーク上の作成者の名前

プロファイル URL
profileUrl string

ソーシャル ネットワーク上の作成者のプロファイル URL

投稿ソース名
postSourceName string

投稿のソース名。

投稿ソース サイト
postSourceSite string

投稿の発信元の Web サイト

postUserShareInfoResponse

名前 パス 説明
獲得したポイント
pointsEarned integer

共有するためにユーザーが獲得したポイント数

共有回数
shareCount integer

ユーザーが共有した数

最新の共有の日付
mostRecentShareDate date-time

この投稿のユーザーの最新の共有の日付

postStatisticsResponse

名前 パス 説明
アプリ内シェア回数の合計
totalInAppShareCount integer

ShareCount のシノニム

追跡 ID
trackingId string
共有回数
shareCount integer

正常に共有されたことが確認された、アプリで開始された共有の数

反応回数
reactionCount integer

共有に対する反応 (いいね!、リツイートなど) の数

所見数
impressionCount integer

共有者の友人やフォロワーによる投稿の潜在的なビュー

表示回数
viewedCount integer

ログインしたユーザーが投稿にアクセスした回数

クリックされた回数
clickCount integer

共有から投稿リンクへのクリック数

「いいね!」の数
likeCount integer

投稿内の「いいね!」の数

コメント数
commentCount integer

投稿内のコメントの数

コメント「いいね!」の数
commentLikeCount integer

投稿内のすべての内部コメントにおける、「いいね!」の合計

userOverviewResponse

ユーザーについての概要情報

名前 パス 説明
ユーザー ID
userId integer

ユーザーの ID

表示名
displayName string

ユーザーの表示名

profilePictureImages
profilePictureImages object
アクティブ
isActive boolean

ユーザーがまだコミュニティのアクティブなメンバーであるかどうか

uploadImageResponse

名前 パス 説明
画像識別子
imageIdentifier string

アップロードされた画像の識別子

userRequestResponse

名前 パス 説明
ID
id integer

ユーザーの内部 ID

電子メール
email string

ユーザーの電子メール アドレス

Handle
handle string

ユーザーのハンドル (「ユーザー名」)

表示名
displayName string

ユーザーが指定した表示名

氏名
fullName string

ユーザーの姓と名

firstName string

ユーザーの名

lastName string

ユーザーの姓

displayNameFormat
displayNameFormat string
状態
status string
プロファイル完了
profileCompleted boolean

オンボード中にユーザー プロファイルが完了したかどうか

最後の活動の日付
lastActivityDate date-time

ユーザーが最後にシステムを操作した時。

敬称
title string

ユーザーのタイトル

場所
location string

ユーザーが記述した場所 (実際の地理的な場所ではない場合があります)

外部 API ユーザー ID
externalApiUserId string

API の呼び出し元によって管理される外部システム上のユーザー ID

マネージャー ユーザー ID
managerUserId integer

ユーザー マネージャーの ID (組織階層機能用)

タイム ゾーン
timeZone string

IANA によって設定された tz データベースのタイム ゾーン名として表されるユーザーのタイム ゾーン。 例: 「アメリカ/ロサンゼルス」。

選択済みタイム ゾーン
selectedTimeZone string

IANA によって設定された tz データベースのタイム ゾーン名として表されるユーザーが選択したタイム ゾーン。 例: 「アメリカ/ロサンゼルス」。

ポイント残高
pointBalance integer

現在までに獲得した合計ポイント

未引き換えのポイント
unredeemedPoints integer

現在引き換え可能なポイント

引き換え済みのポイント
redeemedPoints integer

ユーザーの有効期間中に引き換えたポイント数

API 情報
apiInfo string

API 固有のプロパティ バッグ

パスワードがあるか
hasPassword boolean

ユーザーがアカウントに関連付けられたパスワードを持っているかどうか。

パスワードの変更が必須
mustChangePassword boolean

ユーザーがコミュニティ設定に基づいてパスワードを変更する必要があるかどうか

検証済みアカウントがあるか
isAccountVerified boolean

ユーザーが自分の電子メール アドレスを検証したかどうかを示します

statistics postStatisticsResponse
タグ
tags object
バッジ
badges object
所属
affiliations array of userAffiliationResponse
部門
divisions array of divisionResponse
チャネル
channels array of userChannelResponse
profilePictureImages
profilePictureImages object
言語
languages array of string
母国語
primaryLanguage string

ユーザーの主要なインターフェイス言語

scheduleSettings userScheduleSettingsResponse

共有設定をスケジュールしたユーザー

SSO を使用しているか
isSso boolean

ユーザーが SSO を使用して認証するように設定されているかどうか

permissions userPermissionsResponse

マネージャーのアクセス許可

privileges userPrivilegesResponse

ユーザー特権

識別子
identifiers array of allowlistIdentifiersResponse
対象
targets array of targetOverviewResponse
defaults userDefaultsRequestResponse

ユーザーの既定のコレクション

ウェルカム バナーが閉じられたか
welcomeBannerDismissed boolean

ユーザーがウェルカム バナーを閉じたかどうか

userDefaultsRequestResponse

ユーザーの既定のコレクション

名前 パス 説明
defaultPostState
defaultPostState string
defaultPostApprovalState
defaultPostApprovalState string
既定の投稿ショー社内ディスカッション
defaultPostShowInternalDiscussions boolean

投稿を作成する時の、ユーザーの既定の投稿社内ディスカッション状態

既定の投稿ショー作成者情報
defaultPostShowCreatorInfo boolean

作成者の名前と写真を表示することに関する投稿作成時のユーザーの既定の状態

allowlistIdentifiersResponse

名前 パス 説明
ID
id integer

許可リスト定義 ID

価値
value string

指定された許可リスト定義に対するユーザー応答

userPrivilegesResponse

ユーザーの特権

名前 パス 説明
投稿送信可能
canSubmitPosts boolean

権限とコミュニティ設定に基づいて、ユーザーが投稿を送信できるかどうかを示します

投稿共有可能
canSharePosts boolean

権限とコミュニティ設定に基づいて、ユーザーが投稿を共有できるかどうかを示します

投稿にコメント可能
canCommentPosts boolean

権限とコミュニティ設定に基づいて、ユーザーが投稿投稿したり「いいね!」を付けたりできるかどうかを示します

コミュニティを管理する
canManageCommunity boolean

権限とコミュニティ設定に基づいて、ユーザーがコミュニティーを管理できるマネージャーかどうかを示します

組織の管理が可能
canManageOrganization boolean

ユーザーの特権とコミュニティ設定に基づいて、ユーザーがコミュニティ内の直接および間接レポートにアクセスできるかどうかを示します

投稿を共有可能に設定する
canSetPostShareable boolean

ユーザーが投稿を送信するときに共有可能状態に設定できるかどうか

userPermissionsResponse

マネージャーのアクセス許可

名前 パス 説明
配信を表示する
viewBroadcast boolean

マネージャーが配信を表示できるようにします

配信一覧
listBroadcast boolean

マネージャーが配信の一覧を表示できるようにします

配信を編集する
editBroadcast boolean

マネージャーが配信を作成および編集できるようにします

配信統計を表示する
viewBroadcastStats boolean

マネージャーが配信統計を表示できるようにします

投稿を表示する
viewPost boolean

マネージャーが投稿を表示できるようにします

投稿一覧
listPost boolean

マネージャーが投稿の一覧を表示できるようにします

投稿の編集
editPost boolean

マネージャーが投稿を作成および編集できるようにします

投稿統計を表示する
viewPostStats boolean

マネージャーが投稿統計を表示できるようにします

調査を表示する
viewSurvey boolean

マネージャーが調査を表示できるようにします

調査の一覧
listSurvey boolean

マネージャーが調査の一覧を表示できるようにします

調査の編集
editSurvey boolean

マネージャーが調査を作成および編集できるようにします

コミュニティ設定
communitySettings boolean

マネージャーがコミュニティ設定を表示および編集できるようにします

userScheduleSettingsResponse

共有設定をスケジュールしたユーザー

名前 パス 説明
days string
回数
times array of string

userChannelResponse

ユーザー チャネル。

名前 パス 説明
ユーザー チャネル ID
userChannelId integer

内部ユーザー チャネルID

ユーザー ID
userId integer

内部ユーザー ID

プロバイダー
provider string
件名
name string

ソーシャル プロバイダー上のユーザー名

表示名
displayName string

ソーシャル プロバイダー上のユーザー表示名

プロバイダー ユーザー ID
providerUserId string

プロバイダーのユーザー ID

状態
status string
URL
url string

チャネルの URL

友人
friends integer

チャネル上にいるユーザーの友人数

フォロワー
followers integer

チャネル上にいるユーザーのフォロワー数

フォロー
following integer

チャネル上でユーザーがフォローしている数

投稿
posts integer

チャネル上でユーザーが投稿を作成した数。

ビュー
views integer

チャネル上でのユーザーの閲覧数

ポイント残高
pointBalance integer

チャネル上でのユーザーのポイント残高

ソース表示名
sourceDisplayName string

コンテンツ ソースとして使用する場合のユーザ ーチャネルの表示名

リーチ
reach integer

チャネルでのユーザー アクセス

共有可能
sharable boolean

チャネルが共有をサポートしているかどうか

既定の共有
sharingDefault boolean

チャネルが共有用に事前選択されているかどうか

認証必須
authRequired boolean

チャネルのクレデンシャルを更新する必要があるかどうか

statistics postStatisticsResponse
profilePictureImages
profilePictureImages object

divisionResponse

部門の定義

名前 パス 説明
部門 ID
divisionId integer

部門 ID

件名
name string

部門名

親部門 ID
parentDivisionId integer

この部門の親の ID

userAffiliationResponse

ユーザーの所属

名前 パス 説明
question affiliationQuestionResponse

所属の質問

answer affiliationAnswerResponse

所属の回答

affiliationAnswerResponse

所属の回答

名前 パス 説明
回答 ID
answerId integer

回答 ID

応答
answer string

回答

スコア
score double

提供された場合、スコア

自由書式
freeText string

FreeText 質問タイプの質問のテキスト

回答拒否
declineToAnswer boolean

設定されている場合、これはユーザーが質問への回答を拒否したことを示しています。

位置
position integer

回答の並べ替え位置

affiliationQuestionResponse

所属の質問

名前 パス 説明
質問 ID
questionId integer

質問 ID

件名
name string

質問

スコアの位置
scorePosition integer

質問の並べ替え位置

内容
description string

質問の説明

questionType
questionType string
必要
required boolean

登録するために質問に回答する必要があるかどうか

公開済み
isPubliclyVisible boolean

documentInfoResponse

添付ドキュメントに関連する情報

名前 パス 説明
ID
id uuid

ドキュメント ID

ファイル名
fileName string

拡張子付きドキュメントのファイル名

拡張
extension string

ドキュメントのファイル拡張子

MIME の種類
mimeType string

ドキュメントの MIME の種類

divisionsResponse

システムで定義された部門

名前 パス 説明
部門
divisions array of divisionResponse
プロンプト
prompt string

メンバーに部門の選択を促すラベル

ユーザーに部門の選択を表示
showUserDivisionSelection boolean

登録メンバーが自分の部門を変更できるかどうか

オンボード中にユーザーに部門の選択を表示する
showUserDivisionSelectionDuringOnboarding boolean

新しいメンバーが登録時に自分の部門を選択する必要があるかどうか

ユーザーの部門選択が必須
requireUserDivisionSelection boolean

メンバーが自分の部門を選択する必要があるかどうか。

複数の部門を許可
allowMultipleDivisions boolean

メンバーが複数の部門を選択できるか、1 つの部門のみを選択できるか

categoryResponse1

名前 パス 説明
ID
id integer

カテゴリ ID

件名
name string

カテゴリの名前

内容
description string

カテゴリの説明

表示順序
displayOrder integer

カテゴリを表示する順序

ピン留め済み
isPinned boolean

カテゴリが管理者によってピン留めされているかどうか

強制
isForced boolean

認証されたユーザーが特定のカテゴリに強制的に登録されているかどうか

登録済み
isSubscribed boolean

認証されたユーザーが特定のカテゴリに登録されているかどうか

非表示
isHidden boolean

カテゴリが管理者によって非表示にされているかどうか

ユーザーが選択可能か
isUserSelectable boolean

ユーザーが送信された投稿のカテゴリを選択できるかどうか

親カテゴリ ID
parentCategoryId integer

親カテゴリ ID

targetInfoResponse1

特定のターゲットの詳細情報。

名前 パス 説明
ID
id integer

ターゲット ID

件名
name string

ターゲットの名前

内容
description string

ターゲットの説明

定義 ID
definitionId integer

ターゲットが属するターゲット定義の ID

親 ID
parentId integer

ターゲットの親の ID (存在する場合)

登録済み
isSubscribed boolean

ユーザーが特定のターゲットに登録しているかどうか

childTargets
childTargets array of targetInfoResponse2

targetInfoResponse2

特定のターゲットの詳細情報。

名前 パス 説明
ID
id integer

ターゲット ID

件名
name string

ターゲットの名前

内容
description string

ターゲットの説明

定義 ID
definitionId integer

ターゲットが属するターゲット定義の ID

親 ID
parentId integer

ターゲットの親の ID (存在する場合)

登録済み
isSubscribed boolean

ユーザーが特定のターゲットに登録しているかどうか

childTargets
childTargets array of targetInfoResponse3

targetInfoResponse3

特定のターゲットの詳細情報。

名前 パス 説明
ID
id integer

ターゲット ID

件名
name string

ターゲットの名前

内容
description string

ターゲットの説明

定義 ID
definitionId integer

ターゲットが属するターゲット定義の ID

親 ID
parentId integer

ターゲットの親の ID (存在する場合)

登録済み
isSubscribed boolean

ユーザーが特定のターゲットに登録しているかどうか