Method: indexing.datasources.items.poll

แบบสำรวจสำหรับรายการที่ไม่ได้จองจากคิวการจัดทำดัชนีและทำเครื่องหมายชุดเป็น "จองแล้ว" เริ่มจากรายการที่มีการประทับเวลาที่เก่าที่สุดจาก ItemStatus ที่มีลำดับความสำคัญสูงสุด ลำดับความสำคัญมีดังต่อไปนี้

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

การจองรายการช่วยให้มั่นใจว่าการหยั่งสัญญาณจากชุดข้อความอื่นจะไม่สามารถสร้างชุดที่ทับซ้อนกันได้

หลังจากจัดการสินค้าที่จองแล้ว ลูกค้าควรนำสินค้ากลับสู่สถานะที่ไม่ได้จอง โดยจะเรียกใช้ index, หรือโดยการเรียกใช้ push ด้วยประเภท REQUEUE.

รายการจะพร้อมใช้งานโดยอัตโนมัติ (ไม่ได้จอง) หลังจากผ่านไป 4 ชั่วโมง แม้จะไม่มีการเรียกใช้การอัปเดตหรือวิธีพุชก็ตาม

API นี้ต้องใช้บัญชีผู้ดูแลระบบหรือบัญชีบริการเพื่อดำเนินการ บัญชีบริการที่ใช้เป็นบัญชีที่อนุญาตพิเศษในแหล่งข้อมูลที่เกี่ยวข้อง

คำขอ HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ชื่อของแหล่งข้อมูลที่จะสำรวจรายการ รูปแบบ: แหล่งข้อมูล/{sourceId}

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
ช่อง
connectorName

string

ชื่อของเครื่องมือเชื่อมต่อที่เรียกใช้นี้

รูปแบบ: แหล่งข้อมูล/{sourceId}/เครื่องมือเชื่อมต่อ/{ID}
statusCodes[]

enum (ItemStatus.Code)

จำกัดรายการสำรวจเฉพาะรายการที่มีสถานะเหล่านี้
limit

integer

จำนวนรายการสูงสุดที่จะส่งคืน

ค่าสูงสุดคือ 100 และค่าเริ่มต้นคือ 20
queue

string

ชื่อคิวที่จะดึงข้อมูลรายการ หากไม่ระบุ items.poll จะดึงข้อมูลจาก "ค่าเริ่มต้น" คิว มีความยาวได้สูงสุดไม่เกิน 100 อักขระ
debugOptions

object (DebugOptions)

ตัวเลือกการแก้ไขข้อบกพร่องทั่วไป

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
ช่อง
items[]

object (Item)

ชุดของรายการจากคิวที่พร้อมให้เครื่องมือเชื่อมต่อประมวลผล

รายการเหล่านี้มีฟิลด์ชุดย่อยที่ป้อนข้อมูลต่อไปนี้

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์