Method: indexing.datasources.items.push

דחיפת פריט לתור לצורך בדיקה ועדכון מאוחר יותר.

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
item.name

string

השם של ה-item שרוצים לדחוף לתור ההוספה לאינדקס.

פורמט: datasources/{sourceId}/items/{ID}

יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
שדות
item.type

enum (PushItem.Type)

סוג פעולת ה-push שמגדיר את התנהגות ה-push.
item.metadataHash

string

גיבוב המטא-נתונים של הפריט לפי המאגר. אם צוין, המאפיין הזה משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרת השדה הזה והשדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
item.structuredDataHash

string

גיבוב של הנתונים המובְנים של הפריט בהתאם למאגר. אם צוין, המאפיין הזה משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרה של השדה הזה ושל השדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
item.contentHash

string

גיבוב התוכן של הפריט לפי המאגר. אם צוין, המאפיין הזה משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרה של השדה הזה ושל השדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
item.payload

string (bytes format)

מספק למחבר מידע נוסף על מצב המסמך, כמו מזהה מאגר חלופי ומטא-נתונים אחרים. האורך המקסימלי הוא 8,192 בייטים.

מחרוזת בקידוד Base64.
item.queue

string

התור שאליו שייך הפריט. אם השדה הזה לא צוין, המערכת תבחור את התור default. האורך המקסימלי הוא 512 תווים.
item.repositoryError

object (RepositoryError)

מאכלסים את השדה הזה כדי לאחסן פרטי שגיאה של המחבר או המאגר. המידע הזה מוצג במסוף Admin. השדה הזה יכול להיות מאוכלס רק כאשר הערך של type הוא REPOSITORY_ERROR.
connectorName

string

השם של המחבר שמבצע את הקריאה הזו.

פורמט: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

אפשרויות נפוצות לניפוי באגים.

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של Item.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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

PushItem

מייצג פריט שרוצים לדחוף לתור ההוספה לאינדקס.

ייצוג ב-JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
שדות
name

string

השם של ה-item שרוצים לדחוף לתור ההוספה לאינדקס.

פורמט: datasources/{sourceId}/items/{ID}

יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים.
type

enum (PushItem.Type)

סוג פעולת ה-push שמגדיר את התנהגות ה-push.
metadataHash

string

גיבוב המטא-נתונים של הפריט לפי המאגר. אם צוין, הוא משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרת השדה הזה והשדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
structuredDataHash

string

גיבוב של הנתונים המובְנים של הפריט בהתאם למאגר. אם צוין, המאפיין הזה משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרה של השדה הזה ושל השדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
contentHash

string

גיבוב התוכן של הפריט לפי המאגר. אם צוין, המאפיין הזה משמש לקביעת אופן השינוי של סטטוס הפריט. הגדרה של השדה הזה ושל השדה type גורמת לשגיאה בארגומנטים. האורך המקסימלי הוא 2048 תווים.
payload

string (bytes format)

מספק למחבר מידע נוסף על מצב המסמך, כמו מזהה מאגר חלופי ומטא-נתונים אחרים. האורך המקסימלי הוא 8,192 בייטים.

מחרוזת בקידוד Base64.
queue

string

התור שאליו שייך הפריט. אם השדה הזה לא צוין, המערכת תבחור את התור default. האורך המקסימלי הוא 512 תווים.
repositoryError

object (RepositoryError)

מאכלסים את השדה הזה כדי לאחסן פרטי שגיאה של המחבר או המאגר. המידע הזה מוצג במסוף Admin. השדה הזה יכול להיות מאוכלס רק כאשר הערך של type הוא REPOSITORY_ERROR.

PushItem.Type

סוג פעולת ה-push שמגדיר את התנהגות ה-push.

טיפוסים בני מנייה (enum)
UNSPECIFIED ברירת המחדל היא UNSPECIFIED. מציין שאסור לשנות את ItemStatus בפעולה של ה-push
MODIFIED מציין שהמסמך במאגר השתנה או עודכן מאז הקריאה הקודמת ל-update. הפעולה הזו משנה את הסטטוס למצב MODIFIED לפריט קיים. אם הפונקציה הזו נקראת לגבי פריט לא קיים, הסטטוס משתנה ל-NEW_ITEM.
NOT_MODIFIED הפריט במאגר לא השתנה מאז קריאת העדכון האחרונה. פעולת ה-push הזו תגדיר את הסטטוס למצב ACCEPTED.
REPOSITORY_ERROR המחבר נתקל בשגיאה במאגר לגבי הפריט הזה. משנים את הסטטוס למצב REPOSITORY_ERROR. המערכת מבטלת את ההזמנה של הפריט ומתאמתת מועד חדש לבדיקה, בהתאם לזמן ההשהיה האקספוננציאלית.
REQUEUE צריך להפעיל את הקריאה ל-push עם REQUEUE רק לפריטים ששמורים. הפעולה הזו מבטלת את ההזמנה של הפריט ומאפסת את זמן הזמינות שלו לשעה הרשמית.