メタフィールド定義の構成部分
メタフィールド定義によって、メタフィールドを適用するストアの構成部分とメタフィールドに入力できる値が指定されます。以下のタスクを実行する前に、メタフィールド定義の構成部分を理解するようにしてください。
メタフィールドの定義は、以下の部分から構成されています。
- 名前:管理画面でメタフィールドを特定するために使用されます
- キー (たとえば、ストアの特定の部分のメタフィールドをグループ化するため)
- メタフィールドに入力する値に関する情報などの説明 (オプション)
- テキスト、ファイル、URLなどのタイプ
- 文字制限、最小値と最大値などの検証 (オプション)
たとえば、商品の賞味期限のメタフィールド定義には、products.expiration_date
のキー,日付の値、YYYY/MM/DDの形式で日付を入力してくださいという説明が含まれる場合があります。その検証では、2021/07/01
から2025/12/31
までの日付の値のみが有効と指定することができます。
メタフィールド定義の構成部分の詳細については、以下の表を参照するか、「メタフィールドの開発者ドキュメント」を確認してください。
Name | 説明 |
---|---|
ネームスペースとキー | ネームスペースとキーを合わせて、メタフィールドの固有IDを作成します。これらは「 ネームスペースを使用して類似のメタフィールドをグループ化できますが、それぞれのネームスペースとキーの組み合わせは固有である必要があります。たとえば、ネームスペース「products」を使用して、商品メタフィールドのキー「expiration_date」および「rating」をグループ化することができます。 標準定義では、標準化されたネームスペースとキーが使用されますが、カスタム定義では、編集可能な自動的に生成されたネームスペースとキーが使用されます。 |
値 | メタフィールドに含まれる情報のタイプと形式。たとえば、プレーンテキスト、URL、整数。 メタフィールドには、コンテンツタイプでサポートされている値のみを追加できます。一般的なメタフィールドのタイプでサポートされている値について詳しくは、「メタフィールドのコンテンツタイプと値」を参照してください。 |
説明 (任意) | 正しい値を入力するのに役立つメタフィールドの説明。説明は、メタフィールドの値を追加する管理画面のページに表示されます。 |
検証 (オプション) | メタフィールドに入力できる値を限定するために設定できます。最小値と最大値を設定したり、正規表現を使用してメタフィールドで使用できる値の範囲を管理したりすることができます。 |