assessment_rules

Creates, updates, deletes, gets or lists an assessment_rules resource.

Overview

Name	assessment_rules
Type	Resource
Id	google.contactcenterinsights.assessment_rules

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
active	boolean	If true, apply this rule to conversations. Otherwise, this rule is inactive.
createTime	string (google-datetime)	Output only. The time at which this assessment rule was created.
displayName	string	Display Name of the assessment rule.
sampleRule	object	The sample rule for the assessment rule. (id: GoogleCloudContactcenterinsightsV1SampleRule)
scheduleInfo	object	Schedule info for the assessment rule. (id: GoogleCloudContactcenterinsightsV1ScheduleInfo)
updateTime	string (google-datetime)	Output only. The most recent time at which this assessment rule was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
active	boolean	If true, apply this rule to conversations. Otherwise, this rule is inactive.
createTime	string (google-datetime)	Output only. The time at which this assessment rule was created.
displayName	string	Display Name of the assessment rule.
sampleRule	object	The sample rule for the assessment rule. (id: GoogleCloudContactcenterinsightsV1SampleRule)
scheduleInfo	object	Schedule info for the assessment rule. (id: GoogleCloudContactcenterinsightsV1ScheduleInfo)
updateTime	string (google-datetime)	Output only. The most recent time at which this assessment rule was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, assessmentRulesId		Get an assessment rule.
list	select	projectsId, locationsId	pageSize, pageToken	Lists assessment rules.
create	insert	projectsId, locationsId	assessmentRuleId	Creates an assessment rule.
patch	update	projectsId, locationsId, assessmentRulesId	updateMask	Updates an assessment rule.
delete	delete	projectsId, locationsId, assessmentRulesId		Deletes an assessment rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assessmentRulesId	string
locationsId	string
projectsId	string
assessmentRuleId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get an assessment rule.

SELECT
name,
active,
createTime,
displayName,
sampleRule,
scheduleInfo,
updateTime
FROM google.contactcenterinsights.assessment_rules
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND assessmentRulesId = '{{ assessmentRulesId }}' -- required;

list

Lists assessment rules.

SELECT
name,
active,
createTime,
displayName,
sampleRule,
scheduleInfo,
updateTime
FROM google.contactcenterinsights.assessment_rules
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates an assessment rule.

INSERT INTO google.contactcenterinsights.assessment_rules (
data__name,
data__active,
data__displayName,
data__sampleRule,
data__scheduleInfo,
projectsId,
locationsId,
assessmentRuleId
)
SELECT 
'{{ name }}',
{{ active }},
'{{ displayName }}',
'{{ sampleRule }}',
'{{ scheduleInfo }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ assessmentRuleId }}'
RETURNING
name,
active,
createTime,
displayName,
sampleRule,
scheduleInfo,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: assessment_rules
  props:
    - name: projectsId
      value: string
      description: Required parameter for the assessment_rules resource.
    - name: locationsId
      value: string
      description: Required parameter for the assessment_rules resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
        
    - name: active
      value: boolean
      description: >
        If true, apply this rule to conversations. Otherwise, this rule is inactive.
        
    - name: displayName
      value: string
      description: >
        Display Name of the assessment rule.
        
    - name: sampleRule
      value: object
      description: >
        The sample rule for the assessment rule.
        
    - name: scheduleInfo
      value: object
      description: >
        Schedule info for the assessment rule.
        
    - name: assessmentRuleId
      value: string

UPDATE examples

patch

Updates an assessment rule.

UPDATE google.contactcenterinsights.assessment_rules
SET 
data__name = '{{ name }}',
data__active = {{ active }},
data__displayName = '{{ displayName }}',
data__sampleRule = '{{ sampleRule }}',
data__scheduleInfo = '{{ scheduleInfo }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND assessmentRulesId = '{{ assessmentRulesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
active,
createTime,
displayName,
sampleRule,
scheduleInfo,
updateTime;

DELETE examples

delete

Deletes an assessment rule.

DELETE FROM google.contactcenterinsights.assessment_rules
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND assessmentRulesId = '{{ assessmentRulesId }}' --required;