ファセット検索の使用
日本語翻訳に関する免責事項
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
ファセットをリクエストするには、リクエストにwidget.items.search.facetオブジェクトを追加します。
メモ
facetsを取得する前に、管理者がSearchでfacetsの属性を設定していることを確認してください。
このオブジェクトのデータモデルについては、Search and Recommendation APIリファレンスを参照してください。
次のセクションでは、facetsを取得するためのサンプル要求を示します。
利用可能なすべてのfacetsを取得する
使用可能なすべてのfacetsを取得するには、allキーをtrueに設定します。
次に、要求の例を示します。
{ "widget": { "items": [ { "rfk_id": "rfkid_7", "entity": "content", "search": { "facet": { "all": true } } } ] }, "context": { "locale": { "country": "us", "language": "en" }, "user": { "uuid": "159871551-io-0i-4e-1p-s6ill6vhenvysbu27bbk-1664389956369" } } }
この要求に対する応答は次のとおりです。
{ "widgets": [ { "rfk_id": "rfkid_7", "entity": "content", "facet": [ { "name": "product", "label": "Product", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiRXhwZXJpZW5jZSBQbGF0Zm9ybSAoWFApIn0=", "text": "Experience Platform (XP)", "count": 130 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiRXhwZXJpZW5jZSBNYW5hZ2VyIChYTSkifQ==", "text": "Experience Manager (XM)", "count": 80 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiQ29udGVudCBIdWIifQ==", "text": "Content Hub", "count": 73 } ... ] }, { "name": "type", "label": "Type", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoidHlwZSIsInZhbHVlIjoib3RoZXIifQ==", "text": "other", "count": 990 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoidHlwZSIsInZhbHVlIjoibmV3cyJ9", "text": "news", "count": 623 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoidHlwZSIsInZhbHVlIjoiQmxvZ3MifQ==", "text": "Blogs", "count": 519 } ... ] } ] } ], "dt": 62, "ts": 1669437158552 }
応答facetオブジェクトには、使用可能な2つのfacets productとtypeが表示されていることがわかります。各ファセット配列には、そのファセット型内のファセット値のオブジェクトがあります。
1つのファセットの値を取得する
ファセットの値を取得するには、ファセットのnameを渡してから、必要な値の数を必要な値のmax数として渡します。
たとえば、製品ファセットに5つの値を表示するとします。次に、要求の例を示します。
{ "widget": { "items": [ { "rfk_id": "rfkid_7", "entity": "content", "search": { "facet": { "types": [ { "name": "product", "max": 5 } ] } } } ] }, "context": { "locale": { "country": "us", "language": "en" }, "user": { "uuid": "159871551-io-0i-4e-1p-s6ill6vhenvysbu27bbk-1664389956369" } } }
この要求に対する応答は次のとおりです。
{ "widgets": { "rfkid_7": { "facet": { "product": { "label": "Product", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiRXhwZXJpZW5jZSBQbGF0Zm9ybSAoWFApIn0=", "text": "Experience Platform (XP)", "count": 137 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiRXhwZXJpZW5jZSBNYW5hZ2VyIChYTSkifQ==", "text": "Experience Manager (XM)", "count": 83 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiQ29udGVudCBIdWIifQ==", "text": "Content Hub", "count": 73 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiQ3VzdG9tZXIgRGF0YSBQbGF0Zm9ybSJ9", "text": "Customer Data Platform", "count": 68 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoicHJvZHVjdCIsInZhbHVlIjoiT3JkZXJDbG91ZCJ9", "text": "OrderCloud", "count": 35 } ] } } } }, "dt": 38, "ts": 1666323029989 }
応答facetオブジェクトには、5つの値を持つ1つのファセットProductが表示されます。
動的属性コレクションから上位のfacetsを取得する
動的属性コレクションから上位値を取得するには、動的属性コレクション名をnameとして渡します。 max値を渡して、表示する値の数を指定することもできます。
たとえば、attribute_tags動的属性コレクションの上位5つの値を表示したいとします。次に、要求の例を示します。
{ "widget": { "items": [ { "rfk_id": "rfkid_7", "entity": "product", "search": { "facet": { "types": [ { "name": "attribute_tags", "max": 5 } ] } } } ] }, "context": { "locale": { "country": "us", "language": "en" } } }
この要求に対する応答は次のとおりです。
{ "widgets": [ { "rfk_id": "rfkid_7", "entity": "product", "facet": [ { "name": "attribute_tags.ID13", "label": "Material", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNyIsInZhbHVlIjoiVGV4dGlsZSJ9", "text": "Textile", "count": 3135 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNyIsInZhbHVlIjoiUGxhc3RpYyJ9", "text": "Plastic", "count": 2852 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNyIsInZhbHVlIjoiQWx1bWludW0ifQ==", "text": "Aluminum", "count": 2691 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNyIsInZhbHVlIjoiUG9seWVzdGVyIn0=", "text": "Polyester", "count": 2220 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNyIsInZhbHVlIjoiTGVhdGhlciJ9", "text": "Leather", "count": 2109 } ] }, { "name": "attribute_tags.ID354", "label": "Type - Engine", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzNTYiLCJ2YWx1ZSI6IlR3aW4gQ2FtIFN0eWxlIn0=", "text": "Twin Cam Style", "count": 23137 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzNTYiLCJ2YWx1ZSI6IkV2b2x1dGlvbiBTdHlsZSJ9", "text": "Evolution Style", "count": 14384 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzNTYiLCJ2YWx1ZSI6Ik1pbHdhdWtlZS1FaWdodCAxMDcifQ==", "text": "Milwaukee-Eight 107", "count": 13086 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzNTYiLCJ2YWx1ZSI6Ik1pbHdhdWtlZS1FaWdodCAxMTQifQ==", "text": "Milwaukee-Eight 114", "count": 12629 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzNTYiLCJ2YWx1ZSI6Ik1pbHdhdWtlZS1FaWdodCAxMTcgICJ9", "text": "Milwaukee-Eight 117 ", "count": 10246 } ] }, { "name": "attribute_tags.ID2", "label": "Color", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzIiwidmFsdWUiOiJCbGFjayJ9", "text": "Black", "count": 45536 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzIiwidmFsdWUiOiJHcmF5In0=", "text": "Gray", "count": 7904 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzIiwidmFsdWUiOiJCbHVlIn0=", "text": "Blue", "count": 6628 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzIiwidmFsdWUiOiJDaHJvbWUifQ==", "text": "Chrome", "count": 5021 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQzIiwidmFsdWUiOiJXaGl0ZSJ9", "text": "White", "count": 4843 } ] } ... ] } ], "dt": 31, "ts": 1669044364271 }
応答facetオブジェクトには、attribute_tags.ID136 (米国サイズ) とattribute_tags.ID138 (性別) の2つのファセットタイプがあり、それぞれに多くの値があります。
動的属性コレクションの特定の属性から値を取得する
動的属性コレクションから特定の属性を取得するには、必要な特定の属性の名前を渡します。
たとえば、attribute_tags動的属性コレクションからattribute_tags.ID18属性とattribute_tags.ID12属性を取得するとします。次に、要求の例を示します。
{ "widget": { "items": [ { "rfk_id": "rfkid_7", "entity": "product", "search": { "facet": { "types": [ { "name": "attribute_tags.ID18" }, { "name": "attribute_tags.ID12" } ] } } } ] }, "context": { "locale": { "country": "us", "language": "en" } } }
この要求に対する応答は次のとおりです。
{ "widgets": [ { "rfk_id": "rfkid_7", "entity": "product", "facet": [ { "name": "attribute_tags.ID18", "label": "U.S. Size", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxMyIsInZhbHVlIjoiTWVkaXVtIn0=", "text": "Medium", "count": 5166 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxMyIsInZhbHVlIjoiTGFyZ2UifQ==", "text": "Large", "count": 5003 }, ... ] }, { "name": "attribute_tags.ID12", "label": "Size", "value": [ { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNSIsInZhbHVlIjoiTGFyZ2UifQ==", "text": "Large", "count": 2513 }, { "id": "facetid_eyJ0eXBlIjoiZXEiLCJuYW1lIjoiYXR0cmlidXRlX3RhZ3MuSUQxNSIsInZhbHVlIjoiTWVkaXVtIn0=", "text": "Medium", "count": 2476 }, ... ] } ] } ], "dt": 531, "ts": 1669044284670 }