文件AEM as a Cloud Service使用手冊

了解搭配使用 GraphQL 與 AEM - 範例內容和查詢 learn-graphql-with-aem-sample-content-queries

Last update: Fri Nov 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

  • 管理員
  • 開發人員

透過探索範例內容和查詢，了解如何搭配使用 GraphQL 與 AEM 以提供 Headless 內容。

IMPORTANT
適用於內容片段的GraphQL API各項功能，可透過早期採用者計畫取得。
若要檢視狀態，以及如果您有興趣要如何套用，請檢視發行說明。
NOTE
閱讀本頁以及以下內容：

若要開始使用 GraphQL 查詢，及了解它們如何與 AEM 內容片段搭配使用，查看一些實際範例會有所幫助。

如需相關幫助，請參閱：

GraphQL - 使用範例內容片段結構的範例查詢 graphql-sample-queries-sample-content-fragment-structure

請參閱這些範例查詢，以了解如何建立查詢以及範例結果。

NOTE
視您的執行個體而定，您可以直接存取 AEM GraphQL API 包含的 GraphiQL 介面以提交和測試查詢。
您可以從以下任一方式存取查詢編輯器：
  • 工具 > 一般 > GraphQL 查詢編輯器
  • 直接；例如 http://localhost:4502/aem/graphiql.html
NOTE
範例查詢是根據與 GraphQL 搭配使用的範例內容片段結構

範例查詢 - 所有可用的結構描述和資料類型 sample-all-schemes-datatypes

傳回所有可用結構描述的所有 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"
        }
      ]
    }
  }
}

範例查詢 - 關於所有城市的所有資訊 sample-all-information-all-cities

若要擷取關於所有城市的所有資訊，您可以使用以下基本查詢：
範例查詢

{
  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
        }
      ]
    }
  }
}

範例查詢 - 所有城市的名稱 sample-names-all-cities

此簡單查詢可傳回 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"
        }
      ]
    }
  }
}

範例查詢 - 單一特定城市片段 sample-single-specific-city-fragment

此查詢可傳回存放庫中特定位置之單一片段項目的詳細資訊。

範例查詢

{
  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"
        ]
      }
    }
  }
}

範例查詢 - 所有具有名稱變化的城市 sample-cities-named-variation

如果您為 city 柏林建立名為「柏林中心」(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"
          ]
        }
      ]
    }
  }
}

範例查詢 - 所有標記為 City Breaks 的城市名稱 sample-names-all-cities-tagged-city-breaks

如果您：

  • 建立各種標記，名稱為 Tourism：Business、City Break、Holiday
  • 並將這些標記指派給各種 City 執行個體的主版變化

接著您可以使用查詢傳回在 city 結構描述中標記為「City Breaks」之所有項目的 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 和員工的完整詳細資訊 sample-full-details-company-ceos-employees

使用巢狀片段的結構，此查詢傳回公司 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」的所有人員 sample-all-persons-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」的人員 sample-all-persons-not-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 以特定前置詞開頭的所有冒險 sample-wknd-all-adventures-cycling-path-filter

其 _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"
        }
      ]
    }
  }
}

範例查詢 - 位於德國或瑞士且人口在 400000 到 999999 之間的所有城市 sample-all-cities-d-ch-population

這裡篩選了欄位組合。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 的所有城市，不區分大小寫 sample-all-cities-san-ignore-case

此查詢會質詢名稱中包含 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"
        }
      ]
    }
  }
}

範例查詢 - 篩選至少出現一次項目的陣列 sample-array-item-occur-at-least-once

此查詢篩選至少出現一次項目 (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"
          ]
        }
      ]
    }
  }
}

範例查詢 - 篩選確切的陣列值 sample-array-exact-value

此查詢會篩選確切的陣列值。

範例查詢

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」的所有公司 sample-companies-employee-smith

此查詢說明篩選出任何 name 為「Smith」的 person，從兩個巢狀片段 - 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」獎項的所有公司 sample-all-companies-employee-gamestar-award

此查詢說明了跨三個巢狀片段 - 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 獎項的中繼資料 sample-metadata-awards-gb

此查詢說明了跨三個巢狀片段 - 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 專案的範例查詢 sample-queries-using-wknd-project

這些是根據 WKND 專案的範例查詢。其具有以下：

  • 內容片段模型可在以下位置取用：
    http://<hostname>:<port>/libs/dam/cfm/models/console/content/models.html/conf/wknd

  • 內容片段 (和其他內容) 可在以下位置取用：
    http://<hostname>:<port>/assets.html/content/dam/wknd/en
    http://<hostname>:<port>/assets.html/content/dam/wknd-shared/en

NOTE
因為結果可能很龐大，因此不在此處重現。

具有指定的屬性之特定模型的所有內容片段的範例查詢 sample-wknd-all-model-properties

此範例查詢會質詢：

  • 類型為 article 的所有內容片段
  • 具有 _path 和 authorFragment 的屬性。

範例查詢

{
  articleList {
    items {
      _path
      authorFragment {
        _path
        firstName
        lastName
        birthDay
      }
    }
 }
}

中繼資料的範例查詢 sample-wknd-metadata

此查詢會質詢：

  • 類型為 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
        }
      }
    }
  }
}

特定模型之單一內容片段的範例查詢 sample-wknd-single-content-fragment-of-given-model

此範例查詢會質詢：

  • 在特定路徑中類型為 article 的單一內容片段

    • 在該片段中，所有內容格式：

      • HTML
      • Markdown
      • 純文字
      • JSON

範例查詢

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

來自模型的內容片段模型的範例查詢 sample-wknd-content-fragment-model-from-model

此範例查詢會質詢：

  • 單一內容片段
    • 基礎內容片段模型的詳細資訊

範例查詢

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

巢狀內容片段的範例查詢 - 單一模型類型 sample-wknd-nested-fragment-single-model

此查詢會質詢：

  • 在特定路徑中類型為 article 的單一內容片段
    • 在該片段中，被參考 (巢狀) 片段的路徑和作者
NOTE
referencearticle 欄位的資料類型為 fragment-reference。

範例查詢

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

巢狀內容片段的範例查詢 - 多個模型類型 sample-wknd-nested-fragment-multiple-model

單一參考的模型類型

此查詢會質詢：

  • 多個類型為 bookmark 的內容片段
    • 具有片段參考，其會參考特定模型類型 Article 的其他片段。
NOTE
fragments 欄位的資料類型為 fragment-reference，且已選取 Article 模型。查詢將 fragments 以 [Article] 陣列形式傳遞。
{
  bookmarkList {
    items {
        fragments {
          _path
          author
        }
     }
  }
}

多個參考的模型類型

此查詢會質詢：

  • 多個類型為 bookmark 的內容片段
    • 具有片段參考，其會參考特定模型類型 Article 和 Adventure 的其他片段。
NOTE
fragments 欄位的資料類型為 fragment-reference，且已選取 Article、Adventure 模型。查詢將 fragments 以 [AllFragmentModels] 陣列形式傳遞，其使用聯合類型取消參考。
{
  bookmarkList {
    items {
        fragments {
          ... on ArticleModel {
            _path
            author
          }
          ... on AdventureModel {
            _path
            adventureTitle
          }
        }
     }
  }
}

具有內容參考之特定模型的內容片段的範例查詢 sample-wknd-fragment-specific-model-content-reference

此查詢有兩種形式：

  1. 傳回所有內容參考。
  2. 傳回類型為 attachments 的特定內容參考。

此查詢會質詢：

  • 多個類型為 bookmark 的內容片段
    • 具有對其他片段的內容參考

具有預先擷取之參考的多個內容片段的範例查詢 sample-wknd-multiple-fragments-prefetched-references

以下查詢使用 _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
    }
  }
}

具有附件之多個內容片段的範例查詢 sample-wknd-multiple-fragments-attachments

以下查詢傳回所有 attachments - 類型為 content-reference 的特定欄位 (子群組)：

NOTE
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
        }
      }
    }
  }
}

使用UUID參考的特定模型內容片段範例查詢 sample-wknd-fragment-specific-model-uuid-references

此查詢會質詢：

  • 內容片段以及參考的內容片段或資產的UUID
  • 透過JSON屬性_id傳回結果

使用UUID參考的特定模型的內容片段範例查詢 sample-wknd-fragment-specific-model-using-a-uuid-reference

下列查詢使用_id和_path傳回所有內容參考：

{
  articleList {
    items {
        _id
        _path
        title
        featuredImage {
          ... on ImageRef {
            _id
            _path
          }
        }
        authorFragment {
          firstName
          lastName
          profilePicture {
            ... on ImageRef {
              _id
              _path
            }
          }
        }
      }
  }
}

依UUID參考的內容片段範例查詢 sample-wknd-fragment-specific-model-by-uuid-reference

下列查詢會傳回與特定_id相關的所有內容參考：

{
  articleById(_id: "3ce2bf53-7436-4d3e-b19a-2793bc2ca63e") {
    item {
      _id
      _path
      title
      featuredImage {
        ... on ImageRef {
          _id
          _path
        }
      }
      authorFragment {
        firstName
        lastName
        profilePicture {
          ... on ImageRef {
            _id
            _path
          }
        }
      }
    }
  }
}

具有 RTE 內聯參考的單一內容片段的範例查詢 sample-wknd-single-fragment-rte-inline-reference

此查詢會質詢：

  • 在特定路徑中類型為 bookmark 的單一內容片段
    • 其中有 RTE 內聯參考
NOTE
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
      }
    }
  }
}

特定模型的單一內容片段變化的範例查詢 sample-wknd-single-fragment-given-model

此查詢會質詢：

  • 在特定路徑中類型為 author 的單一內容片段
    • 在該片段中，與變化相關的資料：another

範例查詢

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo", variation: "another") {
    item {
        _path
        _variation
        firstName
        lastName
        birthDay
    }
  }
}

特定模型之多個內容片段的名稱變化的範例查詢 sample-wknd-variation-multiple-fragment-given-model

此查詢會質詢：

  • 類型為 author 的內容片段，具有特定變化：another
NOTE
此查詢將針對沒有所指定名稱之變化的內容片段，示範如何備援。

範例查詢

{
  authorList(variation: "another") {
    items {
        _path
        _variation
        firstName
        lastName
        birthDay
    }
  }
}

對指定模式的多個內容片段及其變化的範例查詢 sample-wknd-multiple-fragment-variations-given-model

此查詢會質詢：

  • 類型為 article 的內容片段和所有變化

範例查詢

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

對附加了特定標記的指定模式的內容片段變化的範例查詢 sample-wknd-fragment-variations-given-model-specific-tag

此查詢會質詢：

  • 類型為 article 的內容片段以及具有 WKND : Activity / Hiking 標記的一或多種變化

範例查詢

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

特定地區設定的多個內容片段的範例查詢 sample-wknd-multiple-fragments-given-locale

此查詢會質詢：

  • 在 fr 地區設定中類型為 article 的內容片段

範例查詢

{
  articleList(_locale: "fr") {
    items {
      _path
      authorFragment {
        _path
        firstName
        lastName
        birthDay
      }
      main {
        html
        markdown
        plaintext
        json
      }
    }
  }
}

使用 offset 和 limit 的範例清單查詢 sample-list-offset-limit

此查詢會質詢：

  • 最多包含五篇文章的結果頁面，從​ 完整 ​結果清單中的第五篇文章開始：

範例查詢

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

使用 first 和 after 的範例分頁查詢 sample-pagination-first-after

此查詢會質詢：

  • 最多包含五篇文章的結果頁面，從​ 完整 ​結果清單中的特定游標項目開始：

範例查詢

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

依 _tags ID 進行篩選並排除變化的範例查詢 sample-filtering-tag-not-variations

此查詢會質詢：

  • 類型為 vehicle 且具有 big-block 標記的內容片段
  • (排除變化)

範例查詢

query {
  vehicleList(
    filter: {
    _tags: {
      _expressions: [
        {
          value: "vehicles:big-block"
          _operator: CONTAINS
        }
      ]
    }
  }) {
    items {
      _variation
      _path
      type
      name
      model
      fuel
      _tags
    }
  }
}

依 _tags ID 進行篩選並包含變化的範例查詢 sample-filtering-tag-with-variations

此查詢會質詢：

  • 類型為 vehicle 且具有 big-block 標記的內容片段
  • (包含變化)

範例查詢

{
  enginePaginated(after: "SjkKNmVkODFmMGQtNTQyYy00NmQ4LTljMzktMjhlNzQwZTY1YWI2Cmo5", first: 9 ,includeVariations:true, sort: "name",
    filter: {
    _tags: {
      _expressions: [
        {
          value: "vehicles:big-block"
          _operator: CONTAINS
        }
      ]
    }
  }) {
    edges{
    node {
        _variation
        _path
        name
        type
        size
        _tags
        _metadata {
          stringArrayMetadata {
            name
            value
          }
        }
    }
      cursor
    }
  }
}

DAM 和 Dynamic Media 資產傳遞的範例查詢 sample-queries-delivery-DAM-DM

對於 Web 最佳化影像傳遞 (DAM 資產)：

對於 Dynamic Media 資產的 URL 傳遞

範例內容片段結構 (與 GraphQL 搭配使用) content-fragment-structure-graphql

這些範例查詢是根據以下結構，該結構使用：

範例內容片段結構 (結構描述) sample-content-fragment-models-schemas

對於範例查詢，您使用以下內容模型及其相互關係 (參考 ->)：

公司 model-company

定義公司的基本欄位是：

欄位名稱
資料類型
參考
公司名稱
單行文字
CEO
片段參考 (單一)
人員
員工
片段參考 (多個欄位)
人員

人員 model-person

定義人員的欄位，人員也可以是員工：

欄位名稱
資料類型
參考
名稱
單行文字
名字
單行文字
獎項
片段參考 (多個欄位)
獎項

獎項 model-award

定義獎項的欄位是：

欄位名稱
資料類型
參考
快速鍵/ID
單行文字
標題
單行文字

城市 model-city

定義城市的名稱是：

欄位名稱
資料類型
參考
名稱
單行文字
國家/地區
單行文字
人口
數字
類別
標記

範例內容片段 sample-content-fragments

以下片段用於適當的模型。

公司 fragment-company

公司名稱
CEO
員工
Apple
Steve Jobs
Duke Marsh
Max Caulfield
Little Pony Inc.
Adam Smith
Lara Croft
Cutter Slade
NextStep Inc.
Steve Jobs
Joe Smith
Abe Lincoln

人員 fragment-person

名稱
名字
獎項
Lincoln
Abe
Smith
Adam
Slade
Cutter
Gameblitz
Gamestar
Marsh
Duke
Smith
Joe
Croft
Lara
Gamestar
Caulfield
最大值
Gameblitz
工作
Steve

獎項 fragment-award

快速鍵/ID
標題
GB
Gameblitz
GS
Gamestar
OSC
Oscar

城市 fragment-city

名稱
國家/地區
人口
類別
巴塞爾
瑞士
172258
city:emea
柏林
德國
3669491
city:capital
city:emea
布加勒斯特
羅馬尼亞
1821000
city:capital
city:emea
舊金山
美國
883306
city:beach
city:na
聖荷西
美國
102635
city:na
斯圖加特
德國
634830
city:emea
蘇黎世
瑞士
415367
city:capital
city:emea
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab