แชร์ผ่าน


เก็บทรัพยากร

หมายเหตุ

ทรัพยากร Store พร้อมใช้งานสําหรับผู้เข้าร่วมแบบเบต้าที่ปิดแล้วเท่านั้น สําหรับข้อมูลเกี่ยวกับการเข้าร่วมในโปรแกรมเบต้าแบบปิดหรือโปรแกรมเบต้าแบบเปิด โปรดติดต่อผู้จัดการบัญชีของคุณ

องค์ประกอบการเขียนโปรแกรมและเอกสารของ Store ทั้งหมดอาจเปลี่ยนแปลงได้ระหว่างเบต้า

ใช้ทรัพยากร Store เพื่อจัดการร้านค้าที่ผู้ใช้เป็นเจ้าของ คุณสามารถเพิ่มร้านค้า รับร้านค้าเฉพาะ หรือรับร้านค้าทั้งหมดที่ผู้ใช้เป็นเจ้าของ อ่านเพิ่มเติม

URI พื้นฐาน

ต่อไปนี้คือ URI พื้นฐานที่คุณผนวกเทมเพลต

https://content.api.ads.microsoft.com/v9.1/bmc

ตัวอย่างเช่น เมื่อต้องการเพิ่มร้านค้าหรือรับรายการร้านค้าที่ผู้ใช้เป็นเจ้าของ ให้ใช้จุดสิ้นสุดต่อไปนี้:

https://content.api.ads.microsoft.com/v9.1/bmc/stores

เทมเพลต

ต่อไปนี้คือเทมเพลตที่คุณผนวกเข้ากับ URI พื้นฐาน เพื่อสร้างจุดสิ้นสุด HTTP

/store เทมเพลต

คํากริยา HTTP คำอธิบาย ทรัพยากร
ประกาศ เพิ่มร้านค้า ข้อจํากัดต่อไปนี้จะมีผลและอาจมีการเปลี่ยนแปลง:
  • ลูกค้าอาจเพิ่มร้านค้าได้สูงสุด 14 ร้านที่ระบุ URL ของร้านค้าเดียวกัน
  • ลูกค้าสามารถเพิ่มร้านค้าได้สูงสุด 1,024 ร้าน
การร้องขอ: StoreCreate
การตอบสนอง: ที่เก็บ
รับ รับรายการของร้านค้าที่ผู้ใช้เป็นเจ้าของ การร้องขอ: N/A
การตอบสนอง: StoreCollection

/store/{merchantId} เทมเพลต

คํากริยา HTTP คำอธิบาย ทรัพยากร
รับ รับที่เก็บที่ระบุ ตั้งค่า {merchantId} เป็น ID ของร้านค้าที่คุณต้องการรับ การร้องขอ: N/A
การตอบสนอง: ที่เก็บ

พารามิเตอร์คิวรี

คําขออาจรวมถึงพารามิเตอร์คิวรีต่อไปนี้:

พารามิเตอร์ คำอธิบาย
แห้ง- ทํางาน เสริม ใช้เพื่อทดสอบหรือดีบักแอปพลิเคชันของคุณ การเรียกที่รวมพารามิเตอร์นี้จะไม่ส่งผลกระทบต่อข้อมูลการผลิต (ไม่ได้เพิ่มร้านค้า) อย่างไรก็ตาม การตอบสนองจะมีข้อผิดพลาดใดๆ ที่การเรียกสร้างขึ้น

พิจารณาข้อจํากัดต่อไปนี้เมื่อใช้พารามิเตอร์นี้
  • เพิ่มการดําเนินการไม่ส่งกลับรหัส
  • บริการไม่ได้สร้างหรือส่งกลับข้อความข้อผิดพลาดรอง เช่น คุณภาพข้อมูล ปัญหาด้านบรรณาธิการ และการตรวจสอบที่เกี่ยวข้องกับฐานข้อมูล
สําหรับข้อมูลเพิ่มเติมเกี่ยวกับการทดสอบแอปพลิเคชันของคุณ ให้ดู Sandbox

หัว กระดาษ

ต่อไปนี้คือส่วนหัวของคําขอและการตอบสนอง

หัว ข้อ คำอธิบาย
AuthenticationToken ส่วนหัวของคําขอ

ตั้งค่าส่วนหัวนี้เป็นโทเค็นการเข้าถึง OAuth สําหรับข้อมูลเกี่ยวกับการรับโทเค็นการเข้าถึง ให้ดู การรับรองความถูกต้องข้อมูลประจําตัวของคุณ
Content-Type ส่วนหัวของคําขอ

การร้องขอ POST ทั้งหมดต้องระบุส่วนหัวนี้ และต้องตั้งค่าเป็นapplication/json
CustomerAccountId ส่วนหัวของคําขอ

ID บัญชีของบัญชีใดๆ ที่คุณจัดการในนามของลูกค้าที่ระบุไว้ใน CustomerId ส่วนหัว ไม่สําคัญว่าคุณระบุบัญชีใด ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการบัญชีในนามของลูกค้าเท่านั้น
CustomerId ส่วนหัวของคําขอ

รหัสลูกค้าของลูกค้าที่คุณจัดการร้านค้า ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการร้านค้าในนามของลูกค้าเท่านั้น หากคุณตั้งค่าส่วนหัวนี้ คุณต้องตั้งค่า CustomerAccountId ส่วนหัวด้วย
DeveloperToken ส่วนหัวของคําขอ

โทเค็นนักพัฒนาของแอปพลิเคชันไคลเอ็นต์ แต่ละคําขอต้องมีส่วนหัวนี้ สําหรับข้อมูลเกี่ยวกับการรับโทเค็น ให้ดูที่ คุณมีข้อมูลประจําตัว Microsoft Advertising และโทเค็นสําหรับนักพัฒนาหรือไม่
WebRequestActivityId ส่วนหัวการตอบสนอง

ID ของรายการแฟ้มบันทึกที่ประกอบด้วยรายละเอียดของการร้องขอ คุณควรจับภาพ ID นี้เสมอถ้ามีข้อผิดพลาดเกิดขึ้น หากคุณไม่สามารถระบุและแก้ไขปัญหาได้ ให้ใส่ ID นี้พร้อมกับข้อมูลอื่น ๆ ที่คุณให้ทีมสนับสนุน

วัตถุการร้องขอและการตอบสนอง

ต่อไปนี้คือคําขอและวัตถุการตอบสนองที่ใช้โดย API

วัตถุ คำอธิบาย
ข้อผิดพลาด กําหนดข้อผิดพลาด
ErrorResponse กําหนดวัตถุข้อผิดพลาดระดับบนสุด
เก็บ กําหนดร้านค้าใน Microsoft Merchant Center
StoreCollection กําหนดคอลเลกชันของร้านค้าใน Microsoft Merchant Center
StoreCreate กําหนดร้านค้าเพื่อเพิ่มไปยัง Microsoft Merchant Center
StoreStatus กําหนดสถานะของร้านค้า

ข้อผิดพลาด

กําหนดข้อผิดพลาด

ชื่อ ค่า ชนิด
รหัส เหตุผลที่คําขอล้มเหลว ตัวอย่างเช่น รหัสคือ InvalidStoreNameErr ถ้า storeName การตรวจสอบความถูกต้องของเขตข้อมูลล้มเหลว สตริง
ข้อความ คําอธิบายของข้อผิดพลาด สตริง

ErrorResponse

กําหนดวัตถุข้อผิดพลาดระดับบนสุด

ชื่อ ค่า ชนิด
ข้อ ผิด พลาด รายการข้อผิดพลาดที่เกิดขึ้นขณะประมวลผลการร้องขอ ข้อผิดพลาด[]

เก็บ

กําหนดร้านค้าใน Microsoft Merchant Center

ชื่อ ค่า ชนิด
isBlockAggregator ค่าบูลีนที่ระบุว่าคุณต้องการป้องกันไม่ให้ตัวรวมแสดงโฆษณาจากร้านค้าของคุณหรือไม่ Aggregators รวมผลิตภัณฑ์ที่นําเสนอจากหลายธุรกิจ ซึ่งมักไม่เกี่ยวข้องกัน ตามค่าเริ่มต้น ตัวรวมสามารถรวมแค็ตตาล็อกของคุณไว้ในโฆษณาของพวกเขาได้

เป็นจริงหากคุณต้องการป้องกันไม่ให้ผลิตภัณฑ์แสดงขึ้นในโฆษณาของผู้รวมใน Bing ถ้าคุณมีร้านค้าสองแห่ง (ร้านค้าหนึ่งสําหรับสหรัฐอเมริกาและอีกแห่งหนึ่งสําหรับสหราชอาณาจักร) ที่ใช้ http://www.contoso.com และหนึ่งในนั้นบล็อกการรวม แล้วทั้งสองร้านค้าจะบล็อกการรวม
บูลีน
isSslCheckout ค่าบูลีนที่ระบุว่าร้านค้าของคุณเปิดใช้งาน SSL หรือไม่ ร้านค้าทั้งหมดต้องมีหน้าเข้าสู่ระบบและเช็คเอาท์ SSL เป็นจริงถ้าเว็บไซต์ของร้านค้าของคุณเปิดใช้งาน SSL บูลีน
merchantId ID ของร้านค้า ความยาวที่ไม่เซ็นชื่อ
notificationEmail รายชื่อผู้รับเพื่อรับอีเมลแจ้งเตือน อีเมลจะแจ้งให้คุณทราบเมื่อร้านค้าได้รับการอนุมัติหรือมีข้อผิดพลาดในการตรวจสอบความถูกต้องกับร้านค้า String[]
notificationLanguage ภาษาที่ใช้เขียนอีเมลแจ้งเตือน ภาษาอยู่ในรูปแบบ <ภาษา>-<ประเทศ/ภูมิภาค> ตัวอย่างเช่น en-US สตริง
storeDescription คําอธิบายที่อธิบายการใช้งานของร้านค้า สตริง
storeName ชื่อของร้านค้า สตริง
storeStatus สถานะของร้านค้า StoreStatus
storeUrl URL ปลายทางของร้านค้า URL ปลายทางคือหน้าเว็บที่ผู้คนจะถูกนําไปยังเมื่อพวกเขาคลิกโฆษณาของคุณ สตริง

StoreCollection

กําหนดรายการของร้านค้า

ชื่อ ค่า ชนิด
ร้าน ค้า รายการร้านค้าที่ผู้ใช้เป็นเจ้าของ Store[]

StoreCreate

กําหนดร้านค้าเพื่อเพิ่มไปยัง Microsoft Merchant Center

ชื่อ ค่า ชนิด ต้องระบุ
isBlockAggregator ค่าบูลีนที่ระบุว่าคุณต้องการป้องกันไม่ให้ตัวรวมแสดงโฆษณาจากร้านค้าของคุณหรือไม่ Aggregators รวมผลิตภัณฑ์ที่นําเสนอจากหลายธุรกิจ ซึ่งมักไม่เกี่ยวข้องกัน ตามค่าเริ่มต้น ตัวรวมสามารถรวมแค็ตตาล็อกของคุณไว้ในโฆษณาของพวกเขาได้

ตั้งค่า เป็นจริง เพื่อป้องกันไม่ให้สินค้าของคุณแสดงขึ้นในโฆษณาของการรวมบน Bing ถ้าคุณมีร้านค้าสองแห่ง (ร้านค้าหนึ่งสําหรับสหรัฐอเมริกาและอีกแห่งหนึ่งสําหรับสหราชอาณาจักร) ที่ใช้ http://www.contoso.com และหนึ่งในนั้นบล็อกการรวม แล้วทั้งสองร้านค้าจะบล็อกการรวม

ค่าเริ่มต้นเป็น เท็จ
บูลีน ไม่ใช่
isSslCheckout ค่าบูลีนที่ระบุว่าร้านค้าของคุณเปิดใช้งาน SSL หรือไม่ ร้านค้าทั้งหมดต้องมีหน้าเข้าสู่ระบบและเช็คเอาท์ SSL ตั้งค่าเป็น จริง ถ้าเว็บไซต์ของร้านค้าของคุณเปิดใช้งาน SSL หากเป็น เท็จ ร้านค้าจะไม่ได้รับอนุมัติ

ค่าเริ่มต้นเป็น จริง
บูลีน ไม่ใช่
notificationEmail รายชื่อผู้รับเพื่อรับอีเมลแจ้งเตือน อีเมลจะแจ้งให้คุณทราบเมื่อร้านค้าได้รับการอนุมัติหรือมีข้อผิดพลาดในการตรวจสอบความถูกต้องกับร้านค้า จํานวนสูงสุดของที่อยู่อีเมลที่คุณอาจระบุคือ 14 String[] ใช่
notificationLanguage ภาษาที่ใช้เขียนอีเมลแจ้งเตือน ภาษาอยู่ในรูปแบบ <ภาษา>-<ประเทศ/ภูมิภาค> ต่อไปนี้คือค่าที่ไม่ตรงตามตัวพิมพ์ใหญ่-เล็กที่คุณอาจระบุ
  • en-US (อังกฤษ-สหรัฐอเมริกา)
  • en-AU (อังกฤษ-ออสเตรเลีย)
  • en-GB (อังกฤษ-สหราชอาณาจักร)
  • fr-FR (ฝรั่งเศส- ฝรั่งเศส)
  • de-DE (เยอรมัน-เยอรมนี)
  • ja-JP (ญี่ปุ่น)
สตริง ใช่
storeDescription คําอธิบายที่อธิบายการใช้งานของร้านค้า คําอธิบายจะถูกจํากัดไว้ที่อักขระไม่เกิน 350 อักขระ และประกอบด้วยตัวอักษรและตัวเลขเท่านั้น ([a-zA-Z0-9]) สตริง ไม่ใช่
storeName ชื่อของร้านค้า เนื่องจากชื่อของร้านค้าปรากฏในโฆษณาผลิตภัณฑ์ โปรดใช้ชื่อที่แสดงเว็บไซต์ของคุณอย่างถูกต้อง ชื่อจะต้อง:
  • ไม่ซ้ํากันภายใน Bing Merchant Center
  • มีอักขระไม่เกิน 70 ตัว
  • ประกอบด้วยอักขระพยัญชนะผสมตัวเลขเท่านั้น ([a-zA-Z0-9])
สตริง ใช่
storeUrl URL ปลายทางของร้านค้า URL ปลายทางคือหน้าเว็บที่ผู้คนจะถูกนําไปยังเมื่อพวกเขาคลิกโฆษณาของคุณ URL ต้องไม่เปลี่ยนเส้นทางไปยังตําแหน่งที่ตั้งอื่น URL ต้องมีรูปแบบที่ดีและมีอักขระได้สูงสุด 1,024 อักขระ คุณต้องตรวจสอบและอ้างสิทธิ์ URL ของเว็บไซต์ของคุณ ร้านค้าไม่ได้รับการอนุมัติหาก Microsoft ไม่สามารถตรวจสอบว่าเว็บไซต์ของคุณเป็นไปตามข้อกําหนด SSL หรือไม่ เว็บไซต์ของร้านค้าต้องมีหน้าการลงชื่อเข้าใช้และการชําระเงิน SSL ตรวจสอบว่าใบรับรอง SSL ของคุณถูกต้อง สตริง ใช่

StoreStatus

กําหนดสถานะของร้านค้า

ชื่อ ค่า ชนิด
ข้อความ เหตุผลที่ร้านค้าไม่ได้รับอนุมัติ วัตถุจะรวมเขตข้อมูลนี้เฉพาะในกรณีที่ status ไม่ได้รับอนุมัติเท่านั้น สตริง
สถานะ สถานะของร้านค้า ต่อไปนี้คือค่าที่เป็นไปได้
  • อนุมัติ
  • ไม่ได้รับอนุมัติ
  • ManualReview
หากร้านค้าไม่ได้รับอนุมัติ โปรดดู message เหตุผล

ร้านค้าที่ได้รับการอนุมัติในตอนแรกโดยอัตโนมัติ สามารถย้ายจาก อนุมัติ เป็น ManualReview ได้ คุณไม่สามารถเพิ่มสินค้าไปยังร้านค้าที่อยู่ระหว่างการตรวจสอบด้วยตนเองและผลิตภัณฑ์ในร้านค้าจะไม่ให้บริการ

คุณอาจสามารถแก้ไขปัญหาโดยใช้แอปพลิเคชันโฆษณา Microsoft ได้ ทั้งนี้ขึ้นอยู่กับเหตุผลการไม่อนุมัติ มิฉะนั้น คุณจะต้องสร้างร้านค้าใหม่ด้วยค่าที่เหมาะสม
สตริง

รหัสสถานะ HTTP

คําขออาจส่งกลับรหัสสถานะ HTTP ต่อไปนี้

รหัสสถานะ คำอธิบาย
200 สำเร็จ
201 เพิ่มที่เก็บเสร็จสมบูรณ์แล้ว
400 การร้องขอไม่ถูกต้อง เนื้อความส่วนใหญ่ของการร้องขอ POST มีข้อมูลที่ไม่ถูกต้องหรือมีรูปแบบที่ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต ข้อมูลประจําตัวของผู้ใช้ไม่ถูกต้อง
404 ไม่พบ ไม่พบที่เก็บที่ร้องขอ
500 ข้อผิดพลาดที่เซิร์ฟเวอร์

รหัสข้อผิดพลาด

คําขออาจส่งกลับรหัสข้อผิดพลาดต่อไปนี้

รหัสข้อผิดพลาด คำอธิบาย
AdultAdvertiserErr ผู้ลงโฆษณาสําหรับผู้ใหญ่ไม่สามารถสร้างร้านค้าได้
DomainNotOwnedByCustomerErr โดเมนที่ระบุในเขตข้อมูล storeUrl ไม่ได้เป็นของลูกค้า ตรวจสอบให้แน่ใจว่าลูกค้ายืนยันว่าพวกเขาเป็นเจ้าของโดเมน
DuplicateStoreNameErr มีที่เก็บอื่นที่มีชื่อที่เก็บที่ระบุอยู่ ชื่อร้านค้าต้องไม่ซ้ํากันกับ Microsoft Merchant Center
ExceededMaxStoresForCustomerErr ลูกค้ามีร้านค้าเกินกว่าจํานวนที่ลูกค้าอาจสร้าง สําหรับขีดจํากัด ดูเพิ่มร้านค้าโพสต์
ExceededMaxStoresForDestinationUrlErr ลูกค้ามีร้านค้าเกินจํานวนที่ลูกค้าอาจสร้างโดยใช้ URL ปลายทางเดียวกัน สําหรับขีดจํากัด ดูเพิ่มร้านค้าโพสต์
InvalidStoreDescriptionErr คําอธิบายที่เก็บไม่ถูกต้อง สําหรับขีดจํากัด ดู storeDescription
InvalidStoreDestinationUrlErr URL ปลายทางของร้านค้าที่คุณระบุในเขตข้อมูล storeUrl ไม่ถูกต้อง
InvalidStoreNameErr ชื่อของที่เก็บไม่ถูกต้อง สําหรับขีดจํากัด ดู soreName
MarketNotSupportedErr ตลาดที่คุณระบุในเขตข้อมูล notificationLanguage ไม่ถูกต้อง
NoDomainsFoundForCustomerErr ลูกค้าไม่มีโดเมนที่ได้รับการตรวจสอบแล้วเป็นเจ้าของ