ทรัพยากรของแค็ตตาล็อก
ทรัพยากรแค็ตตาล็อกช่วยให้คุณสามารถจัดการแค็ตตาล็อกในที่เก็บ Microsoft Merchant Center (MMC) ของคุณได้ สําหรับข้อมูลเกี่ยวกับการใช้ทรัพยากรแค็ตตาล็อก ให้ดู การจัดการแค็ตตาล็อกของคุณ ตัวอย่างเช่น ที่แสดงวิธีการเพิ่ม ลบ และรับแค็ตตาล็อก ดูตัวอย่างโค้ด
URI พื้นฐาน
ต่อไปนี้คือ URI พื้นฐานที่คุณผนวกเทมเพลต
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
เทมเพลต
หากต้องการสร้างจุดสิ้นสุดที่คุณใช้ในการจัดการแค็ตตาล็อกของคุณ ให้ผนวกเทมเพลตที่เหมาะสมเข้ากับ URI พื้นฐาน
| แม่ แบบ | คํากริยา HTTP | คำอธิบาย | ทรัพยากร |
|---|---|---|---|
| {mmcMerchantId}/แค็ตตาล็อก | ประกาศ | ใช้ เพื่อเพิ่มแค็ตตาล็อกไปยังที่เก็บ เมื่อต้องการเพิ่มแค็ตตาล็อก ชื่อของแค็ตตาล็อกต้องไม่ซ้ํากัน คุณสามารถเพิ่มแค็ตตาล็อกได้สูงสุด 100 รายการไปยังร้านค้า ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMC |
การร้องขอ: แค็ตตาล็อก การตอบสนอง: แค็ตตาล็อก |
| {mmcMerchantId}/แค็ตตาล็อก/{catalogId} | ใส่ | ใช้เพื่ออัปเดตแค็ตตาล็อกในที่เก็บ เขตข้อมูลเดียวที่คุณอาจอัปเดตได้คือ name เขตข้อมูล และ isPublishingEnabled คุณต้องระบุทั้งสองเขตข้อมูลตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMC |
การร้องขอ: แค็ตตาล็อก การตอบสนอง: แค็ตตาล็อก |
| {mmcMerchantId}/แค็ตตาล็อก/{catalogId} | ลบ | ใช้เพื่อลบแค็ตตาล็อกจากที่เก็บ ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMCตั้งค่า {catalogId} เป็น ID ของแค็ตตาล็อก |
การร้องขอ: N/A การตอบสนอง: N/A |
| {mmcMerchantId}/แค็ตตาล็อก/{catalogId} | รับ | ใช้ เพื่อรับแค็ตตาล็อกจากที่เก็บ ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMCตั้งค่า {catalogId} เป็น ID ของแค็ตตาล็อก |
การร้องขอ: N/A การตอบสนอง: แค็ตตาล็อก |
| {mmcMerchantId}/แค็ตตาล็อก | รับ | ใช้ เพื่อรับรายการแค็ตตาล็อกจากที่เก็บ ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMC |
การร้องขอ: N/A การตอบสนอง: แค็ตตาล็อก |
พารามิเตอร์คิวรี
ปลายทางอาจรวมถึงพารามิเตอร์คิวรีต่อไปนี้
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| Alt | เสริม ใช้ เพื่อระบุชนิดของเนื้อหาที่ใช้ในการร้องขอและการตอบกลับ ค่าที่เป็นไปได้คือ json และxml ค่าเริ่มต้นคือjson |
หัว กระดาษ
ต่อไปนี้คือส่วนหัวของคําขอและการตอบสนอง
| หัว ข้อ | คำอธิบาย |
|---|---|
| AuthenticationToken | ส่วนหัวของคําขอ ตั้งค่าส่วนหัวนี้เป็นโทเค็นการรับรองความถูกต้อง OAuth สําหรับข้อมูลเกี่ยวกับการรับโทเค็น ให้ดู การรับรองความถูกต้องข้อมูลประจําตัวของคุณ |
| เนื้อหา-ตําแหน่งที่ตั้ง | ส่วนหัวการตอบสนอง URL ที่ระบุที่เก็บที่มีการแทรกแค็ตตาล็อกเข้าไป ส่วนหัวนี้จะรวมอยู่ในการตอบสนองของคําขอแทรก |
| CustomerAccountId | ส่วนหัวของคําขอ ID บัญชีของบัญชีใดๆ ที่คุณจัดการในนามของลูกค้าที่ระบุไว้ใน CustomerId ส่วนหัว ไม่สําคัญว่าคุณระบุบัญชีใด ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการบัญชีในนามของลูกค้าเท่านั้น |
| CustomerId | ส่วนหัวของคําขอ รหัสลูกค้าของลูกค้าที่คุณจัดการร้านค้า ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการร้านค้าในนามของลูกค้าเท่านั้น หากคุณตั้งค่าส่วนหัวนี้ คุณต้องตั้งค่า CustomerAccountId ส่วนหัวด้วย |
| DeveloperToken | ส่วนหัวของคําขอ โทเค็นการเข้าถึงสําหรับนักพัฒนาแอปพลิเคชันไคลเอ็นต์ แต่ละคําขอต้องมีส่วนหัวนี้ สําหรับข้อมูลเกี่ยวกับการรับโทเค็น ให้ดูที่ คุณมีข้อมูลประจําตัว Microsoft Advertising และโทเค็นสําหรับนักพัฒนาหรือไม่ |
| สถาน | ส่วนหัวการตอบสนอง URL ที่ระบุที่เก็บที่มีการแทรกแค็ตตาล็อกเข้าไป ส่วนหัวนี้จะรวมอยู่ในการตอบสนองของคําขอแทรก |
| WebRequestActivityId | ส่วนหัวการตอบสนอง ID ของรายการบันทึกที่มีรายละเอียดเกี่ยวกับคําขอ คุณควรจับภาพ ID นี้เสมอถ้ามีข้อผิดพลาดเกิดขึ้น หากคุณไม่สามารถระบุและแก้ไขปัญหาได้ ให้ใส่ ID นี้พร้อมกับข้อมูลอื่น ๆ ที่คุณให้ทีมสนับสนุน |
วัตถุการร้องขอและการตอบสนอง
ต่อไปนี้คือคําขอและวัตถุการตอบสนองที่ใช้โดย API
แต่ละวัตถุจะกําหนดชื่อคีย์ JSON และชื่อองค์ประกอบ XML ที่คุณใช้โดยขึ้นอยู่กับชนิดเนื้อหาที่คุณระบุสําหรับคําขอ
| วัตถุ | คำอธิบาย |
|---|---|
| แค็ต ตา ล็อก | กําหนดแค็ตตาล็อก |
| แค็ต ตา ล็อก | กําหนดรายการของแค็ตตาล็อก |
แค็ต ตา ล็อก
กําหนดแค็ตตาล็อก
| ชื่อ | ค่า | ชนิด | ชื่อองค์ประกอบ XML |
|---|---|---|---|
| Id | ID ที่ระบุแค็ตตาล็อกในที่เก็บโดยไม่ซ้ํากัน เขตข้อมูลนี้เป็นแบบอ่านอย่างเดียว อย่าตั้งค่าเขตข้อมูลนี้ |
แบบยาวแบบไม่ใส่ลายเซ็น | <Id> |
| isDefault | ค่าบูลีนที่กําหนดว่าแค็ตตาล็อกเป็นแค็ตตาล็อกเริ่มต้นของที่เก็บหรือไม่
เป็นจริงถ้าแค็ตตาล็อกเป็นแค็ตตาล็อกเริ่มต้นของที่เก็บ มิฉะนั้น จะเป็นเท็จ เมื่อคุณสร้างร้านค้า คุณจะได้รับแค็ตตาล็อกเริ่มต้นที่เขียนผลิตภัณฑ์ถ้าคุณไม่ได้ระบุแค็ตตาล็อกอื่น เขตข้อมูลนี้เป็นแบบอ่านอย่างเดียว อย่าตั้งค่าเขตข้อมูลนี้ |
บูลีน | <is_default> |
| isPublishingEnabled | ค่าบูลีนที่กําหนดว่า Microsoft อาจเผยแพร่ผลิตภัณฑ์จากแค็ตตาล็อกหรือไม่ ตั้งค่าเป็น จริง ถ้า Microsoft อาจเผยแพร่ผลิตภัณฑ์จากแค็ตตาล็อก มิฉะนั้น ให้ตั้งค่าเป็น เท็จ คุณสามารถอัปเดตเขตข้อมูลนี้ได้ คุณยังสามารถใช้ฟิลด์นี้เพื่อทดสอบแอพลิเคชันของคุณก่อนที่จะปรับใช้กับการผลิต ด้วยการตั้งค่าเขตข้อมูลนี้เป็น เท็จ คุณอาจเรียกใช้ ทรัพยากรผลิตภัณฑ์ โดยไม่ต้องเปลี่ยนหรือเผยแพร่ข้อมูลการผลิตของคุณ |
บูลีน | <is_publishing_enabled> |
| ตลาด | ตลาดที่มีการเผยแพร่ผลิตภัณฑ์ในแค็ตตาล็อกไป หมาย เหตุ: ยังไม่ใช่ทุกคนที่มีฟีเจอร์นี้ หากคุณไม่ทําสิ่งใด ไม่ต้องกังวล เพราะมันจะมาในเร็วๆ นี้! ต่อไปนี้คือตลาดที่เป็นไปได้ที่คุณอาจระบุ
คุณไม่สามารถอัปเดตเขตข้อมูลนี้หลังจากเพิ่มแค็ตตาล็อกลงในที่เก็บ ในรายการข้างต้น de-DE คือมูลค่าตลาดที่คุณระบุ ไม่รวม (เยอรมัน-เยอรมนี) ในสตริงตลาดของคุณ |
สตริง | <ตลาด> |
| ชื่อ | ชื่อของแค็ตตาล็อก ชื่อสามารถมีอักขระได้สูงสุด 70 อักขระ คุณสามารถอัปเดตเขตข้อมูลนี้ได้ |
สตริง | <ชื่อ> |
แค็ต ตา ล็อก
กําหนดรายการของแค็ตตาล็อก
| ชื่อ | ค่า | ชนิด | ชื่อองค์ประกอบ XML |
|---|---|---|---|
| แค็ต ตา ล็อก | รายการแค็ตตาล็อกในที่เก็บ | แค็ตตาล็อก[] | <แค็ต ตา ล็อก> |
รหัสสถานะ HTTP
คําขออาจส่งกลับรหัสสถานะ HTTP ต่อไปนี้
| รหัสสถานะ | คำอธิบาย |
|---|---|
| 200 | สำเร็จ |
| 201 | เพิ่มแค็ตตาล็อกเรียบร้อยแล้ว |
| 204 | ลบแค็ตตาล็อกเรียบร้อยแล้ว |
| 400 | การร้องขอไม่ถูกต้อง ค่าพารามิเตอร์คิวรีไม่ถูกต้องหรือบางอย่างในเนื้อความของการร้องขอไม่ถูกต้อง |
| 401 | ไม่ได้รับอนุญาต ข้อมูลประจําตัวของผู้ใช้ไม่ถูกต้อง |
| 404 | ไม่พบ |
| 500 | ข้อผิดพลาดที่เซิร์ฟเวอร์ |