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

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

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