FetchDocumentsRequest

Request message for HomepageDataService.FetchDocuments method.

JSON representation
{
  "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.
}
Fields
homepageDataConfig

string

Required. The name of the homepage data config. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/homepageDataConfig

pageSize

integer

The maximum number of documents to return. Maximum allowed value is 20.

type

enum (Type)

The type of request.

disableCache

boolean

Optional. If true, then cache will not be used.

Union field request_type. Type for the request. request_type can be only one of the following:
recommendedDocuments

object (RecommendedDocuments)

Configuration to fetch recommended documents for the user.

recentDocuments

object (RecentDocuments)

Configuration to fetch recent documents for the user.

recentEvents

object (RecentEvents)

Configuration to fetch recent events for the user.

announcements

object (Announcements)

Configuration to fetch announcements for the user.

RecommendedDocuments

Configuration to fetch recommended documents for the user.

JSON representation
{
  "types": [
    enum (Type)
  ]
}
Fields
types[]

enum (Type)

Optional. The type of documents to return in the recommended documents. If empty then all types of documents are returned.

RecentDocuments

Configuration to fetch recent documents for the user.

JSON representation
{
  "types": [
    enum (Type)
  ]
}
Fields
types[]

enum (Type)

Optional. The type of documents to return in the recent documents. If empty then all types of documents are returned.

RecentEvents

This type has no fields.

Configuration to fetch recent events for the user.

Announcements

Configuration to fetch announcements for the user.

JSON representation
{
  "types": [
    enum (Type)
  ]
}
Fields
types[]

enum (Type)

Optional. The type of announcements to return. If empty then all types of announcements are returned.