应用现在可以在capabilities.analytics_queryable中为metaobject定义设置shopify.app.toml,这使得这些定义上兼容的字段可在Shopify分析和ShopifyQL中进行查询。此功能适用于在应用配置中声明metaobject定义的应用。无需采取任何操作,因为除非添加该键,否则该功能默认处于关闭状态。
变更内容
在 shopify.app.toml 的 [metaobjects.app.
此前,应用只能通过 GraphQL Admin API 设置此功能,且仅适用于未在 TOML 中管理的定义。由于通过 API 读取声明式定义是只读的,因此无法使其可查询。
受影响范围
此功能适用于在shopify.app.toml中声明metaobject定义的应用。现有定义不会发生变化。如果某个定义未包含该键,则该功能保持关闭状态。
以下情况不适用:
- 通过GraphQL管理API创建的metaobject定义。对于这些定义,请在API版本2027-01或更高版本中使用metaobjectDefinitionCreate或metaobjectDefinitionUpdate突变来设置analyticsQueryable。
- 由商家拥有的元对象定义。商家可在 Shopify 管理后台自行开启或关闭这些定义的分析功能。
操作指南
无需执行任何操作。若要在分析功能中查询已声明的元对象定义:
- 在shopify.app.toml的定义中添加capabilities.analytics_queryable = true,并确保其至少有一个字段具有分析兼容类型。
- 将应用配置部署到开发商店。
- 确认在GraphQL管理API版本2027-01或更高版本中,定义的capabilities.analyticsQueryable.enabled字段为true,并且其字段出现在引用它的产品、变体、客户或订单元字段的分析报告中。
此示例使designer metaobject的country字段可查询。请替换为您自己的定义和字段。如果定义的字段中没有一个是兼容类型,发布将验证失败,因此在部署前请添加或更改一个字段。
相关文档
- 使您的元对象在分析功能中可查询
- 元对象 TOML 参考
- metaobjectDefinitionCreate 变异

