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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eHomepageDataService.FetchDocuments\u003c/code\u003e method retrieves various types of content for a homepage, including recommended documents, recent documents, recent events, and announcements.\u003c/p\u003e\n"],["\u003cp\u003eThe request for fetching documents requires specifying the \u003ccode\u003ehomepageDataConfig\u003c/code\u003e, and allows setting the \u003ccode\u003epageSize\u003c/code\u003e (up to 20), \u003ccode\u003etype\u003c/code\u003e of the content and optional \u003ccode\u003edisableCache\u003c/code\u003e parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erequest_type\u003c/code\u003e field is a union field that must be one of \u003ccode\u003erecommendedDocuments\u003c/code\u003e, \u003ccode\u003erecentDocuments\u003c/code\u003e, \u003ccode\u003erecentEvents\u003c/code\u003e, or \u003ccode\u003eannouncements\u003c/code\u003e, allowing only one of these types per request.\u003c/p\u003e\n"],["\u003cp\u003eEach of the \u003ccode\u003erequest_type\u003c/code\u003e options can have a \u003ccode\u003etypes\u003c/code\u003e array specified, allowing filtering by specific document types, otherwise, all types are returned.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRecentEvents\u003c/code\u003e type has no configurable fields.\u003c/p\u003e\n"]]],[],null,["# FetchDocumentsRequest\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [RecommendedDocuments](#RecommendedDocuments)\n - [JSON representation](#RecommendedDocuments.SCHEMA_REPRESENTATION)\n- [RecentDocuments](#RecentDocuments)\n - [JSON representation](#RecentDocuments.SCHEMA_REPRESENTATION)\n- [RecentEvents](#RecentEvents)\n- [Announcements](#Announcements)\n - [JSON representation](#Announcements.SCHEMA_REPRESENTATION)\n\nRequest message for `HomepageDataService.FetchDocuments` method.\n\nRecommendedDocuments\n--------------------\n\nConfiguration to fetch recommended documents for the user.\n\nRecentDocuments\n---------------\n\nConfiguration to fetch recent documents for the user.\n\nRecentEvents\n------------\n\nThis type has no fields.\nConfiguration to fetch recent events for the user.\n\nAnnouncements\n-------------\n\nConfiguration to fetch announcements for the user."]]
