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)

省略可。返されるお知らせのタイプ。空の場合、すべてのタイプのお知らせが返されます。