authorized_views

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

Overview

Name	authorized_views
Type	Resource
Id	google.contactcenterinsights.authorized_views

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
conversationFilter	string	A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having authorizedViews.get access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
createTime	string (google-datetime)	Output only. The time at which the authorized view was created.
displayName	string	Display Name. Limit 64 characters.
updateTime	string (google-datetime)	Output only. The most recent time at which the authorized view was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
conversationFilter	string	A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having authorizedViews.get access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
createTime	string (google-datetime)	Output only. The time at which the authorized view was created.
displayName	string	Display Name. Limit 64 characters.
updateTime	string (google-datetime)	Output only. The most recent time at which the authorized view was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId		Get AuthorizedView
list	select	projectsId, locationsId, authorizedViewSetsId	pageSize, pageToken, filter, orderBy	List AuthorizedViewSets
create	insert	projectsId, locationsId, authorizedViewSetsId	authorizedViewId	Create AuthorizedView
patch	update	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId	updateMask	Updates an AuthorizedView.
delete	delete	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId		Deletes an AuthorizedView.
query_metrics	exec	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId		Query metrics.
query_performance_overview	exec	projectsId, locationsId, authorizedViewSetsId, authorizedViewsId		Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.
search	exec	projectsId, locationsId, authorizedViewSetsId	pageSize, pageToken, query, orderBy	SearchAuthorizedViewSets

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
authorizedViewSetsId	string
authorizedViewsId	string
locationsId	string
projectsId	string
authorizedViewId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
query	string
updateMask	string (google-fieldmask)

SELECT examples

get

Get AuthorizedView

SELECT
name,
conversationFilter,
createTime,
displayName,
updateTime
FROM google.contactcenterinsights.authorized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' -- required
AND authorizedViewsId = '{{ authorizedViewsId }}' -- required;

list

List AuthorizedViewSets

SELECT
name,
conversationFilter,
createTime,
displayName,
updateTime
FROM google.contactcenterinsights.authorized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create AuthorizedView

INSERT INTO google.contactcenterinsights.authorized_views (
data__name,
data__displayName,
data__conversationFilter,
projectsId,
locationsId,
authorizedViewSetsId,
authorizedViewId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ conversationFilter }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ authorizedViewSetsId }}',
'{{ authorizedViewId }}'
RETURNING
name,
conversationFilter,
createTime,
displayName,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: authorized_views
  props:
    - name: projectsId
      value: string
      description: Required parameter for the authorized_views resource.
    - name: locationsId
      value: string
      description: Required parameter for the authorized_views resource.
    - name: authorizedViewSetsId
      value: string
      description: Required parameter for the authorized_views resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
        
    - name: displayName
      value: string
      description: >
        Display Name. Limit 64 characters.
        
    - name: conversationFilter
      value: string
      description: >
        A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
        
    - name: authorizedViewId
      value: string

UPDATE examples

patch

Updates an AuthorizedView.

UPDATE google.contactcenterinsights.authorized_views
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__conversationFilter = '{{ conversationFilter }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
conversationFilter,
createTime,
displayName,
updateTime;

DELETE examples

delete

Deletes an AuthorizedView.

DELETE FROM google.contactcenterinsights.authorized_views
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authorizedViewSetsId = '{{ authorizedViewSetsId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required;

Lifecycle Methods

query_metrics

Query metrics.

EXEC google.contactcenterinsights.authorized_views.query_metrics 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@authorizedViewsId='{{ authorizedViewsId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"timeGranularity": "{{ timeGranularity }}", 
"dimensions": "{{ dimensions }}", 
"measureMask": "{{ measureMask }}"
}';

query_performance_overview

Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.

EXEC google.contactcenterinsights.authorized_views.query_performance_overview 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@authorizedViewsId='{{ authorizedViewsId }}' --required 
@@json=
'{
"agentPerformanceSource": "{{ agentPerformanceSource }}", 
"filter": "{{ filter }}", 
"queryInterval": "{{ queryInterval }}", 
"comparisonQueryInterval": "{{ comparisonQueryInterval }}"
}';

search

SearchAuthorizedViewSets

EXEC google.contactcenterinsights.authorized_views.search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authorizedViewSetsId='{{ authorizedViewSetsId }}' --required, 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}', 
@query='{{ query }}', 
@orderBy='{{ orderBy }}';