FastCommentsのRuby SDK

これは FastComments の公式 Ruby SDK です。

FastComments API の公式 Ruby SDK

リポジトリ

インストール

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

このライブラリには、生成された API クライアントと、API の使用を簡単にする SSO ユーティリティが含まれています。

API Client Library Docs

Public vs Secured APIs

API クライアントには、DefaultApi、PublicApi、ModerationApi の 3 つのクラスがあります。DefaultApi には API キーが必要なメソッドが含まれ、PublicApi には認証なしでブラウザやモバイルデバイス等から直接呼び出せる API 呼び出しが含まれます。ModerationApi にはモデレーターダッシュボードを支えるメソッドが含まれています。

ModerationApi は、豊富なライブおよび高速モデレーション API のスイートを提供します。すべての ModerationApi メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッション cookie を使用して認証できます。

クイックスタート

認証された API の使用 (DefaultApi)

重要: 認証されたリクエストを行う前に、ApiClient に API キーを設定する必要があります。設定しない場合、リクエストは 401 エラーで失敗します。

require 'fastcomments'

# APIクライアントを作成し、設定する
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# 必須: APIキーを設定します（FastComments ダッシュボードから取得）
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# 設定されたクライアントで API インスタンスを作成する
api = FastCommentsClient::DefaultApi.new(api_client)

# これで認証された API 呼び出しができます
begin
  # 例: SSO ユーザーを追加
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

  response = api.add_sso_user('YOUR_TENANT_ID', user_data)
  puts "User created: #{response}"

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # 一般的なエラー:
  # - 401: API キーが欠落しているか無効です
  # - 400: リクエストの検証に失敗しました
end

パブリック API の使用 (PublicApi)

パブリックエンドポイントは認証を必要としません：

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

begin
  response = public_api.get_comments_public(
    'YOUR_TENANT_ID',
    'page-url-id'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

モデレーション API の使用 (ModerationApi)

モデレーションメソッドはモデレーターダッシュボードを動かします。sso トークンを渡すことで、SSO 認証されたモデレーターの代理でリクエストが行われます：

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # 例: モデレーションキュー内のコメントを一覧取得
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

共通の問題

401 "missing-api-key" エラー: DefaultApi インスタンスを作成する前に config.api_key['x-api-key'] = 'YOUR_KEY' を設定していることを確認してください。
誤った API クラス: サーバー側の認証リクエストには DefaultApi、クライアント側/パブリックリクエストには PublicApi、モデレーターダッシュボードのリクエストには ModerationApi を使用してください。
NULL の API キー: SDK は API キーが null の場合、認証を黙ってスキップし、結果として 401 エラーが発生します。

注意事項

ブロードキャストID

いくつかのAPI呼び出しでは broadcastId を渡す必要があることがわかります。イベントを受信するとこのIDが返されるので、クライアントで楽観的に変更を適用する予定がある場合は、そのイベントを無視すべきか判断できます（これは最良の体験を提供するため、おそらくそうすることをお勧めします）。ここにはUUIDを渡してください。IDはブラウザセッション内で二度発生しない程度に十分ユニークである必要があります。

SSO (Single Sign-On)

SSO の例は以下を参照してください。

SSOの使用方法

シンプル SSO

require 'fastcomments'

# シンプル SSO トークンを作成
user = FastComments::SSO::SimpleSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  avatar: 'https://example.com/avatar.jpg'
)

sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token

puts "SSO Token: #{token}"

# 認証された API 呼び出しを行うために SSO トークンを使用
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

セキュア SSO

require 'fastcomments'

# セキュア SSO トークンを作成
user = FastComments::SSO::SecureSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  username: 'johndoe',
  avatar: 'https://example.com/avatar.jpg'
)

api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token

puts "Secure SSO Token: #{token}"

# 認証された API 呼び出しを行うために SSO トークンを使用
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

集計

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

ドキュメントをグループ化（groupBy が提供されている場合）し、複数の操作を適用して集計します。sum、countDistinct、avg などのさまざまな操作がサポートされています。

Parameters

名前	型	場所	必須
tenantId	string	query	はい
parentTenantId	string	query	いいえ
includeStats	boolean	query	いいえ

Response

Returns: AggregateResponse

戻り値: AggregateResponse

Example

aggregate の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

監査ログを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

レスポンス

戻り値: GetAuditLogsResponse

例

get_audit_logs の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

ログアウト（公開）

レスポンス

戻り値: APIEmptyResponse

例

logout_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
begin
  
  result = api_instance.logout_public
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->logout_public: #{e}"
end

コメントからのブロック（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: BlockSuccess

例

block_from_comment_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->block_from_comment_public: #{e}"
end

コメントのブロック解除（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

返却値: UnblockSuccess

例

un_block_comment_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_block_comment_public: #{e}"
end

ブロックされたコメントの確認

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
commentIds	string	query	はい	コメントIDのカンマ区切りリスト。
sso	string	query	いいえ

レスポンス

返却値: CheckBlockedCommentsResponse

例

checked_comments_for_blocked の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | コメントIDのカンマ区切りリスト。
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
end

コメントからユーザーをブロック

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

戻り値: BlockSuccess

例

block_user_from_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

コメントを作成（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	パス	はい
urlId	string	クエリ	はい
broadcastId	string	クエリ	はい
sessionId	string	クエリ	いいえ
sso	string	クエリ	いいえ

レスポンス

戻り値: SaveCommentsResponseWithPresence

例

create_comment_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_comment_public: #{e}"
end

コメントを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
contextUserId	string	query	いいえ
isLive	boolean	query	いいえ

レスポンス

戻り値: DeleteCommentResult

例

delete_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには以下の行のコメントを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

コメントを削除（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

レスポンス

返却値: PublicAPIDeleteCommentResponse

例

delete_comment_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_public: #{e}"
end

コメントの投票を削除

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
voteId	string	path	はい
urlId	string	query	はい
broadcastId	string	query	はい
editKey	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: VoteDeleteResponse

例

delete_comment_vote の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_vote: #{e}"
end

コメントを通報

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

返却: FlagCommentResponse

例

flag_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

コメントを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却: APIGetCommentResponse

例

get_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すとAPIキーのプレフィックスを設定できます。例: 'Bearer' (デフォルトはnil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

コメント本文を取得

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
editKey	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: PublicAPIGetCommentTextResponse

例

get_comment_text の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_text: #{e}"
end

コメント投票のユーザー名を取得

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
dir	integer	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetCommentVoteUserNamesSuccessResponse

例

get_comment_vote_user_names の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
dir = 56 # 整数 | 
opts = {
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
end

コメント一覧を取得

パラメータ

名前	型	場所	必須
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	いいえ
fromDate	integer	query	いいえ
toDate	integer	query	いいえ

レスポンス

戻り値: APIGetCommentsResponse

例

get_comments の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには以下の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  page: 56, # 整数 | 
  limit: 56, # 整数 | 
  skip: 56, # 整数 | 
  as_tree: true, # ブール値 | 
  skip_children: 56, # 整数 | 
  limit_children: 56, # 整数 | 
  max_tree_depth: 56, # 整数 | 
  url_id: 'url_id_example', # 文字列 | 
  user_id: 'user_id_example', # 文字列 | 
  anon_user_id: 'anon_user_id_example', # 文字列 | 
  context_user_id: 'context_user_id_example', # 文字列 | 
  hash_tag: 'hash_tag_example', # 文字列 | 
  parent_id: 'parent_id_example', # 文字列 | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # 整数 | 
  to_date: 789 # 整数 | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

コメント一覧を取得（公開）

req tenantId urlId

パラメータ

名前	型	場所	必須
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	いいえ

レスポンス

返却: GetCommentsResponseWithPresencePublicComment

例

get_comments_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  page: 56, # Integer | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  sso: 'sso_example', # String | 
  skip: 56, # Integer | 
  skip_children: 56, # Integer | 
  limit: 56, # Integer | 
  limit_children: 56, # Integer | 
  count_children: true, # Boolean | 
  fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String | 
  include_config: true, # Boolean | 
  count_all: true, # Boolean | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  modules: 'modules_example', # String | 
  is_crawler: true, # Boolean | 
  include_notification_count: true, # Boolean | 
  as_tree: true, # Boolean | 
  max_tree_depth: 56, # Integer | 
  use_full_translation_ids: true, # Boolean | 
  parent_id: 'parent_id_example', # String | 
  search_text: 'search_text_example', # String | 
  hash_tags: ['inner_example'], # Array<String> | 
  user_id: 'user_id_example', # String | 
  custom_config_str: 'custom_config_str_example', # String | 
  after_comment_id: 'after_comment_id_example', # String | 
  before_comment_id: 'before_comment_id_example' # String | 
}
begin
  
  result = api_instance.get_comments_public(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_public: #{e}"
end

コメントをロック

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

lock_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | （文字列）
comment_id = 'comment_id_example' # String | （文字列）
broadcast_id = 'broadcast_id_example' # String | （文字列）
opts = {
  sso: 'sso_example' # String | （文字列）
}
begin
  
  result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->lock_comment: #{e}"
end

コメントをピン留め

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ChangeCommentPinStatusResponse

例

pin_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

コメントを保存

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
isLive	boolean	query	いいえ
doSpamCheck	boolean	query	いいえ
sendEmails	boolean	query	いいえ
populateNotifications	boolean	query	いいえ

レスポンス

戻り値: APISaveCommentResponse

例

save_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

コメントを一括保存

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
isLive	boolean	query	いいえ
doSpamCheck	boolean	query	いいえ
sendEmails	boolean	query	いいえ
populateNotifications	boolean	query	いいえ

レスポンス

戻り値: SaveCommentsBulkResponse

例

save_comments_bulk の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外します（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

コメント本文を設定

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
editKey	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: PublicAPISetCommentTextResponse

例

set_comment_text の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
broadcast_id = 'broadcast_id_example' # 文字列 | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->set_comment_text: #{e}"
end

コメントからのユーザーブロック解除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

戻り値: UnblockSuccess

例

un_block_user_from_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

コメントの通報を取り消し

パラメータ

名前	型	Location	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

戻り値: FlagCommentResponse

例

un_flag_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、以下の行のコメントを解除してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

コメントのロック解除

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

un_lock_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

コメントのピン解除

パラメータ

名前	型	位置	必須
tenantId	string	path	はい
commentId	string	path	はい
broadcastId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ChangeCommentPinStatusResponse

例

un_pin_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_pin_comment: #{e}"
end

コメントを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
contextUserId	string	query	いいえ
doSpamCheck	boolean	query	いいえ
isLive	boolean	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

update_comment の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

コメントに投票

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
commentId	string	path	はい
urlId	string	query	はい
broadcastId	string	query	はい
sessionId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: VoteResponse

例

vote_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

ユーザーのコメントを取得

パラメータ

名前	型	場所	必須
userId	string	query	いいえ
direction	string	query	いいえ
repliesToUserId	string	query	いいえ
page	number	query	いいえ
includei10n	boolean	query	いいえ
locale	string	query	いいえ
isCrawler	boolean	query	いいえ

レスポンス

戻り値: GetCommentsForUserResponse

例

get_comments_for_user の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
opts = {
  user_id: 'user_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  replies_to_user_id: 'replies_to_user_id_example', # String | 
  page: 1.2, # Float | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  is_crawler: true # Boolean | 
}
begin
  
  result = api_instance.get_comments_for_user(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_for_user: #{e}"
end

ドメイン設定を追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: AddDomainConfigResponse

例

add_domain_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer' (デフォルト: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

ドメイン設定を削除

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
domain	string	path	はい

レスポンス

戻り値: DeleteDomainConfigResponse

例

delete_domain_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

ドメイン設定を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
domain	string	path	はい

レスポンス

戻り値: GetDomainConfigResponse

例

get_domain_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックス（例: 'Bearer'）を設定するには、以下の行のコメントを外してください（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

ドメイン設定一覧を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: GetDomainConfigsResponse

例

get_domain_configs の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

ドメイン設定を部分更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
domainToUpdate	string	path	はい

レスポンス

戻り値: PatchDomainConfigResponse

例

patch_domain_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を構成: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すと、APIキーのプレフィックスを設定できます。例: 'Bearer'（デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

ドメイン設定を置換

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

レスポンス

戻り値: PutDomainConfigResponse

例

put_domain_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを解除すると、APIキーのプレフィックスを設定できます。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

メールテンプレートを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateEmailTemplateResponse

例

create_email_template の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

メールテンプレートを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_email_template の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

メールテンプレートのレンダーエラーを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
errorId	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_email_template_render_error の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外して、APIキーのプレフィックスを設定します（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

メールテンプレートを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetEmailTemplateResponse

例

get_email_template の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

メールテンプレート定義を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: GetEmailTemplateDefinitionsResponse

例

get_email_template_definitions の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

メールテンプレートのレンダーエラーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
skip	number	query	いいえ

レスポンス

戻り値: GetEmailTemplateRenderErrorsResponse

例

get_email_template_render_errors の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

メールテンプレート一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetEmailTemplatesResponse

例

get_email_templates の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキー認証の設定: api_key
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

メールテンプレートをレンダリング

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
locale	string	query	いいえ

レスポンス

戻り値: RenderEmailTemplateResponse

例

render_email_template の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 次の行のコメントを外すとAPIキーのプレフィックスを設定できます。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

メールテンプレートを更新

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_email_template の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

イベントログを取得

req tenantId urlId userIdWS

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

戻り値: GetEventLogResponse

例

get_event_log の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

グローバルイベントログを取得

req tenantId urlId userIdWS

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
userIdWS	string	query	はい
startTime	integer	query	はい
endTime	integer	query	いいえ

レスポンス

戻り値: GetEventLogResponse

例

get_global_event_log の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

フィード投稿を作成

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

レスポンス

戻り値: CreateFeedPostsResponse

例

create_feed_post の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すと APIキーにプレフィックスを設定できます。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

フィード投稿を作成（公開）

パラメータ

名前	型	場所	必須
tenantId	string	パス	はい
broadcastId	string	クエリ	いいえ
sso	string	クエリ	いいえ

レスポンス

戻り値: CreateFeedPostResponse

例

create_feed_post_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_feed_post_public: #{e}"
end

フィード投稿を削除（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
postId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: DeleteFeedPostPublicResponse

例

delete_feed_post_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
end

フィード投稿一覧を取得

req tenantId afterId

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
afterId	string	query	いいえ
limit	integer	query	いいえ
tags	array	query	いいえ

レスポンス

返却値: GetFeedPostsResponse

例

get_feed_posts の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 次の行のコメントを外して、APIキーにプレフィックスを設定します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

フィード投稿一覧を取得（公開）

req tenantId afterId

パラメータ

名前	型	場所	必須
tenantId	文字列	パス	はい
afterId	文字列	クエリ	いいえ
limit	整数	クエリ	いいえ
tags	配列	クエリ	いいえ
sso	文字列	クエリ	いいえ
isCrawler	真偽値	クエリ	いいえ
includeUserInfo	真偽値	クエリ	いいえ

レスポンス

戻り値: PublicFeedPostsResponse

例

get_feed_posts_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  after_id: 'after_id_example', # 文字列 | 
  limit: 56, # 整数 | 
  tags: ['inner_example'], # 配列<文字列> | 
  sso: 'sso_example', # 文字列 | 
  is_crawler: true, # 真偽値 | 
  include_user_info: true # 真偽値 | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

フィード投稿の統計を取得

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
postIds	array	query	はい
sso	string	query	いいえ

レスポンス

戻り値: FeedPostsStatsResponse

例

get_feed_posts_stats の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_ids = ['inner_example'] # Array<String> | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
end

ユーザーのリアクションを取得（公開）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
postIds	array	query	いいえ
sso	string	query	いいえ

レスポンス

返却: UserReactsResponse

例

get_user_reacts_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  post_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_reacts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
end

フィード投稿にリアクション（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
postId	string	path	はい
isUndo	boolean	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ReactFeedPostResponse

例

react_feed_post_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

フィード投稿を更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_feed_post の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

フィード投稿を更新（公開）

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
postId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: CreateFeedPostResponse

例

update_feed_post_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

コメントを通報（公開）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
isFlagged	boolean	query	はい
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

flag_comment_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
is_flagged = true # Boolean | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->flag_comment_public: #{e}"
end

大きいGIFを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
largeInternalURLSanitized	string	query	Yes

レスポンス

戻り値: GifGetLargeResponse

例

get_gif_large の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # 文字列 | 
begin
  
  result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gif_large: #{e}"
end

GIF検索を取得

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
search	string	query	はい
locale	string	query	いいえ
rating	string	query	いいえ
page	number	query	いいえ

レスポンス

戻り値: GetGifsSearchResponse

例

get_gifs_search の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
search = 'search_example' # 文字列 | 
opts = {
  locale: 'locale_example', # 文字列 | 
  rating: 'rating_example', # 文字列 | 
  page: 1.2 # 浮動小数点数 | 
}
begin
  
  result = api_instance.get_gifs_search(tenant_id, search, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_search: #{e}"
end

パラメータ

Name	Type	Location	Required
tenantId	string	path	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

レスポンス

返り値: GetGifsTrendingResponse

例

get_gifs_trending の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  locale: 'locale_example', # 文字列 | 
  rating: 'rating_example', # 文字列 | 
  page: 1.2 # 浮動小数点 | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

ハッシュタグを追加

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返却: CreateHashTagResponse

例

add_hash_tag の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、以下の行のコメントを解除してください（例: 'Bearer' (defaults to nil)）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

ハッシュタグを一括追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: BulkCreateHashTagsResponse

例

add_hash_tags_bulk 例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

ハッシュタグを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes
tag	string	path	Yes

レスポンス

返却: APIEmptyResponse

例

delete_hash_tag の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを解除してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

ハッシュタグ一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
page	number	query	いいえ

レスポンス

返却値: GetHashTagsResponse

例

get_hash_tags の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを解除してください。例: 'Bearer'（既定は nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

ハッシュタグを部分更新

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	Yes
tag	string	path	Yes

レスポンス

返却: UpdateHashTagResponse

例

patch_hash_tag の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

モデレーション投票を削除

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
voteId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: VoteDeleteResponse

例

delete_moderation_vote の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->delete_moderation_vote: #{e}"
end

API経由のコメントを取得

Parameters

Name	Type	Location	Required
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

Response

Returns: ModerationAPIGetCommentsResponse

Example

get_api_comments の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2, # Float | 
  count: 1.2, # Float | 
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_comments: #{e}"
end

APIエクスポートのステータスを取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
batchJobId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ModerationExportStatusResponse

例

get_api_export_status 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  batch_job_id: 'batch_job_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.get_api_export_status(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_export_status: #{e}"
end

APIのIDを取得

パラメータ

名前	型	場所	必須
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

レスポンス

戻り値: ModerationAPIGetCommentIdsResponse

例

get_api_ids 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  after_id: 'after_id_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

コメントから禁止されたユーザーを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

返却: GetBannedUsersFromCommentResponse

例

get_ban_users_from_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
end

コメントの禁止状態を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

戻り値: GetCommentBanStatusResponse

例

get_comment_ban_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
end

コメントの子コメントを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

レスポンス

返却: ModerationAPIChildCommentsResponse

例

get_comment_children の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_children(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_children: #{e}"
end

カウントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
text-search	string	query	いいえ
byIPFromComment	string	query	いいえ
filter	string	query	いいえ
searchFilters	string	query	いいえ
demo	boolean	query	いいえ
sso	string	query	いいえ

応答

返却: ModerationAPICountCommentsResponse

例

get_count の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filter: 'filter_example', # String | 
  search_filters: 'search_filters_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_count: #{e}"
end

複数のカウントを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

返却: GetBannedUsersCountResponse

例

get_counts 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_counts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_counts: #{e}"
end

ログを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
commentId	string	path	はい
sso	string	query	いいえ

応答

Returns: ModerationAPIGetLogsResponse

例

get_logs の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_logs(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_logs: #{e}"
end

手動バッジを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: GetTenantManualBadgesResponse

例

get_manual_badges の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.get_manual_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges: #{e}"
end

ユーザーの手動バッジを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

応答

戻り値: GetUserManualBadgesResponse

例

get_manual_badges_for_user の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  badges_user_id: 'badges_user_id_example', # 文字列 | 
  comment_id: 'comment_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.get_manual_badges_for_user(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges_for_user: #{e}"
end

モデレーション用コメントを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
includeEmail	boolean	query	いいえ
includeIP	boolean	query	いいえ
smo	string	query	いいえ

応答

戻り値: ModerationAPICommentResponse

例

get_moderation_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_email: true, # Boolean | 
  include_ip: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
end

モデレーション用コメント本文を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

レスポンス

戻り値: GetCommentTextResponse

例

get_moderation_comment_text の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
end

事前禁止サマリーを取得

パラメータ

名前	タイプ	場所	必須
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

例

get_pre_ban_summary の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
end

検索コメントのサマリーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
value	string	query	いいえ
filters	string	query	いいえ
searchFilters	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ModerationCommentSearchResponse

例

get_search_comments_summary 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_comments_summary(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
end

検索ページを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

応答

返却: ModerationPageSearchResponse

例

get_search_pages 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_pages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_pages: #{e}"
end

検索サイトを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

レスポンス

戻り値: ModerationSiteSearchResponse

例

get_search_sites 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_sites(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_sites: #{e}"
end

検索サジェストを取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

レスポンス

Returns: ModerationSuggestResponse

例

get_search_suggest の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_suggest(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_suggest: #{e}"
end

検索ユーザーを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

レスポンス

返却: ModerationUserSearchResponse

例

get_search_users の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  value: 'value_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.get_search_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_users: #{e}"
end

信頼係数を取得

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: GetUserTrustFactorResponse

例

get_trust_factor 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_trust_factor: #{e}"
end

ユーザーの禁止設定を取得

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

応答

返却: APIModerateGetUserBanPreferencesResponse

例

get_user_ban_preference の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_ban_preference(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
end

ユーザーの内部プロファイルを取得

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	query	No
sso	string	query	No

レスポンス

戻り値: GetUserInternalProfileResponse

例

get_user_internal_profile の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_internal_profile(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
end

コメント投票を調整（POST）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: AdjustVotesResponse

例

post_adjust_comment_votes の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
end

APIエクスポートを開始

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

レスポンス

返却: ModerationExportResponse

例

post_api_export の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  text_search: 'text_search_example', # 文字列 | 
  by_ip_from_comment: 'by_ip_from_comment_example', # 文字列 | 
  filters: 'filters_example', # 文字列 | 
  search_filters: 'search_filters_example', # 文字列 | 
  sorts: 'sorts_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_api_export: #{e}"
end

コメントからユーザーを禁止（POST）

パラメータ

名前	種類	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
banEmail	boolean	query	いいえ
banEmailDomain	boolean	query	いいえ
banIP	boolean	query	いいえ
deleteAllUsersComments	boolean	query	いいえ
bannedUntil	string	query	いいえ
isShadowBan	boolean	query	いいえ
updateId	string	query	いいえ
banReason	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: BanUserFromCommentResult

例

post_ban_user_from_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
opts = {
  ban_email: true, # 真偽値 | 
  ban_email_domain: true, # 真偽値 | 
  ban_ip: true, # 真偽値 | 
  delete_all_users_comments: true, # 真偽値 | 
  banned_until: 'banned_until_example', # 文字列 | 
  is_shadow_ban: true, # 真偽値 | 
  update_id: 'update_id_example', # 文字列 | 
  ban_reason: 'ban_reason_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
end

ユーザー禁止を取り消す（POST）

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
sso	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

post_ban_user_undo の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
end

一括事前禁止サマリーを送信

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

レスポンス

戻り値: BulkPreBanSummary

例

post_bulk_pre_ban_summary の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
end

IDでコメントを取得（POST）

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ModerationAPIChildCommentsResponse

例

post_comments_by_ids 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_comments_by_ids: #{e}"
end

コメントを通報（POST）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

post_flag_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_flag_comment: #{e}"
end

コメントを削除（POST）

Parameters

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

Response

返却: PostRemoveCommentApiResponse

例

post_remove_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
opts = {
  broadcast_id: 'broadcast_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_remove_comment: #{e}"
end

削除済みコメントを復元（POST）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: APIEmptyResponse

例

post_restore_deleted_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_restore_deleted_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
end

コメントの承認状態を設定（POST）

パラメータ

名前	タイプ	ロケーション	必須
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

応答

返り値: SetCommentApprovedResponse

例

post_set_comment_approval_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
opts = {
  approved: true, # 真偽値 | 
  broadcast_id: 'broadcast_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
end

コメントのレビュー状態を設定（POST）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
reviewed	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

Returns: APIEmptyResponse

例

post_set_comment_review_status 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
opts = {
  reviewed: true, # 真偽値 | 
  broadcast_id: 'broadcast_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
end

コメントのスパム状態を設定（POST）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

戻り値: APIEmptyResponse

例

post_set_comment_spam_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
comment_id = 'comment_id_example' # 文字列 | 
opts = {
  spam: true, # 真偽値 | 
  perm_not_spam: true, # 真偽値 | 
  broadcast_id: 'broadcast_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
end

コメント本文を設定（POST）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: SetCommentTextResponse

例

post_set_comment_text の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "ModerationApi->post_set_comment_text を呼び出す際のエラー: #{e}"
end

コメントの通報を解除（POST）

パラメータ

名前	型	場所	必須
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

レスポンス

返り値: APIEmptyResponse

例

post_un_flag_comment の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
end

投票を送信（POST）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	path	はい
direction	string	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

返却: VoteResponse

例

post_vote 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  direction: 'direction_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_vote(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_vote: #{e}"
end

バッジを付与（PUT）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
badgeId	string	query	はい
userId	string	query	いいえ
commentId	string	query	いいえ
broadcastId	string	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: AwardUserBadgeResponse

例

put_award_badge 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_award_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_award_badge: #{e}"
end

スレッドを閉鎖（PUT）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

レスポンス

Returns: APIEmptyResponse

例

put_close_thread 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_close_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_close_thread: #{e}"
end

バッジを削除（PUT）

パラメータ

名前	タイプ	場所	必須
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

レスポンス

返却: RemoveUserBadgeResponse

例

put_remove_badge の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
badge_id = 'badge_id_example' # 文字列 | 
opts = {
  user_id: 'user_id_example', # 文字列 | 
  comment_id: 'comment_id_example', # 文字列 | 
  broadcast_id: 'broadcast_id_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_remove_badge: #{e}"
end

スレッドを再開（PUT）

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
urlId	string	query	はい
sso	string	query	いいえ

応答

返却: APIEmptyResponse

例

put_reopen_thread の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
end

信頼係数を設定

パラメータ

名前	型	場所	必須
tenantId	string	クエリ	はい
userId	string	クエリ	いいえ
trustFactor	string	クエリ	いいえ
sso	string	クエリ	いいえ

レスポンス

返却: SetUserTrustFactorResponse

例

set_trust_factor の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  user_id: 'user_id_example', # 文字列 | 
  trust_factor: 'trust_factor_example', # 文字列 | 
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.set_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->set_trust_factor: #{e}"
end

モデレーターを作成

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: CreateModeratorResponse

例

create_moderator の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーの接頭辞を設定するには、次の行のコメントアウトを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

モデレーターを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
sendEmail	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

delete_moderator の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

モデレーターを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetModeratorResponse

例

get_moderator の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer'（デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

モデレーター一覧を取得

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

返却: GetModeratorsResponse

例

get_moderators の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

招待を送信

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
fromName	string	query	はい

レスポンス

返却: APIEmptyResponse

例

send_invite の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントアウトを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

モデレーターを更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_moderator の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

通知数を削除

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIEmptyResponse

例

delete_notification_count の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキー用のプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

キャッシュされた通知数を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

返却: GetCachedNotificationCountResponse

例

get_cached_notification_count の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

通知数を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
userId	string	query	いいえ
urlId	string	query	いいえ
fromCommentId	string	query	いいえ
viewed	boolean	query	いいえ
type	string	query	いいえ

レスポンス

返却: GetNotificationCountResponse

例

get_notification_count の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すとAPIキーのプレフィックスを設定できます。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

通知一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
userId	string	query	いいえ
urlId	string	query	いいえ
fromCommentId	string	query	いいえ
viewed	boolean	query	いいえ
type	string	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetNotificationsResponse

例

get_notifications の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

通知を更新

パラメータ

名前	型	Location	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

返却値: APIEmptyResponse

例

update_notification の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーの接頭辞を設定するには以下の行のコメントを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

ページリアクションを作成（v1）

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
urlId	string	query	はい
title	string	query	いいえ

レスポンス

戻り値: CreateV1PageReact

例

create_v1_page_react の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
url_id = 'url_id_example' # 文字列 | 
opts = {
  title: 'title_example' # 文字列 | 
}
begin
  
  result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v1_page_react: #{e}"
end

ページリアクションを作成（v2）

パラメータ

名前	型	Location	必須
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい
title	string	query	いいえ

レスポンス

戻り値: CreateV1PageReact

例

create_v2_page_react の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
url_id = 'url_id_example' # 文字列 | 
id = 'id_example' # 文字列 | 
opts = {
  title: 'title_example' # 文字列 | 
}
begin
  
  result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v2_page_react: #{e}"
end

ページリアクションを削除（v1）

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	はい
urlId	string	query	はい

レスポンス

戻り値: CreateV1PageReact

例

delete_v1_page_react の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.delete_v1_page_react(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
end

ページリアクションを削除（v2）

パラメータ

Name	Type	Location	Required
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい

レスポンス

戻り値: CreateV1PageReact

例

delete_v2_page_react の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
url_id = 'url_id_example' # 文字列 | 
id = 'id_example' # 文字列 | 
begin
  
  result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
end

ページのいいね（v1）を取得

パラメータ

名前	型	Location	必須	説明
tenantId	string	path	はい
urlId	string	query	はい

レスポンス

戻り値: GetV1PageLikes

例

get_v1_page_likes の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v1_page_likes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
end

ページリアクションユーザーを取得（v2）

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
id	string	query	はい

レスポンス

戻り値: GetV2PageReactUsersResponse

例

get_v2_page_react_users の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
end

ページリアクションを取得（v2）

パラメータ

名前	型	場所	必須	説明
tenantId	string	パス	はい
urlId	string	クエリ	はい

レスポンス

返却値: GetV2PageReacts

例

get_v2_page_reacts の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v2_page_reacts(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
end

ページを追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: AddPageAPIResponse

例

add_page の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

ページを削除

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: DeletePageAPIResponse

例

delete_page の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

オフラインユーザーを取得

ページ上で過去にコメントしたが現在オンラインではないユーザー。displayName でソートされています。「Members」セクションを表示するために /users/online を使い切った後にこれを使用してください。 commenterName によるカーソルページネーション: サーバーは部分的な {tenantId, urlId, commenterName} インデックスを afterName から $gt を使って前方へ走査します。$skip コストはありません。

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	はい
urlId	string	query	はい	ページのURL識別子（サーバー側でクリーンアップされます）。
afterName	string	query	いいえ	カーソル: 前回のレスポンスの nextAfterName を渡します。
afterUserId	string	query	いいえ	カーソルのタイブレーカー: 前回のレスポンスの nextAfterUserId を渡します。afterName が設定されている場合、名前が同一のエントリが失われないようこれが必要です。

レスポンス

返却: PageUsersOfflineResponse

例

get_offline_users の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | ページ URL の識別子（サーバー側でクリーンアップされます）。
opts = {
  after_name: 'after_name_example', # String | カーソル: 前回のレスポンスの nextAfterName を渡します。
  after_user_id: 'after_user_id_example' # String | カーソルのタイブレーカー: 前回のレスポンスの nextAfterUserId を渡します。afterName が設定されている場合、名前が同一のエントリが失われないようこれが必要です。
}
begin
  
  result = api_instance.get_offline_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_offline_users: #{e}"
end

オンラインユーザーを取得

現在ページにオンラインの閲覧者: 現在そのページに WebSocket セッションでサブスクライブしている人々。 anonCount + totalCount を返します（匿名閲覧者を列挙しない場合でも含めた、ルーム全体の購読者数）。

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	Yes
urlId	string	query	Yes	ページの URL 識別子（サーバー側で正規化されます）。
afterName	string	query	No	カーソル: 前のレスポンスの nextAfterName を渡します。
afterUserId	string	query	No	カーソルのタイブレーカー: 前のレスポンスの nextAfterUserId を渡します。afterName が設定されている場合、名前の重複でエントリが落ちないように必須です。

レスポンス

返却: PageUsersOnlineResponse

例

get_online_users の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | ページの URL 識別子（サーバー側で正規化されます）。
opts = {
  after_name: 'after_name_example', # String | カーソル: 前のレスポンスの nextAfterName を渡します。
  after_user_id: 'after_user_id_example' # String | カーソルのタイブレーカー: 前のレスポンスの nextAfterUserId を渡します。afterName が設定されている場合、名前の重複でエントリが落ちないように必須です。
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

URL IDでページを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
urlId	string	query	はい

レスポンス

戻り値: GetPageByURLIdAPIResponse

例

get_page_by_urlid の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントアウトを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

ページ一覧を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes

レスポンス

戻り値: GetPagesAPIResponse

例

get_pages の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を構成: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントアウトを外すと、APIキーにプレフィックスを設定できます。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

ページ一覧を取得（公開）

テナントのページを一覧表示します。FChat デスクトップクライアントがルームリストを生成するために使用します。各ページの解決されたカスタム設定で enableFChat が true である必要があります。 SSO を必要とするページは、リクエスト元ユーザーのグループアクセスに基づいてフィルタリングされます。

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	はい
cursor	string	query	いいえ	前のリクエストから返された不透明なページネーションカーソル（`nextCursor`）。同じ `sortBy` に紐づきます。
limit	integer	query	いいえ	1..200、デフォルト 50
q	string	query	いいえ	オプションの大文字小文字を区別しないタイトルのプレフィックスフィルター。
sortBy	string	query	いいえ	ソート順。`updatedAt`（デフォルト、最新が先）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
hasComments	boolean	query	いいえ	true の場合、コメントが1件以上あるページのみを返します。

レスポンス

戻り値: GetPublicPagesResponse

例

get_pages_public の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | 前のリクエストから返された不透明なページネーションカーソル（`nextCursor`）。同じ `sortBy` に紐づきます。
  limit: 56, # Integer | 1..200、デフォルト 50
  q: 'q_example', # String | オプションの大文字小文字を区別しないタイトルのプレフィックスフィルター。
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | ソート順。`updatedAt`（デフォルト、最新が先）、`commentCount`（コメント数が多い順）、または `title`（アルファベット順）。
  has_comments: true # Boolean | true の場合、コメントが1件以上あるページのみを返します。
}
begin
  
  result = api_instance.get_pages_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_pages_public: #{e}"
end

ユーザー情報を取得

テナントの一括ユーザー情報。userIdsが与えられると、User / SSOUserから表示情報を返します。コメントウィジェットによって、プレゼンスイベントでちょうど出現したユーザーの情報を補完するために使用されます。ページコンテキストなし：プライバシーは一律に適用されます（非公開プロフィールはマスクされます）。

パラメータ

名前	型	場所	必須	説明
tenantId	string	path	はい
ids	string	query	はい	カンマ区切りの userIds.

レスポンス

戻り値: PageUsersInfoResponse

例

get_users_info 例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | カンマ区切りの userIds.
begin
  
  result = api_instance.get_users_info(tenant_id, ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_users_info: #{e}"
end

ページを部分更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: PatchPageAPIResponse

例

patch_page の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

保留中Webhookイベントを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_pending_webhook_event の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーの接頭辞を設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

保留中Webhookイベントの件数を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	いいえ
externalId	string	query	いいえ
eventType	string	query	いいえ
type	string	query	いいえ
domain	string	query	いいえ
attemptCountGT	number	query	いいえ

レスポンス

戻り値: GetPendingWebhookEventCountResponse

例

get_pending_webhook_event_count の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # API キー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには以下の行のコメントアウトを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

保留中Webhookイベント一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	いいえ
externalId	string	query	いいえ
eventType	string	query	いいえ
type	string	query	いいえ
domain	string	query	いいえ
attemptCountGT	number	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetPendingWebhookEventsResponse

例

get_pending_webhook_events 例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

質問設定を作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateQuestionConfigResponse

例

create_question_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

質問設定を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_question_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

質問設定を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetQuestionConfigResponse

例

get_question_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すと API キーに接頭辞を設定できます。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

質問設定一覧を取得

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetQuestionConfigsResponse

例

get_question_configs の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # API キー認証を設定する: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントアウトを解除してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

質問設定を更新

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_question_config の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

質問結果を作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateQuestionResultResponse

例

create_question_result の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを解除すると API キーのプレフィックス（例: 'Bearer'、デフォルトは nil）を設定できます
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

質問結果を削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_question_result の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントアウトを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

質問結果を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却値: GetQuestionResultResponse

例

get_question_result の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # API キー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

質問結果一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	クエリ	はい
urlId	string	クエリ	いいえ
userId	string	クエリ	いいえ
startDate	string	クエリ	いいえ
questionId	string	クエリ	いいえ
questionIds	string	クエリ	いいえ
skip	number	クエリ	いいえ

レスポンス

戻り値: GetQuestionResultsResponse

例

get_question_results の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントアウトを解除してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

質問結果を更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_question_result の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントアウトを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

質問結果を集計

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
questionId	string	query	いいえ
questionIds	array	query	いいえ
urlId	string	query	いいえ
timeBucket	string	query	いいえ
startDate	string	query	いいえ
forceRecalculate	boolean	query	いいえ

レスポンス

戻り値: AggregateQuestionResultsResponse

例

aggregate_question_results の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックス（例: 'Bearer'）を設定するには、以下の行のコメントを外してください（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

質問結果を一括集計

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
forceRecalculate	boolean	query	いいえ

レスポンス

戻り値: BulkAggregateQuestionResultsResponse

例

bulk_aggregate_question_results の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

コメントと質問結果を結合

パラメータ

名前	型	場所	必須
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

例

combine_comments_with_question_results の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックス（例: 'Bearer'）を設定するには、次の行のコメントを外してください（既定値はnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

SSOユーザーを追加

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: AddSSOUserAPIResponse

例

add_sso_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントアウトを解除してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

SSOユーザーを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	boolean	query	いいえ
commentDeleteMode	string	query	いいえ

レスポンス

戻り値: DeleteSSOUserAPIResponse

例

delete_sso_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # API キー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # API キーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

メールでSSOユーザーを取得

パラメータ

名前	型	位置	必須	説明
tenantId	string	query	Yes
email	string	path	Yes

レスポンス

戻り値: GetSSOUserByEmailAPIResponse

例

get_sso_user_by_email の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

IDでSSOユーザーを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却値: GetSSOUserByIdAPIResponse

例

get_sso_user_by_id の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すとAPIキーのプレフィックスを設定できます。例: 'Bearer'（デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

SSOユーザー一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	integer	query	いいえ

レスポンス

戻り値: GetSSOUsersResponse

例

get_sso_users の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントアウトを外してください。例: 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

SSOユーザーを部分更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	boolean	query	いいえ

レスポンス

戻り値: PatchSSOUserAPIResponse

例

patch_sso_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントアウトを解除してAPIキーのプレフィックスを設定します（例: 'Bearer'、デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

SSOユーザーを置換

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
updateComments	boolean	query	いいえ

レスポンス

戻り値: PutSSOUserAPIResponse

例

put_sso_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # API キー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # API キーにプレフィックスを設定するには次の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

サブスクリプションを作成

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい

レスポンス

戻り値: CreateSubscriptionAPIResponse

例

create_subscription の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントアウトを解除して、APIキーのプレフィックスを設定します。例: 'Bearer'（既定は nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

サブスクリプションを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: DeleteSubscriptionAPIResponse

例

delete_subscription の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

サブスクリプション一覧を取得

パラメータ

名前	型	ロケーション	必須	説明
tenantId	string	query	Yes
userId	string	query	No

レスポンス

返却値: GetSubscriptionsAPIResponse

例

get_subscriptions の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

サブスクリプションを更新

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: UpdateSubscriptionAPIResponse

例

update_subscription の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには、以下の行のコメントを外してください。例：'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

テナントの日次使用量を取得

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
yearNumber	number	query	いいえ
monthNumber	number	query	いいえ
dayNumber	number	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetTenantDailyUsagesResponse

例

get_tenant_daily_usages の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

テナントパッケージを作成

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateTenantPackageResponse

例

create_tenant_package の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

テナントパッケージを削除

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

delete_tenant_package の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを解除してAPIキーのプレフィックスを設定します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

テナントパッケージを取得

パラメータ

名前	型	ロケーション	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetTenantPackageResponse

例

get_tenant_package の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

テナントパッケージ一覧を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetTenantPackagesResponse

例

get_tenant_packages の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

テナントパッケージを置換

パラメータ

名前	タイプ	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

replace_tenant_package の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を構成: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

テナントパッケージを更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_tenant_package の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには以下の行のコメントアウトを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

テナントユーザーを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: CreateTenantUserResponse

例

create_tenant_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントアウトを解除してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

テナントユーザーを削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
deleteComments	string	query	いいえ
commentDeleteMode	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

delete_tenant_user 例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

テナントユーザーを取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetTenantUserResponse

例

get_tenant_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには、次の行のコメントアウトを解除してください。例: 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

テナントユーザー一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
skip	number	query	いいえ

レスポンス

戻り値: GetTenantUsersResponse

例

get_tenant_users の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # API キー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外して API キーのプレフィックスを設定してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

テナントユーザーを置換

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

replace_tenant_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントアウトを解除してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
redirectURL	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

使用例

send_login_link の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーに接頭辞を設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

テナントユーザーを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
updateComments	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

update_tenant_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

テナントを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	Yes

レスポンス

返却: CreateTenantResponse

例

create_tenant の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外します。例: 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

テナントを削除

パラメーター

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
sure	string	query	いいえ

レスポンス

戻り値: APIEmptyResponse

例

delete_tenant の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を構成: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

テナントを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: GetTenantResponse

例

get_tenant の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

テナント一覧を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
meta	string	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: GetTenantsResponse

例

get_tenants の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

テナントを更新

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptyResponse

例

update_tenant の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定する場合は、以下の行のコメントを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

チケットの状態を変更

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
userId	string	query	はい
id	string	path	はい

レスポンス

戻り値: ChangeTicketStateResponse

例

change_ticket_state の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（既定は nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

チケットを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
userId	string	query	はい

レスポンス

戻り値: CreateTicketResponse

例

create_ticket の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントアウトを解除してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

チケットを取得

パラメータ

名前	型	ロケーション	必須
tenantId	string	query	はい
id	string	path	はい
userId	string	query	いいえ

レスポンス

戻り値: GetTicketResponse

例

get_ticket の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください（例: 'Bearer'、デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

チケット一覧を取得

パラメータ

名前	型	場所	必須
tenantId	string	クエリ	はい
userId	string	クエリ	いいえ
state	number	クエリ	いいえ
skip	number	クエリ	いいえ
limit	number	クエリ	いいえ

レスポンス

戻り値: GetTicketsResponse

例

get_tickets の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックス（例: 'Bearer'）を設定するには、以下の行のコメントを外してください（デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  state: 1.2, # Float | 
  skip: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tickets(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tickets: #{e}"
end

翻訳を取得

パラメータ

名前	型	場所	必須
namespace	string	path	はい
component	string	path	はい
locale	string	query	いいえ
useFullTranslationIds	boolean	query	いいえ

レスポンス

戻り値: GetTranslationsResponse

例

get_translations の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # String | 
component = 'component_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  use_full_translation_ids: true # Boolean | 
}
begin
  
  result = api_instance.get_translations(namespace, component, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_translations: #{e}"
end

画像をアップロード

画像のアップロードとリサイズ

パラメータ

Name	Type	Location	Required	Description
tenantId	string	path	Yes
sizePreset	string	query	No	サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成します)
urlId	string	query	No	アップロードが行われているページのID、設定用

レスポンス

戻り値: UploadImageResponse

例

upload_image の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | サイズプリセット: \"Default\" (1000x1000px) または \"CrossPlatform\" (一般的なデバイス向けのサイズを作成します)
  url_id: 'url_id_example' # String | アップロードが行われているページのID、設定用
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

IDでユーザーバッジ進捗を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

例

get_user_badge_progress_by_id の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを解除してください。例: 'Bearer' (デフォルトは nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

ユーザーIDでユーザーバッジ進捗を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
userId	string	path	はい

レスポンス

戻り値: APIGetUserBadgeProgressResponse

例

get_user_badge_progress_by_user_id の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには、以下の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

ユーザーバッジ進捗一覧を取得

パラメータ

名前	型	Location	必須
tenantId	string	query	はい
userId	string	query	いいえ
limit	number	query	いいえ
skip	number	query	いいえ

レスポンス

返却値: APIGetUserBadgeProgressListResponse

例

get_user_badge_progress_list の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すと、APIキーにプレフィックスを設定できます。例: 'Bearer'（デフォルトはnil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

ユーザーバッジを作成

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい

レスポンス

戻り値: APICreateUserBadgeResponse

例

create_user_badge の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

ユーザーバッジを削除

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptySuccessResponse

例

delete_user_badge の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーのプレフィックスを設定するには次の行のコメントを解除してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

ユーザーバッジを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

レスポンス

戻り値: APIGetUserBadgeResponse

例

get_user_badge の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントアウトを解除すると、APIキーにプレフィックスを設定できます（例: 'Bearer'）。デフォルトは nil
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
id = 'id_example' # 文字列 | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

ユーザーバッジ一覧を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
userId	string	query	いいえ
badgeId	string	query	いいえ
type	number	query	いいえ
displayedOnComments	boolean	query	いいえ
limit	number	query	いいえ
skip	number	query	いいえ

レスポンス

戻り値: APIGetUserBadgesResponse

例

get_user_badges の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

ユーザーバッジを更新

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

戻り値: APIEmptySuccessResponse

例

update_user_badge の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証の設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには、次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

ユーザーの通知数を取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	クエリ	はい
sso	string	クエリ	いいえ

レスポンス

戻り値: GetUserNotificationCountResponse

例

get_user_notification_count の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

ユーザーの通知一覧を取得

パラメータ

名前	型	Location	必須	説明
tenantId	string	query	はい
urlId	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	いいえ
includeTenantNotifications	boolean	query	いいえ
sso	string	query	いいえ

レスポンス

返却: GetMyNotificationsResponse

例

get_user_notifications の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 現在のページが購読されているかどうかを判断するために使用されます。
  page_size: 56, # Integer | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Boolean | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  include_translations: true, # Boolean | 
  include_tenant_notifications: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notifications: #{e}"
end

ユーザーの通知数をリセット

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: ResetUserNotificationsResponse

例

reset_user_notification_count の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # 文字列 | 
opts = {
  sso: 'sso_example' # 文字列 | 
}
begin
  
  result = api_instance.reset_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
end

ユーザーの通知をリセット

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
afterId	string	query	いいえ
afterCreatedAt	integer	query	いいえ
unreadOnly	boolean	query	いいえ
dmOnly	boolean	query	いいえ
noDm	boolean	query	いいえ
sso	string	query	いいえ

レスポンス

戻り値: ResetUserNotificationsResponse

例

reset_user_notifications の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notifications: #{e}"
end

ユーザーのコメント購読ステータスを更新

特定のコメントに対する通知を有効化または無効化します。

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
notificationId	string	path	はい
optedInOrOut	string	path	はい
commentId	string	query	はい
sso	string	query	いいえ

レスポンス

戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse

例

update_user_notification_comment_subscription_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
opted_in_or_out = 'in' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
end

ユーザーのページ購読ステータスを更新

ページの通知を有効または無効にします。ユーザーがページを購読している場合、新しいルートコメントに対して通知が作成され、また

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
urlId	string	query	はい
url	string	query	はい
pageTitle	string	query	はい
subscribedOrUnsubscribed	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: UpdateUserNotificationPageSubscriptionStatusResponse

例

update_user_notification_page_subscription_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
url = 'url_example' # String | 
page_title = 'page_title_example' # String | 
subscribed_or_unsubscribed = 'subscribe' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
end

ユーザー通知のステータスを更新

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
notificationId	string	path	はい
newStatus	string	path	はい
sso	string	query	いいえ

レスポンス

戻り値: UpdateUserNotificationStatusResponse

例

update_user_notification_status の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

ユーザーのプレゼンス状態を取得

パラメータ

Name	Type	Location	Required
tenantId	string	query	はい
urlIdWS	string	query	はい
userIds	string	query	はい

レスポンス

戻り値: GetUserPresenceStatusesResponse

例

get_user_presence_statuses の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id_ws = 'url_id_ws_example' # String | 
user_ids = 'user_ids_example' # String | 
begin
  
  result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
end

ユーザーを検索

パラメータ

名前	型	場所	必須
tenantId	string	path	はい
urlId	string	query	はい
usernameStartsWith	string	query	いいえ
mentionGroupIds	array	query	いいえ
sso	string	query	いいえ
searchSection	string	query	いいえ

レスポンス

戻り値: SearchUsersResult

例

search_users の例

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  username_starts_with: 'username_starts_with_example', # String | 
  mention_group_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  search_section: 'fast' # String | 
}
begin
  
  result = api_instance.search_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->search_users: #{e}"
end

ユーザーを取得

パラメータ

Name	Type	Location	Required	Description
tenantId	string	query	はい
id	string	path	はい

レスポンス

返却値: GetUserResponse

例

get_user の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

投票を作成

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
commentId	string	query	はい
direction	string	query	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

戻り値: VoteResponse

例

create_vote の例

Copy

require 'time'
require 'fastcomments-client'
# 認証を設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

投票を削除

パラメータ

名前	型	場所	必須
tenantId	string	query	はい
id	string	path	はい
editKey	string	query	いいえ

レスポンス

戻り値: VoteDeleteResponse

例

delete_vote の例

Copy

require 'time'
require 'fastcomments-client'
# 認証のセットアップ
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには以下の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  edit_key: 'edit_key_example' # String | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

投票一覧を取得

パラメータ

名前	型	場所	必須	説明
tenantId	string	query	はい
urlId	string	query	はい

レスポンス

戻り値: GetVotesResponse

例

get_votes の例

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # APIキーにプレフィックスを設定するには次の行のコメントを外してください。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

ユーザーの投票を取得

パラメータ

名前	型	位置	必須
tenantId	string	query	はい
urlId	string	query	はい
userId	string	query	いいえ
anonUserId	string	query	いいえ

レスポンス

戻り値: GetVotesForUserResponse

例

get_votes_for_user Example

Copy

require 'time'
require 'fastcomments-client'
# 認証の設定
FastCommentsClient.configure do |config|
  # APIキー認証を設定: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # 以下の行のコメントを外すと、APIキーのプレフィックスを設定できます。例: 'Bearer'（デフォルトは nil）
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

ヘルプが必要ですか？

Ruby SDKに関して問題が発生したり質問がある場合は、次のいずれかを行ってください:

貢献

貢献は歓迎します！貢献ガイドラインについてはGitHubリポジトリをご覧ください。

言語 🇯🇵 日本語

はじめに

ドキュメント

使用方法

集計

監査ログ

認証

コメントからブロック

ブロックされたコメントの確認

コメント

ユーザーのコメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメント通報

GIF

ハッシュタグ

モデレーション

モデレーター

通知数

通知

ページリアクション

ページ

保留中のWebhookイベント

質問設定

質問結果

質問結果の集計

SSOユーザー

サブスクリプション

テナントの日次使用量

テナントパッケージ

テナントユーザー

テナント

チケット

翻訳

画像アップロード

ユーザーバッジ進捗

ユーザーバッジ

ユーザー通知

ユーザーのプレゼンス状態

ユーザー検索

ユーザー

投票

FastCommentsのRuby SDK

リポジトリ

インストール

Library Contents

Public vs Secured APIs

クイックスタート

認証された API の使用 (DefaultApi)

パブリック API の使用 (PublicApi)

モデレーション API の使用 (ModerationApi)

共通の問題

注意事項

ブロードキャストID

SSO (Single Sign-On)

SSOの使用方法

シンプル SSO

セキュア SSO

集計

Parameters

Response

Example

監査ログを取得

パラメータ

レスポンス

例

ログアウト（公開）

レスポンス

例

コメントからのブロック（公開）

パラメータ

レスポンス

例

コメントのブロック解除（公開）

パラメータ

レスポンス

例

ブロックされたコメントの確認