如何访问Shopify自定义元数据？

Question

**如何在Shopify中访问自定义元数据（Metafields）？** 在Shopify开发中，经常会遇到需要扩展产品、订单或客户等对象的存储能力，这时就会用到自定义元数据（Metafields）。那么，如何通过Shopify Admin API或Liquid模板访问这些Metafields？常见问题包括：如何查询特定资源的Metafield？如何在前端展示Metafield数据？如何确保访问权限和API版本兼容性？本文将介绍使用Admin API和Liquid模板访问Shopify自定义Metafields的具体方法与注意事项。

Answer 1

如何在Shopify中访问自定义元数据（Metafields）？

在Shopify开发中，Metafields 是一种非常强大的机制，允许开发者为资源（如产品、订单、客户等）添加自定义数据字段。本文将从基础到进阶，系统性地讲解如何在 Shopify Admin API 和 Liquid 模板中访问和操作 Metafields，并探讨相关的技术细节与最佳实践。

1. Metafields 基础概念

Metafields 是 Shopify 中用于扩展资源元数据的自定义字段。它们由命名空间（namespace）和键（key）组成，支持多种数据类型，如字符串、整数、布尔值、JSON 对象等。Metafields 可以附加到多种资源类型上，包括：

• Product
• Variant
• Collection
• Order
• Customer
• Shop

每个 Metafield 必须指定其所属的资源类型、命名空间和键，例如：

{
  "metafield": {
    "namespace": "custom_data",
    "key": "color",
    "value": "red",
    "value_type": "string"
  }
}

2. 使用 Shopify Admin API 访问 Metafields

Shopify Admin API 提供了完整的接口用于创建、读取、更新和删除 Metafields。开发者可以通过 GraphQL 或 REST API 实现。

2.1 查询特定资源的 Metafield

使用 GraphQL 查询产品 Metafields 的示例：

{
  product(id: "gid://shopify/Product/123456789") {
    metafields(first: 10) {
      edges {
        node {
          namespace
          key
          value
        }
      }
    }
  }
}

若使用 REST API，则可通过如下方式获取产品 Metafields：

GET /admin/api/2023-10/products/123456789/metafields.json

2.2 创建和更新 Metafields

创建一个产品 Metafield 的 GraphQL 示例：

mutation {
  metafieldCreate(
    input: {
      namespace: "custom_data",
      key: "color",
      value: "blue",
      valueType: STRING,
      ownerType: PRODUCT,
      ownerId: "gid://shopify/Product/123456789"
    }
  ) {
    metafield {
      id
      namespace
      key
      value
    }
  }
}

3. 在 Liquid 模板中访问 Metafields

在前端模板中，Liquid 提供了便捷的方式访问资源上的 Metafields。访问方式取决于资源类型。

3.1 访问产品 Metafields

假设产品有一个命名空间为 custom_data、键为 color 的 Metafield，Liquid 中的访问方式如下：

{{ product.metafields.custom_data.color }}

3.2 访问变体（Variant）Metafields

对于产品变体，可以使用如下方式：

{% for variant in product.variants %}
  {{ variant.metafields.custom_data.size }}
{% endfor %}

4. 权限与 API 版本兼容性

访问 Metafields 需要确保 API 的权限配置正确。Shopify Admin API 的访问权限取决于应用的 scopes，访问 Metafields 至少需要如下 scopes：

• read_metafields
• write_metafields（如需写入）

此外，Shopify 的 API 是版本化的，建议始终使用最新的稳定版本（如 2023-10）以确保功能可用性和兼容性。

5. 常见问题与解决方案

问题	原因	解决方案
无法访问 Metafield 数据	权限不足或 API 版本过旧	检查应用的 scopes 并升级 API 版本
Metafield 数据未显示在前端	Liquid 模板未正确引用命名空间或键	检查命名空间与键拼写，使用 {{ product.metafields | json }} 调试
GraphQL 查询返回空值	Metafield 未正确附加或资源 ID 错误	确认资源 ID 正确并确保 Metafield 已成功创建

6. 总结

Shopify 的 Metafields 为资源扩展提供了极大的灵活性。无论是通过 Admin API 进行后台操作，还是在 Liquid 模板中进行前端展示，开发者都可以根据需求选择合适的访问方式。理解权限配置、命名空间结构和 API 版本控制是成功使用 Metafields 的关键。