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

השם של מקור הנתונים שאליו יועברו הפריטים בסקר. פורמט: datasources/{sourceId}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
שדות
connectorName

string

שם המחבר שמבצע את השיחה.

פורמט: datasources/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

כדאי להגביל את הפריטים שנסקרו לפריטים עם הסטטוסים האלה.
limit

integer

מספר הפריטים המרבי להחזרה.

הערך המקסימלי הוא 100 וערך ברירת המחדל הוא 20.
queue

string

שם התור שממנו יש לאחזר פריטים. אם לא צוין, items.poll יאוחזר מהתור 'default'. האורך המקסימלי הוא 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.