动态广告所使用目录中的商品。参阅动态广告,目录设置。
从 2021 年 9 月 14 日 12.0 版开始,商品节点上的 review_status
字段将停用。对于 11.0 及更早版本,review_status
将始终返回空字符串
不要在此端点使用分页。分页不完整,可能会导致商品重复或缺失。不要使用分页来完整呈现商品目录。
例如,获取名称包含单词 shoe
的商品名称和类别:
curl -G \ -d 'fields=["category","name"]' \ -d 'filter={"name":{"i_contains":"shoe"}}' \ -d 'summary=true' \ -d 'access_token=<ACCESS_TOKEN>' https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>/products
响应:
{ "data": [ { "category": "mens_shoes", "name": "Awesome Mens Shoes in Black", "id": "1234" }, .... { "category": "mens_shoes", "name": "Hipster Mens Shoes in Red", "id": "5678" } ], .... "summary": { "total_count": 316 } }
Products that a catalog contains
您还可以筛选结果:
字段名称 | 说明 | 类型 | 是否必需 |
---|---|---|---|
|
| 否 |
GET /v19.0/{product-catalog-id}/products HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'/{product-catalog-id}/products',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
"/{product-catalog-id}/products",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{product-catalog-id}/products",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{product-catalog-id}/products"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
参数 | 描述 |
---|---|
bulk_pagination boolean | Used for iterating over the edge in large chunks |
error_priority enum {HIGH, LOW, MEDIUM} | A filter for items having errors with the given priority. We suggest looking at HIGH priority errors first. Priorities are decided based on both the issue type (how severe this issue is) and the item (how important this item is). |
error_type enum {ADDRESS_BLOCKLISTED_IN_MARKET, AR_DELETED_DUE_TO_UPDATE, AR_POLICY_VIOLATED, AVAILABLE, BAD_QUALITY_IMAGE, BIZ_MSG_AI_AGENT_DISABLED_BY_USER, CANNOT_EDIT_SUBSCRIPTION_PRODUCTS, CHECKOUT_DISABLED_BY_USER, COMMERCE_ACCOUNT_NOT_LEGALLY_COMPLIANT, CRAWLED_AVAILABILITY_MISMATCH, DA_DISABLED_BY_USER, DA_POLICY_VIOLATION, DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT, DUPLICATE_IMAGES, DUPLICATE_TITLE_AND_DESCRIPTION, EMPTY_AVAILABILITY, EMPTY_CONDITION, EMPTY_DESCRIPTION, EMPTY_IMAGE_URL, EMPTY_PRODUCT_URL, EMPTY_SELLER_DESCRIPTION, EMPTY_TITLE, EXTERNAL_MERCHANT_ID_MISMATCH, GENERIC_INVALID_FIELD, GROUPS_DISABLED_BY_USER, HIDDEN_UNTIL_PRODUCT_LAUNCH, IMAGE_FETCH_FAILED, IMAGE_FETCH_FAILED_BAD_GATEWAY, IMAGE_FETCH_FAILED_FILE_SIZE_EXCEEDED, IMAGE_FETCH_FAILED_FORBIDDEN, IMAGE_FETCH_FAILED_LINK_BROKEN, IMAGE_FETCH_FAILED_TIMED_OUT, IMAGE_RESOLUTION_LOW, IN_ANOTHER_PRODUCT_LAUNCH, INACTIVE_SHOPIFY_PRODUCT, INVALID_COMMERCE_TAX_CATEGORY, INVALID_CONSOLIDATED_LOCALITY_INFORMATION, INVALID_DEALER_COMMUNICATION_PARAMETERS, INVALID_DMA_CODES, INVALID_FB_PAGE_ID, INVALID_IMAGES, INVALID_MONETIZER_RETURN_POLICY, INVALID_OFFER_DISCLAIMER_URL, INVALID_OFFER_END_DATE, INVALID_PRE_ORDER_PARAMS, INVALID_RANGE_FOR_AREA_SIZE, INVALID_RANGE_FOR_BUILT_UP_AREA_SIZE, INVALID_RANGE_FOR_NUM_OF_BATHS, INVALID_RANGE_FOR_NUM_OF_BEDS, INVALID_RANGE_FOR_NUM_OF_ROOMS, INVALID_RANGE_FOR_PARKING_SPACES, INVALID_SHELTER_PAGE_ID, INVALID_SHIPPING_PROFILE_PARAMS, INVALID_SUBSCRIPTION_DISABLE_PARAMS, INVALID_SUBSCRIPTION_ENABLE_PARAMS, INVALID_SUBSCRIPTION_PARAMS, INVALID_VEHICLE_STATE, INVALID_VIRTUAL_TOUR_URL_DOMAIN, INVENTORY_ZERO_AVAILABILITY_IN_STOCK, ITEM_GROUP_NOT_SPECIFIED, ITEM_NOT_SHIPPABLE_FOR_SCA_SHOP, ITEM_OVERRIDE_EMPTY_AVAILABILITY, ITEM_OVERRIDE_EMPTY_PRICE, ITEM_OVERRIDE_NOT_VISIBLE, ITEM_STALE_OUT_OF_STOCK, MARKETPLACE_DISABLED_BY_USER, MINI_SHOPS_DISABLED_BY_USER, MISSING_CHECKOUT, MISSING_CHECKOUT_CURRENCY, MISSING_COLOR, MISSING_COUNTRY_OVERRIDE_IN_SHIPPING_PROFILE, MISSING_INDIA_COMPLIANCE_FIELDS, MISSING_SHIPPING_PROFILE, MISSING_SIZE, MISSING_TAX_CATEGORY, NEGATIVE_COMMUNITY_FEEDBACK, NEGATIVE_PRICE, NOT_ENOUGH_IMAGES, NOT_ENOUGH_UNIQUE_PRODUCTS, OVERLAY_DISCLAIMER_EXCEEDED_MAX_LENGTH, PART_OF_PRODUCT_LAUNCH, PRODUCT_EXPIRED, PRODUCT_ITEM_HIDDEN_FROM_ALL_SHOPS, PRODUCT_ITEM_INVALID_PARTNER_TOKENS, PRODUCT_ITEM_NOT_INCLUDED_IN_ANY_SHOP, PRODUCT_ITEM_NOT_VISIBLE, PRODUCT_NOT_APPROVED, PRODUCT_NOT_DOMINANT_CURRENCY, PRODUCT_OUT_OF_STOCK, PRODUCT_URL_EQUALS_DOMAIN, PROPERTY_PRICE_CURRENCY_NOT_SUPPORTED, PROPERTY_PRICE_TOO_HIGH, PROPERTY_PRICE_TOO_LOW, PROPERTY_UNIT_PRICE_CURRENCY_MISMATCH_ITEM_PRICE_CURRENCY, PROPERTY_VALUE_CONTAINS_HTML_TAGS, PROPERTY_VALUE_DESCRIPTION_CONTAINS_OFF_PLATFORM_LINK, PROPERTY_VALUE_FORMAT, PROPERTY_VALUE_MISSING, PROPERTY_VALUE_MISSING_WARNING, PROPERTY_VALUE_NON_POSITIVE, PROPERTY_VALUE_STRING_EXCEEDS_LENGTH, PROPERTY_VALUE_STRING_TOO_SHORT, PROPERTY_VALUE_UPPERCASE, PROPERTY_VALUE_UPPERCASE_WARNING, QUALITY_DUPLICATED_DESCRIPTION, QUALITY_ITEM_LINK_BROKEN, QUALITY_ITEM_LINK_REDIRECTING, RETAILER_ID_NOT_PROVIDED, SHOPIFY_INVALID_RETAILER_ID, SHOPIFY_ITEM_MISSING_SHIPPING_PROFILE, SHOPS_POLICY_VIOLATION, SUBSCRIPTION_INFO_NOT_ENABLED_FOR_FEED, TAX_CATEGORY_NOT_SUPPORTED_IN_UK, UNSUPPORTED_PRODUCT_CATEGORY, VARIANT_ATTRIBUTE_ISSUE, VIDEO_FETCH_FAILED, VIDEO_FETCH_FAILED_BAD_GATEWAY, VIDEO_FETCH_FAILED_FILE_SIZE_EXCEEDED, VIDEO_FETCH_FAILED_FORBIDDEN, VIDEO_FETCH_FAILED_LINK_BROKEN, VIDEO_FETCH_FAILED_TIMED_OUT, VIDEO_NOT_DOWNLOADABLE, WHATSAPP_DISABLED_BY_USER, WHATSAPP_POLICY_VIOLATION} | A filter for items affected by a particular issue type. |
filter A JSON-encoded rule | JSON-encoded WCA rule expression representing the filter to be applied for the edge |
return_only_approved_products boolean | 默认值: false Return only approved products, only working for WhatsApp capability for now |
从这条连线读取将返回一个 JSON 格式的结果:
{ "
data
": [], "paging
": {}, "summary
": {} }
data
paging
summary
关于连线的汇总信息(例如次数总计)。请指定字段来调取概要中的参数(例如:概要=total_count
)。
字段 | 说明 |
---|---|
total_count unsigned int32 | Total number of products returned by the query |
错误 | 描述 |
---|---|
100 | Invalid parameter |
80009 | There have been too many calls to this Catalog account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting. |
190 | Invalid OAuth 2.0 Access Token |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
200 | Permissions error |
products
连线发出 POST 请求:参数 | 描述 |
---|---|
additional_image_urls list<URL> | Additional product image URLs |
additional_uploaded_image_ids array<product_image ID> | The ids of the already uploaded images to be used as additional images for this product item. |
additional_variant_attributes JSON object {string : string} | Additional attributes to distinguish the product in its variant group (ex: {"Scent" : "Fruity", "Style" : "Classic"}) |
android_app_name string | The name of the app (suitable for display) |
android_class string | A fully-qualified Activity class name for intent generation |
android_package string | A fully-qualified package name for intent generation |
android_url string | A custom scheme for the Android app |
availability enum{in stock, out of stock, preorder, available for order, discontinued, pending, mark_as_sold} | 默认值: in stock Availability of the product item |
brand string | Brand of the product item |
category string | Google product category for the item. If you need a custom category name instead, use field 'product_type' |
category_specific_fields JSON object | JSON object containing category specific fields |
checkout_url URL | URL to add product item to cart and directly to checkout |
color string | Color of the product item |
commerce_tax_category enum{FB_ANIMAL, FB_ANIMAL_SUPP, FB_APRL, FB_APRL_ACCESSORIES, FB_APRL_ATHL_UNIF, FB_APRL_CASES, FB_APRL_CLOTHING, FB_APRL_COSTUME, FB_APRL_CSTM, FB_APRL_FORMAL, FB_APRL_HANDBAG, FB_APRL_JEWELRY, FB_APRL_SHOE, FB_APRL_SHOE_ACC, FB_APRL_SWIM, FB_APRL_SWIM_CHIL, FB_APRL_SWIM_CVR, FB_ARTS, FB_ARTS_HOBBY, FB_ARTS_PARTY, FB_ARTS_PARTY_GIFT_CARD, FB_ARTS_TICKET, FB_BABY, FB_BABY_BATH, FB_BABY_BLANKET, FB_BABY_DIAPER, FB_BABY_GIFT_SET, FB_BABY_HEALTH, FB_BABY_NURSING, FB_BABY_POTTY_TRN, FB_BABY_SAFE, FB_BABY_TOYS, FB_BABY_TRANSPORT, FB_BABY_TRANSPORT_ACC, FB_BAGS, FB_BAGS_BKPK, FB_BAGS_BOXES, FB_BAGS_BRFCS, FB_BAGS_CSMT_BAG, FB_BAGS_DFFL, FB_BAGS_DIPR, FB_BAGS_FNNY, FB_BAGS_GRMT, FB_BAGS_LUG_ACC, FB_BAGS_LUGG, FB_BAGS_MSGR, FB_BAGS_TOTE, FB_BAGS_TRN_CAS, FB_BLDG, FB_BLDG_ACC, FB_BLDG_CNSMB, FB_BLDG_FENCE, FB_BLDG_FUEL_TNK, FB_BLDG_HT_VNT, FB_BLDG_LOCK, FB_BLDG_MATRL, FB_BLDG_PLMB, FB_BLDG_PUMP, FB_BLDG_PWRS, FB_BLDG_S_ENG, FB_BLDG_STR_TANK, FB_BLDG_TL_ACC, FB_BLDG_TOOL, FB_BUSIND, FB_BUSIND_ADVERTISING, FB_BUSIND_AGRICULTURE, FB_BUSIND_AUTOMATION, FB_BUSIND_HEAVY_MACH, FB_BUSIND_LAB, FB_BUSIND_MEDICAL, FB_BUSIND_RETAIL, FB_BUSIND_SANITARY_CT, FB_BUSIND_SIGN, FB_BUSIND_STORAGE, FB_BUSIND_STORAGE_ACC, FB_BUSIND_WORK_GEAR, FB_CAMERA_ACC, FB_CAMERA_CAMERA, FB_CAMERA_OPTIC, FB_CAMERA_OPTICS, FB_CAMERA_PHOTO, FB_ELEC, FB_ELEC_ACC, FB_ELEC_ARCDADE, FB_ELEC_AUDIO, FB_ELEC_CIRCUIT, FB_ELEC_COMM, FB_ELEC_COMPUTER, FB_ELEC_GPS_ACC, FB_ELEC_GPS_NAV, FB_ELEC_GPS_TRK, FB_ELEC_MARINE, FB_ELEC_NETWORK, FB_ELEC_PART, FB_ELEC_PRINT, FB_ELEC_RADAR, FB_ELEC_SFTWR, FB_ELEC_SPEED_RDR, FB_ELEC_TELEVISION, FB_ELEC_TOLL, FB_ELEC_VID_GM_ACC, FB_ELEC_VID_GM_CNSL, FB_ELEC_VIDEO, FB_FOOD, FB_FURN, FB_FURN_BABY, FB_FURN_BENCH, FB_FURN_CART, FB_FURN_CHAIR, FB_FURN_CHAIR_ACC, FB_FURN_DIVIDE, FB_FURN_DIVIDE_ACC, FB_FURN_ENT_CTR, FB_FURN_FUTN, FB_FURN_FUTN_PAD, FB_FURN_OFFICE, FB_FURN_OFFICE_ACC, FB_FURN_OTTO, FB_FURN_OUTDOOR, FB_FURN_OUTDOOR_ACC, FB_FURN_SETS, FB_FURN_SHELVE_ACC, FB_FURN_SHLF, FB_FURN_SOFA, FB_FURN_SOFA_ACC, FB_FURN_STORAGE, FB_FURN_TABL, FB_FURN_TABL_ACC, FB_GENERIC_TAXABLE, FB_HLTH, FB_HLTH_HLTH, FB_HLTH_JWL_CR, FB_HLTH_LILP_BLM, FB_HLTH_LTN_SPF, FB_HLTH_PRSL_CR, FB_HLTH_SKN_CR, FB_HMGN, FB_HMGN_BATH, FB_HMGN_DCOR, FB_HMGN_EMGY, FB_HMGN_FPLC, FB_HMGN_FPLC_ACC, FB_HMGN_GS_SFT, FB_HMGN_HS_ACC, FB_HMGN_HS_APP, FB_HMGN_HS_SPL, FB_HMGN_KTCN, FB_HMGN_LAWN, FB_HMGN_LGHT, FB_HMGN_LINN, FB_HMGN_LT_ACC, FB_HMGN_OTDR, FB_HMGN_POOL, FB_HMGN_SCTY, FB_HMGN_SMK_ACC, FB_HMGN_UMBR, FB_HMGN_UMBR_ACC, FB_MDIA, FB_MDIA_BOOK, FB_MDIA_DVDS, FB_MDIA_MAG, FB_MDIA_MANL, FB_MDIA_MUSC, FB_MDIA_PRJ_PLN, FB_MDIA_SHT_MUS, FB_OFFC, FB_OFFC_BKAC, FB_OFFC_CRTS, FB_OFFC_DSKP, FB_OFFC_EQIP, FB_OFFC_FLNG, FB_OFFC_GNRL, FB_OFFC_INSTM, FB_OFFC_LP_DSK, FB_OFFC_MATS, FB_OFFC_NM_PLT, FB_OFFC_PPR_HNDL, FB_OFFC_PRSNT_SPL, FB_OFFC_SEALR, FB_OFFC_SHIP_SPL, FB_RLGN, FB_RLGN_CMNY, FB_RLGN_ITEM, FB_RLGN_WEDD, FB_SFTWR, FB_SFWR_CMPTR, FB_SFWR_DGTL_GD, FB_SFWR_GAME, FB_SHIPPING, FB_SPOR, FB_SPORT_ATHL, FB_SPORT_ATHL_CLTH, FB_SPORT_ATHL_SHOE, FB_SPORT_ATHL_SPRT, FB_SPORT_EXRCS, FB_SPORT_INDR_GM, FB_SPORT_OTDR_GM, FB_TOYS, FB_TOYS_EQIP, FB_TOYS_GAME, FB_TOYS_PZZL, FB_TOYS_TMRS, FB_TOYS_TOYS, FB_VEHI, FB_VEHI_PART} | Commerce tax category |
condition enum{new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new} | 默认值: new The condition of the product item |
currency ISO 4217 Currency Code | Currency for the product item 必填 |
custom_data dictionary { string : <string> } | Field used to specify custom variants for a specific catalog item. In this case, variants can be colors, materials, etc.
|
custom_label_0 string | An optional custom label to associate with the product item. Max size: 100 |
custom_label_1 string | An optional custom label to associate with the product item. Max size: 100 |
custom_label_2 string | An optional custom label to associate with the product item. Max size: 100 |
custom_label_3 string | An optional custom label to associate with the product item. Max size: 100 |
custom_label_4 string | An optional custom label to associate with the product item. Max size: 100 |
custom_number_0 int64 | custom_number_0 |
custom_number_1 int64 | custom_number_1 |
custom_number_2 int64 | custom_number_2 |
custom_number_3 int64 | custom_number_3 |
custom_number_4 int64 | custom_number_4 |
description string | Description of the product item. Max size: 5000 支持表情符号 |
expiration_date string | Item's expiration date (YYYY-MM-DD) |
fb_product_category string | Facebook product category for the item |
gender enum{female, male, unisex} | Gender the product item is targeted towards |
gtin string | Global trade ID of the product item |
image_url URI | Required. URL of the product image. |
importer_address JSON object | Address of the product importer |
importer_name string | Name of the product Importer |
inventory int64 | Inventory count for the product item |
ios_app_name string | The name of the app (suitable for display) |
ios_app_store_id int64 | The app ID for the App Store |
ios_url string | A custom scheme for the iOS app |
ipad_app_name string | The name of the app (suitable for display) |
ipad_app_store_id int64 | The app ID for the App Store |
ipad_url string | A custom scheme for the iPhone app |
iphone_app_name string | The name of the app (suitable for display) |
iphone_app_store_id int64 | The app ID for the App Store |
iphone_url string | A custom scheme for the iPhone app |
manufacturer_info string | The Manufacturer Information such as Name, address, etc... |
manufacturer_part_number string | Manufacturer's ID for the product item |
marked_for_product_launch enum{default, marked, not_marked} | Whether this product should be marked for a product launch and hide it from shops until product launch is created with this product. |
material string | Material of the product item |
mobile_link URI | Link to a mobile-optimized external product page |
name string | Name/title of the product item 必填支持表情符号 |
ordering_index int64 | Index used for ordering items within a group |
origin_country enum {AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW} | Product Country of Origin |
pattern string | Pattern of the product item |
price int64 | Price of the item with 2 digits added for cents (ex: use "100" for 1 or "599" for 5.99) 必填 |
product_type string | Retailer defined category of the product item. Max size: 750 |
retailer_id string | A unique identifier for this item (which can be a variant for a product). This field is required. |
retailer_product_group_id string | Item group ID that this product is a variant of |
return_policy_days int64 | return_policy_days |
sale_price int64 | Sale price of the item with 2 digits added for cents (ex: use "100" for 1 or "599" for 5.99) |
sale_price_end_date datetime | Date when the sale price ends |
sale_price_start_date datetime | Date when the sale price starts |
short_description string | A brief description of the product |
size string | Size of the product item |
start_date string | Date when the product started to exist |
url URI | URL of the product item |
visibility enum{staging, published} | 默认值: published Visibility of the product item |
wa_compliance_category enum {DEFAULT, COUNTRY_ORIGIN_EXEMPT} | wa_compliance_category |
windows_phone_app_id string | The app ID (a GUID) for app store |
windows_phone_app_name string | The name of the app (suitable for display) |
windows_phone_url string | A custom scheme for the Windows Phone app |
id
代表的节点。id
: numeric string, 错误 | 描述 |
---|---|
10800 | Duplicate retailer_id when attempting to create a store collection |
100 | Invalid parameter |
10801 | Either "file" or "url" must be specified |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
200 | Permissions error |