Method: indexing.datasources.items.push

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת 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)

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

string

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

string

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

string

גיבוב (hash) של התוכן של הפריט בהתאם למאגר. אם צוין, זה משמש לקביעת האופן שבו ניתן לשנות את הסטטוס של פריט זה. הגדרת השדה הזה והשדה type תגרום לשגיאת ארגומנט. האורך המקסימלי הוא 2,048 תווים.
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)

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

string

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

string

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

string

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

string (bytes format)

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

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

string

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

object (RepositoryError)

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

PushItem.Type

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

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