コンテンツフラグメントと共に使用する AEM GraphQL API

Adobe Experience Manager（AEM）as a Cloud Service のコンテンツフラグメントを AEM GraphQL API と共に使用してヘッドレスコンテンツ配信を実現する方法を説明します。

コンテンツフラグメントと共に使用する AEM as a Cloud Service GraphQL API は、オープンソースの標準 GraphQL API に大きく依存しています。

AEM の GraphQL API を使用すると、ヘッドレス CMS 実装の JavaScript クライアントにコンテンツフラグメントを効率的に配信できます。

• REST で API リクエストの反復を回避
• 特定の要件に限定された配信を確保
• 1 つの API クエリへの応答としてレンダリングに必要なものだけを一括配信

GraphQL API

GraphQL とは次のことを意味します。

• 「…API のクエリ言語と、既存のデータを使用してこれらのクエリを満たすランタイムです。GraphQL は、API のデータの完全で理解可能な説明を提供し、必要なものを正確に要求する力をクライアントに与え、API の長期的な発展を促し、強力な開発ツールの実現を可能にします。」

  GraphQL.org を参照

• 「…柔軟な API レイヤー用のオープンな仕様。GraphQL を既存のバックエンドに重ね合わせて、以前に比べて迅速に製品を構築…。」

  「Explore GraphQL」を参照

• 「…2012 年に Facebook 社内で開発されたデータクエリ言語および仕様です。その後、2015 年には公式にオープンソースとなりました。開発者の生産性を高め、転送データの量を最小限に抑えるために、REST ベースのアーキテクチャに代わる手段を提供します。GraphQL は、あらゆる規模の数百の組織により実稼働環境で使用されています…」

  GraphQL Foundation を参照してください。

GraphQL API の詳細については、（多くのリソースの中でも特に）以下を参照してください。

• graphql.org：

  • GraphQL の概要

  • GraphQL の仕様

• graphql.com：

  • ガイド

  • チュートリアル

  • 導入事例

AEM 用 GraphQL の実装は、標準の GraphQL Java ライブラリをベースにしています。以下を参照してください。

• graphQL.org - Java

• GitHub の GraphQL Java

GraphQL 用語

GraphQL では次を使用します。

• クエリ

• スキーマとタイプ：

  • スキーマは、コンテンツフラグメントモデルに基づいて AEM で生成されます。
  • GraphQL では、スキーマを使用して、AEM 用 GraphQL の実装で使用可能なタイプと操作を提供します。

• フィールド

• GraphQL エンドポイント

  • GraphQL クエリに応答し、GraphQL スキーマへのアクセスを提供する AEM 内のパス。

  • 詳しくは、GraphQL エンドポイントの有効化を参照してください。

ベストプラクティスを含む包括的な詳細については、「(GraphQL.org) GraphQL の概要」を参照してください。

GraphQL クエリタイプ

GraphQL では、次のいずれかを返すクエリを実行できます。

• 1 つのエントリ

• エントリのリスト

AEM は、クエリ（両方のタイプ）を Dispatcher と CDN によってキャッシュできる永続クエリに変換する機能を提供します。

GraphQL クエリのベストプラクティス（Dispatcher と CDN）

永続クエリは、パブリッシュインスタンスで次のように使用することをお勧めします。

• キャッシュされます
• AEM as a Cloud Service で一元管理されます

POST リクエストを使用する GraphQL クエリは、キャッシュされないのでお勧めしません。そのため、デフォルトのインスタンスでは、Dispatcher はそれらのクエリをブロックするように設定されています。

GraphQL は GET リクエストもサポートしていますが、永続クエリを使用して回避できる制限（URL の長さなど）に達する可能性があります。

GraphiQL IDE

また、GraphiQL IDE を使用して、GraphQL クエリのテストとデバッグを行うこともできます。

オーサー環境とパブリッシュ環境の使用例

使用例は、AEM as a Cloud Service 環境のタイプに応じて異なる場合があります。

• パブリッシュ環境の使用目的：

  • JS アプリケーションのデータのクエリ（標準の使用例）

• オーサー環境の使用目的：

  • 「コンテンツ管理用」のデータのクエリ：
    • AEM as a Cloud Service の GraphQL は現在読み取り専用の API です。
    • REST API は、CR(U)D の操作に使用できます。

権限

Assets へのアクセスに必要な権限です。

GraphQL クエリは、基になるリクエストの AEM ユーザーの権限で実行します。一部のフラグメント（Assets として保存）への読み取りアクセス権を持っていない場合、ユーザーは結果セットの一部になりません。

また、ユーザーは GraphQL クエリを実行できるように、GraphQL エンドポイントにアクセスできる必要があります。

スキーマ生成

GraphQL は、厳密に型指定された API です。つまり、データは型別に明確に構造化され編成される必要があります。

GraphQL の仕様には、特定のインスタンス上のデータをクエリするための堅牢な API を作成する方法に関する一連のガイドラインが用意されています。そのタスクを行うには、クライアントはスキーマを取得する必要があります。この中には、クエリに必要なすべての型が定義されています。

コンテンツフラグメントの場合、GraphQL スキーマ（構造とタイプ）は、有効​なコンテンツフラグメントモデルとそれらのデータタイプに基づいています。

例えば、ユーザーが Article というコンテンツフラグメントモデルを作成した場合、AEM は GraphQL タイプ ArticleModel を生成します。このタイプに含まれるフィールドは、モデルで定義されているフィールドとデータタイプに対応しています。さらに、articleByPath や articleList など、このタイプで動作するクエリのいくつかのエントリポイントを作成します。

1. コンテンツフラグメントモデル：

   

2. 対応する GraphQL スキーマ（GraphiQL 自動生成ドキュメントからの出力）:
   

   この図では、生成された型 ArticleModel に複数のフィールドが含まれていることがわかります。

   • そのうちの 3 つ（author、main、referencearticle）は、ユーザーが管理しています。

   • その他のフィールドは AEM によって自動的に追加され、特定のコンテンツフラグメントに関する情報を提供するための便利な方法を表しています。この例では、（ヘルパーフィールド）_path、_metadata、_variations です。

3. ユーザーが Article モデルに基づいてコンテンツフラグメントを作成すると、GraphQL を使用してそれをクエリできます。例については、（GraphQL で使用するコンテンツフラグメント構造のサンプルに基づいた）サンプルクエリを参照してください。

AEM 用 GraphQL では、スキーマには柔軟性があります。つまり、コンテンツフラグメントモデルを作成、更新、削除するたびに、スキーマが自動生成されます。また、コンテンツフラグメントモデルを更新すると、データスキーマキャッシュも更新されます。

また、コンテンツフラグメントモデルを更新すると、データスキーマキャッシュも更新されます。

Sites GraphQL サービスは、コンテンツフラグメントモデルに対する変更を（バックグラウンドで）リッスンします。更新が検出されると、スキーマのその部分だけが再生成されます。この最適化により、時間が節約され、安定性も確保されます。

例えば、次のようになります。

1. Content-Fragment-Model-1 と Content-Fragment-Model-2 を含んだパッケージをインストールすると、

   1. Model-1 と Model-2 の GraphQL 型が生成されます。

2. 次に Content-Fragment-Model-2 を変更すると、

   1. Model-2 GraphQL 型だけが更新されます。

   2. 一方、Model-1 は同じままです。

スキーマは、GraphQL クエリと同じエンドポイントを通じて提供され、クライアントはスキーマが拡張子 GQLschema で呼び出されることに対処します。例えば、/content/cq:graphql/global/endpoint.GQLschema で単純な GET リクエストを実行すると、text/x-graphql-schema;charset=iso-8859-1 の Content-type を持つスキーマが出力されます。

スキーマの生成 - 未公開のモデル

コンテンツフラグメントがネストされると、親のコンテンツフラグメントモデルは公開されますが、参照モデルは公開されません。

この場合、AEM は親コンテンツフラグメントモデルの​不完全な​スキーマを生成します。つまり、非公開のモデルに依存するフラグメント参照がスキーマから削除されます。

フィールド

スキーマ内には、次の 2 つの基本的なカテゴリに属する個々のフィールドがあります。

• ユーザーが生成するフィールド

  選択されたフィールドタイプを使用して、コンテンツフラグメントモデルの設定方法に基づいてフィールドが作成されます。フィールド名は、「データタイプ」タブの「プロパティ名」フィールドから取得されます。

  • ユーザーが特定のデータタイプを設定できるので、レンダリング形式​設定も考慮する必要があります。例えば、1 行のテキストフィールドに複数の 1 行のテキストを含めるように設定するには、ドロップダウンから「multifield」を選択します。

• AEM 用 GraphQL が生成する多数のヘルパーフィールド

データタイプ

AEM 用 GraphQL では一連のタイプをサポートしています。サポートされているすべてのコンテンツフラグメントモデルデータ型と、それに対応する GraphQL 型を以下の表に示します。

ヘルパーフィールド

ユーザー生成フィールドのデータ型に加えて、AEM 用 GraphQL では、コンテンツフラグメントの識別やコンテンツフラグメントに関する追加情報の提供に役立つ多数の​ヘルパー​フィールドも生成されます。

これらのヘルパーフィールドは、ユーザーが定義したものと自動生成されたものを区別するために、先頭に _ が付きます。

パス

パスフィールドは、AEM GraphQL で識別子として使用され、AEM リポジトリ内のコンテンツフラグメントアセットのパスを表します。これをコンテンツフラグメントの識別子として選択した理由は次のとおりです。

• AEM 内で一意である
• 取得しやすい

次のコードでは、WKND チュートリアルで提供されているように、コンテンツフラグメントモデル Author に基づいて作成されたすべてのコンテンツフラグメントのパスを表示します。

{
  authorList {
    items {
      _path
    }
  }
}

特定のタイプのコンテンツフラグメントを 1 つ取得するには、まずそのパスも決定する必要があります。次に例を示します。

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _path
      firstName
      lastName
    }
  }
}

サンプルクエリ - ある 1 つの特定の都市フラグメントを参照してください。

メタデータ

また、AEM では GraphQL を通じて、コンテンツフラグメントのメタデータも公開します。メタデータは、コンテンツフラグメントのタイトル、サムネールパス、コンテンツフラグメントの説明、作成日など、コンテンツフラグメントを説明する情報です。

メタデータはスキーマエディターで生成され、特定の構造を持たないので、コンテンツフラグメントのメタデータを公開するために GraphQL 型 TypedMetaData が実装されました。TypedMetaData では、次のスカラー型でグループ化された情報を公開します。

各スカラー型は、名前と値の 1 つのペアを表すか、名前と値のペアの配列を表します。このペアの値は、グループ化されたときの型になります。

例えば、コンテンツフラグメントのタイトルを取得する場合は、このプロパティが String 型プロパティであることがわかっているので、すべての String 型メタデータをクエリすることになります。

メタデータをクエリするには、次のようにします。

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _metadata {
        stringMetadata {
          name
          value
        }
      }
    }
  }
}

生成された GraphQL スキーマを表示するには、すべてのメタデータ GraphQL 型を表示します。すべてのモデルタイプは同じ TypedMetaData を持ちます。

詳しくは、メタデータのサンプルクエリ - 「GB」という賞のメタデータのリストを参照してください。

バリエーション

コンテンツフラグメントのバリエーションに対するクエリを簡略化するために、_variations フィールドが実装されています。次に例を示します。

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo") {
    item {
      _variations
    }
  }
}

詳しくは、サンプルクエリ - 名前付きバリエーションを持つすべての都市を参照してください。

GraphQL 変数

GraphQL では、クエリに変数を含めることができます。詳しくは、GraphQL の変数に関するドキュメントを参照してください。

例えば、特定のバリエーション（利用可能な場合）でタイプ Author のコンテンツフラグメントをすべて取得するには、GraphiQL で引数 variation を指定できます。

クエリ：

query($variation: String!) {
  authorList(variation: $variation) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

クエリ変数：

{
  "variation": "another"
}

このクエリは、作成者の完全なリストを返します。another バリエーションのない作成者は、元のデータに戻ります（この場合、_variation は master をレポートします）。

指定されたバリエーションを提供する作成者にリストを制限する（元のデータにフォールバックする作成者をスキップする）場合は、フィルターを適用する必要があります。

query($variation: String!) {
  authorList(variation: $variation, filter: {
    _variation: {
      _expressions: {
        value: $variation
      }
    }
  }) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

GraphQL ディレクティブ

GraphQL では、GraphQL ディレクティブと呼ばれる変数に基づいてクエリを変更する可能性があります。

例えば、変数 includePrice に基づいて、すべての AdventureModels のクエリに adventurePrice フィールドを含めることができます。

クエリ：

query GetAdventureByType($includePrice: Boolean!) {
  adventureList {
    items {
      title
      price @include(if: $includePrice)
    }
  }
}

クエリ変数：

{
    "includePrice": true
}

フィルタリング

GraphQL クエリでフィルタリングを使用して、特定のデータを返すこともできます。

フィルタリングでは、論理演算子と論理式に基づいた構文を使用します。

最もアトミックな部分は、特定のフィールドの内容に適用できる単一の式です。フィールドの内容を指定された定数値と比較します。

例えば、次の式

{
  value: "some text"
  _op: EQUALS
}

は、フィールドの内容を値 some text と比較し、内容が値と等しい場合に成功します。そうしないと、式は失敗します。

次の演算子を使用して、フィールドを特定の値と比較できます。

また、式の評価方法を変更する追加のオプションを指定できるタイプもあります。

式は、論理演算子（_logOp）を使用して設定に組み合わせることができます。

• OR - 少なくとも 1 つの式が成功した場合、式のセットは成功します
• AND - すべての式が成功した場合、式のセットは成功します（デフォルト）

各フィールドは、独自の式セットでフィルタリングできます。 フィルター引数で指定されたすべてのフィールドの式セットは、最終的に独自の論理演算子で結合されます。

フィルター定義（filter 引数としてクエリに渡される）には次が含まれます。

• 各フィールドのサブ定義（フィールド名を使用してアクセスできます。例えば、データ（フィールド）タイプの lastName フィールドのフィルターには lastName フィールドがあります）
• 各サブ定義には、式セットを提供する _expressions 配列と、式を組み合わせる必要がある論理演算子を定義する _logOp フィールドが含まれます
• 各式は、値（value フィールド）と演算子（_operator フィールド）によって定義され、フィールドの内容を比較する必要があります

項目を AND で組み合わせたい場合は _logOp を省略できます。また、等価性を確認したい場合は、これらがデフォルト値になるので、_operator を省略できます。

次の例は、大文字と小文字を区別せずに、Provo が lastName である、または sjö を含むすべてのユーザーをフィルタリングする完全なクエリを示しています。

{
  authorList(filter: {
    lastname: {
      _logOp: OR
      _expressions: [
        {
          value: "sjö",
          _operator: CONTAINS,
          _ignoreCase: true
        },
        {
          value: "Provo"
        }
      ]
    }
  }) {
    items {
      lastName
      firstName
    }
  }
}

ネストされたフィールドに対してフィルターを適用することもできますが、パフォーマンスの問題が発生する可能性があるため、お勧めしません。

その他の例については、以下を参照してください。

• AEM 用 GraphQL の拡張機能の詳細

• このサンプルコンテンツおよび構造を使用したサンプルクエリ

  • さらに、サンプルクエリ用に準備されているサンプルコンテンツおよび構造

• WKND プロジェクトに基づいたサンプルクエリ

並べ替え

この機能を使用すると、指定したフィールドに従ってクエリ結果を並べ替えることができます。

並び替え条件：

• フィールドパスを表すコンマ区切りの値のリストにする
  • リストの最初のフィールドではプライマリの並び替え順を定義し、2 番目のフィールドではプライマリの並び替え順の 2 つの値が等しい場合に、3 番目のフィールドでは最初の 2 つの条件が等しい場合などに使用されます。
  • ドット表記（field1.subfield.subfield など）
• （オプション）並べ替えの方向
  • ASC（昇順）または DESC（降順）。デフォルトでは ASC が適用されます
  • 並べ替えの方向は、フィールドごとに指定できます。つまり、あるフィールドを昇順で、別のフィールドを降順（name、firstName DESC）で並べ替えることができます

次に例を示します。

query {
  authorList(sort: "lastName, firstName") {
    items {
      firstName
      lastName
    }
  }
}

次のようにすることもできます。

{
  authorList(sort: "lastName DESC, firstName DESC") {
    items {
        lastName
        firstName
    }
  }
}

また、nestedFragmentname.fieldname の形式を使用して、ネストされたフラグメント内のフィールドで並べ替えることもできます。

次に例を示します。

query {
  articleList(sort: "authorFragment.lastName")  {
    items {
      title
      authorFragment {
        firstName
        lastName
        birthDay
      }
      slug
    }
  }
}

ページング

この機能を使用すると、リストを返すクエリタイプに対してページングを実行できます。 次の 2 つの方法があります。

• List クエリの offset と limit
• Paginated クエリの first と after

リストクエリ - オフセットと制限

...List クエリでは、offset と limit を使用して、特定の結果サブセットを返すことができます。

• offset：返される最初のデータセットを指定します
• limit：返されるデータセットの最大数を指定します

例えば、完全な​結果リストの 5 番目の記事から開始して、最大 5 つの記事を含む結果のページを出力するには、次のようにします。

query {
   articleList(offset: 5, limit: 5) {
    items {
      authorFragment {
        lastName
        firstName
      }
    }
  }
}

ページ分割されたクエリ - first と after

...Paginated クエリタイプは、ほとんどの ...List クエリタイプの機能（フィルタリング、並べ替え）を再利用しますが、offset／limit 引数の代わりに、GraphQL カーソル接続仕様で定義されている first／after 引数を使用します。GraphQL の概要では、堅苦しくない概要を見つけることができます。

• first：返される最初の n 個の項目。
  デフォルトは、50 です。
  最大値は 100 です。
• after：リクエストされたページの先頭を決定するカーソル。カーソルで表される項目は結果セットに含まれないことに注意してください。項目のカーソルは、edges 構造体の cursor フィールドによって決定されます。

例えば、完全な​結果リスト内の指定されたカーソル項目から開始して、最大 5 つの冒険を含む結果のページを出力します。

query {
    adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
        edges {
          cursor
          node {
            title
          }
        }
        pageInfo {
          endCursor
          hasNextPage
        }
    }
}

AEM 用の GraphQL - 拡張機能の概要

AEM 用の GraphQL でのクエリの基本操作は、標準の GraphQL 仕様に従います。AEM での GraphQL クエリには、次のような拡張機能があります。

• 結果のリストを想定している場合：

  • モデル名に List を付け加えます（例：cityList）
  • サンプルクエリ - すべての都市に関するすべての情報を参照してください

  これにより、以下のことが可能になります。

  • 結果の並べ替え

    • ASC : 昇順
    • DESC : 降順

  • 次のいずれかを使用して、結果のページを返します。

    • オフセットと制限を指定したリストクエリ
    • 最初とその後を指定したページ分割クエリ

  • サンプルクエリ - すべての都市に関するすべての情報を参照してください

• 結果が 1 つだけ必要な場合：

  • モデル名（例：city）を使用します

• 結果のリストを想定している場合：

  • モデル名に List を付け加えます（例：cityList）
  • サンプルクエリ - すべての都市に関するすべての情報を参照してください

• 論理和（OR）を使用する場合：

  • _logOp: OR を使用します
  • サンプルクエリ - 「Jobs」または「Smith」という名前を持つすべての人物を参照してください

• 論理積（AND）も存在しますが、（多くの場合）暗黙的です

• コンテンツフラグメントモデル内のフィールドに対応するフィールド名に対してクエリを実行できます

  • サンプルクエリ - ある会社の CEO と従業員の詳細を参照してください

• モデルのフィールドに加えて、次のようなシステム生成フィールドがあります（フィールド名の先頭にアンダースコアが付きます）。

  • コンテンツの場合：

    • _locale：言語を表示します（言語マネージャーに基づく）

      • 特定ロケールの複数のコンテンツフラグメントのサンプルクエリを参照してください

    • _metadata：フラグメントのメタデータを表示します

      • メタデータのサンプルクエリ - 「GB」という賞のメタデータのリストを参照してください

    • _model：コンテンツフラグメントモデル（パスとタイトル）のクエリを許可します

      • モデルからのコンテンツフラグメントモデルのサンプルクエリを参照してください

    • _path：リポジトリ内のコンテンツフラグメントへのパス

      • サンプルクエリ - 1 つの特定の都市フラグメントを参照してください

    • _reference：参照（リッチテキストエディターでのインライン参照など）を表示します

      • プリフェッチされた参照を含んだ複数のコンテンツフラグメントのサンプルクエリを参照してください

    • _variation：コンテンツフラグメント内の特定のバリエーションを表示します

      メモ

      指定されたバリエーションがコンテンツフラグメントに対して存在しない場合、マスターバリエーションが（フォールバック）デフォルトとして返されます。

      • サンプルクエリ - 名前付きバリエーションを持つすべての都市を参照してください

  • 操作の場合：

    • _operator：特定の演算子（EQUALS、EQUALS_NOT、GREATER_EQUAL、LOWER、CONTAINS、STARTS_WITH）を適用します
      • サンプルクエリ - 「Jobs」という名前を持たないすべての人物を参照してください
      • サンプルクエリ - _path が特定のプレフィックスで始まるすべてのアドベンチャーを参照してください
    • _apply：特定の条件（例：AT_LEAST_ONCE）を適用します
      • サンプルクエリ - 少なくとも 1 回は現れる項目を含んだ配列をフィルタリングを参照してください
    • _ignoreCase：クエリの実行時に大文字と小文字を区別しません
      • サンプルクエリ - 名前に SAN が含まれるすべての都市（大文字と小文字を区別しない場合）を参照してください

• GraphQL のユニオン型がサポートされています

  • ... on を使用します
    • 特定モデルのコンテンツフラグメントのうちコンテンツ参照を含んだものを取得するサンプルクエリを参照してください

• ネストされたフラグメントに対するクエリ時のフォールバック：

  • 任意のバリエーションがネストされたフラグメントに存在しない場合、マスター​バリエーションが返されます。

外部 web サイトからの GraphQL エンドポイントのクエリ

外部 web サイトから GraphQL エンドポイントにアクセスするには、次の項目を設定する必要があります。

• CORS フィルター
• リファラーフィルター

認証

コンテンツフラグメントに対するリモート AEM GraphQL クエリの認証を参照してください。

FAQ

次のような質問が寄せられました。

1. Q：「AEM 用 GraphQL API と Query Builder API の違いは何ですか？」

   • A：「AEM GraphQL API は JSON 出力の完全な制御が可能であり、コンテンツをクエリするための業界標準になっています。今後、AEM GraphQL API への投資が計画されています。」

チュートリアル - AEM ヘッドレスと GraphQL をはじめる前に

実践的なチュートリアルを探している場合は、AEM の GraphQL API を使用し、外部アプリで使用するコンテンツをヘッドレス CMS シナリオで構築して公開する方法を示す「AEM ヘッドレスと GraphQL をはじめる前に」のエンドツーエンドのチュートリアルをご覧ください。

Business.Adobe.com リソース