使用此參考資料來查看 POST /{catalog_id}/items_batch
端點和 POST /{catalog_id}/batch
支援的欄位和各欄位的範例。
/{catalog_id}/batch
和 /{catalog_id}/items_batch
的參數名稱看起來相似,但其實明顯不同。
我們建議使用 /{catalog_id}/items_batch
API,此 API 支援更多使用案例,且受積極維護。
/{catalog_id}/batch
CREATE
和 UPDATE
方法支援的欄位如下。
更新商品時,提供空字串做為欄位值可取消設定選用欄位。將欄位值設為 null
不會取消設定該欄位。
欄位 | 說明 |
---|---|
類型: 陣列<string> | 選用項目。 最多 9-10 個不同圖像的網址。 |
類型: 清單<KeyValue:string,string> | 選用項目。 用於區分產品款式群組的附加屬性。 範例: |
類型:字串 | 必要項目 識別供貨狀態:
|
類型:字串 | 選用項目。 年齡相同或相近的用戶族群。接受的值為 |
類型: 物件<> | 選用項目。 行動應用程式的連結。 |
類型:字串 | 選用項目,但建議用於高效速成+ 目錄廣告(可能有助於提高廣告成效)。Instagram 購物和粉絲專頁商店的選用項目,但若要在這些管道啟用站內結帳,則為必要項目(僅限美國)。Marketplace 的必要項目(僅限美國)。 商品的 Google 產品類別(GPC)。請使用這裡列出的類別分類法路徑或類別編號。 如果您在 Instagram 或 Facebook(僅限美國)上使用結帳功能,商品的 GPC 會影響其稅金和退貨政策。深入瞭解廣告使用說明:目錄商品的 Google 產品類別。 範例: |
類型:字串 | 選用項目。 大小上限:100。 商品顏色。 |
類型:字串 | 必要項目。 商品狀況: |
類型:字串 | 必要項目。 |
類型:字串 | 選用項目。 字元上限:100 商品的其他相關資訊。提供空字串可取消設定。 |
類型:字串 | 必要項目。 大小上限:5000。 商品的簡要說明。 |
類型:字串 | 選用項目。 用於尺寸的性別。欄位值包括 |
類型:字串 | 選用項目。 大小上限:70。 全球貿易商品編號可以包括 |
類型:字串 | 必要項目。 廣告中使用的商品圖像連結。請提供適當的圖像大小。 單一圖像的高效速成+ 目錄廣告
如果圖像超出此長寬比,Facebook 會根據其原始長寬比,將其裁切為最接近最小長寬比或最大長寬比。 輪播圖像的高效速成+ 目錄廣告 - 最小圖像解析度需求為 500px * 500px,Facebook 會將其裁切為 1:1 的長寬比。 建議:請避免頻繁變更 |
類型:數字 | 選用項目。 廣告主可用來儲存庫存量資訊的整數。 |
類型:字串 | 不適用於高效速成+ 目錄廣告。商務的選用項目。 指示商品是否將用在商品發表會中。支援的值:
|
類型:字串 | 必要項目。 大小上限:100。 商品的標題。 |
類型:字串 | 選用項目 大小上限:100。 商品上的圖案或圖形印刷。 |
類型:整數 | 必要項目。 價格乘以 100(適用於所有幣別)。範例:490 使用 USD 代表 $4.90 美元,而 49000 使用 JPY 代表 ¥490 日元。 |
類型:字串 | 選用項目。 大小上限:750。 零售商定義的商品類別。 範例:TSV 格式:家居與園藝 > 廚房與餐廳 > 電器 > 冰箱。 範例:XML 格式:product_type > 家居與園藝 > 廚房與餐廳 > 電器 > 冰箱 > product_type。 |
類型:字串 | 選用項目。 接受字串。廣告主可以使用此編號將產品分組在一起。 |
類型:整數 | 選用項目。 商品促銷時的折扣價。這是優惠價乘以 100(適用於所有幣別)。範例:490 使用 USD 代表 $4.90 美元,而 49000 使用 JPY 代表 ¥490 日元。 |
類型:字串 | 選用項目。 促銷活動的結束日期和時間。 範例: |
類型:字串 | 選用項目。 促銷活動的開始日期和時間。 範例: |
類型: 陣列<object> | 選用項目。 配送資訊。 |
類型:字串 | 選用項目。 商品尺碼。範例: |
類型:字串 | 必要項目。 可供購買商品的商家網站連結。 |
類型:字串 | 選用項目。 銷售商品的供應商/賣家編號。 |
/{catalog_id}/batch
{ "access_token": "<ACCESS_TOKEN>", "requests": [ { "method": "DELETE", "retailer_id": "retailer-1" }, { "method": "CREATE", "retailer_id": "retailer-2", "data": { "availability": "in stock", "brand": "Nike", "category": "t-shirts", "description": "product description", "image_url": "http://www.images.example.com/t-shirts/1.png", "name": "product name", "price": 1000, "currency": "USD", "shipping": [ { "country": "US", "region": "CA", "service": "service", "price_value": "10", "price_currency": "USD" } ], "condition": "new", "url":"http://www.images.example.com/t-shirts/1.png", "retailer_product_group_id": "product-group-1" }, "applinks": { "android": [{ "app_name": "Electronic Example Android", "package": "com.electronic", "url": "example-android://electronic" }], "ios": [{ "app_name": "Electronic Example iOS", "app_store_id": 2222, "url": "example-ios://electronic" }] }, }, { "method": "UPDATE", "retailer_id": "retailer-3", "data": { "availability": "out of stock", } } ] }
/{catalog_id}/batch
將會傳回一或多個控制項。
"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch
/{catalog_id}/items_batch
在第 3.3 版和第 3.2 版中,CREATE
和 UPDATE
方法可支援下列產品欄位:
欄位 | 說明 |
---|---|
類型: 陣列<string> | 選用項目。 最多 9-10 個不同圖像的連結。 |
類型: 清單<KeyValue:string,string> | 選用項目。 用於區分產品款式群組的附加屬性。 範例: |
類型:字串 | 選用項目。 年齡相同或相近的用戶族群。接受的值為 |
類型: 物件<string> | 選用項目。 行動應用程式的連結。 範例: "applink" : { "ios_url": "example-ios://electronic", "ios_app_store_id": "42", "ios_app_name": "Electronic Example iOS", "iphone_url": "example-iphone://electronic", "iphone_app_store_id": "43", "iphone_app_name": "Electronic Example iPhone", "ipad_url": "example-ipad://electronic", "ipad_app_store_id": "44", "ipad_app_name": "Electronic Example iPad", "android_url": "example-android://electronic", "android_package": "com.electronic", "android_class": "com.electronic.Example", "android_app_name": "Electronic Example Android", "windows_phone_url": "example-windows://electronic", "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name": "Electronic Example Windows", } |
類型:字串 | 必要項目。 識別供貨狀態:
|
類型:字串 | 選用項目。 商品的品牌。 |
類型:字串 | 選用項目。 大小上限:100。 商品顏色。 |
類型:字串 | 必要項目。 產品狀況: |
類型:字串 | 選用項目。 字元上限:100 商品的其他相關資訊。 |
類型:字串 | 必要項目。 大小上限:5000。 描述產品的簡短文字。 |
類型: 陣列<string> | 選用項目。 所要停用的功能清單。可能的值為: |
類型:字串 | 選用項目。 用於尺寸的性別。欄位值包括 |
類型:字串 | 選用項目。 大小上限:250。 Google 產品分類法中的預先定義值(字串或類別編號)。 範例:服飾和配件 > 服裝 > 洋裝或 2271。 |
類型:字串 | 選用項目。 大小上限:70。 全球貿易商品編號(GTIN)可以包括 |
類型:字串 | 必要項目。 零售商編號 |
類型:陣列 <object> | 要用在廣告或商店中的圖像網址和標籤。最多支援 20 個不同的圖像。標籤為選用項目,使用時應描述圖像中的內容。 範例: "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ] |
類型:字串 | 若有提供 建議改用 廣告中使用的商品圖像連結。請提供適當的圖像大小。 單一圖像的高效速成+ 目錄廣告:
輪播圖像的高效速成+ 目錄廣告:最小圖像解析度需求為 500px * 500px,Facebook 會將其裁切為 1:1 的長寬比。 |
類型:字串 | 新增內部標籤,協助您在建立商品組合時篩選商品。舉例來說,您可以為屬於夏季促銷活動範圍的所有商品新增「summer」標籤,然後將這些商品篩選為組合。僅有您本人能夠查看標籤 在每個標籤前後加上單引號('),並使用逗號(,)分隔多個標籤。請勿在標籤的開頭或結尾加入空格。字元數量上限:每項商品最多可有 5,000 個標籤,每個標籤則以 110 個字元為限。 範例(TSV、XLSX、Google Sheets):['summer','trending'] 範例(CSV):“['summer','trending']” 注意:如果您目前使用自訂標籤( 這個欄位之前稱為 |
類型:物件 | 選用項目。 廣告主可用來儲存庫存量資訊的整數。 |
類型:字串 | 選用項目。 廣告主提供的產品群組編號;不是 FBID。接受字串。廣告主可以使用此編號將各種不同物件(產品項目、車輛、飯店、航班等)分組在一起。 |
類型:字串 | 必要項目。 可供購買商品的商家網站連結。 |
類型:字串 | 選用項目。 產品的製造商專屬編號。 |
類型:字串 | 選用項目。 大小上限:100。 產品上的主要圖案或印花。 |
類型:字串 | 必要項目。 商品的價格。以成本格式標示價格,後面接著 3 位數字母 ISO 幣別代碼,成本與幣別之間空一格。 範例: |
類型:數字 | 選用項目。 購買者對此商品的評分數量。此值必須大於 0,且應搭配 範例:100 |
類型:字串 | 選用項目,但若要將「疊壓文字」功能用於高效速成+ 目錄廣告,則為必要項目。 折扣價(若為促銷商品)。以成本格式標示價格,後面接著 3 位字母 ISO 幣別代碼,成本與幣別之間空一格。 範例: |
類型:字串 | 選用項目。 促銷活動開始及結束的日期和時間(以斜線分隔)。請以 YYYY-MM-DD 格式輸入開始和結束日期。在每個日期後面加一個「T」,然後再加上時間。以 24 小時格式(0:00 至 23:59)輸入時間。 範例: |
類型:字串 | 選用項目。 每個國家和地區的 Blob 價格不同。不同地區以逗號分隔。格式應為 範例: |
類型:字串 | 選用項目。 商品尺碼。範例: |
類型:字串 | 必要項目。 大小上限:100。 商品的標題。 |
類型:數字 | 選用項目。 購買者對此商品的平均評分。此值的範圍在 1.0 到 5.0 之間,允許小數點一位,且應搭配 範例:4.5 |
類型:陣列 <object> | 要用在廣告或商店中的影片網址和標籤。在目錄層級可支援最多 30,000 個影片。標籤為選用項目,使用時應描述影片中的內容。 影片檔案大小上限為 200 MB。支援的格式包括:.3g2、.3gp、.3gpp、.asf、.avi、.dat、.divx、.dv、.f4v、.flv、.gif、.m2ts、.m4v、.mkv、.mod、.mov、.mp4、.mpe、.mpeg、.mpeg4、.mpg、.mts、.nsv、.ogm、.ogv、.qt、.tod、.ts、.vob 和 .wmv 範例: "video": [ { "url":"http://example.com/video_1.mp4", "tag": ['Swimming pool','Gym'], } ] 注意:如果產品有影片 1、2,若要刪除影片 1,請從陣列中移除影片 1: [ { "method": "UPDATE", "data": { "video": [ { "url": "https://google.com/video_2.mp4", "tag": ["video_2"] } ] } } ] 若要刪除所有影片,請傳送空陣列: [ { "method": "UPDATE", "data": { "video": [] } } ] |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
請參閱 API 參考資料,深入瞭解產品欄位。
PRODUCT_ITEM
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "PRODUCT_ITEM", "requests": [ { "method": "DELETE", "data": { "id": "retailer-1" } }, { "method": "CREATE", "data": { "id": "retailer-2", "applink" : { "ios_url":"example-ios://electronic", "ios_app_store_id":"42", "ios_app_name":"Electronic Example iOS", "iphone_url":"example-iphone://electronic", "iphone_app_store_id":"43", "iphone_app_name":"Electronic Example iPhone", "ipad_url":"example-ipad://electronic", "ipad_app_store_id":"44", "ipad_app_name":"Electronic Example iPad", "android_url":"example-android://electronic", "android_package":"com.electronic", "android_class":"com.electronic.Example", "android_app_name":"Electronic Example Android", "windows_phone_url":"example-windows://electronic", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Electronic Example Windows", }, "availability": "in stock", "brand": "Nike", "google_product_category": "t-shirts", "description": "product description", "image_link": "http://www.images.example.com/t-shirts/1.png", "title": "product name", "price": "10.00 USD", "shipping": [ { "shipping_country": "US", "shipping_region": "CA", "shipping_service": "service", "shipping_price_value": "10", "shipping_price_currency": "USD" } ], "condition": "new", "link":"http://www.images.example.com/t-shirts/1.png", "item_group_id": "product-group-1" } }, { "method": "UPDATE", "data": { "availability": "out of stock", "id": "retailer-3", } } ] }
PRODUCT_ITEM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
深入瞭解如何使用資料摘要來新增目錄商品。
在第 3.2 版中,用於 HOTEL
類型的 CREATE
和 UPDATE
方法可支援下列產品欄位:
欄位 | 說明 |
---|---|
類型: 物件<string> | 必要項目。 飯店的地址。 |
類型: | 選用項目。 行動應用程式的連結。 |
類型:字串 | 必要項目。 飯店客房的每晚基本價格。在價格中加入貨幣類型。以成本格式標示價格,後面接著 ISO 幣別代碼,成本與幣別之間空一格。範例: |
類型:字串 | 選用項目。 連鎖飯店的品牌。 |
類型:字串 | 字元上限:100 最多五個自訂欄位,設定您在建立商品組合時,要用於篩選商品的任何其他資訊。舉例來說,您可以使用自訂欄位來指出所有夏季促銷房間,然後將這些房間篩選為商品組合。此欄位支援所有文字值,包括數字。 範例: 此為補充摘要支援的欄位。 |
類型:整數 | 您在建立商品組合時,可針對想用來篩選商品的任何其他數字相關資訊加入最多五個自訂欄位。此欄位允許您在建立商品組合時,依數字範圍(大於和小於)進行篩選。舉例來說,您可以使用此欄位來標示飯店的開業年分,然後將特定年分範圍篩選成商品組合。 此欄位支援 0 到 4294967295 之間的整數,不支援負數、十進位數字或逗號,例如 -2、5.5 或 10,000。 範例: |
類型:字串 | 必要項目。 字元上限:5000。 飯店的簡要說明。 |
類型: 陣列<object> | 選用項目。 房客對飯店的評分。 |
類型:字串 | 必要項目。 飯店的專屬編號。 |
類型: 陣列<object> | 必要項目。 要用在廣告中的圖像網址和標籤。最多支援 20 個不同圖像。標籤為選用項目,使用時應描述圖像中的內容。範例: |
類型:字串 | 必要項目。 飯店的緯度位置。 |
類型:字串 | 必要項目。 飯店的經度位置。 |
類型:字串 | 選用項目。 用於飯店的忠誠度計畫。 |
類型:字串 | 選用項目。 飯店獲利能力指標;為介於 |
類型:字串 | 必要項目。 飯店的名稱。 |
類型: 陣列<string> | 選用項目。 飯店的一或多個鄰近地區。範例: |
類型:字串 | 選用項目。 含國碼/區碼的電話號碼。 |
類型:字串 | 選用項目。 飯店的每晚優惠價。使用此欄位來投放飯店原價的折扣廣告。必要項目:在價格中加入貨幣類型。以成本格式標示價格,後面接著 ISO 幣別代碼,成本與幣別之間空一格。範例: |
類型:字串 | 選用項目。 飯店星級。星數應介於 |
類型:字串 | 必要項目。 可供預訂飯店客房的外部網站連結。 |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
HOTEL
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "HOTEL", "requests": [ { "method": "DELETE", "data": { "hotel_id": "hotel-1" } }, { "method": "CREATE", "data": { "hotel_id": "1234", "brand": "Premium_brand", "description": "A very nice hotel", "name": "The best hotel", "base_price": "100.00 USD", "longitude":"42.10", "latitude":"42.10", "address": { "addr1":"100 Main Street", "city":"North Pole", "region":"ABC", "country":"US", "postal_code":"11111" }, "guest_rating" : [ { "rating_system":"tripAdvisor", "score":"7.8", "number_of_reviewers":"300", "max_score":"10", }, { "rating_system":"Yelp", "score":"5.1", "number_of_reviewers":"123", "max_score":"10", }, ], "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ], "applink" : { "ios_url":"example-ios://electronic", "ios_app_store_id":"42", "ios_app_name":"Electronic Example iOS", "iphone_url":"example-iphone://electronic", "iphone_app_store_id":"43", "iphone_app_name":"Electronic Example iPhone", "ipad_url":"example-ipad://electronic", "ipad_app_store_id":"44", "ipad_app_name":"Electronic Example iPad", "android_url":"example-android://electronic", "android_package":"com.electronic", "android_class":"com.electronic.Example", "android_app_name":"Electronic Example Android", "windows_phone_url":"example-windows://electronic", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Electronic Example Windows", }, "loyalty_program":"Premium_program", "margin_level": "8", "phone":"+61 2-96027455", "star_rating":"4", "url":"http://www.images.example.com/t-shirts/1.png" } }, { "method": "UPDATE", "data": { "base_price": "90.00 USD", "hotel_id": "hotel-3", } } ] }
HOTEL
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
在第 3.2 版中,用於 HOTEL_ROOM
類型的 CREATE
和 UPDATE
方法可支援下列產品欄位。
欄位 | 說明 |
---|---|
類型:字串 | 必要項目。 1 晚基本價格。幣別應遵循 ISO 4217 幣別代碼。 範例: |
類型:字串 | 必要項目。 大小上限:5000。 描述客房的簡短文字。 |
類型:字串 | 必要項目。 飯店零售商的專屬編號。 |
類型:字串 | 必要項目。 飯店的專屬編號。 |
類型: 陣列<object> | 必要項目。 客房的圖像。 |
類型:字串 | 必要項目。 大小上限:100。 客房的名稱。 |
類型:字串 | 必要項目。 可供預訂住宿的廣告主網站連結。 |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
HOTEL_ROOM
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "HOTEL_ROOM", "requests": [ { "method": "DELETE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-1", } }, { "method": "CREATE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-2", "description": "product description", "name": "product name", "base_price": "100 USD", "url": "http://www.example.com/t-shirts/1.html", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['Swimming pool','Gym'], } ] }, { "method": "UPDATE", "data": { "hotel_retailer_id": "1234", "hotel_room_id": "room-3", "base_price": "120 USD", } } ] }
HOTEL_ROOM
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
在第 3.2 版中,用於 FLIGHT
類型的 CREATE
和 UPDATE
方法可支援下列產品欄位。
欄位 | 說明 |
---|---|
類型:字串 | 選用項目。 字元上限:5000。 航班的說明。 |
類型:字串 | 必要項目。 航班的目的地機場。應以 IATA 代碼輸入。 範例: |
類型:字串 | 選用項目。 航班的目的地城市名稱。 |
類型: 陣列<object> | 必要項目。 要用在廣告中的圖像網址和標籤。最多支援 20 個不同圖像。標籤為選用項目,使用時應描述圖像中的內容。 範例: |
類型:字串 | 必要項目。 航班的出發地機場。應以 IATA 代碼輸入。 範例: |
類型:字串 | 選用項目。 航班的出發地城市名稱。 |
類型:字串 | 選用項目。 航班的成本和幣別。價格為一個數字後面接著幣別代碼;使用 ISO 4217 標準。使用「.」作為價格的小數點。 |
類型:字串 | 選用項目。 可供預訂航班的網站連結。 |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
FLIGHT
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "FLIGHT", "requests": [ { "method": "DELETE", "data": { "origin_airport": "BOS", "destination_airport": "JFK", } }, { "method": "CREATE", "data": { "origin_airport": "BOS", "destination_airport": "SFO", "description": "Best Flight to SFO", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['City'], }, { "url":"http://example.com/some.image_2.jpg", "tag": ['Food'], } ], "price":"100.00 USD", } }, { "method": "UPDATE", "data": {
FLIGHT
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
在第 3.2 版中,用於 DESTINATION
類型的 CREATE
和 UPDATE
方法可支援下列產品欄位。
欄位 | 說明 |
---|---|
類型: 物件<string> | 選用項目。 行動應用程式的連結。 |
類型: 物件<string> | 必要項目。 飯店的地址。 |
類型:字串 | 選用項目。 字元上限:5000。 目的地簡介。 |
類型:字串 | 必要項目。 字元上限:100。 目的地的專屬編號。 |
類型: 陣列<object> | 必要項目。 要用在廣告中的圖像網址和標籤。最多支援 20 個不同圖像。標籤為選用項目,使用時應描述圖像中的內容。 範例: |
類型:字串 | 必要項目。 目的地的緯度位置。 |
類型:字串 | 必要項目。 目的地的經度位置。 |
類型:字串 | 必要項目。 目的地的名稱。 |
類型: 陣列<string> | 選用項目。 允許的鄰近地區數量上限:20。目的地的一或多個鄰近地區。 範例: |
類型:字串 | 選用項目。 目的地的最低平均成本和幣別。價格的格式為一個數字後面接著幣別代碼;使用 ISO 4217 標準。使用「.」作為價格的小數點。 |
類型:字串 | 選用項目。 價格變更。可用來建立商品組合及用於廣告創意:
範例:""average price in NYC dropped by X"" 或 ""average price in NYC dropped"" |
類型: 陣列<string> | 必要項目。 目的地類型的數量上限:20。目的地的類型。一個目的地可以有多種類型。 範例: |
類型:字串 | 必要項目。 可供預訂目的地的網站連結。 |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
DESTINATION
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "DESTINATION", "requests": [ { "method": "DELETE", "data": { "destination_id": "destination-1" } }, { "method": "CREATE", "data": { "destination_id": "123456789", "description": "My destination is the best.", "name": "The best destination", "price": "199.00 USD", "price_change": "-20", "longitude":"-122.4424", "latitude":"37.7712", "image": [ { "url":"http://example.com/image_1.jpg", "tag": ['City','Package'], }, { "url":"http://example.com/some.image_2.jpg", "tag": ['Tour','Landmark'], } ], "address": { "addr1":"1 Market Street", "city":"San Francisco", "region":"California", "country":"United States", "postal_code":"94117" }, "applink" : { "ios_url":"example-ios://travelapp", "ios_app_store_id":"42", "ios_app_name":"Travel App iOS", "iphone_url":"example-iphone://travelapp", "iphone_app_store_id":"43", "iphone_app_name":"Travel App iPhone", "ipad_url":"example-ipad://travelapp", "ipad_app_store_id":"44", "ipad_app_name":"Travel App iPad", "android_url":"example-android://travelapp", "android_package":"com.travelapp", "android_class":"com.travelapp.Example", "android_app_name":"Travel App Android", "windows_phone_url":"example-windows://travelapp", "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0", "windows_phone_app_name":"Travel App Windows", }, "type":["city","culture"], "neighborhood":["Mission","SoMa"], "url":"http://www.thebestdestination.com" } }, { "method": "UPDATE", "data": { "price": "159.99", "destination_id": "destination-3", } } ] }
DESTINATION
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
在第 3.3 版和第 3.2 版中,用於 HOME_LISTING
類型的 CREATE
和 UPDATE
方法可支援下列產品欄位。
欄位 | 說明 |
---|---|
類型: 物件<string> | 選用項目。 行動應用程式的連結。 |
類型: 物件<string> | 必要項目。 房地產廣告商品的街道地址。 |
類型:字串 | 必要項目。 房地產廣告商品目前的供應情況。支援的值: |
類型: 陣列<object> | 選用項目。 價格配置。 |
類型:字串 | 選用項目。 字元上限:5000。 房地產廣告商品簡介。 |
類型: 陣列<object> | 必要項目。 要用在廣告中的圖像網址和標籤。最多支援 20 個不同圖像。標籤為選用項目,使用時應描述圖像中的內容。 範例: |
類型:字串 | 選用項目。 房地產廣告商品的緯度位置。 |
類型:字串 | 選用項目。 房地產廣告商品的經度位置。 |
類型:字串 | 選用項目。 廣告商品的類型。支援的值: |
類型:字串 | 必要項目。 房地產廣告商品的名稱。 |
類型: 陣列<object> | 選用項目。 房地產廣告商品的鄰近地區。允許的鄰近地區數量上限:20。 |
類型:字串 | 選用項目。 衛浴數量。 |
類型:字串 | 選用項目。 臥室數量。 |
類型:字串 | 選用項目。 可供應的單位數量。僅限用於可供出租/租賃的公寓或大廈。 |
類型:字串 | 必要項目。 房地產廣告商品的成本和幣別。價格為一個數字後面接著幣別代碼;使用 ISO 4217 標準。使用「.」作為價格的小數點。 |
類型:字串 | 選用項目。 價格變更。可用來建立商品組合及用於廣告創意:
範例:""average price in NYC dropped by X"" 或 ""average price in NYC dropped"" |
類型:字串 | 選用項目。 資產的類型。支援的值: |
類型:字串 | 必要項目。 可供檢視商品資訊的網站連結。 |
類型:字串 | 選用項目。 房屋落成年份。 |
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
HOME_LISTING
{ "access_token": "<ACCESS_TOKEN>", "item_type": "HOME_LISTING", "requests": [ { "method": "DELETE", "data": { "home_listing_id": "home-listing-1" } }, { "method": "CREATE", "data": { "home_listing_id": "12345678", "availability": "for_sale", "description": "An amazing listing", "name": "1 Hacker Way, Menlo Park, CA 94025", "price": "110000 USD", "longitude":"1.11414", "latitude":"-1.835003", "address": { "addr1":"1 Hacker Way", "city":"Menlo Park", "region":"California", "country":"United States", "postal_code":"94025" }, "neighborhood":["Menlo Oaks"], "image": [ { "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg", }, ], "listing_type": "for_sale_by_agent", "num_baths":"6", "num_beds":"5", "num_units":"1", "property_type":"house", "year_built":"2007", "available_dates_price_config" : [ { "start_date":"2020-11-15", "end_date":"2020-12-15", "rate":"10000", "currency":"USD", "interval":"nightly", }, { "start_date":"2020-11-15", "end_date":"2020-12-15", "rate":"50000", "currency":"USD", "interval":"weekly", }, ], "applink" : { "ios_url":"example-ios://travelapp", "ios_app_store_id":"42", "ios_app_name":"Travel App iOS", "android_url":"example-android://travelapp", "android_package":"com.travelapp", "android_class":"com.travelapp.Example", "android_app_name":"Travel App Android", }, "url":"http://www.example.com/link_to_listing" } }, { "method": "UPDATE", "data": { "price": "100000 USD", "home_listing_id": "home-listing-3", } } ] }
HOME_LISTING
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
若要查看用於 VEHICLE
類型的 CREATE
和 UPDATE
方法有哪些支援的欄位,請參閱汽車庫存目錄欄位 - 車輛。
如果商品還不存在,也可以使用 UPDATE
方法來建立商品。
VEHICLE
curl \ -d @body.json \ -H "Content-Type: application/json" { "access_token": "<ACCESS_TOKEN>", "item_type": "VEHICLE", "requests": [ { "method": "DELETE", "data": { "vehicle_id": "vehicle-1" } }, { "method": "CREATE", "data": { "vehicle_id": "i2 2017 Ford Fusion", "availability": "AVAILABLE", "make": "Ford", "model": "Fusion", "year": "2017", "mileage": { "value": "1500", "unit": "KM", }, "image": [ { "url":"http://www.facebook.com/teapic.jpg", "tag":["Car"], }, ], "fuel_type":"gasoline", "body_style":"sedan", "drivetrain":"FWD", "vin":"1FADP5AU6DL536022", "condition":"EXCELLENT", "description": "Turbocharged! Gasoline!", "title": "SE Ford Certified and 6-Speed Automatic.", "price": "18000 USD", "exterior_color":"white", "sale_price":"16000 USD", "state_of_vehicle":"new", "longitude":"52.35", "latitude":"42.1", "address": { "addr1":"550 Auto Center Dr", "city":"Watsonville", "region":"CA", "country":"US", "postal_code":"96075" }, "url":"http://www.example.com/test" } }, { "method": "UPDATE", "data": { "price": "16000 USD", "vehicle_id": "vehicle-3", } } ] }
VEHICLE
{ // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"] }
/{catalog_id}/items_batch
(注意:我們建議使用此端點,因其支援更多使用案例,且系統會持續進行維護。)
/{catalog_id}/batch
/{catalog_id}/check_batch_request_status
/{catalog_id}/localized_items_batch