次の方法で共有

Dynamic Signal (プレビュー)

Dynamic Signal は、従業員のつながり、調整、関与を行うために組織から信頼されている、従業員のコミュニケーションとエンゲージメント プラットフォームです。 Dynamic Signal に接続して、投稿とユーザーを作成および管理します。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
コネクタ メタデータ
Publisher 動的信号

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

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

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

名前 タイプ Description 必須
ベアラー トークン securestring この API のベアラー トークン 正しい
動的シグナル URL 文字列 Dynamic Signal にアクセスする URL。 正しい

調整制限

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

アクション

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

URL を使用して投稿画像を設定します。
アップロードを使用して投稿に画像を追加する

バイナリ アップロードを使用して投稿画像を設定します。
カテゴリを取得する

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

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

システムで定義されているユーザー タグの一覧を取得します。
ユーザーを事前登録する

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

投稿を作成します。
投稿を取得する

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

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

サーバー認証呼び出しで、1 つの要求内の複数の投稿のプロパティを更新できるようにします
投稿タグを取得する

システムで定義されているポスト タグを取得します。
文書を投稿にアップロードする

バイナリ アップロードを使用して文書を投稿にアップロードする
画像のアップロード

バイナリ アップロードを使用して画像をアップロードする
部門を取得する

区分の一覧を取得します。
電子メールでユーザーを取得する

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

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

操作 ID:
AddImageToPost

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

パラメーター

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

post ID(必須): true
ウェブアドレス
 url True string

HTTP または HTTPS URL

戻り値

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

response
successResponse

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

操作 ID:
PutImageToPost

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

パラメーター

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

投稿 ID
File
 File True binary

アップロードするファイル
image/jpg、image/pjpeg、image/png、image/x-png、image/gif などの Content-Type
 Content-Type True string

アップロードされたファイルの Content-Type

戻り値

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

response
successResponse

カテゴリを取得する

操作 ID:
GetCategories

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

戻り値

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

response
categoriesResponse

ターゲットを取得する

操作 ID:
GetTargets

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

戻り値

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

response
targetDefinitionsInfoResponse

ユーザー タグを取得する

操作 ID:
GetUserTags

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

戻り値

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

response
manageUserTagsResponse

ユーザーを事前登録する

操作 ID:
PreregisterUser

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

パラメーター

名前 キー 必須 型 説明
Email
 email string

ユーザーの電子メール アドレス
外部 SSO ユーザー ID
 externalSsoUserId string

SSO ID プロバイダーによって管理される外部システム上のユーザーの ID
ハンドル
 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

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

戻り値

response
userRequestResponse

投稿を作成する

操作 ID:
CreatePost

投稿を作成します。

パラメーター

名前 キー 必須 型 説明
Description
 description string

投稿の簡単な説明
タグ ライン
 tagLine string

投稿のタグ行
Content
 content string

投稿の本文
作成者コメント
 creatorComments string

投稿に関連付けられているメッセージ
Perma Link
 permaLink string

投稿によって参照される外部 URL
内部ディスカッションの有効化
 internalDiscussionsEnabled boolean

メンバーが同様のアクションを実行し、内部的に投稿にコメントを追加できるかどうかを示します
Title
 title True string

投稿のタイトル
メンバー ビデオ URL
 memberVideoUrl string

投稿によって参照されるビデオ URL
Post Type
 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
 language string

投稿コンテンツの言語
ドキュメント​
 documents array of uuid

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

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

作成者情報を投稿と共に表示するかどうかを制御します。このプロパティは、現時点ではサーバー認証要求でのみ使用できます。
カテゴリ ID
 categoryIds array of integer

投稿に割り当てられているカテゴリ ID の一覧
ターゲット ID
 targetIds array of integer

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

戻り値

投稿

response
postResponse

投稿を取得する

操作 ID:
GetPost

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

パラメーター

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

投稿 ID。;これは投稿の一意識別子です。
ユーザーID
 userId integer

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

戻り値

投稿

response
postResponse

投稿を更新する

操作 ID:
UpdatePost

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

パラメーター

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

投稿 ID
Title
 title string

投稿のタイトル
Description
 description string

投稿の簡単な説明
タグ ライン
 tagLine string

投稿のタグ行
Content
 content string

投稿の本文
作成者コメント
 creatorComments string

投稿に関連付けられているメッセージ
Perma Link
 permaLink string

投稿によって参照される外部 URL
内部ディスカッションの有効化
 internalDiscussionsEnabled boolean

メンバーが同様のアクションを実行し、内部的に投稿にコメントを追加できるかどうかを示します

戻り値

投稿

response
postResponse

投稿を管理する

操作 ID:
ManagePosts

サーバー認証呼び出しで、1 つの要求内の複数の投稿のプロパティを更新できるようにします

パラメーター

名前 キー 必須 型 説明
POST 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 要求の影響を受けません)

戻り値

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

response
successResponse

投稿タグを取得する

操作 ID:
GetPostTags

システムで定義されているポスト タグを取得します。

戻り値

システムで定義されているポスト タグの一覧

response
managePostTagsResponse

文書を投稿にアップロードする

操作 ID:
PutDocument

バイナリ アップロードを使用して文書を投稿にアップロードする

パラメーター

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

ドキュメントの優先ファイル名 (拡張子付き)
ID
 id True uuid

投稿 ID
File
 File True binary

アップロードするファイル
image/jpg、image/pjpeg、image/png、image/x-png、image/gif などの Content-Type
 Content-Type True string

アップロードされたファイルの Content-Type

戻り値

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

response
documentInfoResponse

画像のアップロード

操作 ID:
ManageImage

バイナリ アップロードを使用して画像をアップロードする

パラメーター

名前 キー 必須 型 説明
File
 File True binary

アップロードするファイル
image/jpg、image/pjpeg、image/png、image/x-png、image/gif などの Content-Type
 Content-Type True string

アップロードされたファイルの Content-Type

戻り値

response
uploadImageResponse

部門を取得する

操作 ID:
GetDivisions

区分の一覧を取得します。

戻り値

システムで定義されている区分

response
divisionsResponse

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

操作 ID:
GetUserByEmail

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

パラメーター

名前 キー 必須 型 説明
Email
 email True string

ユーザーの電子メール
含める
 include array of string

ユーザーと共に返す省略可能なデータを指定します。

戻り値

response
userRequestResponse

定義

successResponse

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

名前 パス 型 説明
Code
 code string

値 "success" は、成功した操作を示します

targetDefinitionsInfoResponse

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

名前 パス 型 説明
definitions
 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
 description string

ターゲットの descritption
定義 ID
 definitionId integer

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

ターゲットの親の ID (親の ID がある場合)
サブスクライブ済み
 isSubscribed boolean

ユーザーが特定のターゲットにサブスクライブされているかどうか
childTargets
 childTargets array of targetInfoResponse1

managePostTagsResponse

システムで定義されているポスト タグの一覧

名前 パス 型 説明
tags
 tags array of managePostTagResponse

managePostTagResponse

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

名前 パス 型 説明
ID
 id integer

タグ ID
名前
 name string

タグ名
メンバーが使用できる
 isAvailableToMembers boolean

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

manageUserTagsResponse

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

名前 パス 型 説明
tags
 tags array of manageUserTagResponse

manageUserTagResponse

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

名前 パス 型 説明
ID
 id integer

タグ ID
名前
 name string

タグ名
型
 type string
acceptedValues
 acceptedValues array of string

categoriesResponse

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

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

メンバーにカテゴリ サブスクリプションの選択を求めるラベル
カテゴリ サブスクリプションを有効にする
 enableCategorySubscription boolean

メンバーがカテゴリ サブスクリプションの変更を許可されるかどうか
サブスクリプションの選択が必要
 requireSubscriptionSelection boolean

オンボーディング中にメンバーがカテゴリ サブスクリプションを選択する必要があるかどうか
ランディング ページの既定のカテゴリ
 landingPageDefaultCategory integer

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

categoryResponse

名前 パス 型 説明
ID
 id integer

カテゴリ ID
名前
 name string

カテゴリ名
Description
 description string

カテゴリの説明
表示順序
 displayOrder integer

カテゴリを表示する順序
ピン留めされている
 isPinned boolean

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

認証されたユーザーが特定のカテゴリに強制的にサブスクライブされるかどうか
サブスクライブ済み
 isSubscribed boolean

認証されたユーザーが特定のカテゴリにサブスクライブされている
非表示
 isHidden boolean

カテゴリが管理者によって非表示になっているかどうか
ユーザーが選択可能か
 isUserSelectable boolean

送信された投稿のカテゴリの選択をユーザーに許可するかどうか
親カテゴリ ID
 parentCategoryId integer

親カテゴリ ID
childCategories
 childCategories array of categoryResponse1

postResponse

投稿

名前 パス 型 説明
Post ID
 postId uuid

投稿 ID
ソース ID の投稿
 postSourceId integer

ソース ID
Title
 title string

投稿のタイトル
Description
 description string

投稿の簡単な説明
タグ ライン
 tagLine string

投稿のタグ行
Content
 content string

投稿の本文
生コンテンツ
 rawContent string

すべての HTML を含む投稿の本文 (Content と RawContent の両方が含まれている場合)
作成者コメント
 creatorComments string

投稿に関連付けられているメッセージ
creatorInfo userOverviewResponse

ユーザーに関する概要情報
ロケーション
 location string

投稿に関連する地理的な場所
プロパティ
 properties object

投稿のその他のプロパティ。 すべての投稿の種類では使用できません
Perma Link
 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
 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 Slug
 urlSlug string

投稿へのパブリック リンクに配置する SEO テキスト
Classification
 classification string

プロバイダー ネットワーク上の投稿の種類。
画像と共有する
 shareWithImages boolean

短いメッセージ サービス (Twitter など) に共有されている投稿に画像が共有されているかどうかを制御します。
画像のみを共有する
 shareImagesOnly boolean

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

投稿と URL のアクション 項目の一覧を含む JSON BLOB
メンション
 mentions string

JSON BLOB として格納されているメンション (ユーザー、ハッシュ タグなど)。
statistics postStatisticsResponse
userShareInfo postUserShareInfoResponse
author postAuthorRequestResponse
links
 links array of postLinkRequestResponse
tags
 tags array of postTagRequestResponse
メディア
 media array of postMediaRequestResponse
images
 images object
candidateImages
 candidateImages array of postCandidateImageResponse
目に見える
 visible boolean

投稿が現在表示されているかどうか
shareDisclosures
 shareDisclosures array of postShareDisclosureResponse
shareCommentRules
 shareCommentRules array of postShareCommentRulesResponse
Language
 language string

投稿コンテンツの言語
ユーザー非表示
 userHidden boolean

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

現在のユーザーが投稿を表示したかどうか。
ユーザーがディスカッションを表示する
 isDiscussionViewedByUser boolean

投稿のディスカッション スレッドが現在のユーザーによって表示されたかどうか
ユーザーにいいね!
 isLikedByUser boolean

投稿が現在のユーザーによって内部的に気に入られたかどうか。
ユーザーがコメントを付けた場合
 isCommentedByUser boolean

投稿が現在のユーザーによってコメントされたかどうか。
ユーザーが共有する
 isSharedByUser boolean

投稿が現在のユーザーによって以前に共有されているかどうか
targets
 targets array of targetOverviewResponse
categories
 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 string

イメージの URL
Width
 width integer

画像の幅
高さ
 height integer

画像の高さ
Mime の種類
 mimeType string

画像の MIME の種類
Ssl Url
 sslUrl string

イメージのセキュリティで保護された URL

postMediaRequestResponse

名前 パス 型 説明
名前
 name string

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

メディア オブジェクトの幅 (ピクセル単位)
高さ
 height integer

メディア オブジェクトの高さ (ピクセル単位)
Mime の種類
 mimeType string

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

メディア オブジェクトのレンダリングに使用できる HTML
ウェブアドレス
 url string

メディア オブジェクトの URL
始点
 origin string

使用可能な場合は、メディア オブジェクトの元の場所を指定します
プロバイダー
 provider string

ソーシャル プロバイダー名
Role
 role string

メディアの種類 (決定された場合)
期間
 duration integer

ビデオの再生時間 (ミリ秒)
Description
 description string

ビデオ形式の説明
ビデオ URL がある
 hasVideoUrl boolean

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

postTagRequestResponse

名前 パス 型 説明
名前
 name string

タグ名

postLinkRequestResponse

名前 パス 型 説明
ウェブアドレス
 url string

投稿 URL
展開された URL
 expandedUrl string

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

投稿のタイトル
ドメイン
 domain string

リンク ドメイン
Favicon Url
 faviconUrl string

リンクの favicon URL
名前
 name string

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

リンクの短いキャプション (つまり、リンクの下のテキスト)
Description
 description string

リンクの説明 (キャプションの下の長いテキスト)
変更日
 modifiedDate date-time
作成日
 createdDate date-time

postAuthorRequestResponse

名前 パス 型 説明
Author
 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

共有からの投稿リンクへのクリック数
Like Count
 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
 email string

ユーザーのメール アドレス
ハンドル
 handle string

ユーザー ハンドル ("ユーザー名")
表示される名前
 displayName string

ユーザー優先表示名
氏名
 fullName string

ユーザーの姓と名
名前
 firstName string

ユーザー名
姓
 lastName string

ユーザーの姓
displayNameFormat
 displayNameFormat string
状態
 status string
プロファイルの完了
 profileCompleted boolean

オンボード中にユーザー プロファイルが完了したかどうか
最後のアクティビティ日付
 lastActivityDate date-time

ユーザーがシステムと最後に対話した時刻。
Title
 title string

ユーザー のタイトル
ロケーション
 location string

ユーザーの自己記述型の場所 (実際の地理的な場所ではない可能性があります)
外部 API ユーザー ID
 externalApiUserId string

この API の呼び出し元によって管理される外部システムのユーザー ID
マネージャーのユーザー ID
 managerUserId integer

ユーザー マネージャーの ID (組織階層機能の場合)
タイム ゾーン
 timeZone string

IANA によって設定された tz データベースのタイム ゾーン名として表されるユーザー タイム ゾーン。 例: "America/Los_Angeles"。
選択したタイム ゾーン
 selectedTimeZone string

ユーザーは、IANA によって設定された tz データベースのタイム ゾーン名として表されるタイム ゾーンを選択しました。 例: "America/Los_Angeles"。
ポイント残高
 pointBalance integer

現在までに獲得した合計ポイント数
未解決のポイント
 unredeemedPoints integer

現在引き換え可能なポイント
引き換えられたポイント
 redeemedPoints integer

ユーザーの有効期間中に引き換えられたポイントの数
API 情報
 apiInfo string

API 固有のプロパティ バッグ
パスワードを持つ
 hasPassword boolean

ユーザーがアカウントに関連付けられているパスワードを持っているかどうか。
パスワードを変更する必要がある
 mustChangePassword boolean

ユーザーがコミュニティ設定に基づいてパスワードを変更する必要があるかどうか
アカウントの検証済み
 isAccountVerified boolean

ユーザーが自分のメール アドレスを確認したかどうかを示します
statistics postStatisticsResponse
tags
 tags object
バッジ
 badges object
所属
 affiliations array of userAffiliationResponse
部門
 divisions array of divisionResponse
channels
 channels array of userChannelResponse
profilePictureImages
 profilePictureImages object
言語
 languages array of string
第一言語
 primaryLanguage string

ユーザーのプライマリ インターフェイス言語
scheduleSettings userScheduleSettingsResponse

ユーザーのスケジュールされた共有設定
Is Sso
 isSso boolean

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

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

ユーザー特権
識別子
 identifiers array of allowlistIdentifiersResponse
targets
 targets array of targetOverviewResponse
defaults userDefaultsRequestResponse

ユーザーのコレクションの既定値
ウェルカム バナーが閉じられた
 welcomeBannerDismissed boolean

ユーザーがウェルカム バナーを無視したかどうか

userDefaultsRequestResponse

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

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

ユーザーは、投稿を作成するときの既定の内部ディスカッションの状態を投稿します
既定の Post Show Creator Info
 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 string

チャネルの URL
フレンズ
 friends integer

ユーザーがチャネルに接続しているフレンドの数
Followers
 followers integer

ユーザーがチャネルに対して持っているフォロワーの数
Following
 following integer

ユーザーがチャネルでフォローしているユーザーの数
Posts
 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
 score double

スコア (指定されている場合)
フリー テキスト
 freeText string

FreeText の質問の種類を持つ質問のテキスト
回答を拒否する
 declineToAnswer boolean

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

回答の並べ替え位置

affiliationQuestionResponse

所属の質問

名前 パス 型 説明
質問の ID
 questionId integer

質問 ID
名前
 name string

質問
スコアの位置
 scorePosition integer

質問の並べ替え位置
Description
 description string

質問の説明
questionType
 questionType string
必須
 required boolean

登録するために質問に回答する必要があるかどうか
パブリックに表示される
 isPubliclyVisible boolean

documentInfoResponse

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

名前 パス 型 説明
ID
 id uuid

ドキュメント ID
ファイル名
 fileName string

ドキュメントファイル名 (拡張子付き)
Extension
 extension string

ドキュメント ファイル拡張子
Mime の種類
 mimeType string

ドキュメントの MIME の種類

divisionsResponse

システムで定義されている区分

名前 パス 型 説明
部門
 divisions array of divisionResponse
Prompt
 prompt string

メンバーに部門の選択を求めるラベル
ユーザー分割の選択を表示する
 showUserDivisionSelection boolean

登録済みメンバーが自分の部署を変更できるかどうか
オンボーディング中にユーザー部門の選択を表示する
 showUserDivisionSelectionDuringOnboarding boolean

新規メンバーが登録時に自分の部門を選択する必要があるかどうか
ユーザー部門の選択が必要
 requireUserDivisionSelection boolean

メンバーが自分の部門を選択する必要があるかどうか。
複数の区分を許可する
 allowMultipleDivisions boolean

メンバーが複数または 1 つの除算のみを選択できるかどうかを指定します。

categoryResponse1

名前 パス 型 説明
ID
 id integer

カテゴリ ID
名前
 name string

カテゴリ名
Description
 description string

カテゴリの説明
表示順序
 displayOrder integer

カテゴリを表示する順序
ピン留めされている
 isPinned boolean

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

認証されたユーザーが特定のカテゴリに強制的にサブスクライブされるかどうか
サブスクライブ済み
 isSubscribed boolean

認証されたユーザーが特定のカテゴリにサブスクライブされている
非表示
 isHidden boolean

カテゴリが管理者によって非表示になっているかどうか
ユーザーが選択可能か
 isUserSelectable boolean

送信された投稿のカテゴリの選択をユーザーに許可するかどうか
親カテゴリ ID
 parentCategoryId integer

親カテゴリ ID

targetInfoResponse1

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

名前 パス 型 説明
ID
 id integer

ターゲット ID
名前
 name string

ターゲットの名前
Description
 description string

ターゲットの descritption
定義 ID
 definitionId integer

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

ターゲットの親の ID (親の ID がある場合)
サブスクライブ済み
 isSubscribed boolean

ユーザーが特定のターゲットにサブスクライブされているかどうか
childTargets
 childTargets array of targetInfoResponse2

targetInfoResponse2

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

名前 パス 型 説明
ID
 id integer

ターゲット ID
名前
 name string

ターゲットの名前
Description
 description string

ターゲットの descritption
定義 ID
 definitionId integer

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

ターゲットの親の ID (親の ID がある場合)
サブスクライブ済み
 isSubscribed boolean

ユーザーが特定のターゲットにサブスクライブされているかどうか
childTargets
 childTargets array of targetInfoResponse3

targetInfoResponse3

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

名前 パス 型 説明
ID
 id integer

ターゲット ID
名前
 name string

ターゲットの名前
Description
 description string

ターゲットの descritption
定義 ID
 definitionId integer

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

ターゲットの親の ID (親の ID がある場合)
サブスクライブ済み
 isSubscribed boolean

ユーザーが特定のターゲットにサブスクライブされているかどうか