notes

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

Overview

Name	notes
Type	Resource
Id	google.contactcenterinsights.notes

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
assessmentNote	object	The note is associated to the entire parent assessment. (id: GoogleCloudContactcenterinsightsV1NoteAssessmentNote)
content	string	The note content.
conversationTurnNote	object	The note is associated with a conversation turn. (id: GoogleCloudContactcenterinsightsV1NoteConversationTurnNote)
createTime	string (google-datetime)	Output only. The time at which the note was created.
noteCreator	object	Output only. The user that created the note. (id: GoogleCloudContactcenterinsightsV1UserInfo)
qaQuestionNote	object	The note is associated with a QA question in one of the conversation's scorecard results. (id: GoogleCloudContactcenterinsightsV1NoteQaQuestionNote)
updateTime	string (google-datetime)	Output only. The time at which the note was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId	pageSize, pageToken	List Notes.
create	insert	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId		Create Note.
patch	update	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId, notesId	updateMask	Update Note.
delete	delete	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId, conversationsId, assessmentsId, notesId		Deletes a Note.

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
assessmentsId	string
authorizedViewSetsId	string
authorizedViewsId	string
conversationsId	string
locationsId	string
notesId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

list

List Notes.

SELECT
name,
assessmentNote,
content,
conversationTurnNote,
createTime,
noteCreator,
qaQuestionNote,
updateTime
FROM google.contactcenterinsights.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' -- required
AND authorizedViewsId = '{{ authorizedViewsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND assessmentsId = '{{ assessmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Create Note.

INSERT INTO google.contactcenterinsights.notes (
data__conversationTurnNote,
data__qaQuestionNote,
data__assessmentNote,
data__name,
data__content,
projectsId,
locationsId,
authorizedViewSetsId,
authorizedViewsId,
conversationsId,
assessmentsId
)
SELECT 
'{{ conversationTurnNote }}',
'{{ qaQuestionNote }}',
'{{ assessmentNote }}',
'{{ name }}',
'{{ content }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ authorizedViewSetsId }}',
'{{ authorizedViewsId }}',
'{{ conversationsId }}',
'{{ assessmentsId }}'
RETURNING
name,
assessmentNote,
content,
conversationTurnNote,
createTime,
noteCreator,
qaQuestionNote,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: notes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the notes resource.
    - name: locationsId
      value: string
      description: Required parameter for the notes resource.
    - name: authorizedViewSetsId
      value: string
      description: Required parameter for the notes resource.
    - name: authorizedViewsId
      value: string
      description: Required parameter for the notes resource.
    - name: conversationsId
      value: string
      description: Required parameter for the notes resource.
    - name: assessmentsId
      value: string
      description: Required parameter for the notes resource.
    - name: conversationTurnNote
      value: object
      description: >
        The note is associated with a conversation turn.
        
    - name: qaQuestionNote
      value: object
      description: >
        The note is associated with a QA question in one of the conversation's scorecard results.
        
    - name: assessmentNote
      value: object
      description: >
        The note is associated to the entire parent assessment.
        
    - name: name
      value: string
      description: >
        Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
        
    - name: content
      value: string
      description: >
        The note content.
        

UPDATE examples

patch

Update Note.

UPDATE google.contactcenterinsights.notes
SET 
data__conversationTurnNote = '{{ conversationTurnNote }}',
data__qaQuestionNote = '{{ qaQuestionNote }}',
data__assessmentNote = '{{ assessmentNote }}',
data__name = '{{ name }}',
data__content = '{{ content }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND conversationsId = '{{ conversationsId }}' --required
AND assessmentsId = '{{ assessmentsId }}' --required
AND notesId = '{{ notesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
assessmentNote,
content,
conversationTurnNote,
createTime,
noteCreator,
qaQuestionNote,
updateTime;

DELETE examples

delete

Deletes a Note.

DELETE FROM google.contactcenterinsights.notes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND conversationsId = '{{ conversationsId }}' --required
AND assessmentsId = '{{ assessmentsId }}' --required
AND notesId = '{{ notesId }}' --required;