Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class QueryMetricsRequest.
The request for querying metrics.
Generated from protobuf message google.cloud.contactcenterinsights.v1.QueryMetricsRequest
Namespace
Google \ Cloud \ ContactCenterInsights \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ location |
string
Required. The location of the data. "projects/{project}/locations/{location}" |
↳ filter |
string
Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). |
↳ time_granularity |
int
The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified. |
↳ dimensions |
array<Dimension>
The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now. |
↳ measure_mask |
Google\Protobuf\FieldMask
Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the |
getLocation
Required. The location of the data.
"projects/{project}/locations/{location}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
Required. The location of the data.
"projects/{project}/locations/{location}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimeGranularity
The time granularity of each data point in the time series.
Defaults to NONE if this field is unspecified.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTimeGranularity
The time granularity of each data point in the time series.
Defaults to NONE if this field is unspecified.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDimensions
The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.
If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDimensions
The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.
If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Dimension>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMeasureMask
Measures to return. Defaults to all measures if this field is unspecified.
A valid mask should traverse from the measure field from the response.
For example, a path from a measure mask to get the conversation count is
"conversation_measure.count".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasMeasureMask
clearMeasureMask
setMeasureMask
Measures to return. Defaults to all measures if this field is unspecified.
A valid mask should traverse from the measure field from the response.
For example, a path from a measure mask to get the conversation count is
"conversation_measure.count".
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|