
言語 🇯🇵 日本語
はじめに
ドキュメント
APIリファレンス
集計
監査ログ
認証
コメントのブロック
ブロックされたコメントの確認
コメント
ユーザーのコメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
コメントの通報
GIF
ハッシュタグ
モデレーション
モデレーター
通知数
通知
ページのリアクション
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果の集計
SSOユーザー
サブスクリプション
テナントの日次使用量
テナントパッケージ
テナントユーザー
テナント
チケット
翻訳
画像アップロード
ユーザーバッジの進捗
ユーザーバッジ
ユーザーの通知
ユーザーのプレゼンスステータス
ユーザー検索
ユーザー
投票
FastComments Swift SDK
これは FastComments の公式 Swift SDK です。
FastComments API の公式 Swift SDK
リポジトリ
インストール 
Swift パッケージマネージャ
以下を Package.swift ファイルに追加してください:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
または Xcode で:
- File > パッケージを追加...
- リポジトリ URL を入力してください:
https://github.com/fastcomments/fastcomments-swift.git - 使用したいバージョンを選択してください
要件
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
ライブラリの内容 
FastComments Swift SDK はいくつかのモジュールで構成されています:
-
Client Module - FastComments REST API 用の API クライアント
- すべての API モデルに対する完全な型定義
- 認証済み(
DefaultAPI)、パブリック(PublicAPI)、およびモデレーション(ModerationAPI)のメソッド - 完全な async/await のサポート
- 詳細な API ドキュメントは client/README.md を参照してください
-
SSO Module - サーバーサイドのシングルサインオン用ユーティリティ
- ユーザー認証のための安全なトークン生成
- シンプルな SSO モードとセキュアな SSO モードの両方をサポート
- CryptoKit を使用した HMAC-SHA256 ベースのトークン署名
クイックスタート 
パブリック API の使用
import FastCommentsSwift
// ページのコメントを取得
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
認証済み API の使用
import FastCommentsSwift
// 共有設定に API キーを設定 (x-api-key ヘッダーとして送信されます)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// 認証済み API を使用してコメントを取得
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
モデレーション API の使用
import FastCommentsSwift
// モデレーションメソッドは、実行モデレーター用の `sso` トークンで認可されます
// (FastCommentsSSO で生成し、上記の SSO セクションを参照してください)。
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
認証に SSO を使用
セキュア SSO(本番環境推奨)
import FastCommentsSwift
let apiKey = "your-api-key"
// セキュア SSO ユーザーデータを作成 (サーバー側のみ!)
let userData = SecureSSOUserData(
id: "user-123", // User ID
email: "user@example.com", // Email
username: "johndoe", // Username
avatar: "https://example.com/avatar.jpg" // Avatar URL
)
// SSO トークンを生成
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// このトークンをフロントエンドに渡して認証に使用
} catch {
print("Error creating SSO token: \(error)")
}
シンプル SSO(開発/テスト用)
import FastCommentsSwift
// シンプル SSO ユーザーデータを作成 (API キーは不要)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// シンプル SSO トークンを生成
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
APIクライアント 
The FastComments SDK は 3 つの API クライアントを提供します:
PublicAPI - クライアント安全なメソッド
PublicAPI には、クライアント側のコード(iOS/macOS アプリ)から安全に呼び出せるメソッドが含まれています。これらのメソッドは:
- API キーを必要としません
- 認証に SSO トークンを使用できます
- ユーザー/デバイスごとにレート制限があります
- エンドユーザー向けアプリケーションに適しています
使用例: iOS アプリでコメントを取得・作成する
DefaultAPI - サーバー側メソッド
DefaultAPI には、API キーが必要な認証済みメソッドが含まれています。これらのメソッドは:
- FastComments API キーが必要です
- サーバー側のコードからのみ呼び出すべきです
- FastComments データへのフルアクセスが可能です
- テナントごとにレート制限があります
使用例: 管理操作、バルクデータエクスポート、ユーザー管理
ModerationAPI - モデレーターダッシュボードメソッド
ModerationAPI は、豊富なライブ・高速モデレーション API を提供します。すべての ModerationAPI メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッションクッキーで認証できます。
使用例: コミュニティのモデレーター向けモデレーション体験を構築する
IMPORTANT: クライアント側のコードに API キーを決して公開しないでください。API キーはサーバー側でのみ使用すべきです。
API呼び出しの実行 
Swift SDK は、すべての API 呼び出しにモダンな async/await 構文を使用します:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
よくある問題 
401 Unauthorized エラー
認証済み API を使用しているときに 401 エラーが発生する場合:
- API キーを確認: FastComments ダッシュボードから正しい API キーを使用していることを確認してください
- テナント ID を確認: テナント ID がアカウントと一致していることを確認してください
- API キーの形式: API キーは共有設定の
x-api-keyヘッダーとして設定する必要があります:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- 間違った API の使用: 認証済み呼び出しには
DefaultAPI(PublicAPIではなく)を使用していることを確認してください
SSO トークンの問題
SSO トークンが機能しない場合:
- 本番環境ではセキュアモードを使用: 本番環境では常に API キーと共に
FastCommentsSSO.createSecure()を使用してください - サーバー側のみ: セキュア SSO トークンはサーバー上で生成し、クライアントに API キーを公開しないでください
- ユーザーデータを確認: 必要なフィールド(id、email、username)がすべて提供されていることを確認してください
- トークンの有効期限: セキュア SSO トークンにはタイムスタンプが含まれ、期限切れになる可能性があります。必要に応じて新しいトークンを生成してください。
SSL/TLS エラー
SSL/TLS エラーが発生した場合:
- アプリの Info.plist が fastcomments.com への HTTPS 接続を許可していることを確認してください
- 接続をブロックする可能性のある App Transport Security の例外を使用していないか確認してください
注意事項 
ブロードキャストID
いくつかの API 呼び出しで broadcastId を渡す必要があることがわかるでしょう。イベントを受信すると、この ID が返されます。クライアント側で楽観的に変更を適用するつもりなら(これは最良の体験を提供するため、おそらくそうするでしょう)、そのイベントを無視すべきかどうかがわかります。ここには UUID を渡してください。ID はセッション内で二度出現しない程度に十分一意である必要があります。
let broadcastId = UUID().uuidString
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| parentTenantId | string | query | いいえ | |
| includeStats | boolean | query | いいえ |
Response
Returns: AggregateResponse
Example

getAuditLogs 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Response
戻り値: GetAuditLogsResponse
Example

logoutPublic 
レスポンス
戻り値: APIEmptyResponse
例

blockFromCommentPublic 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: BlockSuccess
例

unBlockCommentPublic 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却: UnblockSuccess
例

checkedCommentsForBlocked 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentIds | string | query | はい | カンマ区切りのコメントIDのリスト。 |
| sso | string | query | いいえ |
レスポンス
戻り値: CheckBlockedCommentsResponse
例

blockUserFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: BlockSuccess
例

createCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: SaveCommentsResponseWithPresence
例

deleteComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
応答
返り値: DeleteCommentResult
例

deleteCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | 文字列 | パス | はい | |
| commentId | 文字列 | パス | はい | |
| broadcastId | 文字列 | クエリ | はい | |
| editKey | 文字列 | クエリ | いいえ | |
| sso | 文字列 | クエリ | いいえ |
応答
返り値: PublicAPIDeleteCommentResponse
例

deleteCommentVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
レスポンス
例

flagComment 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: FlagCommentResponse
例

getComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getComments 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
応答
例

getCommentsPublic 
リクエスト
tenantId
urlId
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
レスポンス
戻り値: GetCommentsResponseWithPresencePublicComment
例

getCommentText 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: PublicAPIGetCommentTextResponse
例

getCommentVoteUserNames 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| dir | integer | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetCommentVoteUserNamesSuccessResponse
例

lockComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

pinComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

saveComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
レスポンス
例

saveCommentsBulk 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
レスポンス
Returns: [SaveCommentsBulkResponse]
例

setCommentText 
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: PublicAPISetCommentTextResponse
例

unBlockUserFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
返り値: UnblockSuccess
例

unFlagComment 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
応答
戻り値: FlagCommentResponse
例

unLockComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

unPinComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

updateComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
応答
返却: APIEmptyResponse
例

voteComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: VoteResponse
例

getCommentsForUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
レスポンス
返却: GetCommentsForUserResponse
例

addDomainConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例

deleteDomainConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
戻り値: DeleteDomainConfigResponse
例

getDomainConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
例

getDomainConfigs 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

patchDomainConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
戻り値: PatchDomainConfigResponse
例

putDomainConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
例

createEmailTemplate 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateEmailTemplateResponse
例

deleteEmailTemplate 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
Response
戻り値: APIEmptyResponse
例

deleteEmailTemplateRenderError 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

getEmailTemplate 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getEmailTemplateDefinitions 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetEmailTemplateDefinitionsResponse
例

getEmailTemplateRenderErrors 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetEmailTemplateRenderErrorsResponse
例

getEmailTemplates 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
返却値: GetEmailTemplatesResponse
例

renderEmailTemplate 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| locale | string | query | いいえ |
レスポンス
戻り値: RenderEmailTemplateResponse
例

updateEmailTemplate 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
返却: APIEmptyResponse
例

getEventLog 
req tenantId urlId userIdWS
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
戻り値: GetEventLogResponse
例

getGlobalEventLog 
リクエスト tenantId urlId userIdWS
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
戻り値: GetEventLogResponse
例

createFeedPost 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
応答
例

createFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

deleteFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: DeleteFeedPostPublicResponse
例

getFeedPosts 
リクエスト
tenantId
afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
レスポンス
返り値: GetFeedPostsResponse
例

getFeedPostsPublic 
req tenantId afterId
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ | |
| sso | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeUserInfo | boolean | query | いいえ |
レスポンス
例

getFeedPostsStats 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

getUserReactsPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
レスポンス
例

reactFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

updateFeedPost 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

updateFeedPostPublic 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

flagCommentPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| isFlagged | boolean | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: APIEmptyResponse
例

getGifLarge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| largeInternalURLSanitized | string | query | はい |
レスポンス
戻り値: GifGetLargeResponse
例

getGifsSearch 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
レスポンス
例

getGifsTrending 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
レスポンス
例

addHashTag 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
Returns: CreateHashTagResponse
例

addHashTagsBulk 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
返却: BulkCreateHashTagsResponse
例

deleteHashTag 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
応答
戻り値: APIEmptyResponse
例

getHashTags 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | number | query | いいえ |
レスポンス
例

patchHashTag 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| tag | string | path | はい |
レスポンス
例

deleteModerationVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| voteId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

getApiComments 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationAPIGetCommentsResponse
例

getApiExportStatus 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| batchJobId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: ModerationExportStatusResponse
例

getApiIds 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
応答
Returns: ModerationAPIGetCommentIdsResponse
例

getBanUsersFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetBannedUsersFromCommentResponse
例

getCommentBanStatus 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
応答
戻り値: GetCommentBanStatusResponse
例

getCommentChildren 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
返り値: ModerationAPIChildCommentsResponse
例

getCount 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| byIPFromComment | string | query | いいえ | |
| filter | string | query | いいえ | |
| searchFilters | string | query | いいえ | |
| demo | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
Returns: ModerationAPICountCommentsResponse
例

getCounts 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| sso | string | クエリ | いいえ |
レスポンス
返り値: GetBannedUsersCountResponse
例

getLogs 
Parameters(パラメータ)
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response(レスポンス)
返却: ModerationAPIGetLogsResponse
Example(例)

getManualBadges 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: GetTenantManualBadgesResponse
例

getManualBadgesForUser 
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: GetUserManualBadgesResponse
例

getModerationComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
応答
戻り値: ModerationAPICommentResponse
例

getModerationCommentText 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
応答
例

getPreBanSummary 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
レスポンス
返却: PreBanSummary
例

getSearchCommentsSummary 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationCommentSearchResponse
例

getSearchPages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
応答
返り値: ModerationPageSearchResponse
例

getSearchSites 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ModerationSiteSearchResponse
例

getSearchSuggest 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
レスポンス
例

getSearchUsers 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationUserSearchResponse
例

getTrustFactor 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
応答
返却: GetUserTrustFactorResponse
例

getUserBanPreference 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
Response
返り値: APIModerateGetUserBanPreferencesResponse
例

getUserInternalProfile 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: GetUserInternalProfileResponse
例

postAdjustCommentVotes 
パラメータ
| 名前 | タイプ | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
例

postApiExport 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| byIPFromComment | string | query | いいえ | |
| filters | string | query | いいえ | |
| searchFilters | string | query | いいえ | |
| sorts | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

postBanUserFromComment 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
レスポンス
例

postBanUserUndo 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例

postBulkPreBanSummary 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
戻り値: BulkPreBanSummary
Example

postCommentsByIds 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
応答
返り値: ModerationAPIChildCommentsResponse
例

postFlagComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: APIEmptyResponse
例

postRemoveComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: PostRemoveCommentApiResponse
例

postRestoreDeletedComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: APIEmptyResponse
例

postSetCommentApprovalStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| approved | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
戻り値: SetCommentApprovedResponse
例

postSetCommentReviewStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| reviewed | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例

postSetCommentSpamStatus 
Parameters
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| spam | boolean | query | いいえ | |
| permNotSpam | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
Response
戻り値: APIEmptyResponse
Example

postSetCommentText 
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
例

postUnFlagComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

postVote 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| direction | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: VoteResponse
例

putAwardBadge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

putCloseThread 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返り値: APIEmptyResponse
例

putRemoveBadge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

putReopenThread 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

setTrustFactor 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
レスポンス
返却: SetUserTrustFactorResponse
例

createModerator 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

deleteModerator 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sendEmail | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getModerator 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetModeratorResponse
例

getModerators 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

sendInvite 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| fromName | string | query | はい |
レスポンス
戻り値: APIEmptyResponse
例

updateModerator 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

deleteNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却: APIEmptyResponse
例

getCachedNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetCachedNotificationCountResponse
例

getNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
応答
Returns: GetNotificationCountResponse
例

getNotifications 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
レスポンス
例

updateNotification 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

createV1PageReact 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
レスポンス
例

createV2PageReact 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい | |
| title | string | query | いいえ |
レスポンス
戻り値: CreateV1PageReact
例

deleteV1PageReact 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: CreateV1PageReact
例

deleteV2PageReact 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい |
レスポンス
戻り値: CreateV1PageReact
例

getV1PageLikes 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetV1PageLikes
例

getV2PageReacts 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetV2PageReacts
例

getV2PageReactUsers 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい |
レスポンス
戻り値: GetV2PageReactUsersResponse
例

addPage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: AddPageAPIResponse
例

deletePage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | ページ URL 識別子(サーバー側でクリーンアップ済み)。 |
| afterName | string | query | いいえ | カーソル: 前回のレスポンスから nextAfterName を渡します。 |
| afterUserId | string | query | いいえ | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡します。afterName が設定されている場合に必要で、名前が同じエントリが除外されないようにします。 |
レスポンス
例

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | ページ URL 識別子(サーバー側でクリーンアップ済み)。 |
| afterName | string | query | No | カーソル: 前回のレスポンスから nextAfterName を渡す。 |
| afterUserId | string | query | No | カーソルのタイブレーカー: 前回のレスポンスから nextAfterUserId を渡す。afterName が設定されている場合に必須で、名前が同じ場合にエントリが除外されません。 |
Response
Returns: PageUsersOnlineResponse
例

getPageByURLId 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetPageByURLIdAPIResponse
例

getPages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetPagesAPIResponse
例

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | 前回のリクエストで nextCursor として返された不透明なページネーションカーソルです。sortBy と同じものに結び付けられます。 |
| limit | integer | query | No | 1..200、デフォルトは 50 |
| q | string | query | No | オプションの大文字小文字を区別しないタイトルプレフィックスフィルタです。 |
| sortBy | string | query | No | ソート順です。updatedAt(デフォルト、最新が最初)、commentCount(コメント数が多い順)、または title(アルファベット順)。 |
| hasComments | boolean | query | No | true の場合、少なくとも1つのコメントがあるページのみを返します。 |
Response
例

getUsersInfo 
テナントの複数ユーザー情報。userIds を受け取り、User / SSOUser から表示情報を返します。 コメントウィジェットが、プレゼンスイベントで新たに現れたユーザーの情報を補完するために使用します。 ページコンテキストがないため、プライバシーは一律に適用されます(非公開プロファイルはマスクされます)。
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | カンマ区切りの userIds。 |
レスポンス
例

patchPage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: PatchPageAPIResponse
例

deletePendingWebhookEvent 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getPendingWebhookEventCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
レスポンス
戻り値: GetPendingWebhookEventCountResponse
例

getPendingWebhookEvents 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
レスポンス
返却: GetPendingWebhookEventsResponse
例

createQuestionConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateQuestionConfigResponse
例

deleteQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetQuestionConfigResponse
例

getQuestionConfigs 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionConfigsResponse
例

updateQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

createQuestionResult 
パラメータ
| 名称 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateQuestionResultResponse
例

deleteQuestionResult 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getQuestionResult 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getQuestionResults 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | いいえ | |
| userId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| questionId | string | query | いいえ | |
| questionIds | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
返却: GetQuestionResultsResponse
例

updateQuestionResult 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

aggregateQuestionResults 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| timeBucket | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
返却: AggregateQuestionResultsResponse
例

bulkAggregateQuestionResults 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResultsResponse
例

combineCommentsWithQuestionResults 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ | |
| minValue | number | query | いいえ | |
| maxValue | number | query | いいえ | |
| limit | number | query | いいえ |
応答
返り値: CombineQuestionResultsWithCommentsResponse
例

addSSOUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

deleteSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
レスポンス
例

getSSOUserByEmail 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| string | path | はい |
レスポンス
戻り値: GetSSOUserByEmailAPIResponse
例

getSSOUserById 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetSSOUserByIdAPIResponse
例

getSSOUsers 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
レスポンス
戻り値: GetSSOUsersResponse
例

patchSSOUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

putSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

createSubscription 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateSubscriptionAPIResponse
例

deleteSubscription 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: DeleteSubscriptionAPIResponse
例

getSubscriptions 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: GetSubscriptionsAPIResponse
例

updateSubscription 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
Response
戻り値: UpdateSubscriptionAPIResponse
例

getTenantDailyUsages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
レスポンス
Returns: GetTenantDailyUsagesResponse
例

createTenantPackage 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantPackageResponse
例

deleteTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
例

getTenantPackages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantPackagesResponse
例

replaceTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

updateTenantPackage 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

createTenantUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

deleteTenantUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | string | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getTenantUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getTenantUsers 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

replaceTenantUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

sendLoginLink 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| redirectURL | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

updateTenantUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

createTenant 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantResponse
例

deleteTenant 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sure | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getTenant 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetTenantResponse
例

getTenants 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
レスポンス
例

updateTenant 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

changeTicketState 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: ChangeTicketStateResponse
例

createTicket 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい |
レスポンス
返却値: CreateTicketResponse
例

getTicket 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: GetTicketResponse
例

getTickets 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
応答
戻り値: GetTicketsResponse
例

getTranslations 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| namespace | string | path | はい | |
| component | string | path | はい | |
| locale | string | query | いいえ | |
| useFullTranslationIds | boolean | query | いいえ |
レスポンス
例

uploadImage 
画像のアップロードとリサイズ
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス用のサイズを作成) |
| urlId | string | query | No | アップロードが行われているページの ID、設定用 |
レスポンス
例

getUserBadgeProgressById 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却値: APIGetUserBadgeProgressResponse
例

getUserBadgeProgressByUserId 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | path | はい |
レスポンス
戻り値: APIGetUserBadgeProgressResponse
例

getUserBadgeProgressList 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
Returns: APIGetUserBadgeProgressListResponse
例

createUserBadge 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
戻り値: APICreateUserBadgeResponse
例

deleteUserBadge 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getUserBadge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getUserBadges 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| badgeId | string | query | いいえ | |
| type | number | query | いいえ | |
| displayedOnComments | boolean | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
応答
例

updateUserBadge 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getUserNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: GetUserNotificationCountResponse
例

getUserNotifications 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | 現在のページが購読されているかどうかを判定するために使用されます。 |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
レスポンス
Returns: GetMyNotificationsResponse
例

resetUserNotificationCount 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ResetUserNotificationsResponse
例

resetUserNotifications 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
レスポンス
返却: ResetUserNotificationsResponse
例

updateUserNotificationCommentSubscriptionStatus 
特定のコメントに対する通知を有効化または無効化します。
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| notificationId | string | path | はい | |
| optedInOrOut | string | path | はい | |
| commentId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse
例

updateUserNotificationPageSubscriptionStatus 
ページの通知を有効または無効にします。ユーザーがページを購読している場合、新しいルートコメントに対して通知が作成され、また
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| url | string | query | はい | |
| pageTitle | string | query | はい | |
| subscribedOrUnsubscribed | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: UpdateUserNotificationPageSubscriptionStatusResponse
例

updateUserNotificationStatus 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: UpdateUserNotificationStatusResponse
例

getUserPresenceStatuses 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| urlIdWS | string | クエリ | はい | |
| userIds | string | クエリ | はい |
レスポンス
返却: GetUserPresenceStatusesResponse
例

searchUsers 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
レスポンス
Returns: SearchUsersResult
例

getUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetUserResponse
例

createVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
応答
返り値: VoteResponse
例

deleteVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| editKey | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

getVotes 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
レスポンス
戻り値: GetVotesResponse
例

getVotesForUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
例

ヘルプが必要ですか?
Swift SDK に関して問題が発生した場合や質問がある場合は、次のいずれかを行ってください:
貢献
貢献を歓迎します!貢献ガイドラインはGitHubリポジトリをご覧ください。