recommendations オブジェクト
商品ページで Shopify の商品推奨 API を使用したときに、販売データと商品情報に基づいて関連商品を取得するオブジェクト。本番環境でのみ機能し、推奨商品のリストと件数を返す。
仕様
85 行 / json{
"access": {
"global": false,
"parents": [],
"template": []
},
"deprecated": false,
"deprecation_reason": "",
"description": "Product recommendations become more accurate over time as new orders and product data become available. To learn more about\nhow product recommendations are generated, refer to [Product recommendations](/themes/product-merchandising/recommendations).\n\n> Note:\n> The `recommendations` object returns products only when rendered in a section using the [Product Recommendations API](/api/ajax/reference/product-recommendations)\n> and the [Section Rendering API](/api/section-rendering). To learn about how to include product recommendations in your theme,\n> refer to [Show product recommendations](/themes/product-merchandising/recommendations/show-product-recommendations).",
"properties": [
{
"deprecated": false,
"deprecation_reason": "",
"description": "",
"examples": [],
"return_type": [
{
"type": "boolean",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "Returns `true` when being referenced inside a section that's been rendered using the Product Recommendations API and\nthe Section Rendering API. Returns `false` if not.",
"name": "performed?"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "If `performed?` is `false`, then an [EmptyDrop](/docs/api/liquid/basics#emptydrop) is returned.",
"examples": [],
"return_type": [
{
"type": "array",
"name": "",
"description": "",
"array_value": "product"
}
],
"summary": "The recommended products.",
"name": "products"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "If `performed?` is `false`, then 0 is returned.",
"examples": [],
"return_type": [
{
"type": "number",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The number of recommended products.",
"name": "products_count"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "If `performed?` is `false`, then `nil` is returned.",
"examples": [],
"return_type": [
{
"type": "string",
"name": "",
"description": "",
"array_value": ""
}
],
"summary": "The recommendation intent.",
"name": "intent"
}
],
"summary": "Product recommendations for a specific product based on sales data, product descriptions, and collection relationships.",
"name": "recommendations",
"examples": [],
"json_data": {
"path": "",
"handle": "",
"data_from_file": "{\"products\":[],\"products_count\":4,\"performed?\":true}"
},
"return_type": []
}出典・ライセンス
- Repository:
- https://github.com/Shopify/theme-liquid-docs
- License:
- MIT
このコードは Shopify 著作の MIT ライセンスソースです。 原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。
関連項目
content_for_header オブジェクト
Shopify が必要とするスクリプト(分析・チェックアウト・言語設定など)をすべて動的に出力するオブジェクト。theme.liquid の <head> タグ内に埋め込む必須要素。
metaobjects オブジェクト
ストア全体のメタオブジェクト定義にアクセスするグローバルオブジェクト。個別のメタオブジェクトはタイプとハンドルで参照でき、メタオブジェクト定義のエントリをループで反復処理できる。
additional_checkout_buttons オブジェクト
PayPal Express Checkout など、オフサイト決済に対応した外部決済プロバイダーがストアに設定されているかを真偽値で返す。`content_for_additional_checkout_buttons` と組み合わせて、該当するチェックアウトボタンを条件付きで表示する。
canonical_url オブジェクト
現在のページの正規 URL を取得するオブジェクト。Google などの検索エンジンに対してどのページ版が正規であるかを指定するために使用する。
content_for_index オブジェクト
ホームページに表示するセクションの内容を動的に返すオブジェクト。Liquid インデックステンプレートで必ず使用する。
content_for_additional_checkout_buttons オブジェクト
PayPal、Apple Pay、Google Pay など複数の決済プロバイダが有効になっているとき、その決済ボタンを HTML として出力するオブジェクト。`additional_checkout_buttons` で有無を判定したうえで、このオブジェクトで実際のボタンを表示する。