大数跨境

元对象分析的可查询功能现已在管理 API 中提供

元对象分析的可查询功能现已在管理 API 中提供 Shopify电商独立站
2026-10-20
3
导读:从 GraphQL Admin API 版本 2027-01 开始,您可以读取和配置元对象定义中的分析可查询能力(analytics Queryable capability)。此功能适用于创建、更新

从 GraphQL Admin API 版本 2027-01 开始,您可以读取和配置元对象定义上的 analyticsQueryable 功能。这适用于创建、更新或检查元对象定义的应用程序。除非您希望您的应用程序控制是否可以在分析中查询元对象定义,否则无需采取任何操作。

变更内容

GraphQL Admin API 现在为 metaobject 定义公开了可查询的分析功能。

您可以读取 MetaobjectCapabilities.analyticsQueryable,其中包括:

  • eligible: 表示 metaobject 定义是否可以使用该功能。如果其至少有一个字段使用了与分析兼容的类型,则该定义符合资格。
  • enabled: 表示该功能当前是否已启用。

您还可以在创建或更新 metaobject 定义时通过以下方式设置此功能:

  • MetaobjectCapabilityCreateInput.analyticsQueryable
  • MetaobjectCapabilityUpdateInput.analyticsQueryable
  • MetaobjectCapabilityAnalyticsQueryableInput.enabled

MetaobjectCapabilityType 枚举现在包括 ANALYTICS_QUERYABLE,而 MetaobjectUserErrorCode 包括 CAPABILITY_NOT_ELIGIBLE,用于无法启用该功能的定义。

受影响对象

此更改适用于使用 GraphQL Admin API 版本 2027-01 或更高版本来创建、更新或检查元对象定义的应用程序。

使用早期版本的应用程序看不到 analyticsQueryable 字段、输入、枚举值或错误代码。现有应用程序无需进行更改,除非它们希望支持元对象定义的分析可查询性。

为何重要

您现在可以通过公共 GraphQL Admin API 确定 metaobject 定义是否符合分析查询条件并启用该功能。这使得 metaobject 定义与 metafield 定义保持一致,让您能够统一控制哪些自定义数据类型会出现在分析结果中。

操作指南

无需采取任何操作。

如果您希望使用此功能:

  1. 将您的应用程序更新为使用 GraphQL Admin API 版本 2027-01 或更高版本。
  2. 更新您的元对象定义查询或变更以包含 analyticsQueryable。

例如,要读取 metaobject 定义的功能,请包含:

capabilities { analyticsQueryable { eligible enabled } }

在创建或更新元对象定义时,在功能输入中设置 analyticsQueryable.enabled。先检查 eligible,并在变更用户错误中处理 CAPABILITY_NOT_ELIGIBLE。使用此方法确认定义是否支持该功能,并在不支持时提供清晰的反馈。

相关文档

  • GraphQL Admin API 参考
  • Shopify 应用中的 Metaobjects
【声明】内容源于网络
0
0
Shopify电商独立站
1234
内容 7146
粉丝 0
Shopify电商独立站 1234
总阅读87.4k
粉丝0
内容7.1k