FetchDocumentsRequest

Message de requête pour la méthode HomepageDataService.FetchDocuments.

Représentation 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.
}
Champs
homepageDataConfig

string

Obligatoire. Nom de la configuration des données de la page d'accueil. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/homepageDataConfig

pageSize

integer

Nombre maximal de documents à renvoyer. La valeur maximale autorisée est de 20.

type

enum (Type)

Type de demande.

disableCache

boolean

Facultatif. Si la valeur est "true", le cache ne sera pas utilisé.

Champ d'union request_type. Type de la demande. request_type ne peut être qu'un des éléments suivants :
recommendedDocuments

object (RecommendedDocuments)

Configuration permettant de récupérer les documents recommandés pour l'utilisateur.

recentDocuments

object (RecentDocuments)

Configuration permettant de récupérer les documents récents de l'utilisateur.

recentEvents

object (RecentEvents)

Configuration permettant de récupérer les événements récents pour l'utilisateur.

announcements

object (Announcements)

Configuration permettant de récupérer les annonces pour l'utilisateur.

RecommendedDocuments

Configuration permettant de récupérer les documents recommandés pour l'utilisateur.

Représentation JSON
{
  "types": [
    enum (Type)
  ]
}
Champs
types[]

enum (Type)

Facultatif. Type de documents à renvoyer dans les documents recommandés. Si ce paramètre est vide, tous les types de documents sont renvoyés.

RecentDocuments

Configuration permettant de récupérer les documents récents de l'utilisateur.

Représentation JSON
{
  "types": [
    enum (Type)
  ]
}
Champs
types[]

enum (Type)

Facultatif. Type de documents à renvoyer dans les documents récents. Si ce paramètre est vide, tous les types de documents sont renvoyés.

RecentEvents

Ce type ne comporte aucun champ.

Configuration permettant de récupérer les événements récents pour l'utilisateur.

Annonces

Configuration permettant de récupérer les annonces pour l'utilisateur.

Représentation JSON
{
  "types": [
    enum (Type)
  ]
}
Champs
types[]

enum (Type)

Facultatif. Type d'annonces à renvoyer. Si ce paramètre est vide, tous les types d'annonces sont renvoyés.