コミュニティライブラリ
TypeScript から Nodaro のコミュニティライブラリを閲覧し、共有されたキャラクター、ロケーション、オブジェクトを自分のアカウントに複製し、お気に入りに登録し、掲載を通報します。
Nodaro Cloud · Business エディション で利用できます
client.community は、コミュニティライブラリを読み取ります。これは、Nodaro チームがキュレーションする、キャラクター、ロケーション、オブジェクトの共有コレクションです。閲覧と検索、1 件の掲載の読み取り、掲載を自分のアカウントへ複製すること、お気に入りへの登録、モデレーション用の通報ができます。これらのメソッドは、コミュニティ REST API を呼び出します。この機能と、肖像・同意に関するルールについては、コミュニティライブラリを参照してください。
コミュニティライブラリは、複数ユーザー向けのインストール環境、つまり Nodaro Cloud と Business エディションにあります。1 人用の Community エディションのインストール環境では、どの呼び出しも NotFoundError を返します。公開作品を許可していないデプロイ環境では、掲載は提供されません。browse() と favorites() は空のリストを返し、get()、getFull()、clone() は NotFoundError をスローします。
メソッド
| メソッド | 内容 |
|---|---|
browse(params?) | 掲載を閲覧、検索します |
get(slug) | 1 件の掲載を読み取ります |
getFull(slug) | 1 件の掲載を、完全な公開スナップショットとともに読み取ります |
favorites() | お気に入りに登録した掲載を一覧表示します |
clone(id, entityType) | 掲載を自分のアカウントに複製します |
favorite(id) | お気に入りを追加または解除します |
report(id, reason) | モデレーション用に掲載を通報します |
公開機能は SDK に含まれていません。SDK で使う個人用 API トークンと OAuth トークンでは、公開できません。
client.community
掲載は CommunityCard です。そのフィールドは、API が送るとおりの snake_case です。CommunityEntityType は、"character"、"location"、"object" のいずれかです。
browse(params?)
公開されている掲載のページと、nextCursor を返します(GET /v1/community/browse)。次のページを取得するには、nextCursor を cursor に渡してください。最後のページでは null になります。
browse(params?: BrowseCommunityParams): Promise<{ data: CommunityCard[]; nextCursor: string | null }>プロパティ
型
const { data: listings, nextCursor } = await client.community.browse({
entityType: "character",
sort: "popular",
limit: 20,
})get(slug)
スラッグを指定して、1 件の掲載を読み取ります(GET /v1/community/detail/:slug)。
get(slug: string): Promise<{ data: CommunityCard }>プロパティ
型
const { data: listing } = await client.community.get("detective-mara")掲載が存在しない場合や、すでに有効でない場合は、NotFoundError をスローします。
getFull(slug)
1 件の掲載を、完全な公開スナップショット(詳細ページに表示されるとおりの画像、ボイス、テキスト)とともに読み取ります(GET /v1/community/detail/:slug/full)。
getFull(slug: string): Promise<{ data: CommunityFullDetail }>プロパティ
型
const { data: detail } = await client.community.getFull("detective-mara")favorites()
お気に入りに登録した掲載を一覧表示します(GET /v1/community/favorites)。
favorites(): Promise<{ data: CommunityCard[] }>const { data: favorites } = await client.community.favorites()clone(id, entityType)
掲載を、独立したコピーとしてあなたのライブラリに複製します(POST /v1/community/listings/:id/clone)。ファイルはあなた自身のストレージにコピーされるため、元の掲載が変更されたり削除されたりしても、コピーは残ります。新しいアセットの種類と ID を返します。
clone(id: string, entityType: "character" | "location" | "object"): Promise<{ entityType: string; id: string }>プロパティ
型
const { id: characterId } = await client.community.clone(listingId, "character")
const character = await client.characters.get(characterId)OAuth トークンには assets:write スコープが必要です。ストレージが満杯の場合は、StorageExceededError をスローします。
favorite(id)
掲載をお気に入りに追加します。すでに追加されている場合は削除します(POST /v1/community/listings/:id/favorite)。新しい状態を返します。
favorite(id: string): Promise<{ favorited: boolean }>プロパティ
型
const { favorited } = await client.community.favorite(listingId)report(id, reason)
モデレーション用に掲載を通報します(POST /v1/community/listings/:id/report)。
report(id: string, reason: CommunityReportReason): Promise<{ ok: true }>プロパティ
型
await client.community.report(listingId, "real_person_no_consent")client.keepers
client.keepers は、プラットフォームの管理者が選んだキャラクター、クリーチャー、ロケーション、オブジェクトを集めた共有の棚、Nodaro Keepers を読み取り、アイテムを自分のアカウントにコピーします。メソッドは Keepers のルートを呼び出します。棚の読み取りには認証情報が不要なので、ゲストも閲覧できます。読み取りとコピーに、クレジットはかかりません。
catalog(params?)
棚の 1 ページ { data: KeeperCatalogItem[], next } を返します。
catalog(params?: { kind?: KeeperKind; cursor?: string; limit?: number }): Promise<KeeperCatalogPage>プロパティ
型
各アイテムは { id, kind, name, description, imageUrl, previewUrl, category, sort, createdAt } です。previewUrl は、タイル用の、幅 480 ピクセルのメイン画像のコピーです。category は棚の見出しで、sort は棚の並び順です。棚には表示用のフィールドだけが含まれます。1 分間キャッシュされ、1 つのアドレスから読み取れるのは 1 分あたり 60 回までです。
const { data, next } = await client.keepers.catalog({ kind: "character" })copy(kind, id)
棚のアイテムを自分のアカウントにコピーし、{ id, name, kind, created } を返します。id は自分自身の行です。client.characters.get(id) や、ほかのアセットのメソッドで読み取れます。
copy(kind: KeeperKind, id: string): Promise<CopyKeeperResult>- コピーには、公開されているテキスト、メイン画像、バリエーションのアセットが含まれます。すべてのファイルは自分のストレージにコピーされ、その容量を使います。
- プリメイドまたはライブラリのボイスは、そのまま引き継がれます。カスタムまたはクローンのボイスは、名前とサンプルだけになります。所有者のピッカーの選択、リファレンス写真、学習済みモデルのフィールドは、引き継がれません。
- コピーは、デフォルトのプロジェクトに入ります。元のアイテムが変更されても、コピーは変わりません。
- コピーは、1 人につき 1 アイテム 1 件です。後の呼び出しは、同じコピーを
created: falseで返します。アーカイブしたコピーは、アーカイブが解除されて戻ります。すでに持っているコピーは、アイテムが棚に残っているかどうかに関係なく、自分のものです。 - アイテムが棚になく、そのコピーも持っていない場合は
NotFoundErrorを、ファイルがストレージに収まらない場合は413 storage_limit_exceededを、組織が個人スペースを閉じている場合はpersonal_space_disabledのForbiddenErrorをスローします。 - OAuth アプリのトークンには、
assets:writeスコープが必要です。
const { id } = await client.keepers.copy("character", item.id)
const mine = await client.characters.get(id)よくある質問
コミュニティのキャラクターを自分のアカウントにコピーするにはどうすればよいですか?
掲載の ID と、character のようなエンティティタイプを指定して、client.community.clone を呼び出します。コピーはあなたのものになり、元の掲載が変わっても変化しません。あなたのストレージ容量に加算されます。
SDK でコミュニティライブラリに公開できますか?
できません。公開機能は SDK に含まれていません。SDK でできるのは、掲載の閲覧、読み取り、複製、お気に入り登録、通報です。
自分のインストール環境で client.community が 404 を返すのはなぜですか?
コミュニティライブラリは、Nodaro Cloud と Business エディションのインストール環境にあります。1 人用の Community エディションのインストール環境には、コミュニティ用のルートがなく、404 を返します。
実在の人物を同意なく描写している掲載を通報するには、どうすればよいですか?
掲載の ID と、理由 real_person_no_consent を指定して、client.community.report を呼び出します。掲載はモデレーションに送られます。
SDK から Nodaro Keepers のキャラクターを使うには、どうすればよいですか?
client.keepers.catalog で棚を読み取り、アイテムの種類と ID を指定して client.keepers.copy を呼び出します。コピーは自分自身のキャラクターになり、クレジットはかかりません。
関連ページ
コミュニティライブラリ
キャラクター
ロケーション
コミュニティライブラリ
最終更新