概述
元字段(Metafield)用于为 SHOPLINE 资源添加自定义数据。你可以为商品、订单、客户、页面等资源存储额外信息,并在商家后台、Open API 和主题模板中进行读取和展示。
应用场景
元字段的应用场景举例说明如下:
-
在商品维度维护补充信息(如材质说明、尺寸补充、扩展展示字段)。
-
在订单或客户维度记录业务属性(如自定义备注、流程标签)。
-
在主题页面中展示自定义内容,满足页面动态 展示需求。
元字段的组成结构
元字段由以下内容组成:
| 内容 | 说明 |
|---|---|
| 资源 | 元字段所归属的资源类型,参考 资源类型。 |
| 资源 ID | 元字段所归属的资源 ID。 |
| 命名空间 | 元字段所属的命名空间。创建后不支持修改。 |
| 键名 | 元字段在命名空间中的唯一标识符。创建后不支持修改。 |
| 数据类型 | 元字段的数据类型,例如 single_line_text_field 和 number_integer,更多信息查看 数据类型。 |
| 值 | 存储在元字段中的值,均为字符串类型。 |
| 名称 | 元字段定义名称。可用于标识其使用场景。 |
| 描述 | 元字段定义说明。 |
资源类型
元字段可归属的资源类型如下:
| 资源类型 | 接口对应枚举值 | 说明 |
|---|---|---|
| 商品 | products | 为商品扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 商品分类 | collections | 为商品分类扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 商品款式 | variants | 为商品款式扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 页面 | pages | 为页面扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 客户 | customers | 为客户扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 博客 | articles | 为博客扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 博客集合 | blogs | 为博客集合扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 订单 | orders | 为订单扩展自定义数据。支持通过商家后台和 Open API 管理。 |
| 公司 | companies | 为公司扩展自定义数据。商家后台仅对 Enterprise 店铺开放,可通过 Open API 管理。 |
| 店铺 | shop | 为店铺扩展自定义数据。仅支持通过 Open API 管理。 |
元字段定义
元字段定义(Metafield definition)规定某类资源可以使用的元字段及其数据结构。元字段定义不等同于具体资源实例上的元字段值。你可以先创建元字段定义,以确定数据类型、配置数据校验规则,并支持在 SHOPLINE 商家后台中展示和管理元字段。对于临时扩展或尚未确定字段模型的场景,也可以直接写入未定义元字段。
本节先说明如何创建与管理元字段定义,再介绍写入元字段值时“已定义元字段”与“未定义元字段”两种模式的区别与适用场景。
管理方式
元字段定义可通过以下两种方式创建与管理(本节不涉及元字段值的增删改查):
-
在 SHOPLINE 商家后台进入 设置 > 自定义数据,按需增加元字段定义。详情参考 元字段功能使用指南。
-
通过 REST Admin API 新增、更新、删除或查询元字段定义。详情参考 元字段定义使用说明。
已定义与未定义元字段
写入元字段值时,系统会根据资源类型、命名空间、键名和数据类型判断是否已存在对应的元字段定义,元字段分为以下两类:
已定义元字段
如果需要对相同的资源类型、命名空间、键名和数据类型的元字段进行统一管理,你可以使用元字段定义相关接口进行操作,参考 元字段定义使用说明。
采用已定义元字段有助于进行权限控制、后台协作和数据规范管理,推荐使用此方案。
未定义元字段
未定义元字段适用于临时扩展或尚未确定字段模型的场景。你可以通过 批量操作元字段 直接写入元字段的值。需要注意的 是,未定义的元字段不支持数据规则校验,因此不建议作为长期的数据存储方案。
Metafields SEO数据优化
Meta Tag 价值
Meta Tag是描述页面内容的文本片段;Meta Tag一般包含MetaTitle、Meta Description。Meta Tag不会出现在页面本身上,而只会出现在页面的源代码中。Meta Tag本质上是内容描述符,有助于告诉Google等搜索引擎网页是关于什么内容的。 商家对站内URL的Meta Tag 进行优化,有利于Google蜘蛛抓取、分析和收录、SERP自然排名等。 您可以通过OpenAPI来新增/修改/查询/删除拥有SEO信息的所有资源的 SEO 数据。
前置条件
- 熟悉Metafield,了解 Metafield 是如何工作的
- 了解Metafield的OpenAPI
管理SEO信息
您可以在商家后台管理资源的SEO信息。 例如,在商家后台创建商品后,商品详情页面的meta_title和meta_description将默认取商品的标题和描述,您有以下两个方法商品详情页面的页面标题和描述:
- 通过商家后台,在资源的编辑页面编辑资源对应页面的SEO信息;
- 通过Metafield的OpenAPI编辑资源对应页面的SEO信息;
页面的 meta_title 和 meta_description 存储在 Metafield 中 “seo” 的 namespace,且类型为 single_line_text_field。
通过Metafield的OpenAPI编辑资源对应页面的SEO信息
第一步,通过 批量查询元字段 OpenAPI,查询SEO元字段的metafield Id;
第二步,通过 更新元字段 OpenAPI,编辑的SEO信息,参考以下资源SEO的存储方式;
- namespace:seo
- key:seoTitle、seoDescription
- resource:
- 首页:shop(首页SEO资源使用店铺资源的Metafield查询/编辑接口)
- 商品:products
- 商品分类:collections
- 博客集:blogs
- 博客:articles
- 自定义页面:pages
- 类型:single_line_text_field