CitrusAd รองรับรูปแบบสามประเภทสำหรับการซิงค์ข้อมูลผลิตภัณฑ์ผ่านไฟล์:
- TSV
- CSV
- XML
ส่วนนี้อธิบายโครงสร้างของแต่ละรูปแบบไฟล์สำหรับข้อมูลผลิตภัณฑ์ที่เราประมวลผลใน CitrusAd
ไฟล์ TSV/CSV
ตารางด้านล่างแสดงชื่อคอลัมน์และคำอธิบายของคอลัมน์สำหรับผลิตภัณฑ์ในไฟล์ TSV/CSV ในตารางนี้ เรายังระบุคอลัมน์บังคับที่ต้องระบุในไฟล์ เมื่อต้องมีคอลัมน์ ต้องระบุค่าทั้งหมดในคอลัมน์ในแถวของคอลัมน์นั้น
️ TSV ที่ไม่มีเครื่องหมายอัญประกาศ
ไฟล์ TSV ไม่สามารถอยู่ในรูปแบบที่ยกมา เมื่อซิงโครไนซ์ผ่าน TSV ตรวจสอบให้แน่ใจว่าคุณซิงโครไนซ์ไฟล์ที่ไม่มีเครื่องหมายคำพูด
ชื่อคอลัมน์และคำอธิบายข้อมูลผลิตภัณฑ์ในไฟล์ TSV/CSV
ชื่อคอลัมน์ | จำเป็นต้องใช้/ไม่บังคับ | ประเภทข้อมูล | คำอธิบาย | ตัวอย่าง |
---|---|---|---|---|
product_code | ต้องระบุ | ข้อความ สูงสุด 50 ตัวอักษร | รหัสเพื่อระบุผลิตภัณฑ์ในระบบของคุณ ช่องนี้เหมือนกับช่อง gtin และรายการในการซิงค์ไฟล์ API และ XML | F153212AN1 |
name | ต้องระบุ | ข้อความ สูงสุด 150 ตัวอักษร | ชื่อผลิตภัณฑ์ | ทีสติ๊กเกอร์ SS สําหรับเด็ก |
image_url | ต้องระบุ | URL สูงสุด 2048 ตัวอักษร | ไฮเปอร์ลิงก์ไปยังภาพของผลิตภัณฑ์ ต้องเป็น URL ที่ถูกต้อง | https://www.retailer.com/product/1234.jpg |
inventory | ต้องระบุ | ตัวเลข 32 บิต แนะนำจำนวนเต็มที่ไม่ได้ลงนาม | สินค้าคงคลังของสินค้า หากค่าเป็น 0 จะไม่มีการแสดงโฆษณาผลิตภัณฑ์สำหรับผลิตภัณฑ์ | 1 |
description | ต้องระบุ | ข้อความ สูงสุด 5000 ตัวอักษร | คำอธิบายผลิตภัณฑ์ | กางเกงวอร์มขาสั้น Sport Sweat มาพร้อมลายปัก Trefoils และแถบสีขาวสามแถบตัดกันเป็นข้อเสนอใหม่ล่าสุดจาก Adidas Originals |
KEY (as a value) | จำเป็นสำหรับหมวดหมู่และตำแหน่งที่แสดงแบบกว้าง | ข้อความ สูงสุด 1,000 ตัวอักษรต่อคอลัมน์ | หากใช้คอลัมน์ประเภทนี้ ผู้ค้าปลีกต้องระบุค่าสำหรับ คุณอาจมีหลายคอลัมน์ที่มีวากยสัมพันธ์นี้ในไฟล์ TSV | ชื่อคอลัมน์อาจเป็น "ตัวกรอง:brand_name" และค่าของเซลล์ในคอลัมน์อาจเป็น "green-fairy"ซึ่งจะส่งผลให้มีตัวกรอง "brand_name:green-fairy" บนผลิตภัณฑ์ |
subClassName | ไม่ใช้แล้ว จำเป็นสำหรับการวางขายพ่วง/ขายต่อยอดผลิตภัณฑ์ | ข้อความ สูงสุด 750 ตัวอักษร | ชื่อของคลาสย่อย/หมวดหมู่ของผลิตภัณฑ์ที่เกี่ยวข้อง คลาสย่อยช่วยให้กําหนดเป้าหมายผลิตภัณฑ์ได้ดีขึ้น เช่น ผลิตภัณฑ์เนยสามารถกําหนดเป้าหมายขนมปังได้ แต่จะไม่กําหนดเป้าหมายไปที่เครื่องช่วยวงดนตรี | เนยแข็ง |
xSellSubClassName | ไม่ใช้แล้ว จำเป็นสำหรับการวางขายพ่วง/ขายต่อยอดผลิตภัณฑ์ | ข้อความ สูงสุด 750 ตัวอักษร | ชื่อของคลาสย่อย/หมวดหมู่ที่ผลิตภัณฑ์ที่เกี่ยวข้องสามารถกำหนดเป้าหมายผลิตภัณฑ์ภายใน | ขนมปัง, สเปรด, แครกเกอร์ |
price | ไม่บังคับ | ตัวเลข แนะนำจุดทศนิยม 2 หลัก | ราคาผลิตภัณฑ์ | 30.00 |
brand | ต้องระบุ | ข้อความ สูงสุด 70 ตัวอักษร | แบรนด์ของผลิตภัณฑ์ | Tommy Hilfiger |
type | ต้องระบุ | ข้อความ สูงสุด 750 ตัวอักษร | ประเภทผลิตภัณฑ์ | เสื้อผ้า |
retailer_taxonomy | จำเป็นสำหรับการแสดงที่มาที่ปรับปรุง ต้องไม่มีช่องว่างระหว่าง > อักขระ | ข้อความ สูงสุด 750 ตัวอักษร | อนุกรมวิธานของผู้ค้าปลีกแต่ละรายของผลิตภัณฑ์ | ผู้ชาย > เสื้อผ้าผู้ชาย > เสื้อสเวตเตอร์ |
google_taxonomy | จำเป็นสำหรับการแสดงที่มาที่ปรับปรุงหาก retailer_taxonomy ไม่สามารถให้ได้ | ข้อความ สูงสุด 750 ตัวอักษร | อนุกรมวิธาน Google มาตรฐานของผลิตภัณฑ์ ดูข้อมูลเพิ่มเติมได้ที่นี่: https://www.google.com/basepages/producttype/taxonomy.en-US.txt | เครื่องแต่งกายและเครื่องประดับ > เสื้อผ้า > เสื้อ |
global_identifier | ต้องระบุ | ข้อความ สูงสุด 50 ตัวอักษร | ตัวระบุส่วนกลางสําหรับผลิตภัณฑ์ | 08719108994761 |
global_identifier_type | ต้องระบุ | ข้อความ | ประเภทตัวระบุส่วนกลาง | GTIN |
custom_payload | ไม่จําเป็นเว้นแต่จะได้รับคําแนะนํา | อาร์เรย์ไบต์ที่เข้ารหัส Base64 | ฟิลด์นี้มีเพย์โหลดกำหนดเองที่ควรถูกเธรดผ่านไปยังการสร้างโฆษณา ฟิลด์ควรมีอ็อบเจ็กต์ JSON ที่ถูกต้องที่ถูกทำให้เป็นอนุกรมในอาร์เรย์ไบต์และเข้ารหัส Base64 อ็อบเจ็กต์ JSON ควรเป็นไปตามสคีมา | ดูส่วนเพย์โหลดที่กําหนดเอง |
hfss | ไม่บังคับ | บูลีน | ใช้เพื่อระบุว่าผลิตภัณฑ์นั้นเป็น HFSS หรือไม่ ซึ่งมีประโยชน์เพิ่มเติมใน UI ของ CitrusAd ดู เอกสาร HFSS ของเราสำหรับข้อมูลเพิ่มเติม | จริง |
seller_id | ไม่บังคับ | ข้อความ สูงสุด 50 ตัวอักษร | รหัสเฉพาะของผู้ขาย จำเป็นก็ต่อเมื่อเริ่มแนะนำการใช้งานแก่ผู้ขายในตลาด สามารถเว้นว่างไว้สำหรับผลิตภัณฑ์ที่ไม่ใช่ของตลาด มีข้อกําหนดเพิ่มเติมในการรวม seller_ids โปรดดูที่ Marketplace sellerId สําหรับข้อมูลเพิ่มเติม | aes-de4-ss |
สามารถดูไฟล์ตัวอย่างที่แสดงเป็นตารางด้านล่าง:
product_code | name | image_url | inventory | description | filter:Category | filter:Size | filter:Country | groups | price | brand | type | retailer_taxonomy | google_taxonomy | global_identifier | seller_id | subClassName | XSellSubClassName |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
80591101 | แพ็คของขวัญแอ๊บซินท์กรีนแฟรี่ 500 มล. | https://www.retailer.com/product/1234.jpg | 20 | แอ๊บซินท์กรีนแฟรี่และแพ็คของขวัญช้อนนี้เป็นของขวัญที่สมบูรณ์แบบสำหรับคนรักแอ๊บซินท์หรือค็อกเทล วางน้ำตาลก้อนหนึ่งบนช้อนแล้วเทแอ๊บซินท์ลงด้านบนเพื่อดื่มสุรานี้แบบแท้จริง | ของขวัญ, แอลกอฮอล์, Gift-packs | 500 มล. | สาธารณรัฐเชก | ของขวัญ, แอลกอฮอล์, Gift-packs | 5.00 | กรีนแฟรี่ | แอลกอฮอล์ | ของขวัญ > เครื่องดื่มแอลกอฮอล์ > ชุดของขวัญ | อาหาร เครื่องดื่มและยาสูบ > เครื่องดื่ม > เครื่องดื่มแอลกอฮอล์ > สุราและสุรา > แอ๊บซินท์ | 8594001443079 | 7328s-dmie3-9jdae | ชุดของขวัญ | สุรา |
ไฟล์ TSV ไม่สามารถอยู่ในรูปแบบที่ยกมา
ไฟล์ XML
CitrusAd ได้กำหนดรายการแท็กที่ใช้อธิบายเอกสาร XML สำหรับผลิตภัณฑ์ ตารางด้านล่างแสดงแท็กและคำอธิบาย แท็ก 'item' ใช้เพื่ออธิบายผลิตภัณฑ์ในเอกสาร XML แท็กอื่นๆ ทั้งหมดสำหรับช่องอื่นๆ จะต้องเขียนไว้ในแท็กนี้
แท็ก XML | จำเป็นต้องใช้/ไม่บังคับ | คำอธิบาย |
---|---|---|
item | ต้องระบุ | แท็กนี้ใช้เพื่ออธิบายผลิตภัณฑ์ แท็ก XML อื่นๆ ทั้งหมดสำหรับผลิตภัณฑ์ต้องอยู่ภายในแท็กนี้ เอกสาร XML สำหรับผลิตภัณฑ์ต้องมีรายการแท็กสินค้า ช่องนี้เหมือนกับช่อง gtin และ product_code ในการซิงค์ไฟล์ API และ TSV |
id | ต้องระบุ | รหัสเพื่อระบุผลิตภัณฑ์ในระบบของคุณ เทียบเท่า product_code ในไฟล์ TSV ช่องนี้เหมือนกับช่อง gtin และรายการในการซิงค์ไฟล์ API และ XML |
title | ต้องระบุ | ชื่อผลิตภัณฑ์ |
image_link | จำเป็น สูงสุด 50 ตัวอักษร | ไฮเปอร์ลิงก์ไปยังภาพของผลิตภัณฑ์ ต้องเป็น URL ที่ถูกต้อง |
brand | จำเป็น สูงสุด 70 ตัวอักษร | แบรนด์ของผลิตภัณฑ์ |
availability | จำเป็น 32 บิต แนะนำจำนวนเต็มที่ไม่ได้ลงนาม | แท็กนี้ใช้เพื่ออธิบายสินค้าคงคลังของผลิตภัณฑ์ ค่าต้องเป็นตัวเลข |
description | จำเป็น สูงสุด 5000 ตัวอักษร | แท็กนี้มีไว้เพื่ออธิบายรายละเอียดผลิตภัณฑ์ |
price | ไม่บังคับ แนะนำจุดทศนิยม 2 หลัก | แท็กนี้ใช้เพื่ออธิบายราคาผลิตภัณฑ์ หากระบุค่าภายในแท็ก จะต้องเป็นตัวเลข |
type | ไม่บังคับ สูงสุด 750 ตัวอักษร | ประเภทผลิตภัณฑ์ |
retailer_taxonomy | จำเป็นสำหรับการแสดงที่มาที่ปรับปรุง จําเป็นสําหรับการรวมหมวดหมู่ด้วย ตัวอักษรสูงสุด 750 ตัว | อนุกรมวิธานของผู้ค้าปลีกแต่ละรายของผลิตภัณฑ์ เช่น ผู้ชาย > เสื้อผ้าผู้ชาย > เสื้อสเวตเตอร์ |
google_taxonomy | จำเป็นสำหรับการแสดงที่มาที่ปรับปรุงหาก retailer_taxonomy ไม่สามารถระบุได้สูงสุด 750 ตัวอักษร | อนุกรมวิธาน Google มาตรฐานของผลิตภัณฑ์ ดูข้อมูลเพิ่มเติมได้ที่นี่: https://www.google.com/basepages/producttype/taxonomy.en-US.txt |
global_identifier | จำเป็น สูงสุด 50 ตัวอักษร | ตัวระบุส่วนกลางสําหรับผลิตภัณฑ์ เช่น 08719108994761 |
global_identifier_type | ต้องระบุ | ประเภทตัวระบุส่วนกลาง เช่น GTIN |
custom_payload | ไม่จําเป็นเว้นแต่จะได้รับคําแนะนํา | ฟิลด์นี้มีเพย์โหลดกำหนดเองที่ควรถูกเธรดผ่านไปยังการสร้างโฆษณา ฟิลด์ควรมีอ็อบเจ็กต์ JSON ที่ถูกต้องที่ถูกทำให้เป็นอนุกรมในอาร์เรย์ไบต์และเข้ารหัส Base64 อ็อบเจ็กต์ JSON ควรเป็นไปตามสคีมา |
hfss | ไม่บังคับ | ใช้เพื่อระบุว่าผลิตภัณฑ์นั้นเป็น HFSS หรือไม่ ซึ่งมีประโยชน์เพิ่มเติมใน UI ของ CitrusAd ดู เอกสาร HFSS ของเราสำหรับข้อมูลเพิ่มเติม |
seller_id | ไม่บังคับ สูงสุด 50 ตัวอักษร | รหัสเฉพาะของผู้ขาย จำเป็นก็ต่อเมื่อเริ่มแนะนำการใช้งานแก่ผู้ขายในตลาด สามารถเว้นว่างไว้สำหรับผลิตภัณฑ์ที่ไม่ใช่ของตลาด มีข้อกําหนดเพิ่มเติมในการรวม seller_ids โปรดดูที่ Marketplace sellerId สําหรับข้อมูลเพิ่มเติม |
ตัวอย่างเอกสาร XML ที่ถูกต้องพร้อมแท็กมีดังต่อไปนี้:
<rss>
<item>
<id>80591011</id>
<title>Melissa & Doug Dinosaur Stamp Set, 4yrs+</title>
<description>Imagine a rugged landscape littered with volcanoes, and full of dinosaurs roaming around</description>
<image_link>https://www.retailer.com/productImages/image1.jpg</image_link>
<price>£9.99</price>
<brand>Melissa & Doug</price>
<product_type>Food Cupboard</product_type>
<availability>10</availability>
<hfss>true</hfss>
</item>
<item>
<id>87086011</id>
<title>Waitrose Splits Strawberry Ice Lollies</title>
<description>Strawberry splits; Suitable for vegetarians. Strawberry splits vanilla flavoured ice cream with a fruity strawberry ice coating. Our fundamental belief is that few things in life are more important than the food you buy. Good quality is essential.</description>
<image_link>https://www.retailer.com/productImages/image2.jpg</image_link>
<price>£1.25</price>
<brand>Waitrose</brand>
<product_type>Frozen Ice Cream Ice Cream Lollies</product_type>
<availability>20</availability>
<brand>Waitrose</brand>
<hfss>false</hfss>
<seller_id>432un3-sd32s-ssaar</seller_id>
</item>
</rss>
เพย์โหลดที่กําหนดเอง
เพย์โหลดที่กําหนดเองคืออะไร
เพย์โหลดที่กำหนดเองคือฟิลด์ที่มีเธรดผ่าน ‘ตามที่เป็น’ ตั้งแต่การนำเข้าแค็ตตาล็อกไปจนถึงการแสดงโฆษณา จะไม่มีการนำการเปลี่ยนแปลงไปใช้ในฟิลด์ อย่างไรก็ตาม จะมีการดำเนินการการตรวจสอบตาม JSON Schema ( https://json-schema.org/ ) ในฟิลด์ ข้อมูลจำเพาะของเพย์โหลดมีให้ผ่านลิงก์ด้านล่าง (สัญกรณ์ JSON Schema):
ในการตอบกลับโฆษณาผลิตภัณฑ์ เพย์โหลดที่กำหนดเองที่ถูกต้องจะถูกส่งคืนไปยังผู้รวมระบบในฟิลด์ชื่อ customPayload
ตัวอย่างเพย์โหลดที่ถูกต้องแสดงไว้ด้านล่าง:
{
"id": "102013703",
"upc": "4400000463",
"name": "Bee Farms Honey - 14.4 Oz",
"nutrientName": [
"Kosher"
],
"description": "Honey",
"brand": "Bee Farms",
"imageUrl": "https://www.retailer.com/products/1/image.png",
"productUrl": "https://www.retailer.com/products/1/page.html",
"aisleId": "1_22_2_3",
"departmentName": "Breakfast ",
"aisleName": "Breakfast spreads",
"shelfName": "Honeu",
"salesRank": 481,
"details": "Made with real honey. No high fructose corn syrup. 8 g of while grain per 31 g serving. Per 8 Crackers: 130 calories; 0 g sat fat (% DV); 160 mg sodium (7% DV); 8 g total sugars. Start with: Bee farms honey grahams. Fill grahams with toasted marshmallows. Add milk chocolate squares. For full nutritional information, go to honeymaid.com. Try our other delicious flavors: Grahams made with real cinnamon. Grahams made with real chocolate. 8 g of whole grain per 31 g serving. Nutritionist recommend eating 18 g or more of whole grains throughout the day. 100% Whole Grain: 8 per serving. Eat 48 g or more of whole grains daily. WholeGrainsCouncil.org. Smartlabel. Visit us at: beefarms.com 1-809-622-4726 please have package available. Keep it Going: 100 recycled paperboard. Please recycle this carton. Minimum 35% post-consumer content. Made in Mexico.",
"averageWeight": 0,
"displayType": 0,
"stores": [
{
"storeId": "2543",
"price": 3.99,
"salePrice": 0.28,
"pricePer": 4.99,
"unitOfMeasure": "OUNCE",
"restrictedFlag": false,
"sellByWeight": false,
"promoDescription": "I",
"promoText": "Club Price: $3.99<BR>SAVE up to: $1",
"promoType": "P",
"offerFlag": true
},
{
"storeId": "2544",
"price": 3.99,
"salePrice": 0.28,
"pricePer": 4.99,
"unitOfMeasure": "OUNCE",
"restrictedFlag": false,
"sellByWeight": false,
"promoDescription": "I",
"promoText": "Club Price: $3.99<BR>SAVE up to: $1",
"promoType": "P",
"offerFlag": true
}
]
}
ไฟล์เท่านั้น
โปรดทราบว่าเพย์โหลดแบบกำหนดเองได้รับการสนับสนุนเฉพาะเมื่อซิงโครไนซ์ผลิตภัณฑ์ผ่านไฟล์เท่านั้น
เพย์โหลดที่กำหนดเองในการสร้างโฆษณา
เมื่อส่งคืนโฆษณาผลิตภัณฑ์ เพย์โหลดที่กำหนดเองจะถูกเธรดผ่านเป็นส่วนหนึ่งของโฆษณาที่สร้างขึ้น เพย์โหลดโฆษณาที่ส่งคืนจะมีฟิลด์เพิ่มเติม customPayload
ที่จะมีอ็อบเจ็กต์ JSON ที่เป็นไปตามข้อกำหนดเดียวกันกับข้อมูลที่ให้ไว้ในฟีด
ตัวอย่างการตอบสนองอาจเป็น:
{
"ads": [
{
"id": "display_SEY2W7-VZzspoirbw4ANs-r-w6YyODk5MDQ5UA==",
"gtin": "4400000463",
"customPayload": {
"id": "102013703",
"upc": "4400000463",
"name": "Bee Farms Honey - 14.4 Oz",
"nutrientName": [
"Kosher"
],
"description": "Honey",
"brand": "Bee Farms",
"imageUrl": "https://www.retailer.com/products/1/image.png",
"productUrl": "https://www.retailer.com/products/1/page.html",
"aisleId": "1_22_2_3",
"departmentName": "Breakfast ",
"aisleName": "Breakfast spreads",
"shelfName": "Honeu",
"salesRank": 481,
"details": "Made with real honey. No high fructose corn syrup. 8 g of while grain per 31 g serving. Per 8 Crackers: 130 calories; 0 g sat fat (% DV); 160 mg sodium (7% DV); 8 g total sugars. Start with: Bee farms honey grahams. Fill grahams with toasted marshmallows. Add milk chocolate squares. For full nutritional information, go to honeymaid.com. Try our other delicious flavors: Grahams made with real cinnamon. Grahams made with real chocolate. 8 g of whole grain per 31 g serving. Nutritionist recommend eating 18 g or more of whole grains throughout the day. 100% Whole Grain: 8 per serving. Eat 48 g or more of whole grains daily. WholeGrainsCouncil.org. Smartlabel. Visit us at: beefarms.com 1-809-622-4726 please have package available. Keep it Going: 100 recycled paperboard. Please recycle this carton. Minimum 35% post-consumer content. Made in Mexico.",
"averageWeight": 0,
"displayType": 0,
"stores": [
{
"storeId": "2543",
"price": 3.99,
"salePrice": 0.28,
"pricePer": 4.99,
"unitOfMeasure": "OUNCE",
"restrictedFlag": false,
"sellByWeight": false,
"promoDescription": "I",
"promoText": "Club Price: $3.99<BR>SAVE up to: $1",
"promoType": "P",
"offerFlag": true
},
{
"storeId": "2544",
"price": 3.99,
"salePrice": 0.28,
"pricePer": 4.99,
"unitOfMeasure": "OUNCE",
"restrictedFlag": false,
"sellByWeight": false,
"promoDescription": "I",
"promoText": "Club Price: $3.99<BR>SAVE up to: $1",
"promoType": "P",
"offerFlag": true
}
]
} ,
"discount": {
"amount": 0,
"minPrice": 0,
"maxPerCustomer": 0
},
"expiry": "2019-12-10T01:46:07.516943179Z"
}
],
"banners": [],
"products": []
}
เนื่องจากเพย์โหลดที่กําหนดเองเป็นภาระงานเพิ่มเติมสําหรับบริการสร้างโฆษณาของเรา โปรดทราบว่าการผสานรวมเพย์โหลดที่กําหนดเองจะไม่อยู่ภายใต้ CitrusAd SLA เว้นแต่จะระบุไว้เป็นอย่างอื่น