CatalogSearchParams

非推奨を表示

*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

CatalogSearchParams データタイプは、カタログ検索のパラメータを AvatarEditorService:SearchCatalog() を通じて保存します。

When accessing the value of the CatalogSearchParams.BundleTypes または CatalogSearchParams.AssetTypes プロパティ the returned table will be read-only to avoid confusion when not directly accessing the CatalogSearchParams インスタンス.

たとえば、次のようにこれらのプロパティを使用できます：

local params = CatalogSearchParams.new()

params.SearchKeyword = "Test"

params.MinPrice = 5000

params.MaxPrice = 10000

params.BundleTypes = {Enum.BundleType.Animations, Enum.BundleType.BodyParts}



local types = params.BundleTypes

for _, val in types do

  print(val)

end

-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only

概要

プロパティ

プロパティ

SearchKeyword

string

カタログ結果を検索するキーワード。

MinPrice

number

検索する最低アイテム価格。

0

MaxPrice

number

検索する最大アイテム価格。

デフォルト値: 2147483647

SortType

Enum.CatalogSortType

結果を並べ替える順序、Enum.CatalogSortType で表現されます。

デフォルト値: Enum.CatalogSortType.Relevance

SortAggregation

Enum.CatalogSortAggregation

種類結果を集計するために使用する期間、Enum.CatalogCategoryFilter で表現されます。これは、種類が Enum.CatalogSortType.MostFavorited または Enum.CatalogSortType.BestSelling の場合にのみ適用されます。他の種類のタイプには適用されません。

デフォルト値: Enum.CatalogSortAggregation.AllTime

CategoryFilter

Enum.CatalogCategoryFilter

検索をフィルタするカテゴリ、Enum.CatalogCategoryFilter で表現されます。

デフォルト値: Enum.CatalogCategoryFilter.None

SalesTypeFilter

Enum.SalesTypeFilter

販売タイプは、Enum.SalesTypeFilter によって検索を表現します。

デフォルト値: Enum.SalesTypeFilter.All

BundleTypes

Array<Enum.BundleType>

検索をフィルタするための Enum.BundleType 値を含む配列

デフォルト値: {}

AssetTypes

Array<Enum.AvatarAssetType>

検索をフィルタするための Enum.AvatarAssetType 値を含む配列

IncludeOffSale

boolean

販売中のアイテムを結果に含めるかどうか。

CreatorName

string

指定されたクリエーター名を持つアイテムを検索します。ユーザー、グループ、または両方を検索するかどうかを CatalogSearchParams.CreatorType で指定します。

CreatorType

Enum.CreatorTypeFilter

指定のクリエイタータイプによって作成されたアイテムを検索します。指定されないと、両方の Enum.CreatorTypeFilter.User と Enum.CreatorTypeFilter.Group から作品を返すことになります。検索結果が CatalogSearchParams.CreatorId によって Enum.CreatorTypeFilter.All で HTTP 400 悪いリクエストエラーが発生します。

デフォルト値: Enum.CreatorTypeFilter.All

CreatorId

number

単一のクリエーターIDによって作成されたアイテムを検索するユーザーまたはグループを CatalogSearchParams.CreatorType で指定します。クリエーターID と クリエーター名を検索することはサポートされていません;両方ではなく、1つを指定してください。

0

Limit

number

返すアイテムの数を指定します。10、28、30、60、および120を受け入れます。デフォルトは 30 です。