工具 API
catalog_ product_ get
Gets products from a product catalog. You can filter by `product_ids`, `sku_ids`, `product_set_ids`, or `conditions`, and sort by product availability or custom sort conditions. When `product_ids` or `sku_ids` is provided, `order` and `conditions` are ignored. In v1.3, `bc_id` and `catalog_id` are strings; earlier v1.2 numeric parameter names/types changed to string-based `product_ids`, `product_set_ids`, and `case_sensitive`-style filtering.
调用信息
- 工具标识
- tiktok-ads.catalog_product_get
- 服务提供方
- TikTok 广告
- 平均响应
- 0 ms
- 近 7 天调用
- 0
输入参数
bc_id必填Business Center ID.
catalog_id必填Catalog ID.
conditionsFiltering conditions. When you specify a filtering condition, all fields inside each condition object are required except `case_senstive`. Ignored when `product_ids` or `sku_ids` is specified. Supported `field` values under `conditions` with Available for and case sensitivity: `sku_id` (Available for: E-commerce; case-sensitive: No), `product_id` (Available for: E-commerce, Entertainment; case-sensitive: E-commerce Yes), `audit_status` (Available for: E-commerce, Entertainment; case-sensitive: E-commerce Yes), `title` (Available for: E-commerce, Entertainment, Auto-Inventory, Auto-Model; case-sensitive: E-commerce No, Auto-Inventory Yes, Auto-Model Yes), `description` (Available for: E-commerce, Flight, Entertainment, Auto-Inventory; case-sensitive: E-commerce No, Flight Yes, Auto-Inventory Yes), `brand` (Available for: E-commerce; case-sensitive: No), `item_group_id` (Available for: E-commerce; case-sensitive: No), `google_product_category` (Available for: E-commerce; case-sensitive: No), `price_info` (Available for: E-commerce; case-sensitive: Yes), `sale_price` (Available for: E-commerce; case-sensitive: Yes), `sale_price_effective_start_date` (Available for: E-commerce; case-sensitive: Yes), `sale_price_effective_end_date` (Available for: E-commerce; case-sensitive: Yes), `condition` (Available for: E-commerce, Auto-Inventory; case-sensitive: E-commerce Yes, Auto-Inventory No), `age_group` (Available for: E-commerce; case-sensitive: Yes), `color` (Available for: E-commerce; case-sensitive: No), `gender` (Available for: E-commerce; case-sensitive: Yes), `size` (Available for: E-commerce; case-sensitive: No), `material` (Available for: E-commerce; case-sensitive: No), `pattern` (Available for: E-commerce; case-sensitive: No), `product_category` (Available for: E-commerce; case-sensitive: No), `custom_label_0` (Available for: E-commerce, Flight; case-sensitive: No), `custom_label_1` (Available for: E-commerce, Flight; case-sensitive: No), `custom_label_2` (Available for: E-commerce, Flight; case-sensitive: No), `custom_label_3` (Available for: E-commerce, Flight; case-sensitive: No), `custom_label_4` (Available for: E-commerce, Flight; case-sensitive: No), `active_status` (Available for: E-commerce; case-sensitive: Yes), `flight_id` (Available for: Flight; case-sensitive: No), `origin_airport` (Available for: Flight; case-sensitive: No), `destination_airport` (Available for: Flight; case-sensitive: No), `origin_city` (Available for: Flight; case-sensitive: No), `destination_city` (Available for: Flight; case-sensitive: No), `cabin_class` (Available for: Flight; case-sensitive: No), `airline_company` (Available for: Flight; case-sensitive: No), `price` (Available for: Flight; case-sensitive: No), `media_title_id` (Available for: Entertainment), `availability` (Available for: Entertainment, Auto-Inventory; case-sensitive: Auto-Inventory No), `timeline` (Available for: Entertainment), `genres` (Available for: Entertainment), `vehicle_id` (Available for: Auto-Inventory, Auto-Model; case-sensitive: Yes), `state_of_vehicle` (Available for: Auto-Inventory; case-sensitive: No), `make` (Available for: Auto-Inventory, Auto-Model; case-sensitive: Yes), `model` (Available for: Auto-Inventory, Auto-Model; case-sensitive: Yes), `trim` (Available for: Auto-Inventory, Auto-Model; case-sensitive: Yes), `year` (Available for: Auto-Inventory, Auto-Model; case-sensitive: Auto-Inventory No, Auto-Model Yes), `vin` (Available for: Auto-Inventory; case-sensitive: Yes), `mileage` (Available for: Auto-Inventory; case-sensitive: No), `body_style` (Available for: Auto-Inventory; case-sensitive: No), `drivetrain` (Available for: Auto-Inventory; case-sensitive: No), `fuel_type` (Available for: Auto-Inventory; case-sensitive: No), and `city` (Available for: Auto-Inventory order-by only, not supported under `conditions`).
orderOrdering settings. Ignored when `product_ids` or `sku_ids` is specified. Supported `custom_order.field` values with Available for: `sku_id` (E-commerce), `product_id` (E-commerce), `title` (E-commerce, Auto-Inventory, Auto-Model), `description` (E-commerce, Flight, Auto-Inventory), `brand` (E-commerce), `item_group_id` (E-commerce), `google_product_category` (E-commerce), `price_info` (E-commerce), `sale_price` (E-commerce), `sale_price_effective_start_date` (E-commerce), `sale_price_effective_end_date` (E-commerce), `color` (E-commerce), `size` (E-commerce), `material` (E-commerce), `pattern` (E-commerce), `product_category` (E-commerce), `custom_label_0` (E-commerce, Flight), `custom_label_1` (E-commerce, Flight), `custom_label_2` (E-commerce, Flight), `custom_label_3` (E-commerce, Flight), `custom_label_4` (E-commerce, Flight), `flight_id` (Flight), `origin_airport` (Flight), `destination_airport` (Flight), `origin_city` (Flight), `destination_city` (Flight), `cabin_class` (Flight), `airline_company` (Flight), `price` (Flight), `vehicle_id` (Auto-Inventory, Auto-Model), `make` (Auto-Inventory, Auto-Model), `model` (Auto-Inventory, Auto-Model), `trim` (Auto-Inventory, Auto-Model), `year` (Auto-Inventory, Auto-Model), `vin` (Auto-Inventory), `mileage` (Auto-Inventory), and `city` (Auto-Inventory only; order-by supported, but not supported under `conditions`). Entertainment catalog products do not support custom ordering-by fields in the provided table.
pageCurrent page number. At most 10,000 results can be returned, so `page * page_size` must not exceed 10,000.
page_sizePage size. Default is 10. Maximum is 500.
product_idsIDs of the products to retrieve. Maximum 1,000 product IDs. `product_ids` and `sku_ids` cannot be specified at the same time. For mini series catalogs, `product_ids` is the only supported filter.
product_set_idsIDs of the product sets to retrieve. Maximum 100 IDs.
sku_idsSKU IDs to retrieve. Maximum 1,000 items. Each SKU ID can be up to 100 characters and cannot contain emojis. Duplicate SKU IDs are not supported. `product_ids` and `sku_ids` cannot be specified at the same time.