WidgetListSessionsRequest

WidgetService.WidgetListSessions メソッドに対するリクエスト メッセージ。

JSON 表現 
{
  "location": string,
  "configId": string,
  "listSessionsRequest": {
    object (ListSessionsRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
フィールド
location

string

必須。ウィジェット リスト セッションが実行されるビジネス リソース。形式: locations/{location}
configId

string

必須。WidgetConfig の UUID。このフィールドは、ウィジェットの構成を識別するために使用されます。
listSessionsRequest

object (ListSessionsRequest)

必須。ConversationalSearchService.ListSessions へのプロキシ リクエスト。
additionalParams

object (AdditionalParams)

必須。セキュリティとプライバシーの強化のための追加パラメータ。

ListSessionsRequest

ListSessions メソッドのリクエスト。

JSON 表現 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
フィールド
parent

string

必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}
pageSize

integer

ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
pageToken

string

前回の ListSessions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter

string

フィルタするフィールドのカンマ区切りのリスト（EBNF 文法）。

サポートされているフィールドは次のとおりです。

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time

例:

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
orderBy

string

昇順で並べ替えるフィールドのカンマ区切りリスト。降順にするには、フィールド名の後に desc を使用します。

サポートされているフィールド:

  • update_time
  • create_time
  • session_name
  • is_pinned

例:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: セッションをまず is_pinned で並べ替え、次に update_time で並べ替えます。