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

ユーザーデータを 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 を通じて、訪問者データをドキュメントに渡します。

URL

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

フィーチャーフラグ

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

認証済みアクセス

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