Google Cloud Contact Center Insights V1 Client - Class ListConversationsRequest (2.2.1)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class ListConversationsRequest.

Request to list conversations.

Generated from protobuf message google.cloud.contactcenterinsights.v1.ListConversationsRequest

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent resource of the conversation.
↳ page_size int

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 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.
↳ filter string

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
↳ order_by 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.
↳ view int

The level of details of the conversation. Default is BASIC.

getParent

Required. The parent resource of the conversation.

Returns
Type Description
string

setParent

Required. The parent resource of the conversation.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Returns
Type Description
string

setFilter

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

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
Type Description
string

setOrderBy

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getView

The level of details of the conversation. Default is BASIC.

Returns
Type Description
int

setView

The level of details of the conversation. Default is BASIC.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource of the conversation. Please see ContactCenterInsightsClient::locationName() for help formatting this field.
Returns
Type Description
ListConversationsRequest