For the complete documentation index, see llms.txt. This page is also available as Markdown.

適応型コンテンツを有効にする

ユーザーデータをGitBookに渡す認証方法を選択します。

読者向けにドキュメント体験をカスタマイズし始めるには、アダプティブコンテンツを有効にし、訪問者データを GitBook にどのように渡すかを決める必要があります。これにより、サイトのコンテンツは閲覧者に応じて動的に適応します。

アダプティブコンテンツを有効にする

ユーザーデータを GitBook に渡せるようにする前に、サイトでアダプティブコンテンツを使用するよう設定する必要があります。

次へ進んで サイトの設定、そして有効にする アダプティブコンテンツ サイトのオーディエンス設定から。有効にすると、生成された「Visitor token signing key」が取得でき、これがアダプティブコンテンツの設定を続けるために必要になります。

A GitBook screenshot showing the enable adaptive content toggle
サイトの設定でアダプティブコンテンツを有効にする

ビジタースキーマを設定する

アダプティブコンテンツを有効にしたら、ユーザーがサイトを訪れたときに GitBook が受け取ると想定するクレームの種類について、スキーマを定義する必要があります。

ビジタースキーマは、これらのクレームが GitBook に送られる際の構造を反映している必要があります。

たとえば、訪問者が製品のベータユーザーである可能性があると想定する場合、次のようなビジタースキーマを設定します。

これにより、クレームを設定する際にオートコンプリートも使いやすくなります 条件エディタ。ビジタースキーマでサポートされるのは以下の型のみです:

文字列として渡されるクレームを読み取ります。

GitBook は動的文字列を受け付けます。つまり、ユーザー名や開発者トークンなどの文字列データを動的に渡せます。

文字列には 任意の enum キーを含めることもでき、GitBook が受け取るデータを設定済みの値のいずれかに制限できます。

真偽値として渡されるクレームを読み取ります。

関連する値をまとめるために、クレームをオブジェクトに入れ子で含めます。

署名なしクレームを設定する

署名なしクレームは、クライアントアプリケーションによって署名されていない可能性のある、受け渡されるクレームを識別する特定の種類のクレームです。ビジタースキーマでは、クレームを次のように設定する必要があります 署名なし URL パラメーター、署名なし Cookie、機能フラグを通じてクレームを渡す場合。

署名なしクレームを扱う場合は、署名済みクレームと並べて、スキーマ内の「unsigned」プロップで期待するクレームを宣言する必要があります。

訪問者データを GitBook に渡す

GitBook では、サイトのコンテンツを適応させるために訪問者データを渡すさまざまな方法を用意しています。スキーマを定義したら、訪問者データを GitBook にどのように渡すかを決める必要があります。

最終更新

役に立ちましたか?