Method: indexing.datasources.items.poll

הבדיקה מחפשת פריטים שלא הוקצו מתוך תור ההוספה לאינדקס ומסמנת קבוצה כ'הוקצה', החל מהפריטים עם חותמת הזמן הישנה ביותר מהעדיפות הגבוהה ביותר ItemStatus. סדר העדיפויות הוא:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

הזמנת פריטים מבטיחה שבדיקה חוזרת (polling) משרשורות אחרים לא תיצור קבוצות חופפות.

אחרי הטיפול בפריטים ששמורים, הלקוח צריך להחזיר את הפריטים למצב 'לא שמור', על ידי קריאה ל-index, או ל-push עם הסוג REQUEUE..

הפריטים הופכים לזמינים באופן אוטומטי (לא שמורים) אחרי 4 שעות, גם אם לא נקראה שיטת עדכון או שיטת דחיפה.

כדי להפעיל את ה-API הזה, נדרש חשבון אדמין או חשבון שירות. חשבון השירות שבו נעשה שימוש הוא זה שמופיע ברשימת ההיתרים במקור הנתונים המתאים.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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 תאחזר מהתור 'ברירת מחדל'. האורך המקסימלי הוא 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

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