דוחף פריט לתור לצורך תשאול ועדכון במועד מאוחר יותר.
כדי להפעיל את ה-API הזה, צריך חשבון אדמין או חשבון שירות. חשבון השירות שבו נעשה שימוש הוא החשבון שנכלל ברשימת ההיתרים במקור הנתונים התואם.
בקשת HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
item.name |
השם של פורמט: datasources/{sourceId}/items/{ID} יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "item": { "name": string, "type": enum ( |
שדות | |
---|---|
item.type |
סוג פעולת הדחיפה שמגדירה את התנהגות הדחיפה. |
item.metadataHash |
גיבוב (hash) של מטא-נתונים של הפריט בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
item.structuredDataHash |
גיבוב (hash) של נתונים מובְנים של הפריט, בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
item.contentHash |
גיבוב (hash) של התוכן של הפריט בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
item.payload |
מספק מידע נוסף על מצב המסמך עבור המחבר, כגון מזהה מאגר חלופי ומטא-נתונים אחרים. האורך המקסימלי הוא 8,192 בייטים. מחרוזת בקידוד base64. |
item.queue |
התור שאליו שייך הפריט הזה. אם לא מציינים את השדה הזה, התור של |
item.repositoryError |
צריך לאכלס את השדה הזה כדי לאחסן פרטים על שגיאות של מחבר או מאגר. המידע הזה מוצג במסוף Admin. אפשר לאכלס את השדה הזה רק כשהערך בשדה |
connectorName |
שם המחבר שמבצע את השיחה. פורמט: datasources/{sourceId}/connectors/{ID} |
debugOptions |
אפשרויות נפוצות לניפוי באגים. |
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Item
.
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
למידע נוסף, ניתן לעיין במדריך ההרשאות.
PushItem
מייצג פריט לדחיפה לתור ההוספה לאינדקס.
ייצוג JSON |
---|
{ "name": string, "type": enum ( |
שדות | |
---|---|
name |
השם של פורמט: datasources/{sourceId}/items/{ID} יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים. |
type |
סוג פעולת הדחיפה שמגדירה את התנהגות הדחיפה. |
metadataHash |
גיבוב (hash) של מטא-נתונים של הפריט בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
structuredDataHash |
גיבוב (hash) של נתונים מובְנים של הפריט, בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
contentHash |
גיבוב (hash) של התוכן של הפריט בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה |
payload |
מספק מידע נוסף על מצב המסמך עבור המחבר, כגון מזהה מאגר חלופי ומטא-נתונים אחרים. האורך המקסימלי הוא 8,192 בייטים. מחרוזת בקידוד base64. |
queue |
התור שאליו שייך הפריט הזה. אם לא מציינים את השדה הזה, התור של |
repositoryError |
צריך לאכלס את השדה הזה כדי לאחסן פרטים על שגיאות של מחבר או מאגר. המידע הזה מוצג במסוף Admin. אפשר לאכלס את השדה הזה רק כשהערך בשדה |
PushItem.Type
סוג פעולת הדחיפה שמגדירה את התנהגות הדחיפה.
טיפוסים בני מנייה (enums) | |
---|---|
UNSPECIFIED |
ברירת המחדל היא UNSPECIFIED. המדיניות הזו קובעת שפעולת הדחיפה לא אמורה לשנות את ItemStatus |
MODIFIED |
מציין שמסמך המאגר השתנה או עודכן מאז הקריאה הקודמת ל-update . הפעולה הזו משנה את הסטטוס של פריט קיים למצב MODIFIED . אם מפעילים את התכונה הזו בפריט שלא קיים, הסטטוס ישתנה ל-NEW_ITEM . |
NOT_MODIFIED |
הפריט במאגר לא השתנה מאז הפעלת העדכון האחרונה. פעולת הדחיפה הזו תגדיר את הסטטוס למצב ACCEPTED . |
REPOSITORY_ERROR |
המחבר נתקל בשגיאת מאגר לגבי פריט זה. שינוי הסטטוס למצב REPOSITORY_ERROR . הפריט לא שמור והוא תוזמן מחדש למועד עתידי שנקבע לפי השהיה מעריכית. |
REQUEUE |
דחיפת שיחה עם 'יש צורך' רק לפריטים שהוזמנו. הפעולה הזו מבטלת את שמירת הפריט ומאפסת את הזמן הזמין שלו לשעה של שעון הקיר. |