Model Specification

id

string

Y

idはスペースの一意の識別子

"1"

channelId

string

Y

channelIdはスペースが属するチャネルの一意の識別子

"1"

createdAt

number

Y

createdAtはスペースが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtはスペースが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

publishState

'published' | 'unpublished'

Y

publishStateはスペースが公開されているかどうかを決定。「published」のスペースは公開されており、「unpublished」のスペースは公開されていません。

"published"

name

map<string, string>

Y

nameはスペースのローカライズされた名前のマップ

{ "en": "User Guide", "ja": "ご利用ガイド" }

avatarUrl

string

N

avatarUrlはスペースのプロフィール画像のURLであり、公開されたWebサイトでファビコンやロゴとして使用可能

"https://cf.channel.io/path/to/image.png"

defaultLanguage

string

Y

defaultLanguageはスペースのデフォルト言語

"ja"

supportedLanguages

string[]

Y

supportLanguagesはスペースの対応言語のリスト

["ja", "en"]

website

{ url: string }

N

websiteはスペースの公開済みWebサイトに関するメタデータ

{ "url": "https://docs.channel.io/help" }

id

string

Y

記事の一意の識別子。ただし、1つの記事には複数のリビジョン（バージョン）があり、各言語ごとに公開（ライブ）バージョンが存在する可能性があります。(id, language) の組み合わせが、ライブコンテンツを識別するためのキーとして機能します。

"1"

spaceId

string

Y

記事が属するスペースの一意の識別子

"1"

createdAt

number

Y

リクエストされた言語における記事のリビジョンが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

リクエストされた言語における記事のリビジョンが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

state

'draft' | 'published' | 'unpublished'

Y

リクエストされた言語における記事の現在のリビジョンの状態。

• draft：記事は編集可能であり、一般には公開されません。

• published：記事は一般に公開されており、編集できません。

• unpublished：記事は一般に公開されておらず、編集もできません。

"published"

publishedRevisionId

string

N

リクエストされた言語における記事の公開済み（ライブ）リビジョンの識別子。記事が公開されていない場合、このフィールドは空になります。

"1"

publishedAt

number

N

記事が公開された日時のエポックミリ秒単位のタイムスタンプ。このタイムスタンプは、記事が公開されている場合にのみ利用可能です。publishedAtは新しいリビジョンが公開された際に更新されることがありますが、ユーザーが手動で設定することも可能です。

1704067200000

currentRevisionId

string

Y

リクエストされた言語における記事の現在のリビジョンの識別子です。1つの記事は単一の言語内に複数のリビジョンを持つことができますが、そのうちの1つだけが「現在」のリビジョンと見なされます。

• 公開済みのリビジョンがある場合、現在のリビジョンは公開済みのリビジョンとなります。

• 未公開のリビジョンがある場合、現在のリビジョンは updatedAt タイムスタンプが最新のものです。

• 下書きリビジョンのみがある場合、現在のリビジョンは updatedAt タイムスタンプが最新のものです。

"1"

slug

string

Y

スペース内で一意の記事のキーであり、URLに使用可能

"192a233f"

topicIds

string[]

Y

記事に関連付けられているトピックのIDリスト

["1", "2", "3"]

website

{ url: string }

N

authorId

string

Y

記事の執筆者の識別子

"1"

name

string

Y

リクエストされた言語における記事の現在のリビジョンの名前

"日本語20240701_0000"

coverImageUrl

string

N

記事のブロック形式のコンテンツ

"https://cf.channel.io/path/to/image.png"

title

string

N

記事のタイトル

"ご利用ガイド"

subtitle

string

N

記事のサブタイトル

"チャネルトークを初めて操作する際に必要な設定をご案内します。"

summary

string

N

記事のプレーンテキストによる要約

`"チャネルトークを初めて操作する際に必要な設定をご案内します。"`

body

Blocks

N

記事のブロック形式のコンテンツ

[{ "type": "text", "content": [{ "type": "plain", "attrs": { "text": "チャネルトークを初めて操作する際に必要な設定をご案内します。" } }] }]

bodyHtml

string

N

この記事のHTML形式のコンテンツ

<p>チャネルトークを初めて操作する際に必要な設定をご案内します。</p>

id

string

Y

idは執筆者の一意の識別子

"1"

spaceId

string

Y

spaceIdは執筆者が属するスペースの一意の識別子

"1"

createdAt

number

Y

createdAtは執筆者が作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtは執筆者が最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

avatarUrl

string

N

avatarUrlは執筆者のプロフィール画像のURL

"https://cf.channel.io/path/to/image.png"

profile

map<string, { name: string, bio?: string }>

Y

profileは執筆者のローカライズされたプロフィールのマップ

{ "en": { "name": "Channel Talk", "bio": "Channel Talk is all-in-one live chat messenger for businesses." } }

id

string

Y

idはカテゴリーの一意の識別子

"1"

spaceId

string

Y

spaceIdはカテゴリーが属するスペースの一意の識別子

"1"

createdAt

number

Y

createdAtはカテゴリーが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtはカテゴリーが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

slug

string

Y

slugはスペース内で一意のカテゴリーのキーであり、URLに使用可能

"192a233f"

name

map<string, string>

Y

nameはカテゴリーのローカライズされた名前のマップ

{ "en": "FAQ", "ja": "よくある質問" }

description

map<string, string>

Y

descriptionはカテゴリーのローカライズされた説明のマップ

{ "en": "Category for frequently asked questions.", "ja": "よくある質問を集めたカテゴリーです。" }

coverImageUrl

map<string, string>

Y

coverImageUrlは各言語ごとのカバー画像URLのマップ

{ "en": "https://cf.channel.io/path/to/image-en.png", "ja": "https://cf.channel.io/path/to/image-ja.png" }

publishState

map<string, 'published' | 'unpublished'>

Y

publishStateは各言語においてカテゴリーが公開されているかどうかの設定。

「published」カテゴリーは公開されており、「unpublished」カテゴリーは公開されていません。

{ "en": "unpublished", "ja": "published" }

code

string

Y

言語コード

"ja"

name

string

Y

英語での言語名

"Japanese"

localizedName

string

Y

対象言語での言語名

"日本語"

id

string

Y

idはナビゲーションノードの一意の識別子

"1"

spaceId

string

Y

spaceIdはナビゲーションノードが属するスペースの一意の識別子

"1"

createdAt

number

Y

createdAtはナビゲーションノードが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtはナビゲーションノードが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

nodeType

'root' | 'article' | 'category'

Y

nodeTypeはナビゲーションノードのタイプで、以下のいずれかになります。

• root：ナビゲーションツリーのルートノード。1つのナビゲーションツリーに1つだけ存在します。

• category：ナビゲーションツリー内のカテゴリノード

• article：ナビゲーションツリー内の記事ノード

"category"

rootNodeId

string

Y

parentNodeId

string

N

parentNodeIdはノードの親ノードのID。ルートノードには親ノードはありません。

"1"

rank

number

Y

rankはナビゲーションツリー内における兄弟ノード間での順序

0

entityType

'article' | 'category'

N

entityTypeはノードに接続されているエンティティのタイプ。ルートノードには接続されているエンティティはありません。以下のいずれかになります。

• category：接続されているエンティティはカテゴリ

• article：接続されているエンティティは記事

"category"

entityId

string

N

entityIdはノードに接続されているエンティティのID。ルートノードには接続されているエンティティはありません。

"1"

id

string

Y

idはリビジョンの一意の識別子

"1"

spaceId

string

Y

spaceIdはリビジョンが属するスペースの一意の識別子

"1"

createdAt

number

Y

createdAtはリビジョンが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtはリビジョンが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

articleId

string

Y

articleIdはリビジョンが属する記事の識別子

"1"

language

string

Y

languageはリビジョンの言語

"ko"

state

'draft' | 'published' | 'unpublished'

Y

stateはリビジョンの現在の状態。

• draft：下書き。編集可能ですが、一般には公開されません。

• published：公開済み。一般に公開されており、編集はできません。

• unpublished：公開停止。一般には公開されておらず、編集もできません。

"published"

authorId

string

Y

authorIdはリビジョンの執筆者の識別子

"1"

name

string

Y

nameはリビジョンの名前

"日本語20240701_0000"

coverImageUrl

string

N

coverImageUrlはリビジョンのカバー画像のURL

"https://cf.channel.io/path/to/image.png"

title

string

N

titleはリビジョンのタイトル

"ご利用ガイド"

subtitle

string

N

subtitleはリビジョンのサブタイトル

"チャネルトークを初めて操作する際に必要な設定をご案内します。"

summary

string

N

summaryはリビジョンのコンテンツのプレーンテキストによる要約

"チャネルトークを初めて操作する際に必要な設定をご案内します。"

body

Blocks

N

bodyはリビジョンのブロック形式のコンテンツ

[{ "type": "text", "content": [{ "type": "plain", "attrs": { "text": "チャネルトークを初めて操作する際に必要な設定をご案内します。" } }] }]

bodyHtml

string

N

bodyHtmlはリビジョンのHTML形式のコンテンツ

<p>チャネルトークを初めて操作する際に必要な設定をご案内します。</p>

id

string

Y

idはトピックの一意の識別子

"1"

spaceId

string

Y

spaceIdはトピックが属するスペースの一意の識別子

"1"

createdAt

number

Y

createdAtはトピックが作成された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

updatedAt

number

Y

updatedAtはトピックが最後に更新された日時のエポックミリ秒単位のタイムスタンプ

1704067200000

name

map<string, string>

Y

nameはトピックのローカライズされた名前のマップ

{ "en": "Documents", "ja": "ドキュメント" }

description

map<string, string>

Y

idはトピックの一意の識別子

{ "en": "Your Knowledge Base in One Place", "ja": "ご利用ガイド・ブログ・開発者文書までをチャネルトーク一つで" }