2025-05-23
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Description : Delete an Assessment.
Parameters :
force
Location : query
Description : Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.
Type : boolean
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Required : Yes
Description : Required. The name of the assessment to delete.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:publish
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Location : path
Required : Yes
Description : Required. The name of the assessment to publish.
Description : Publish an Assessment.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Get Assessment.
Path : v1/{+name}
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Description : Required. The name of the assessment to get.
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list
Parameter Order : parent
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/assessments
Parameters :
filter
Location : query
Type : string
Description : Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for
pageToken
Description : Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.
Type : string
Location : query
parent
Description : Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
pageSize
Location : query
Description : The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Format : int32
Type : integer
Description : List Assessments.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal
Description : Appeal an Assessment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal
Path : v1/{+name}:appeal
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the assessment to appeal.
Type : string
Parameter Order : name
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Description : Required. The parent resource of the assessment.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Required : Yes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments
HTTP Method : POST
Description : Create Assessment.
Path : v1/{+parent}/assessments
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the assessment to finalize.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:finalize
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize
HTTP Method : POST
Description : Finalize an Assessment.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes
Path : v1/{+parent}/notes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create Note.
Parameters :
parent
Location : path
Description : Required. The parent resource of the note.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$
Description : Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : PATCH
Description : Update Note.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}
Parameters :
name
Description : Required. The name of the note to delete.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$
Type : string
Location : path
Parameter Order : name
Path : v1/{+name}
Description : Deletes a Note.
HTTP Method : DELETE
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list
Parameters :
pageToken
Location : query
Description : Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/assessments/[^/]+$
Location : path
Description : Required. The parent resource of the notes.
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes
HTTP Method : GET
Path : v1/{+parent}/notes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : List Notes.
▼ ▲ contactcenterinsights.projects.locations.assessmentRules.patch
Parameter Order : name
Description : Updates an assessment rule.
Path : v1/{+name}
HTTP Method : PATCH
Parameters :
updateMask
Description : Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
Format : google-fieldmask
Type : string
Location : query
name
Description : Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
Pattern : ^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$
Location : path
Required : Yes
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}
▼ ▲ contactcenterinsights.projects.locations.assessmentRules.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/assessmentRules
Description : Lists assessment rules.
HTTP Method : GET
Parameters :
pageToken
Location : query
Type : string
Description : Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Description : Required. The parent resource of the assessment rules.
Required : Yes
pageSize
Location : query
Description : Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Type : integer
Format : int32
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1/{+parent}/assessmentRules
▼ ▲ contactcenterinsights.projects.locations.assessmentRules.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/assessmentRules
Parameter Order : parent
Path : v1/{+parent}/assessmentRules
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an assessment rule.
Parameters :
assessmentRuleId
Type : string
Description : Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
Location : query
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/`
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.assessmentRules.delete
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}
Parameters :
name
Description : Required. The name of the assessment rule to delete.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$
Type : string
Required : Yes
Description : Deletes an assessment rule.
HTTP Method : DELETE
▼ ▲ contactcenterinsights.projects.locations.assessmentRules.get
HTTP Method : GET
Parameters :
name
Location : path
Description : Required. The name of the assessment rule to get.
Pattern : ^projects/[^/]+/locations/[^/]+/assessmentRules/[^/]+$
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}
Description : Get an assessment rule.
Path : v1/{+name}
Parameter Order : name
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.notes.list
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List Notes.
Path : v1/{+parent}/notes
Parameters :
pageToken
Location : query
Type : string
Description : Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data.
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Description : Required. The parent resource of the notes.
Location : path
pageSize
Type : integer
Format : int32
Description : Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Location : query
Parameter Order : parent
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.notes.delete
Path : v1/{+name}
Description : Deletes a Note.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$
Type : string
Required : Yes
Description : Required. The name of the note to delete.
Location : path
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.notes.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}
Parameters :
updateMask
Description : Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`
Format : google-fieldmask
Location : query
Type : string
name
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+/notes/[^/]+$
Description : Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
Description : Update Note.
Parameter Order : name
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.notes.create
Path : v1/{+parent}/notes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Description : Required. The parent resource of the note.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Description : Create Note.
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.publish
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish
Description : Publish an Assessment.
Path : v1/{+name}:publish
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Location : path
Description : Required. The name of the assessment to publish.
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.create
HTTP Method : POST
Parameter Order : parent
Path : v1/{+parent}/assessments
Description : Create Assessment.
Parameters :
parent
Description : Required. The parent resource of the assessment.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.get
Parameters :
name
Location : path
Required : Yes
Description : Required. The name of the assessment to get.
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Type : string
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get Assessment.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.list
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments
Description : List Assessments.
Path : v1/{+parent}/assessments
HTTP Method : GET
Parameters :
pageSize
Location : query
Description : The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
Format : int32
Type : integer
filter
Location : query
Description : Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for
Type : string
parent
Required : Yes
Location : path
Description : Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character.
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+$
Type : string
pageToken
Type : string
Location : query
Description : Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.appeal
Parameter Order : name
Description : Appeal an Assessment.
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the assessment to appeal.
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal
HTTP Method : POST
Path : v1/{+name}:appeal
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.finalize
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize
Parameter Order : name
HTTP Method : POST
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the assessment to finalize.
Path : v1/{+name}:finalize
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Finalize an Assessment.
▼ ▲ contactcenterinsights.projects.locations.conversations.assessments.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/conversations/[^/]+/assessments/[^/]+$
Description : Required. The name of the assessment to delete.
force
Description : Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.
Location : query
Type : boolean
Description : Delete an Assessment.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Path : v1/{+name}
Parameter Order : name