AEM での GraphQL の使用方法 - サンプルコンテンツとサンプルクエリ

最終更新日： 2023-08-07
  • 作成対象：
  • Developer

AEM で GraphQL を使用し、サンプルコンテンツとクエリで、コンテンツをヘッドレスに配信する方法を説明します。

メモ

GraphQL クエリの基本と、AEM コンテンツフラグメントとの連携方法を学ぶには、いくつかの実践的な例が参考になります。

以下を参照してください。

GraphQL - サンプルコンテンツフラグメント構造を使用したサンプルクエリ

クエリの作成とサンプル結果については、これらのサンプルクエリを参照してください。

メモ

インスタンスによっては、AEM GraphQL API に付属している GraphiQL インターフェイスに直接アクセスして、クエリの送信とテストを実行できます。

例：http://localhost:4502/content/graphiql.html

メモ

サンプルクエリは、GraphQL で使用するコンテンツフラグメント構造のサンプルに基づいています。

サンプルクエリ - 使用可能なすべてのスキーマとデータタイプ

このサンプルクエリは、使用可能なすべてのスキーマに対するすべての types を返します。

サンプルクエリ

{
  __schema {
    types {
      name
      description
    }
  }
}

サンプル結果

{
  "data": {
    "__schema": {
      "types": [
        {
          "name": "AdventureModel",
          "description": null
        },
        {
          "name": "AdventureModelArrayFilter",
          "description": null
        },
        {
          "name": "AdventureModelFilter",
          "description": null
        },
        {
          "name": "AdventureModelResult",
          "description": null
        },
        {
          "name": "AdventureModelResults",
          "description": null
        },
        {
          "name": "AllFragmentModels",
          "description": null
        },
        {
          "name": "ArchiveRef",
          "description": null
        },
        {
          "name": "ArrayMode",
          "description": null
        },
        {
          "name": "ArticleModel",
          "description": null
        },

...more results...

        {
          "name": "__EnumValue",
          "description": null
        },
        {
          "name": "__Field",
          "description": null
        },
        {
          "name": "__InputValue",
          "description": null
        },
        {
          "name": "__Schema",
          "description": "A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations."
        },
        {
          "name": "__Type",
          "description": null
        },
        {
          "name": "__TypeKind",
          "description": "An enum describing what kind of type a given __Type is"
        }
      ]
    }
  }
}

サンプルクエリ - すべての都市に関するすべての情報

すべての都市に関するすべての情報を取得するには、次のような基本的なクエリを使用します。
サンプルクエリ

{
  cityList {
    items
  }
}

実行時にシステムは自動的にすべてのフィールドを含むようにクエリを展開します。

{
  cityList {
    items {
      _path
      name
      country
      population
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "_path": "/content/dam/sample-content-fragments/cities/basel",
          "name": "Basel",
          "country": "Switzerland",
          "population": 172258
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/berlin",
          "name": "Berlin",
          "country": "Germany",
          "population": 3669491
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/bucharest",
          "name": "Bucharest",
          "country": "Romania",
          "population": 1821000
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/san-francisco",
          "name": "San Francisco",
          "country": "USA",
          "population": 883306
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/san-jose",
          "name": "San Jose",
          "country": "USA",
          "population": 1026350
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/stuttgart",
          "name": "Stuttgart",
          "country": "Germany",
          "population": 634830
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/zurich",
          "name": "Zurich",
          "country": "Switzerland",
          "population": 415367
        }
      ]
    }
  }
}

サンプルクエリ - すべての都市の名前

このサンプルクエリは、city スキーマ内のすべてのエントリの name を返す単純なクエリです。

サンプルクエリ

query {
  cityList {
    items {
      name
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Basel"
        },
        {
          "name": "Berlin"
        },
        {
          "name": "Bucharest"
        },
        {
          "name": "San Francisco"
        },
        {
          "name": "San Jose"
        },
        {
          "name": "Stuttgart"
        },
        {
          "name": "Zurich"
        }
      ]
    }
  }
}

サンプルクエリ - 1 つの特定の都市フラグメント

このサンプルクエリは、リポジトリ内の特定の場所にある 1 つのフラグメントエントリの詳細を返すクエリです。

サンプルクエリ

{
  cityByPath (_path: "/content/dam/sample-content-fragments/cities/berlin") {
    item {
      _path
      name
      country
      population
     categories
    }
  }
}

サンプル結果

{
  "data": {
    "cityByPath": {
      "item": {
        "_path": "/content/dam/sample-content-fragments/cities/berlin",
        "name": "Berlin",
        "country": "Germany",
        "population": 3669491,
        "categories": [
          "city:capital",
          "city:emea"
        ]
      }
    }
  }
}

サンプルクエリ - 名前付きバリエーションを持つすべての都市

city Berlin のバリエーションを「Berlin Center」（berlin_centre）という名前で作成する場合は、クエリを使用してバリエーションの詳細を返すことができます。

サンプルクエリ

{
  cityList (variation: "berlin_center") {
    items {
      _path
      name
      country
      population
      categories
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "_path": "/content/dam/sample-content-fragments/cities/berlin",
          "name": "Berlin",
          "country": "Germany",
          "population": 3669491,
          "categories": [
            "city:capital",
            "city:emea"
          ]
        }
      ]
    }
  }
}

サンプルクエリ - すべての都市の名前都市滞在型休暇としてタグ付けされた

次の場合：

  • Tourism、Business、City Break、Holiday という様々な名前のタグを作成する
  • これらを様々な City インスタンスのプライマリバリエーションに割り当てます

この場合、クエリを使用して、city スキーマで都市滞在型休暇としてタグ付けされたすべてのエントリの name および tags の詳細を返すことができます。

サンプルクエリ

query {
  cityList(
    includeVariations: true,
    filter: {_tags: {_expressions: [{value: "tourism:city-break", _operator: CONTAINS}]}}
  ){
    items {
      name,
      _tags
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Berlin",
          "_tags": [
            "tourism:city-break",
            "tourism:business"
          ]
        },
        {
          "name": "Zurich",
          "_tags": [
            "tourism:city-break",
            "tourism:business"
          ]
        }
      ]
    }
  }
}

サンプルクエリ - ある会社の CEO と従業員の詳細

このクエリでは、ネストされたフラグメントの構造を使用して、ある会社の CEO とすべての従業員の詳細を返します。

サンプルクエリ

query {
  companyList {
    items {
      name
      ceo {
        _path
        name
        firstName
        awards {
        id
          title
        }
      }
      employees {
       name
        firstName
       awards {
         id
          title
        }
      }
    }
  }
}

サンプル結果

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "Apple Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
            "name": "Jobs",
            "firstName": "Steve",
            "awards": []
          },
          "employees": [
            {
              "name": "Marsh",
              "firstName": "Duke",
              "awards": []
            },
            {
              "name": "Caulfield",
              "firstName": "Max",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                }
              ]
            }
          ]
        },
        {
          "name": "Little Pony, Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/adam-smith",
            "name": "Smith",
            "firstName": "Adam",
            "awards": []
          },
          "employees": [
            {
              "name": "Croft",
              "firstName": "Lara",
              "awards": [
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            },
            {
              "name": "Slade",
              "firstName": "Cutter",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                },
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            }
          ]
        },
        {
          "name": "NextStep Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
            "name": "Jobs",
            "firstName": "Steve",
            "awards": []
          },
          "employees": [
            {
              "name": "Smith",
              "firstName": "Joe",
              "awards": []
            },
            {
              "name": "Lincoln",
              "firstName": "Abraham",
              "awards": []
            }
          ]
        }
      ]
    }
  }
}

サンプルクエリ - 「Jobs」または「Smith」という名前を持つすべての人物

このサンプルクエリは、Jobs または Smith という名前を持つすべての persons をフィルターします。

サンプルクエリ

query {
  personList(filter: {
    name: {
      _logOp: OR
      _expressions: [
        {
          value: "Jobs"
        },
        {
          value: "Smith"
        }
      ]
    }
  }) {
    items {
      name
      firstName
    }
  }
}

サンプル結果

{
  "data": {
    "personList": {
      "items": [
        {
          "name": "Smith",
          "firstName": "Adam"
        },
        {
          "name": "Smith",
          "firstName": "Joe"
        },
        {
          "name": "Jobs",
          "firstName": "Steve"
        }
      ]
    }
  }
}

サンプルクエリ - 「Jobs」という名前を持たないすべての人物

このサンプル クエリでは、Jobs または Smith という名前のすべての persons をフィルタリングします。

サンプルクエリ

query {
  personList(filter: {
    name: {
      _expressions: [
        {
          value: "Jobs"
          _operator: EQUALS_NOT
        }
      ]
    }
  }) {
    items {
      name
      firstName
    }
  }
}

サンプル結果

{
  "data": {
    "personList": {
      "items": [
        {
          "name": "Lincoln",
          "firstName": "Abraham"
        },
        {
          "name": "Smith",
          "firstName": "Adam"
        },
        {
          "name": "Slade",
          "firstName": "Cutter"
        },
        {
          "name": "Marsh",
          "firstName": "Duke"
        },
        {
          "name": "Smith",
          "firstName": "Joe"
        },
        {
          "name": "Croft",
          "firstName": "Lara"
        },
        {
          "name": "Caulfield",
          "firstName": "Max"
        }
      ]
    }
  }
}

サンプルクエリ - _path が特定のプレフィックスで始まるすべてのアドベンチャー

_path が特定のプレフィックス（/content/dam/wknd/en/adventures/cycling）で始まるすべての adventures。

サンプルクエリ

query {
  adventureList(
    filter: {
      _path: {
        _expressions: [
        {
          value: "/content/dam/wknd/en/adventures/cycling"
         _operator: STARTS_WITH
        }]
       }
    })
    {
    items {
      _path
    }
  }
}

サンプル結果

{
  "data": {
    "adventureList": {
      "items": [
        {
          "_path": "/content/dam/wknd/en/adventures/cycling-southern-utah/cycling-southern-utah"
        },
        {
          "_path": "/content/dam/wknd/en/adventures/cycling-tuscany/cycling-tuscany"
        }
      ]
    }
  }
}

サンプルクエリ - ドイツまたはスイスにあり、人口が 40 万人以上 100 万人未満のすべての都市

ここでは、複数のフィールドの組み合わせがフィルタリングされます。AND（暗黙的）を使用して population の範囲を選択しつつ、OR（明示的）を使用して必要な都市を選択しています。

サンプルクエリ

query {
  cityList(filter: {
    population: {
      _expressions: [
        {
          value: 400000
          _operator: GREATER_EQUAL
        }, {
          value: 1000000
          _operator: LOWER
        }
      ]
    },
    country: {
      _logOp: OR
      _expressions: [
        {
          value: "Germany"
        }, {
          value: "Switzerland"
        }
      ]
    }
  }) {
    items {
      name
      population
      country
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Stuttgart",
          "population": 634830,
          "country": "Germany"
        },
        {
          "name": "Zurich",
          "population": 415367,
          "country": "Switzerland"
        }
      ]
    }
  }
}

サンプルクエリ - 名前に SAN が含まれるすべての都市（大文字と小文字を区別しない場合）

このクエリでは、名前に SAN が含まれるすべての都市を、大文字と小文字を区別せずに検索します。

サンプルクエリ

query {
  cityList(filter: {
    name: {
      _expressions: [
        {
          value: "SAN"
          _operator: CONTAINS
          _ignoreCase: true
        }
      ]
    }
  }) {
    items {
      name
      population
      country
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA"
        },
        {
          "name": "San Jose",
          "population": 1026350,
          "country": "USA"
        }
      ]
    }
  }
}

サンプルクエリ - 少なくとも 1 回は現れる項目を含んだ配列をフィルタリング

このクエリでは、少なくとも 1 回は現れる項目（city:na）を含んだ配列を抜き出します。

サンプルクエリ

query {
  cityList(filter: {
    categories: {
      _expressions: [
        {
          value: "city:na"
          _apply: AT_LEAST_ONCE
        }
      ]
    }
  }) {
    items {
      name
      population
      country
      categories
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA",
          "categories": [
            "city:beach",
            "city:na"
          ]
        },
        {
          "name": "San Jose",
          "population": 1026350,
          "country": "USA",
          "categories": [
            "city:na"
          ]
        }
      ]
    }
  }
}

サンプルクエリ - 配列値が正確に一致するものだけをフィルタリング

このクエリでは、配列値が正確に一致するものだけを抜き出します。

サンプルクエリ

query {
  cityList(filter: {
    categories: {
      _expressions: [
        {
          values: [
            "city:beach",
            "city:na"
          ]
        }
      ]
    }
  }) {
    items {
      name
      population
      country
      categories
    }
  }
}

サンプル結果

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA",
          "categories": [
            "city:beach",
            "city:na"
          ]
        }
      ]
    }
  }
}

ネストされたコンテンツフラグメントのサンプルクエリ - 「Smith」という名前を持つ従業員が少なくとも 1 人いるすべての会社

このクエリでは、「Smith」という name の person をフィルタリングし、ネストされた 2 つのフラグメント（company と employee）から取得した情報を返します。

サンプルクエリ

query {
  companyList(filter: {
    employees: {
      _match: {
        name: {
          _expressions: [
            {
              value: "Smith"
            }
          ]
        }
      }
    }
  }) {
    items {
      name
      ceo {
        name
        firstName
      }
      employees {
        name
        firstName
      }
    }
  }
}

サンプル結果

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "NextStep Inc.",
          "ceo": {
            "name": "Jobs",
            "firstName": "Steve"
          },
          "employees": [
            {
              "name": "Smith",
              "firstName": "Joe"
            },
            {
              "name": "Lincoln",
              "firstName": "Abraham"
            }
          ]
        }
      ]
    }
  }
}

ネストされたコンテンツフラグメントのサンプルクエリ - すべての従業員が「Gamestar」賞を受賞したすべての会社

このクエリは、ネストされた 3 つのフラグメント（company、employee、award）にわたるフィルタリングの例を示しています。

サンプルクエリ

query {
  companyList(filter: {
    employees: {
      _apply: ALL
      _match: {
        awards: {
          _match: {
            id: {
              _expressions: [
                {
                  value: "GS"
                  _operator:EQUALS
                }
              ]
            }
          }
        }
      }
    }
  }) {
    items {
      name
      ceo {
        name
        firstName
      }
      employees {
        name
        firstName
        awards {
          id
          title
        }
      }
    }
  }
}

サンプル結果

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "Little Pony, Inc.",
          "ceo": {
            "name": "Smith",
            "firstName": "Adam"
          },
          "employees": [
            {
              "name": "Croft",
              "firstName": "Lara",
              "awards": [
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            },
            {
              "name": "Slade",
              "firstName": "Cutter",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                },
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

メタデータのサンプルクエリ - 「GB」という賞のメタデータのリスト

このクエリは、ネストされた 3 つのフラグメント（company、employee、award）にわたるフィルタリングの例を示しています。

サンプルクエリ

query {
  awardList(filter: {
      id: {
        _expressions: [
          {
            value:"GB"
          }
        ]
    }
  }) {
    items {
      _metadata {
        stringMetadata {
          name,
          value
        }
      }
      id
      title
    }
  }
}

サンプル結果

{
  "data": {
    "awardList": {
      "items": [
        {
          "_metadata": {
            "stringMetadata": [
              {
                "name": "title",
                "value": "Gameblitz Award"
              },
              {
                "name": "description",
                "value": ""
              }
            ]
          },
          "id": "GB",
          "title": "Gameblitz"
        }
      ]
    }
  }
}

WKND プロジェクトを使用したサンプルクエリ

これらのサンプルクエリは WKND プロジェクトに基づいています。以下が含まれています。

  • 次の URL で入手できるコンテンツフラグメントモデル：
    http://<hostname>:<port>/libs/dam/cfm/models/console/content/models.html/conf/wknd

  • 次の URL で入手できるコンテンツフラグメント（およびその他のコンテンツ）：
    http://<hostname>:<port>/assets.html/content/dam/wknd/en

メモ

結果は膨大な量になる可能性があるので、ここでは再現しません。

特定モデルのコンテンツフラグメントのうち指定のプロパティを持つものをすべて取得するサンプルクエリ

このサンプルクエリでは次のものを検索します。

  • article タイプのすべてのコンテンツフラグメントについて
  • path および author プロパティを持つもの。

サンプルクエリ

{
  articleList {
    items {
      _path
      author
    }
  }
}

メタデータのサンプルクエリ

このクエリでは次のものを検索します。

  • adventure タイプのすべてのコンテンツフラグメントについて
  • メタデータ

サンプルクエリ

{
  adventureList {
    items {
      _path,
      _metadata {
        stringMetadata {
          name,
          value
        }
        stringArrayMetadata {
          name,
          value
        }
        intMetadata {
          name,
          value
        }
        intArrayMetadata {
          name,
          value
        }
        floatMetadata {
          name,
          value
        }
        floatArrayMetadata {
          name,
          value
        }
        booleanMetadata {
          name,
          value
        }
        booleanArrayMetadata {
          name,
          value
        }
        calendarMetadata {
          name,
          value
        }
        calendarArrayMetadata {
          name,
          value
        }
      }
    }
  }
}

特定モデルの 1 つのコンテンツフラグメントのサンプルクエリ

このサンプルクエリでは次のものを検索します。

  • 特定のパスにある article タイプの 1 つのコンテンツフラグメントについて
    • 特定のパス内にある、次のすべてのコンテンツ形式：
      • HTML
      • Markdown
      • プレーンテキスト
      • JSON

サンプルクエリ

{
  articleByPath (_path: "/content/dam/wknd/en/magazine/alaska-adventure/alaskan-adventures") {
    item {
        _path
        author
        main {
          html
          markdown
          plaintext
          json
        }
    }
  }
}

モデルからのコンテンツフラグメントモデルのサンプルクエリ

このサンプルクエリでは次のものを検索します。

  • 1 つのコンテンツフラグメントについて
    • 基になるコンテンツフラグメントモデルの詳細

サンプルクエリ

{
  adventureByPath(_path: "/content/dam/wknd/en/adventures/riverside-camping-australia/riverside-camping-australia") {
    item {
      _path
      adventureTitle
      _model {
        _path
        title
      }
    }
  }
}

ネストされたコンテンツフラグメントのサンプルクエリ - 単一モデルタイプ

このクエリでは次のものを検索します。

  • 特定のパスにある article タイプの 1 つのコンテンツフラグメントについて
    • 特定のパス内にある、参照されている（ネストされた）フラグメントのパスと作成者
メモ

フィールド referencearticle のデータタイプは fragment-reference です。

サンプルクエリ

{
  adventureByPath(_path: "/content/dam/wknd-shared/en/magazine/western-australia/western-australia-by-camper-van") {
    item {
      _path
      title
      _model {
        _path
        title
      }
    }
  }
}

ネストされたコンテンツフラグメントのサンプルクエリ - 複数モデルタイプ

単一の参照モデルタイプ

このクエリでは次のものを検索します。

  • bookmark タイプの複数のコンテンツフラグメントについて
    • 特定のモデルタイプ Article の他のフラグメントへのフラグメント参照を含むもの
メモ

フィールド fragments のデータタイプは fragment-reference で、モデル Article が選択されています。クエリは fragments を [Article] の配列として配信します。

{
  bookmarkList {
    items {
        fragments {
          _path
          author
        }
     }
  }
}

複数の参照モデルタイプ

このクエリでは次のものを検索します。

  • bookmark タイプの複数のコンテンツフラグメントについて
    • 特定のモデルタイプ Article および Adventure の他のフラグメントへのフラグメント参照を含むもの
メモ

フィールド fragments のデータタイプは fragment-reference で、モデル Article および Adventure が選択されています。クエリは fragments を [AllFragmentModels] の配列として配信します。これはユニオン型でデリファレンスされます。

{
  bookmarkList {
    items {
        fragments {
          ... on ArticleModel {
            _path
            author
          }
          ... on AdventureModel {
            _path
            adventureTitle
          }
        }
     }
  }
}

特定モデルのコンテンツフラグメントのうちコンテンツ参照を含んだものを取得するサンプルクエリ

このクエリには次の 2 種類があります。

  1. すべてのコンテンツ参照を返すもの。
  2. attachments タイプの特定のコンテンツ参照を返すもの。

これらのクエリでは次のものを検索します。

  • bookmark タイプの複数のコンテンツフラグメントについて
    • 他のフラグメントへのコンテンツ参照を含むもの

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

次のクエリは、_references を使用して、すべてのコンテンツ参照を返します。

{
  bookmarkList {
     _references {
         ... on ImageRef {
          _path
          type
          height
        }
        ... on MultimediaRef {
          _path
          type
          size
        }
        ... on DocumentRef {
          _path
          type
          author
        }
        ... on ArchiveRef {
          _path
          type
          format
        }
    }
    items {
        _path
    }
  }
}

添付ファイルを含んだ複数のコンテンツフラグメントのサンプルクエリ

次のクエリは、すべての attachments、つまり content-reference タイプの特定のフィールド（サブグループ）を返します。

メモ

フィールド attachments のデータタイプは content-reference で、様々な形式が選択されています。

{
  bookmarkList {
    items {
      attachments {
        ... on PageRef {
          _path
          type
        }
        ... on ImageRef {
          _path
          width
        }
        ... on MultimediaRef {
          _path
          size
        }
        ... on DocumentRef {
          _path
          author
        }
        ... on ArchiveRef {
          _path
          format
        }
      }
    }
  }
}

RTE インライン参照を含んだ 1 つのコンテンツフラグメントのサンプルクエリ

このクエリでは次のものを検索します。

  • 特定のパスにある bookmark タイプの 1 つのコンテンツフラグメントについて
    • その中の RTE インライン参照
メモ

RTE インライン参照は、_references 内に含まれます。

サンプルクエリ

{
  bookmarkByPath(_path: "/content/dam/wknd/en/bookmarks/skitouring") {
    item {
      _path
      description {
        json
      }
    }
    _references {
      ... on ArticleModel {
        _path
      }
      ... on AdventureModel {
        _path
      }
      ... on ImageRef {
        _path
      }
      ... on MultimediaRef {
        _path
      }
      ... on DocumentRef {
        _path
      }
      ... on ArchiveRef {
        _path
      }
    }
  }
}

特定モデルの 1 つのコンテンツフラグメントバリエーションのサンプルクエリ

このクエリでは次のものを検索します。

  • 特定のパスにある article タイプの 1 つのコンテンツフラグメントについて
    • そのパス中の、バリエーション variation1 に関するデータ

サンプルクエリ

{
  articleByPath (_path: "/content/dam/wknd/en/magazine/alaska-adventure/alaskan-adventures", variation: "variation1") {
    item {
      _path
      author
      main {
        html
        markdown
        plaintext
        json
      }
    }
  }
}

特定モデルの複数のコンテンツフラグメントの名前付きバリエーションを取得するサンプルクエリ

このクエリでは次のものを検索します。

  • 特定のバリエーション variation1 を持つ article タイプのコンテンツフラグメント

サンプルクエリ

{
  articleList (variation: "variation1") {
    items {
      _path
      author
      main {
        html
        markdown
        plaintext
        json
      }
    }
  }
}

特定モデルの複数のコンテンツフラグメントとそのバリエーションのサンプルクエリ

このクエリでは次のものを検索します。

  • article タイプのコンテンツフラグメントとすべてのバリエーション

サンプルクエリ

query {
  articleList(
    includeVariations: true  ){
    items {
      _variation
      _path
      _tags
      _metadata {
        stringArrayMetadata {
          name
          value
        }
      }
    }
  }
}

特定のタグが設定された特定モデルのコンテンツフラグメントバリエーションのサンプルクエリ

このクエリでは次のものを検索します。

  • タグ WKND : Activity / Hiking の付いた 1 つ以上のバリエーションを持つ article タイプのコンテンツフラグメント

サンプルクエリ

{
  articleList(
    includeVariations: true,
    filter: {_tags: {_expressions: [{value: "wknd:activity/hiking", _operator: CONTAINS}]}}
  ){
    items {
      _variation
      _path
      _tags
      _metadata {
        stringArrayMetadata {
          name
          value
        }
      }
    }
  }
}

特定ロケールの複数のコンテンツフラグメントのサンプルクエリ

このクエリでは次のものを検索します。

  • fr ロケール内の article タイプのコンテンツフラグメント

サンプルクエリ

{
  articleList (_locale: "fr") {
    items {
      _path
      author
      main {
        html
        markdown
        plaintext
        json
      }
    }
  }
}

GraphQL で使用するコンテンツフラグメント構造のサンプル

サンプルクエリは次の構造に基づいています。

サンプルコンテンツフラグメントモデル（スキーマ）

サンプルクエリでは、次のコンテンツモデルとその相互関係（参照関係 ->）を使用します。

Company（会社）

会社を定義する基本フィールドは次のとおりです。

フィールド名 データタイプ 参照
会社名 1 行のテキスト
CEO フラグメント参照（1 つ） Person
従業員数 フラグメント参照（複数フィールド） Person

Person（人物）

人物（従業員になることも可能）を定義するフィールドは次のとおりです。

フィールド名 データタイプ 参照
name（氏名） 1 行のテキスト
名前（名） 1 行のテキスト
授賞歴 フラグメント参照（複数フィールド） Award

Award（賞）

賞を定義するフィールドは次のとおりです。

フィールド名 データタイプ 参照
ショートカット／ID 1 行のテキスト
タイトル 1 行のテキスト

City（市区町村）

都市を定義するフィールドは次のとおりです。

フィールド名 データタイプ 参照
name（氏名） 1 行のテキスト
国 1 行のテキスト
人口 数値
カテゴリ タグ

サンプルコンテンツフラグメント

適切なモデルでは次のフラグメントが使用されます。

Company（会社）

会社名 CEO 従業員数
Apple Inc. Steve Jobs Duke Marsh
Max Caulfield
Little Pony, Inc. Adam Smith Lara Croft
Cutter Slade
NextStep Inc. Steve Jobs Joe Smith
Abe Lincoln

Person（人物）

name 名 授賞歴
Lincoln Abe
Smith Adam
Slade Cutter Gameblitz
Gamestar
Marsh Duke
Smith Joe
Croft Lara Gamestar
Caulfield Max Gameblitz
Jobs Steve

賞

ショートカット／ID title
GB Gameblitz
GS Gamestar
OSC Oscar

都市

name 国名 人口 カテゴリ
Basel Switzerland 172258 city:emea
Berlin Germany 3669491 city:capital
city:emea
Bucharest Romania 1821000 city:capital
city:emea
San Francisco USA 883306 city:beach
city:na
San Jose USA 102635 city:na
Stuttgart Germany 634830 city:emea
Zurich Switzerland 415367 city:capital
city:emea
前のページ
Next page

このページ