適応コンテンツの有効化

ユーザーデータをGitBookに渡すための認証方法を選択する

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

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

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

に移動します 設定、および有効にする 適応型コンテンツ サイトのオーディエンス設定から。 有効にすると、アダプティブコンテンツの設定を続行するために必要となる生成された「訪問者トークン署名キー」が取得できます。

サイトの設定でアダプティブコンテンツを有効にする

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

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

訪問者スキーマは、これらのクレームがGitBookに送信されるときにどのように構造化されているかを反映するべきです。

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

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

これにより、設定時にオートコンプリートを使用するのにも役立ちます 条件エディタ。訪問者スキーマは次の型のみをサポートします：

文字列

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

GitBookは動的文字列を受け入れます。つまり、ユーザー名や開発者トークンなどの文字列データを動的に渡すことができます。

文字列はまた オプションのenum キーを含めることができ、これによりGitBookが受け取るデータを定められた値のうちのいずれかに制限できます。

{
  "type": "object",
  "properties": {
    "language": {
          "type": "string",
          "description": "訪問者の言語",
          // Optional enum property
          "enum": [
            "en",
            "fr",
            "it"
          ]
  },
  "additionalProperties": false
}

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

ブール値

オブジェクト

署名されていないクレームを設定する

署名されていないクレームは、クライアントアプリケーションによって署名されていない可能性のある通過クレームを識別する特定のタイプのクレームです。URLパラメータ、署名されていないクッキー、機能フラグを介してクレームを渡す場合は、訪問者スキーマでクレームを 未署名の として設定することが必要です。

署名されていないクレームを扱う予定がある場合は、署名済みクレームと並んでスキーマ内の「unsigned」プロパティの下に期待するクレームを宣言する必要があります。

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "訪問者がベータユーザーかどうか。"
    },
    // Add unsigned claims
    "unsigned": {
      "type": "object",
      "description": "サイト訪問者の署名されていないクレーム。",
      "properties": {
        "language": {
          "type": "string",
          "description": "訪問者の言語",
          // Optional enum property
          "enum": [
            "en",
            "fr",
            "it"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

訪問者データをGitBookに渡す

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

クッキー

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

URL

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

フィーチャーフラグ

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

認証付きアクセス

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