プレビュー GraphQL API

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

読み取り専用プレビュー GraphQL APIでは、コンテンツ管理インスタンスから提供される未公開(ドラフト)および公開済みSitecoreコンテンツの両方を取得できます。このAPIは通常、ローカル開発やアプリの非本番環境(テストやステージング)で使用されます。未公開コンテンツの閲覧は、コンテンツを最終決定しExperience Edgeに公開する前に、コンテンツ開発ライフサイクルの重要な部分です。

本番環境で公開されたコンテンツのみを取得する場合は、代わりにDelivery GraphQL APIをご利用ください。

認可およびAPIアクセス

認証およびAPIアクセスオプション は、アクセス先によってAPIによって異なります。

要請本体

リクエスト本体はGraphQLクエリです。クエリ の例も参照してください。

応答形式

レスポンスはJSONオブジェクトです。クエリ の例も参照してください。

スキーマと参照ドキュメント

GraphQL IDE内のGraphQLスキーマとAPI参照ドキュメントにアクセスできます。

制限と制限

プレビュー GraphQL API制限や制限を確認してください。

スキーマ拡張

プレビュー GraphQL APIスキーマはデリバリー GraphQL APIのスキーマを反映しています。プレビュー GraphQL APIスキーマはExperience Edgeとの互換性を保つ必要があるため拡張できません。

トークン化検索索引

Delivery GraphQL APIとは異なり、プレビュー GraphQL APIエンドポイントはトークン化された検索インデックスを使用します。その結果、検索の挙動はフィールドのインデックス付け方法に依存します:

  • CONTAINS演算子はトークン化されたフィールド値に基づいて複数の結果を返すことができます。
  • EQ(等)演算子は、完全に一致が期待されていてもトークン化されたテキストフィールドに対して複数の結果を返すこともあります。

プレビューエンドポイントのEQと正確に一致させるために、SearchQueryFieldMapping機能を使ってトークン化されたフィールドを非トークン化された計算フィールドにマッピングします。関連するサポート記事も参照KB1003665

探索演算子の挙動に関する情報は「 Search演算子の挙動」を参照してください。

メディアアイテムの認証を無効にすること

デフォルトでは、プレビューエンドポイントでメディア項目を表示するには認証が必要です。ただし、sitecore.configファイルのMedia.UrlSignatureExpirationTimeout設定を以下の形式で使用することで、指定された期間その要件を無効にすることができます。

値が0に設定されている場合、認証は常に強制されます。

設定を更新した後は、パッチファイルを使って 設定変更を適用することを忘れないでください。

この記事を改善するための提案がある場合は、 お知らせください!