แชร์ผ่าน

ทรัพยากร ProductStatuses

  • บทความ

หมายเหตุ

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

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

ใช้ทรัพยากร ProductStatuses เพื่อรับสถานะของข้อเสนอผลิตภัณฑ์ในร้านค้า

URI พื้นฐาน

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

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

ตัวอย่างเช่น เมื่อต้องรับมุมมองสรุปของสถานะของผลิตภัณฑ์ที่เสนอในร้านค้า ให้ใช้จุดสิ้นสุดต่อไปนี้:

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

เทมเพลต

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

/store/{merchantId}/productstatusessummary

คํากริยา HTTP คำอธิบาย ทรัพยากร
รับ รับมุมมองสรุปเกี่ยวกับสถานะของข้อเสนอผลิตภัณฑ์ในร้านค้า บริการส่งกลับจํานวนข้อเสนอที่ได้รับอนุมัติ อนุมัติ และหมดอายุในร้านค้า ตั้งค่า {merchantId} เป็น ID ของร้านค้าเพื่อรับสถานะ

อาจใช้เวลาถึงสองชั่วโมงนับจากเวลาที่สถานะของข้อเสนอเปลี่ยนแปลงไปตามเวลาที่แสดงในมุมมองสรุป		 การร้องขอ: N/A
การตอบสนอง: ProductStatusesSummary

/store/{merchantId}/productstatuses

คํากริยา HTTP คำอธิบาย ทรัพยากร
รับ รับมุมมองรายละเอียดของสถานะของข้อเสนอผลิตภัณฑ์ในร้านค้า รายละเอียดจะถูกส่งกลับสําหรับผลิตภัณฑ์ที่มีสถานะเป็น ไม่อนุมัติ หรือ คําเตือน เท่านั้น ตั้งค่า {merchantId} เป็น ID ของร้านค้าที่คุณต้องการรับสถานะ

พารามิเตอร์คิวรี ผลลัพธ์สูงสุด จะกําหนดจํานวนของข้อเสนอที่บริการส่งกลับ หากต้องการดูข้อเสนอทั้งหมด ให้ใช้พารามิเตอร์คิวรีโทเค็นต่อเนื่อง		 การร้องขอ: N/A
การตอบสนอง: ProductStatuses

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

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

พารามิเตอร์ คำอธิบาย
ผลลัพธ์สูงสุด เสริม ใช้ เพื่อระบุจํานวนสูงสุดของหน่วยข้อมูลที่จะส่งกลับในการร้องขอรายการ เช่น/stores/{merchantId}/productstatuses ค่าสูงสุดที่คุณอาจระบุคือ 250 ค่าเริ่มต้นคือ 25
continuation-token เสริม ใช้ เพื่อเลื่อนดูรายการสถานะผลิตภัณฑ์ของร้านค้า โทเค็นจะระบุหน้าถัดไปของสถานะผลิตภัณฑ์ที่จะส่งกลับ ไม่ต้องระบุพารามิเตอร์นี้ในการร้องขอรายการแรก ถ้าร้านค้าประกอบด้วยจํานวนผลิตภัณฑ์ที่ร้องขอมากกว่า (ดูพารามิเตอร์คิวรี ผลลัพธ์สูงสุด ) การตอบสนองจะ nextPageToken รวมถึงเขตข้อมูล ในคําขอถัดไป ให้ตั้งค่า continuation-token เป็นค่าโทเค็นในnextPageToken

หัว กระดาษ

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

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

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

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

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

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

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

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

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

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

วัตถุ คำอธิบาย
ข้อผิดพลาด กําหนดข้อผิดพลาด
ErrorResponse กําหนดวัตถุข้อผิดพลาดระดับบนสุด
ProductStatus กําหนดสถานะของข้อเสนอผลิตภัณฑ์
ProductStatuses กําหนดรายการข้อเสนอของผลิตภัณฑ์ที่มีปัญหา
ProductStatusesSummary กําหนดมุมมองสรุปของสถานะการเสนอผลิตภัณฑ์ในร้านค้า
ProductStatusItemLevelIssue กําหนดปัญหาเกี่ยวกับข้อเสนอผลิตภัณฑ์

ข้อผิดพลาด

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

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

ErrorResponse

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

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

ProductStatus

กําหนดสถานะของข้อเสนอผลิตภัณฑ์

ชื่อ ค่า ชนิด
วันที่สร้าง วันที่และเวลาที่สร้างข้อเสนอผลิตภัณฑ์ Datetime
expirationDate วันที่และเวลาที่ข้อเสนอผลิตภัณฑ์ถูกตั้งค่าให้หมดอายุ Datetime
itemLevelIssues รายการปัญหาเกี่ยวกับข้อเสนอผลิตภัณฑ์ ProductStatusItemLevelIssue[]
lastUpdateDate วันที่และเวลาที่อัปเดตข้อเสนอผลิตภัณฑ์ครั้งล่าสุด Datetime
productId ID ของผลิตภัณฑ์ สตริง
สถานะ สถานะการอนุมัติของผลิตภัณฑ์ ค่าที่เป็นไปได้คือ:
  • ไม่ได้รับอนุมัติ
  • คำเตือน
ไม่มีบริการผลิตภัณฑ์ที่ไม่ได้รับอนุมัติ คําเตือนระบุว่าผลิตภัณฑ์มีปัญหาที่คุณควรแก้ไข แต่ไม่ได้ป้องกันไม่ให้ข้อเสนอผลิตภัณฑ์ให้บริการ คุณควรแก้ไขปัญหาและส่งข้อเสนอผลิตภัณฑ์อีกครั้ง		 สตริง
ชื่อ เรื่อง ชื่อผลิตภัณฑ์ สตริง

ProductStatuses

กําหนดรายการข้อเสนอของผลิตภัณฑ์ที่มีปัญหา

ชื่อ ค่า ชนิด
nextPageToken โทเค็นที่จะตั้งค่าพารามิเตอร์คิวรี โทเค็นต่อเนื่อง เป็นถ้ามีผลิตภัณฑ์เพิ่มเติมที่พร้อมให้รับ สตริง
ทรัพยากร รายการผลิตภัณฑ์ที่มีปัญหา พารามิเตอร์คิวรี ผลลัพธ์สูงสุด จะกําหนดจํานวนสูงสุดของข้อเสนอในรายการ ตัวเลขจริงที่ส่งกลับอาจน้อยกว่า ProductStatus[]

ProductStatusesSummary

กําหนดมุมมองสรุปของสถานะการเสนอผลิตภัณฑ์ในร้านค้า ถ้าร้านค้าเพิ่งถูกสร้างขึ้น ค่าทั้งหมดจะเป็นศูนย์

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

ProductStatusItemLevelIssue

กําหนดปัญหาเกี่ยวกับข้อเสนอผลิตภัณฑ์

ชื่อ ค่า ชนิด
attributeName ชื่อของคุณสมบัติของข้อเสนอผลิตภัณฑ์ที่ก่อให้เกิดปัญหา ปัญหาทั้งหมดไม่ได้ระบุคุณสมบัติ ตัวอย่างเช่น วัตถุไม่รวมเขตข้อมูลนี้ถ้าปัญหาเกิดจากคุณสมบัติมากกว่าหนึ่งรายการ สตริง
รหัส รหัสข้อผิดพลาดที่ระบุปัญหา ตัวอย่างเช่น TitleTooLongErr สตริง
คำ อธิบาย คําอธิบายที่อธิบายปัญหาเกี่ยวกับคุณสมบัติ สตริง
ความสามารถในการให้บริการ ค่าที่ระบุว่าปัญหาขัดขวางไม่ให้ให้บริการข้อเสนอหรือไม่ ค่าที่เป็นไปได้คือ:
  • ไม่ได้รับอนุมัติ
  • ไม่ได้รับผลกระทบ
หากไม่ได้รับอนุมัติ ข้อเสนอจะไม่ให้บริการ		 สตริง

รหัสสถานะ HTTP

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

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

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

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

รหัสข้อผิดพลาด คำอธิบาย
ContinuationTokenInvalidErr ค่าพารามิเตอร์คิวรี continuation-token ไม่ถูกต้อง ตรวจสอบให้แน่ใจว่าคุณได้ตั้งค่าพารามิเตอร์โดยใช้ค่าในเขตข้อมูลของnextPageTokenออบเจ็กต์ ProductStatuses