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)

可选。要返回的公告类型。如果为空，则返回所有类型的公告。