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

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