FetchDocumentsRequest

Anfragenachricht für die Methode HomepageDataService.FetchDocuments.

JSON-Darstellung 
{
  "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.
}
Felder
homepageDataConfig

string

Erforderlich. Der Name der Konfiguration für die Startseitendaten. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/homepageDataConfig
pageSize

integer

Die maximale Anzahl der zurückzugebenden Dokumente. Der maximal zulässige Wert beträgt 20.
type

enum (Type)

Die Art der Anfrage.
disableCache

boolean

Optional. Wenn „true“, wird der Cache nicht verwendet.
Union-Feld request_type. Typ der Anfrage. Für request_type ist nur einer der folgenden Werte zulässig:
recommendedDocuments

object (RecommendedDocuments)

Konfiguration zum Abrufen empfohlener Dokumente für den Nutzer.
recentDocuments

object (RecentDocuments)

Konfiguration zum Abrufen der letzten Dokumente für den Nutzer.
recentEvents

object (RecentEvents)

Konfiguration zum Abrufen der letzten Ereignisse für den Nutzer.
announcements

object (Announcements)

Konfiguration zum Abrufen von Ankündigungen für den Nutzer.

RecommendedDocuments

Konfiguration zum Abrufen empfohlener Dokumente für den Nutzer.

JSON-Darstellung 
{
  "types": [
    enum (Type)
  ]
}
Felder
types[]

enum (Type)

Optional. Der Typ der Dokumente, die in den empfohlenen Dokumenten zurückgegeben werden sollen. Wenn leer, werden alle Dokumenttypen zurückgegeben.

RecentDocuments

Konfiguration zum Abrufen der letzten Dokumente für den Nutzer.

JSON-Darstellung 
{
  "types": [
    enum (Type)
  ]
}
Felder
types[]

enum (Type)

Optional. Der Typ der Dokumente, die in den zuletzt verwendeten Dokumenten zurückgegeben werden sollen. Wenn leer, werden alle Dokumenttypen zurückgegeben.

RecentEvents

Dieser Typ hat keine Felder.

Konfiguration zum Abrufen der letzten Ereignisse für den Nutzer.

Ankündigungen

Konfiguration zum Abrufen von Ankündigungen für den Nutzer.

JSON-Darstellung 
{
  "types": [
    enum (Type)
  ]
}
Felder
types[]

enum (Type)

Optional. Der Typ der zurückzugebenden Ankündigungen. Wenn leer, werden alle Arten von Mitteilungen zurückgegeben.