2024-11-15
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics
Parameters :
location
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Description : Required. The location of the data. "projects/{project}/locations/{location}"
Location : path
HTTP Method : POST
Parameter Order : location
Description : Query metrics.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics
Path : v1/{+location}:queryMetrics
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats
Path : v1/{+location}:calculateStats
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats
Parameter Order : location
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets conversation statistics.
Parameters :
filter
Type : string
Location : query
Description : A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
location
Type : string
Description : Required. The location of the conversations.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Location : path
Required : Yes
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch
Parameters :
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. The list of fields to be updated.
name
Type : string
Description : Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update feedback label.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete
Parameter Order : name
Description : Delete feedback label.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. The name of the feedback label to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
HTTP Method : DELETE
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create
Parameters :
feedbackLabelId
Type : string
Description : Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
Location : query
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Description : Required. The parent resource of the feedback label.
Location : path
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Description : Create feedback label.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/feedbackLabels
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list
HTTP Method : GET
Description : List feedback labels.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Path : v1/{+parent}/feedbackLabels
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Location : path
Required : Yes
Type : string
Description : Required. The parent resource of the feedback labels.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
filter
Location : query
Description : Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
Type : string
pageToken
Type : string
Description : Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
Location : query
pageSize
Description : Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Location : query
Type : integer
Format : int32
Parameter Order : parent
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get
HTTP Method : GET
Description : Get feedback label.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the feedback label to get.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+parent}/analyses
Parameters :
parent
Type : string
Description : Required. The parent resource of the analysis.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required : Yes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Description : Creates an analysis. The long running operation is done when the analysis has completed.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list
Path : v1/{+parent}/analyses
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Parameters :
pageToken
Description : The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
Location : query
Type : string
filter
Location : query
Type : string
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required : Yes
Description : Required. The parent resource of the analyses.
Location : path
Type : string
pageSize
Description : The maximum number of analyses to return in the response. If this value is 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
Type : integer
Format : int32
HTTP Method : GET
Description : Lists analyses.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Description : Gets an analysis.
Path : v1/{+name}
Parameters :
name
Required : Yes
Description : Required. The name of the analysis to get.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Type : string
HTTP Method : GET
Parameter Order : name
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Description : Required. The name of the analysis to delete.
Required : Yes
Description : Deletes an analysis.
HTTP Method : DELETE
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete
Parameter Order : name
Parameters :
force
Location : query
Description : If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
Type : boolean
name
Location : path
Required : Yes
Description : Required. The name of the conversation to delete.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes a conversation.
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create
Path : v1/{+parent}/conversations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Parameter Order : parent
Parameters :
conversationId
Description : A unique ID for the new conversation. This ID will become the final component of the conversation'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-z0-9-]{4,64}$`. Valid characters are `a-z-`
Location : query
Type : string
parent
Description : Required. The parent resource of the conversation.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
HTTP Method : POST
Description : Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get
Description : Gets a conversation.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Description : Required. The name of the conversation to get.
view
Enum :
Location : query
Enum Descriptions :
Description : The level of details of the conversation. Default is `FULL`.
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Parameter Order : name
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch
Parameters :
name
Location : path
Description : Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
HTTP Method : PATCH
Parameter Order : name
Description : Updates a conversation.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list
Description : Lists conversations.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Path : v1/{+parent}/conversations
Parameters :
parent
Location : path
Description : Required. The parent resource of the conversation.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Required : Yes
Type : string
pageToken
Description : The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.
Location : query
Type : string
filter
Location : query
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Type : string
orderBy
Description : Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
Location : query
Type : string
view
Description : The level of details of the conversation. Default is `BASIC`.
Enum Descriptions :
Location : query
Enum :
Type : string
pageSize
Format : int32
Location : query
Description : The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Type : integer
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload
Parameter Order : parent
Description : Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
Parameters :
redactionConfig.deidentifyTemplate
Location : query
Description : The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
Type : string
redactionConfig.inspectTemplate
Location : query
Type : string
Description : The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
conversationId
Location : query
Type : string
Description : Optional. A unique ID for the new conversation. This ID will become the final component of the conversation'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-z0-9-]{4,64}$`. Valid characters are `a-z-`
speechConfig.speechRecognizer
Type : string
Description : The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
Location : query
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : Required. The parent resource of the conversation.
Required : Yes
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload
Path : v1/{+parent}/conversations:upload
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}
HTTP Method : GET
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Required : Yes
Parameter Order : name
Path : v1/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations
Path : v1/{+name}/operations
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : The name of the operation's parent resource.
Location : path
pageSize
Location : query
Format : int32
Type : integer
Description : The standard list page size.
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Description : The standard list filter.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy
HTTP Method : GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions
Parameters :
resource
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order : resource
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path : v1/{+resource}:testIamPermissions
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method : POST
Parameters :
resource
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy