
言語 🇯🇵 日本語
はじめに
ドキュメント
集計
監査ログ
コメントによるブロック
ブロック済みコメントの確認
コメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
コメント報告
ハッシュタグ
モデレーター
通知数
通知
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果の集計
SSOユーザー
サブスクリプション
テナント日次使用量
テナントパッケージ
テナントユーザー
テナント
画像アップロード
ユーザーバッジ進捗
ユーザーバッジ
ユーザー通知
ユーザーのプレゼンス状態
ユーザー検索
ユーザー
投票
FastComments Python SDK
これは FastComments の公式 Python SDK です。
FastComments API の公式 Python SDK
リポジトリ
インストール 
PyPI
pip install fastcomments
ライブラリの内容
このライブラリには2つのモジュールが含まれています: 生成された API クライアントと、手作業で書かれたユーティリティを含むコア Python ライブラリで、SSO サポートを含め API の操作を簡単にします。
公開 API と保護された API
API クライアントには、DefaultApi と PublicApi の 2 つのクラスがあります。DefaultApi は API キーが必要なメソッドを含み、PublicApi はブラウザやモバイル端末などから認証なしで直接呼び出せる API コールを含みます。
クイックスタート 
認証された API の使用 (DefaultApi)
重要: 認証されたリクエストを行う前に必ず Configuration に API キーを設定してください。設定しないと、リクエストは 401 エラーで失敗します。
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Create and configure the API client
config = Configuration()
config.host = "https://fastcomments.com/api"
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Create the API instance with the configured client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Now you can make authenticated API calls
try:
# Example: Add an SSO user
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
パブリック API の使用 (PublicApi)
パブリックエンドポイントは認証を必要としません:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
SSO(シングルサインオン)の使用
SDK には安全な SSO トークンを生成するユーティリティが含まれています:
from sso import FastCommentsSSO, SecureSSOUserData
# Create user data
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Create SSO instance with your API secret
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Generate the SSO token
sso_token = sso.create_token()
# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")
簡易 SSO(セキュリティが低く、テスト用):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
よくある問題
- 401 "missing-api-key" エラー:
DefaultApiインスタンスを作成する前にconfig.api_key = {"ApiKeyAuth": "YOUR_KEY"}を設定していることを確認してください。 - API クラスの間違い: サーバー側の認証済みリクエストには
DefaultApiを、クライアント側/パブリックリクエストにはPublicApiを使用してください。 - インポートエラー: 正しいモジュールからインポートしていることを確認してください:
- API クライアント:
from client import ... - SSO ユーティリティ:
from sso import ...
- API クライアント:
注意事項 
ブロードキャストID
一部のAPI呼び出しでは broadcast_id を渡す必要があることが分かるでしょう。イベントを受信すると、このIDが返されるので、クライアント側で楽観的に変更を適用する予定がある場合にそのイベントを無視すべきかを判断できます(ユーザー体験が最も良いため、おそらくそうするでしょう)。ここにはUUIDを渡してください。そのIDは、同じブラウザセッション内で重複しない程度に十分一意である必要があります。
要件 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
aggregate 
ドキュメントをグループ化(groupBy が指定されている場合)し、複数の操作を適用して集計します。 さまざまな操作(例: sum、countDistinct、avg など)をサポートしています。
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
レスポンス
戻り値: AggregationResponse
例

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

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

un_block_comment_public 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: UnBlockCommentPublic200Response
例

checked_comments_for_blocked 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | コメントIDのカンマ区切りの一覧。 |
| sso | string | query | No |
レスポンス
戻り値: CheckedCommentsForBlocked200Response
例

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

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

delete_comment 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
例

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

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

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

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

get_comment_text 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: GetCommentText200Response
例

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

get_comments 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | integer | query | いいえ | |
| limit | integer | query | いいえ | |
| skip | integer | query | いいえ | |
| asTree | boolean | query | いいえ | |
| skipChildren | integer | query | いいえ | |
| limitChildren | integer | query | いいえ | |
| maxTreeDepth | integer | query | いいえ | |
| urlId | string | query | いいえ | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ | |
| contextUserId | string | query | いいえ | |
| hashTag | string | query | いいえ | |
| parentId | string | query | いいえ | |
| direction | string | query | いいえ |
レスポンス
Returns: GetComments200Response
例

get_comments_public 
req tenantId urlId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| page | integer | query | いいえ | |
| direction | string | query | いいえ | |
| sso | string | query | いいえ | |
| skip | integer | query | いいえ | |
| skipChildren | integer | query | いいえ | |
| limit | integer | query | いいえ | |
| limitChildren | integer | query | いいえ | |
| countChildren | boolean | query | いいえ | |
| fetchPageForCommentId | string | query | いいえ | |
| includeConfig | boolean | query | いいえ | |
| countAll | boolean | query | いいえ | |
| includei10n | boolean | query | いいえ | |
| locale | string | query | いいえ | |
| modules | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeNotificationCount | boolean | query | いいえ | |
| asTree | boolean | query | いいえ | |
| maxTreeDepth | integer | query | いいえ | |
| useFullTranslationIds | boolean | query | いいえ | |
| parentId | string | query | いいえ | |
| searchText | string | query | いいえ | |
| hashTags | array | query | いいえ | |
| userId | string | query | いいえ | |
| customConfigStr | string | query | いいえ | |
| afterCommentId | string | query | いいえ | |
| beforeCommentId | string | query | いいえ |
レスポンス
戻り値: GetCommentsPublic200Response
例

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

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

save_comment 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

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

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

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

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

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

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

update_comment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

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

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

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

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

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

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

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

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

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

delete_email_template_render_error 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
レスポンス
戻り値: FlagCommentPublic200Response
例

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

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

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

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

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

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

get_event_log 
req tenantId urlId userIdWS
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
レスポンス
例

get_global_event_log 
req tenantId urlId userIdWS
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
レスポンス
例

create_feed_post 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| broadcastId | string | query | いいえ | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| skipDupCheck | boolean | query | いいえ |
レスポンス
戻り値: CreateFeedPost200Response
例

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

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

get_feed_posts 
req tenantId afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ |
レスポンス
例

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

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

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

react_feed_post_public 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| isUndo | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ReactFeedPostPublic200Response
例

update_feed_post 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却値: FlagCommentPublic200Response
例

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

flag_comment_public 
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| isFlagged | boolean | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: FlagCommentPublic200Response
例

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

add_hash_tags_bulk 
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | No |
レスポンス
返却値: AddHashTagsBulk200Response
例

delete_hash_tag 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
レスポンス
戻り値: FlagCommentPublic200Response
例

get_hash_tags 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| page | number | query | いいえ |
Response
例

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

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

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

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

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

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

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

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

get_cached_notification_count 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetCachedNotificationCount200Response
例

get_notification_count 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ |
レスポンス
戻り値: GetNotificationCount200Response
例

get_notifications 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetNotifications200Response
例

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

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

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

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

get_pages 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
戻り値: GetPagesAPIResponse
例

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

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

get_pending_webhook_event_count 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| externalId | string | query | いいえ | |
| eventType | string | query | いいえ | |
| type | string | query | いいえ | |
| domain | string | query | いいえ | |
| attemptCountGT | number | query | いいえ |
レスポンス
戻り値: GetPendingWebhookEventCount200Response
例

get_pending_webhook_events 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
レスポンス
戻り値: GetPendingWebhookEvents200Response
例

create_question_config 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateQuestionConfig200Response
例

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

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

get_question_configs 
パラメータ
| 名前 | Type | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionConfigs200Response
例

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

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

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

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

get_question_results 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | いいえ | |
| userId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| questionId | string | query | いいえ | |
| questionIds | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionResults200Response
例

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

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

bulk_aggregate_question_results 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResults200Response
例

combine_comments_with_question_results 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | いいえ |
レスポンス
戻り値: CombineCommentsWithQuestionResults200Response
例

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

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

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

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

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

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

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

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

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

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

get_tenant_daily_usages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| yearNumber | number | クエリ | いいえ | |
| monthNumber | number | クエリ | いいえ | |
| dayNumber | number | クエリ | いいえ | |
| skip | number | クエリ | いいえ |
レスポンス
戻り値: GetTenantDailyUsages200Response
例

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

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

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

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

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

update_tenant_package 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却値: FlagCommentPublic200Response
例

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

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

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

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

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

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

update_tenant_user 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
返却値: FlagCommentPublic200Response
例

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

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

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

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

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

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

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

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

get_user_badge_progress_list 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| userId | string | クエリ | いいえ | |
| limit | number | クエリ | いいえ | |
| skip | number | クエリ | いいえ |
レスポンス
戻り値: GetUserBadgeProgressList200Response
例

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

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

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

get_user_badges 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| badgeId | string | query | いいえ | |
| type | number | query | いいえ | |
| displayedOnComments | boolean | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
例

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

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

get_user_notifications 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| pageSize | integer | query | いいえ | |
| afterId | string | query | いいえ | |
| includeContext | boolean | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| includeTranslations | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: GetUserNotifications200Response
例

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

reset_user_notifications 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ResetUserNotifications200Response
例

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

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

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

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

search_users 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| usernameStartsWith | string | query | はい | |
| mentionGroupIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

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

create_vote 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | はい | |
| direction | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

delete_vote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい | |
| editKey | string | クエリ | いいえ |
レスポンス
戻り値: DeleteCommentVote200Response
例

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

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

お困りですか?
Python SDK に関して問題が発生したり質問がある場合は、次をご利用ください:
貢献
貢献は歓迎します!貢献ガイドラインについてはGitHubリポジトリをご覧ください。