qa_scorecards

Creates, updates, deletes, gets or lists a qa_scorecards resource.

Overview

Name	qa_scorecards
Type	Resource
Id	google.contactcenterinsights.qa_scorecards

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
createTime	string (google-datetime)	Output only. The time at which this scorecard was created.
description	string	A text description explaining the intent of the scorecard.
displayName	string	The user-specified display name of the scorecard.
isDefault	boolean	Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
source	string	Output only. The source of the scorecard.
updateTime	string (google-datetime)	Output only. The most recent time at which the scorecard was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
createTime	string (google-datetime)	Output only. The time at which this scorecard was created.
description	string	A text description explaining the intent of the scorecard.
displayName	string	The user-specified display name of the scorecard.
isDefault	boolean	Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
source	string	Output only. The source of the scorecard.
updateTime	string (google-datetime)	Output only. The most recent time at which the scorecard was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, qaScorecardsId		Gets a QaScorecard.
list	select	projectsId, locationsId	pageSize, pageToken, qaScorecardSources	Lists QaScorecards.
create	insert	projectsId, locationsId	qaScorecardId	Create a QaScorecard.
patch	update	projectsId, locationsId, qaScorecardsId	updateMask	Updates a QaScorecard.
delete	delete	projectsId, locationsId, qaScorecardsId	force	Deletes a QaScorecard.

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
locationsId	string
projectsId	string
qaScorecardsId	string
force	boolean
pageSize	integer (int32)
pageToken	string
qaScorecardId	string
qaScorecardSources	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a QaScorecard.

SELECT
name,
createTime,
description,
displayName,
isDefault,
source,
updateTime
FROM google.contactcenterinsights.qa_scorecards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND qaScorecardsId = '{{ qaScorecardsId }}' -- required;

list

Lists QaScorecards.

SELECT
name,
createTime,
description,
displayName,
isDefault,
source,
updateTime
FROM google.contactcenterinsights.qa_scorecards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND qaScorecardSources = '{{ qaScorecardSources }}';

INSERT examples

create

Create a QaScorecard.

INSERT INTO google.contactcenterinsights.qa_scorecards (
data__name,
data__displayName,
data__description,
data__isDefault,
projectsId,
locationsId,
qaScorecardId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
{{ isDefault }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ qaScorecardId }}'
RETURNING
name,
createTime,
description,
displayName,
isDefault,
source,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: qa_scorecards
  props:
    - name: projectsId
      value: string
      description: Required parameter for the qa_scorecards resource.
    - name: locationsId
      value: string
      description: Required parameter for the qa_scorecards resource.
    - name: name
      value: string
      description: >
        Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
        
    - name: displayName
      value: string
      description: >
        The user-specified display name of the scorecard.
        
    - name: description
      value: string
      description: >
        A text description explaining the intent of the scorecard.
        
    - name: isDefault
      value: boolean
      description: >
        Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
        
    - name: qaScorecardId
      value: string

UPDATE examples

patch

Updates a QaScorecard.

UPDATE google.contactcenterinsights.qa_scorecards
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__isDefault = {{ isDefault }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND qaScorecardsId = '{{ qaScorecardsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
isDefault,
source,
updateTime;

DELETE examples

delete

Deletes a QaScorecard.

DELETE FROM google.contactcenterinsights.qa_scorecards
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND qaScorecardsId = '{{ qaScorecardsId }}' --required
AND force = '{{ force }}';