กรองรายการคําขอ

list จะดึงข้อมูลทรัพยากรหลายรายการของประเภทที่กำหนด filter พารามิเตอร์การค้นหา ช่วยให้คุณระบุเกณฑ์ที่ทรัพยากรที่เรียกข้อมูลต้องเป็นไปตามได้

โครงสร้างตัวกรอง

ค่าพารามิเตอร์ filter เป็นสตริง สตริงเหล่านี้ประกอบด้วยเกณฑ์อย่างน้อย 1 รายการ ระบบจะรวมเกณฑ์เข้าด้วยกันด้วยโอเปอเรเตอร์ AND หรือ OR

เกณฑ์เดียวมีรูปแบบ {field} {operator} {value} เช่น

  entityStatus="ENTITY_STATUS_ACTIVE"

สตริงตัวกรองมีอักขระได้ไม่เกิน 500 ตัว หากสตริงยาวเกินไป ให้ทำดังนี้

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

ใส่ค่าสำหรับเกณฑ์ในเครื่องหมายคำพูด

ตรวจสอบว่าสตริงตัวกรองได้รับการเข้ารหัสสําหรับใช้ใน URL เมื่อทําการเรียก API โดยตรง

ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างสตริงตัวกรองได้ที่ส่วนเกณฑ์การรวม

เกณฑ์การกรอง

วิธีการลิสต์แต่ละรายการรองรับเกณฑ์ตัวกรองบางอย่าง คำอธิบายสำหรับพารามิเตอร์ filter ของเมธอดจะแสดงเกณฑ์เหล่านี้ โดยปกติแล้ว เกณฑ์ตัวกรองจะเป็น ฟิลด์ของทรัพยากรที่ดึงข้อมูลมา

เกณฑ์แต่ละรายการรองรับโอเปอเรเตอร์อย่างน้อย 1 รายการ ดังนี้

โอเปอเรเตอร์ที่เทียบเท่า
EQUALS (=)

ฟิลด์มีค่าเท่ากับค่าที่ระบุ

ตัวอย่าง: entityStatus="ENTITY_STATUS_ACTIVE"
LESS THAN OR EQUAL TO (<=)

ฟิลด์มีค่าน้อยกว่าหรือเท่ากับค่าที่ระบุ มักใช้เพื่อกรองตามวันที่หรือวันที่และเวลา

ตัวอย่าง: updateTime<="2023-04-01T12:00:00Z"
GREATER THAN OR EQUAL TO (>=)

ฟิลด์มีค่ามากกว่าหรือเท่ากับค่าที่ระบุ มักใช้เพื่อกรองตามวันที่หรือวันที่และเวลา

ตัวอย่าง: updateTime>="2023-03-01T12:00:00Z"
HAS (:)

ฟิลด์มีค่าที่ระบุ หากฟิลด์เป็นสตริง ระบบจะตรวจสอบว่าค่าที่ระบุเป็นสตริงย่อยหรือไม่ หากฟิลด์เป็นอาร์เรย์ ระบบจะตรวจสอบอาร์เรย์สำหรับค่าที่ระบุ

ตัวอย่าง: lineItemIds:"1234"

หากเกณฑ์ไม่ได้ระบุโอเปอเรเตอร์ จะรองรับเฉพาะ EQUALS (=)

เกณฑ์จะระบุว่าต้องใช้รูปแบบพิเศษหรือไม่

เกณฑ์การเข้าร่วม

รวมเกณฑ์หลายรายการเพื่อจำกัดlistคำตอบเพิ่มเติม

รวมเกณฑ์ด้วยโอเปอเรเตอร์ทางตรรกะ AND และ OR list แต่ละวิธี จะระบุว่ารองรับวิธีใดบ้าง บางวิธีรองรับเฉพาะตัวกรองที่มีเกณฑ์เดียว

โปรดพิจารณาขีดจำกัดต่อไปนี้เมื่อใช้เกณฑ์หลายรายการ

ข้อจำกัดและตัวอย่าง
AND ต้องรวมข้อจำกัดหรือกลุ่มข้อจำกัดที่กรองช่องต่างๆ หรือกรองช่องเดียวกันในลักษณะที่แตกต่างกัน updateTime>="2023-03-01T12:00:00Z" AND updateTime<="2023-04-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
OR ต้องรวมข้อจํากัดแต่ละรายการที่กรองตามฟิลด์เดียวกัน (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" OR lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT")
OR รวมข้อจำกัด 2 กลุ่มไม่ได้ โปรดใช้listคำขอหลายรายการที่มีค่าตัวกรองแตกต่างกันแทน ต้องใช้สตริงตัวกรอง 2 รายการต่อไปนี้ในคำขอแยกกันและรวมกันไม่ได้โดยใช้ตัวดำเนินการ OR
  • (lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" AND insertionOrderId="123")
  • (lineItemType="LINE_ITEM_TYPE_VIDEO_DEFAULT" AND insertionOrderId="456")
ระบบอาจถือว่ามีวงเล็บเพื่อจัดกลุ่มข้อจำกัดแม้ว่าจะไม่มีวงเล็บก็ตาม ระบบตีความสตริงตัวกรอง updateTime>="2023-03-01T12:00:00Z" AND entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT" เป็น updateTime>="2023-03-01T12:00:00Z" AND (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED" OR entityStatus="ENTITY_STATUS_DRAFT")