ซิงค์แคตตาล็อก & สินค้าผ่านไฟล์

CitrusAd รองรับรูปแบบสามประเภทสำหรับการซิงค์ข้อมูลผลิตภัณฑ์ผ่านไฟล์:

  • TSV
  • CSV
  • XML

ส่วนนี้อธิบายโครงสร้างของแต่ละรูปแบบไฟล์สำหรับข้อมูลผลิตภัณฑ์ที่เราประมวลผลใน CitrusAd

ไฟล์ TSV/CSV

ตารางด้านล่างแสดงชื่อคอลัมน์และคำอธิบายของคอลัมน์สำหรับผลิตภัณฑ์ในไฟล์ TSV/CSV ในตารางนี้ เรายังระบุคอลัมน์บังคับที่ต้องระบุในไฟล์ เมื่อต้องมีคอลัมน์ ต้องระบุค่าทั้งหมดในคอลัมน์ในแถวของคอลัมน์นั้น

️ TSV ที่ไม่มีเครื่องหมายอัญประกาศ

ไฟล์ TSV ไม่สามารถอยู่ในรูปแบบที่ยกมา เมื่อซิงโครไนซ์ผ่าน TSV ตรวจสอบให้แน่ใจว่าคุณซิงโครไนซ์ไฟล์ที่ไม่มีเครื่องหมายคำพูด

ชื่อคอลัมน์และคำอธิบายข้อมูลผลิตภัณฑ์ในไฟล์ TSV/CSV

ชื่อคอลัมน์จำเป็นต้องใช้/ไม่บังคับประเภทข้อมูลคำอธิบายตัวอย่าง
product_codeต้องระบุข้อความรหัสเพื่อระบุผลิตภัณฑ์ในระบบของคุณ ช่องนี้เหมือนกับช่อง gtin และรายการในการซิงค์ไฟล์ API และ XMLF153212AN1
nameต้องระบุข้อความชื่อผลิตภัณฑ์ทีสติ๊กเกอร์ SS สําหรับเด็ก
image_urlต้องระบุURLไฮเปอร์ลิงก์ไปยังภาพของผลิตภัณฑ์ ต้องเป็น URL ที่ถูกต้องhttps://www.retailer.com/product/1234.jpg
inventoryต้องระบุหมายเลขสินค้าคงคลังของสินค้า หากค่าเป็น 0 จะไม่มีการแสดงโฆษณาผลิตภัณฑ์สำหรับผลิตภัณฑ์1
descriptionต้องระบุข้อความคำอธิบายผลิตภัณฑ์กางเกงวอร์มขาสั้น Sport Sweat มาพร้อมลายปัก Trefoils และแถบสีขาวสามแถบตัดกันเป็นข้อเสนอใหม่ล่าสุดจาก Adidas Originals
KEY (as a value)จำเป็นสำหรับหมวดหมู่และตำแหน่งที่แสดงแบบกว้างข้อความหากใช้คอลัมน์ประเภทนี้ ผู้ค้าปลีกต้องระบุค่าสำหรับ

คุณอาจมีหลายคอลัมน์ที่มีวากยสัมพันธ์นี้ในไฟล์ TSV
ชื่อคอลัมน์อาจเป็น "ตัวกรอง:brand_name" และค่าของเซลล์ในคอลัมน์อาจเป็น "green-fairy"ซึ่งจะส่งผลให้มีตัวกรอง "brand_name:green-fairy" บนผลิตภัณฑ์
subClassNameจำเป็นสำหรับตำแหน่งการขายพ่วง/การขายต่อยอดข้อความชื่อของคลาสย่อย/หมวดหมู่ของผลิตภัณฑ์ที่เกี่ยวข้อง

คลาสย่อยช่วยให้กําหนดเป้าหมายผลิตภัณฑ์ได้ดีขึ้น เช่น ผลิตภัณฑ์เนยสามารถกําหนดเป้าหมายขนมปังได้ แต่จะไม่กําหนดเป้าหมายไปที่เครื่องช่วยวงดนตรี
เนยแข็ง
xSellSubClassNameจำเป็นสำหรับตำแหน่งการขายพ่วง/การขายต่อยอดข้อความชื่อของคลาสย่อย/หมวดหมู่ที่ผลิตภัณฑ์ที่เกี่ยวข้องสามารถกำหนดเป้าหมายผลิตภัณฑ์ภายในขนมปัง, สเปรด, แครกเกอร์
priceไม่บังคับหมายเลขราคาผลิตภัณฑ์30.00
brandต้องระบุข้อความแบรนด์ของผลิตภัณฑ์Tommy Hilfiger
typeต้องระบุข้อความประเภทผลิตภัณฑ์เสื้อผ้า
retailer_taxonomyจำเป็นสำหรับการแสดงที่มาที่ปรับปรุง ต้องไม่มีช่องว่างระหว่าง > อักขระข้อความอนุกรมวิธานของผู้ค้าปลีกแต่ละรายของผลิตภัณฑ์ผู้ชาย > เสื้อผ้าผู้ชาย > เสื้อสเวตเตอร์
google_taxonomyจำเป็นสำหรับการแสดงที่มาที่ปรับปรุงหาก retailer_taxonomy ไม่สามารถให้ได้ข้อความอนุกรมวิธาน Google มาตรฐานของผลิตภัณฑ์ ดูข้อมูลเพิ่มเติมได้ที่นี่: https://www.google.com/basepages/producttype/taxonomy.en-US.txtเครื่องแต่งกายและเครื่องประดับ > เสื้อผ้า > เสื้อ
global_identifierต้องระบุข้อความตัวระบุส่วนกลางสําหรับผลิตภัณฑ์08719108994761
global_identifier_typeต้องระบุข้อความประเภทตัวระบุส่วนกลางGTIN
custom_payloadไม่บังคับ*อาร์เรย์ไบต์ที่เข้ารหัส Base64ฟิลด์นี้มีเพย์โหลดกำหนดเองที่ควรถูกเธรดผ่านไปยังการสร้างโฆษณา ฟิลด์ควรมีอ็อบเจ็กต์ JSON ที่ถูกต้องที่ถูกทำให้เป็นอนุกรมในอาร์เรย์ไบต์และเข้ารหัส Base64 อ็อบเจ็กต์ JSON ควรเป็นไปตามสคีมาดูส่วนเพย์โหลดที่กําหนดเอง
hfssไม่บังคับบูลีนใช้เพื่อระบุว่าผลิตภัณฑ์นั้นเป็น HFSS หรือไม่ ซึ่งมีประโยชน์เพิ่มเติมใน UI ของ CitrusAd ดู เอกสาร HFSS ของเราสำหรับข้อมูลเพิ่มเติมจริง
seller_idไม่บังคับข้อความรหัสเฉพาะของผู้ขาย จำเป็นก็ต่อเมื่อเริ่มแนะนำการใช้งานแก่ผู้ขายในตลาด สามารถเว้นว่างไว้สำหรับผลิตภัณฑ์ที่ไม่ใช่ของตลาด

มีข้อกําหนดเพิ่มเติมในการรวม seller_ids โปรดดูที่ Marketplace sellerId สําหรับข้อมูลเพิ่มเติม
aes-de4-ss

สามารถดูไฟล์ตัวอย่างที่แสดงเป็นตารางด้านล่าง:

product_codenameimage_urlinventorydescriptionfilter:Categoryfilter:Sizefilter:Countrygroupspricebrandtyperetailer_taxonomygoogle_taxonomyglobal_identifierseller_idsubClassNameXSellSubClassName
80591101แพ็คของขวัญแอ๊บซินท์กรีนแฟรี่ 500 มล.https://www.retailer.com/product/1234.jpg20แอ๊บซินท์กรีนแฟรี่และแพ็คของขวัญช้อนนี้เป็นของขวัญที่สมบูรณ์แบบสำหรับคนรักแอ๊บซินท์หรือค็อกเทล วางน้ำตาลก้อนหนึ่งบนช้อนแล้วเทแอ๊บซินท์ลงด้านบนเพื่อดื่มสุรานี้แบบแท้จริงของขวัญ, แอลกอฮอล์, Gift-packs500 มล.สาธารณรัฐเชกของขวัญ, แอลกอฮอล์, Gift-packs5.00กรีนแฟรี่แอลกอฮอล์ของขวัญ > เครื่องดื่มแอลกอฮอล์ > ชุดของขวัญอาหาร เครื่องดื่มและยาสูบ > เครื่องดื่ม > เครื่องดื่มแอลกอฮอล์ > สุราและสุรา > แอ๊บซินท์85940014430797328s-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ต้องระบุไฮเปอร์ลิงก์ไปยังภาพของผลิตภัณฑ์ ต้องเป็น URL ที่ถูกต้อง
brandต้องระบุแบรนด์ของผลิตภัณฑ์
availabilityต้องระบุแท็กนี้ใช้เพื่ออธิบายสินค้าคงคลังของผลิตภัณฑ์ ค่าต้องเป็นตัวเลข
descriptionต้องระบุแท็กนี้มีไว้เพื่ออธิบายรายละเอียดผลิตภัณฑ์
priceไม่บังคับแท็กนี้ใช้เพื่ออธิบายราคาผลิตภัณฑ์ หากระบุค่าภายในแท็ก จะต้องเป็นตัวเลข
typeไม่บังคับประเภทผลิตภัณฑ์
retailer_taxonomyจำเป็นสำหรับการแสดงที่มาที่ปรับปรุง จําเป็นสําหรับการรวมหมวดหมู่ด้วยอนุกรมวิธานของผู้ค้าปลีกแต่ละรายของผลิตภัณฑ์ เช่น ผู้ชาย > เสื้อผ้าผู้ชาย > เสื้อสเวตเตอร์
google_taxonomyจำเป็นสำหรับการแสดงที่มาที่ปรับปรุงหาก retailer_taxonomy ไม่สามารถให้ได้อนุกรมวิธาน Google มาตรฐานของผลิตภัณฑ์ ดูข้อมูลเพิ่มเติมได้ที่นี่: https://www.google.com/basepages/producttype/taxonomy.en-US.txt
global_identifierต้องระบุตัวระบุส่วนกลางสําหรับผลิตภัณฑ์ เช่น 08719108994761
global_identifier_typeต้องระบุประเภทตัวระบุส่วนกลาง เช่น GTIN
custom_payloadไม่บังคับ*ฟิลด์นี้มีเพย์โหลดกำหนดเองที่ควรถูกเธรดผ่านไปยังการสร้างโฆษณา ฟิลด์ควรมีอ็อบเจ็กต์ JSON ที่ถูกต้องที่ถูกทำให้เป็นอนุกรมในอาร์เรย์ไบต์และเข้ารหัส Base64 อ็อบเจ็กต์ JSON ควรเป็นไปตามสคีมา
hfssไม่บังคับใช้เพื่อระบุว่าผลิตภัณฑ์นั้นเป็น HFSS หรือไม่ ซึ่งมีประโยชน์เพิ่มเติมใน UI ของ CitrusAd ดู เอกสาร HFSS ของเราสำหรับข้อมูลเพิ่มเติม
seller_idไม่บังคับรหัสเฉพาะของผู้ขาย จำเป็นก็ต่อเมื่อเริ่มแนะนำการใช้งานแก่ผู้ขายในตลาด สามารถเว้นว่างไว้สำหรับผลิตภัณฑ์ที่ไม่ใช่ของตลาด

มีข้อกําหนดเพิ่มเติมในการรวม seller_ids โปรดดูที่ Marketplace sellerId สําหรับข้อมูลเพิ่มเติม

ตัวอย่างเอกสาร XML ที่ถูกต้องพร้อมแท็กมีดังต่อไปนี้:

<rss>
  <item>
      <id>80591011</id>
      <title>Melissa &amp; 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>&pound;9.99</price>
      <brand>Melissa &amp; 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>&pound;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&lt;BR&gt;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&lt;BR&gt;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&lt;BR&gt;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&lt;BR&gt;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 เว้นแต่จะระบุไว้เป็นอย่างอื่น