FetchDocumentsRequest

הודעת בקשה לשיטה HomepageDataService.FetchDocuments.

ייצוג ב-JSON 
{
  "homepageDataConfig": string,
  "pageSize": integer,
  "type": enum (Type),
  "disableCache": boolean,

  // Union field request_type can be only one of the following:
  "recommendedDocuments": {
    object (RecommendedDocuments)
  },
  "recentDocuments": {
    object (RecentDocuments)
  },
  "recentEvents": {
    object (RecentEvents)
  },
  "announcements": {
    object (Announcements)
  }
  // End of list of possible types for union field request_type.
}
שדות
homepageDataConfig

string

חובה. השם של הגדרת הנתונים של דף הבית. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/homepageDataConfig
pageSize

integer

המספר המקסימלי של מסמכים שיוחזרו. הערך המקסימלי המותר הוא 20.
type

enum (Type)

סוג הבקשה.
disableCache

boolean

זה שינוי אופציונלי. אם המדיניות מוגדרת כ-True, לא ייעשה שימוש במטמון.
שדה איחוד request_type. מקלידים את הבקשה. הערך request_type יכול להיות רק אחד מהבאים:
recommendedDocuments

object (RecommendedDocuments)

הגדרה לאחזור מסמכים מומלצים עבור המשתמש.
recentDocuments

object (RecentDocuments)

הגדרה לאחזור מסמכים מהזמן האחרון של המשתמש.
recentEvents

object (RecentEvents)

הגדרה לאחזור אירועים אחרונים של המשתמש.
announcements

object (Announcements)

הגדרה לאחזור הודעות למשתמש.

RecommendedDocuments

הגדרה לאחזור מסמכים מומלצים עבור המשתמש.

ייצוג ב-JSON 
{
  "types": [
    enum (Type)
  ]
}
שדות
types[]

enum (Type)

זה שינוי אופציונלי. סוג המסמכים שיוחזרו במסמכים המומלצים. אם השדה ריק, יוחזרו כל סוגי המסמכים.

RecentDocuments

הגדרה לאחזור מסמכים מהזמן האחרון של המשתמש.

ייצוג ב-JSON 
{
  "types": [
    enum (Type)
  ]
}
שדות
types[]

enum (Type)

זה שינוי אופציונלי. סוג המסמכים שיוחזרו ברשימת המסמכים האחרונים. אם השדה ריק, יוחזרו כל סוגי המסמכים.

RecentEvents

בסוג הזה אין שדות.

הגדרה לאחזור אירועים אחרונים של המשתמש.

עדכונים

הגדרה לאחזור הודעות למשתמש.

ייצוג ב-JSON 
{
  "types": [
    enum (Type)
  ]
}
שדות
types[]

enum (Type)

זה שינוי אופציונלי. סוג ההודעות להחזרה. אם לא מציינים ערך, הפונקציה מחזירה את כל סוגי ההודעות.