Returns the charts Resource.
Close httplib2 connections.
create(parent, body=None, dashboardId=None, x__xgafv=None)
Creates a Dashboard.
Deletes a Dashboard.
Gets a Dashboard.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Dashboards.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a Dashboard.
close()
Close httplib2 connections.
create(parent, body=None, dashboardId=None, x__xgafv=None)
Creates a Dashboard.
Args:
parent: string, Required. The parent resource of the dashboard. (required)
body: object, The request body.
The object takes the form of:
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
}
dashboardId: string, Optional. A unique ID for the new Dashboard. This ID will become the final component of the Dashboard'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])?$`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
}
delete(name, x__xgafv=None)
Deletes a Dashboard.
Args:
name: string, Required. The name of the dashboard to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets a Dashboard.
Args:
name: string, Required. The name of the dashboard to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Dashboards.
Args:
parent: string, Required. The parent resource of the dashboards. (required)
filter: string, Optional. The filter expression to filter dashboards listed in the response.
orderBy: string, Optional. The order by expression to order dashboards listed in the response.
pageSize: integer, Optional. The maximum number of dashboards to return. The service may return fewer than this value. The default and maximum value is 100.
pageToken: string, Optional. The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response of listing dashboards.
"dashboards": [ # The dashboards under the parent.
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
},
],
"nextPageToken": "A String", # The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a Dashboard.
Args:
name: string, Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard} (required)
body: object, The request body.
The object takes the form of:
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
}
updateMask: string, Optional. 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: * `display_name` * `root_container`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard
"createTime": "A String", # Output only. Dashboard creation time.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the dashboard.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Dashboard description
"displayName": "A String", # User provided display name of the dashboard.
"filter": "A String", # Filter applied to all charts in the dashboard. Should support scope later.
"name": "A String", # Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
"readOnly": True or False, # Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
"rootContainer": { # Configurable dashboard's container. Container can contain multiple widgets. # The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
"containerId": "A String", # Output only. Unique ID for the container.
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to all charts in the container.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Container description
"displayName": "A String", # User provided display name of the Container.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the container in grid units.
"widgets": [ # Widgets in the Container.
{ # Represents a dashboard element, could be a nested Container or Chart.
"chart": { # Configurable dashboard's widget that displays data as a chart. # A chart widget.
"chartType": "A String", # Output only. Chart type.
"chartVisualizationType": "A String", # Chart visualization type.
"createTime": "A String", # Output only. Chart create time.
"dataSource": { # The request data for visualizing the dataset in the chart.
"generativeInsights": { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
"chartCheckpoint": { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
"revisionId": "A String", # The revision id of the chart.
"sessionId": "A String", # The session id of the chart.
},
"chartConversations": [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
"conversationId": "A String", # The conversation id of the chart.
"createTime": "A String", # The create time of the conversation.
"messages": [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
"createTime": "A String", # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
"messageId": "A String", # The message id of the message.
"systemMessage": { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
"chartSpec": { # Chart spec from LLM
"a_key": "", # Properties of the object.
},
"generatedSqlQuery": "A String", # Raw SQL from LLM, before templatization
"textOutput": { # A text output message from the system. # A direct natural language response to the user message.
"texts": [ # The parts of the message.
"A String",
],
"type": "A String", # The type of the text message.
},
},
"userMessage": { # The user message. # A message from the user that is interacting with the system.
"text": "A String", # A message from the user that is interacting with the system.
},
},
],
"updateTime": "A String", # The update time of the conversation.
},
],
"chartSpec": { # Chart spec for the chart.
"a_key": "", # Properties of the object.
},
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"sqlComparisonKey": "A String", # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
"sqlQuery": "A String", # SQL query used to generate the chart.
},
"queryMetrics": { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
"request": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
},
"dateRangeConfig": { # Date range configuration for dashboard charts. # Date range config applied to the chart.
"absoluteDateRange": { # A time window for querying conversations. # An absolute date range.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"relativeDateRange": { # Relative date range configuration. # A relative date range.
"quantity": "A String", # Required. The quantity of units in the past.
"unit": "A String", # Required. The unit of time.
},
},
"description": "A String", # Chart description
"displayName": "A String", # User provided display name of the chart.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
"height": 42, # The height of the chart in grid units.
"name": "A String", # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"updateTime": "A String", # Output only. Chart last update time.
"width": 42, # The width of the chart in grid units.
},
"chartReference": "A String", # A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
"container": # Object with schema name: GoogleCloudContactcenterinsightsV1Container # A container widget.
"filter": "A String", # Filter applied to all charts in the container. Should support scope later.
},
],
"width": 42, # The width of the container in grid units.
},
"updateTime": "A String", # Output only. Dashboard last update time.
}