Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class QueryMetricsResponse.
The response for querying metrics.
Generated from protobuf message google.cloud.contactcenterinsights.v1.QueryMetricsResponse
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}" |
↳ update_time |
Google\Protobuf\Timestamp
The metrics last update time. |
↳ slices |
array<QueryMetricsResponse\Slice>
A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request. |
↳ macro_average_slice |
QueryMetricsResponse\Slice
The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension. |
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 |
|
getUpdateTime
The metrics last update time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
The metrics last update time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSlices
A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSlices
A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.
| Parameter | |
|---|---|
| Name | Description |
var |
array<QueryMetricsResponse\Slice>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMacroAverageSlice
The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents.
This field is only populated if the request specifies a Dimension.
| Returns | |
|---|---|
| Type | Description |
QueryMetricsResponse\Slice|null |
|
hasMacroAverageSlice
clearMacroAverageSlice
setMacroAverageSlice
The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents.
This field is only populated if the request specifies a Dimension.
| Parameter | |
|---|---|
| Name | Description |
var |
QueryMetricsResponse\Slice
|
| Returns | |
|---|---|
| Type | Description |
$this |
|