Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest.
Request to list conversations.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — A filter to reduce results to a specific subset. Useful for querying
conversations with specific properties.
#filter=
deffilter=(value)->::String
Parameter
value (::String) — A filter to reduce results to a specific subset. Useful for querying
conversations with specific properties.
Returns
(::String) — A filter to reduce results to a specific subset. Useful for querying
conversations with specific properties.
#order_by
deforder_by()->::String
Returns
(::String) — Optional. The attribute by which to order conversations in the response.
If empty, conversations will be ordered by descending creation time.
Supported values are one of the following:
create_time
customer_satisfaction_rating
duration
latest_analysis
start_time
turn_count
The default sort order is ascending. To specify order, append asc or
desc (create_time desc).
For more details, see Google AIPs
Ordering.
#order_by=
deforder_by=(value)->::String
Parameter
value (::String) — Optional. The attribute by which to order conversations in the response.
If empty, conversations will be ordered by descending creation time.
Supported values are one of the following:
create_time
customer_satisfaction_rating
duration
latest_analysis
start_time
turn_count
The default sort order is ascending. To specify order, append asc or
desc (create_time desc).
For more details, see Google AIPs
Ordering.
Returns
(::String) — Optional. The attribute by which to order conversations in the response.
If empty, conversations will be ordered by descending creation time.
Supported values are one of the following:
create_time
customer_satisfaction_rating
duration
latest_analysis
start_time
turn_count
The default sort order is ascending. To specify order, append asc or
desc (create_time desc).
For more details, see Google AIPs
Ordering.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — The maximum number of conversations to return in the response. A valid page
size ranges from 0 to 100,000 inclusive. If the page size is zero or
unspecified, a default page size of 100 will be chosen. Note that a call
might return fewer results than the requested page size.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — The maximum number of conversations to return in the response. A valid page
size ranges from 0 to 100,000 inclusive. If the page size is zero or
unspecified, a default page size of 100 will be chosen. Note that a call
might return fewer results than the requested page size.
Returns
(::Integer) — The maximum number of conversations to return in the response. A valid page
size ranges from 0 to 100,000 inclusive. If the page size is zero or
unspecified, a default page size of 100 will be chosen. Note that a call
might return fewer results than the requested page size.
#page_token
defpage_token()->::String
Returns
(::String) — The value returned by the last ListConversationsResponse. This value
indicates that this is a continuation of a prior ListConversations call
and that the system should return the next page of data.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — The value returned by the last ListConversationsResponse. This value
indicates that this is a continuation of a prior ListConversations call
and that the system should return the next page of data.
Returns
(::String) — The value returned by the last ListConversationsResponse. This value
indicates that this is a continuation of a prior ListConversations call
and that the system should return the next page of data.
#parent
defparent()->::String
Returns
(::String) — Required. The parent resource of the conversation.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The parent resource of the conversation.
Returns
(::String) — Required. The parent resource of the conversation.
[[["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-08-28 UTC."],[],[],null,["# Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest (v1.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.0 (latest)](/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.5.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.5.1/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.4.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.3.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.2.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.1.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/1.0.1/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.22.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.22.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.21.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.21.1/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.20.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.20.1/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.19.1](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.19.1/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.18.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.17.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.16.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.15.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.14.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.13.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.12.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.11.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.10.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.9.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.8.2/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.7.2/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-contact_center_insights-v1/0.6.0/Google-Cloud-ContactCenterInsights-V1-ListConversationsRequest) \nReference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::ListConversationsRequest.\n\nRequest to list conversations. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. \n**Returns**\n\n- (::String) --- A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.\n\n### #order_by\n\n def order_by() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:\n\n - create_time\n - customer_satisfaction_rating\n - duration\n - latest_analysis\n - start_time\n - turn_count\n\n The default sort order is ascending. To specify order, append `asc` or\n `desc` (`create_time desc`).\n For more details, see [Google AIPs\n Ordering](https://google.aip.dev/132#ordering).\n\n### #order_by=\n\n def order_by=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:\n\n\n - create_time\n - customer_satisfaction_rating\n - duration\n - latest_analysis\n - start_time\n - turn_count\n\n The default sort order is ascending. To specify order, append `asc` or\n `desc` (`create_time desc`).\n For more details, see [Google AIPs\nOrdering](https://google.aip.dev/132#ordering). \n**Returns**\n\n- (::String) --- Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:\n\n - create_time\n - customer_satisfaction_rating\n - duration\n - latest_analysis\n - start_time\n - turn_count\n\n The default sort order is ascending. To specify order, append `asc` or\n `desc` (`create_time desc`).\n For more details, see [Google AIPs\n Ordering](https://google.aip.dev/132#ordering).\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. \n**Returns**\n\n- (::Integer) --- The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. \n**Returns**\n\n- (::String) --- The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent resource of the conversation.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent resource of the conversation. \n**Returns**\n\n- (::String) --- Required. The parent resource of the conversation.\n\n### #view\n\n def view() -\u003e ::Google::Cloud::ContactCenterInsights::V1::ConversationView\n\n**Returns**\n\n- ([::Google::Cloud::ContactCenterInsights::V1::ConversationView](./Google-Cloud-ContactCenterInsights-V1-ConversationView)) --- The level of details of the conversation. Default is `BASIC`.\n\n### #view=\n\n def view=(value) -\u003e ::Google::Cloud::ContactCenterInsights::V1::ConversationView\n\n**Parameter**\n\n- **value** ([::Google::Cloud::ContactCenterInsights::V1::ConversationView](./Google-Cloud-ContactCenterInsights-V1-ConversationView)) --- The level of details of the conversation. Default is `BASIC`. \n**Returns**\n\n- ([::Google::Cloud::ContactCenterInsights::V1::ConversationView](./Google-Cloud-ContactCenterInsights-V1-ConversationView)) --- The level of details of the conversation. Default is `BASIC`."]]