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