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

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

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

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

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

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

サイトの設定で適応型コンテンツを有効にする

訪問者スキーマを設定する

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

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

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

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "訪問者がベータユーザーであるかどうか。"
    }
  },
  "additionalProperties": false
}

また、の中でクレームを設定する際にオートコンプリートを使用するのにも役立ちます 条件エディタ。訪問者スキーマは次の型のみをサポートしています。

文字列

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

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

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

{
  "type": "object",
  "properties": {
    "language": {
          "type": "string",
          "description": "訪問者の言語",
          // 任意の enum プロパティ
          "enum": [
            "en",
            "fr",
            "it"
          ]
  },
  "additionalProperties": false
}

enum キーなしで定義された動的文字列は、に対してのみ受け付けられます インライン式。要素（ページ、セクション、ブロック）の表示に関する条件式は、enum キー付きで定義された文字列でのみ機能します。

ブール値

オブジェクト

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

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

署名なしクレームを扱う予定がある場合は、署名済みクレームと並べて、“unsigned” プロパティの下に、スキーマ内で想定するクレームを宣言する必要があります。

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "訪問者がベータユーザーであるかどうか。"
    },
    // 署名なしクレームを追加
    "unsigned": {
      "type": "object",
      "description": "サイト訪問者の署名なしクレーム。",
      "properties": {
        "language": {
          "type": "string",
          "description": "訪問者の言語",
          // 任意の enum プロパティ
          "enum": [
            "en",
            "fr",
            "it"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

訪問者データを GitBook に渡す

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

Cookie

公開 Cookie または署名付き Cookie を通じて、訪問者データをドキュメントに渡します。

URL

URL クエリパラメータを通じて、訪問者データをドキュメントに渡します。

フィーチャーフラグ

フィーチャーフラグプロバイダーを通じて、訪問者データをドキュメントに渡します。

認証付きアクセス

認証プロバイダーを通じて、訪問者データをドキュメントに渡します。