pages

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

Overview

Name	pages
Type	Resource
Id	google.dialogflow.pages

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_flows_pages_get

Successful response

Name	Datatype	Description
name	string	The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.
advancedSettings	object	Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. (id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string	The description of the page. The maximum length is 500 characters.
displayName	string	Required. The human-readable name of the page, unique within the flow.
entryFulfillment	object	The fulfillment to call when the session is entering the page. (id: GoogleCloudDialogflowCxV3Fulfillment)
eventHandlers	array	Handlers associated with the page to handle events such as webhook errors, no match or no input.
form	object	The form associated with the page, used for collecting parameters relevant to the page. (id: GoogleCloudDialogflowCxV3Form)
knowledgeConnectorSettings	object	Optional. Knowledge connector configuration. (id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
transitionRouteGroups	array	Ordered list of TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups.
transitionRoutes	array	A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

projects_locations_agents_flows_pages_list

Successful response

Name	Datatype	Description
name	string	The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.
advancedSettings	object	Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level. (id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string	The description of the page. The maximum length is 500 characters.
displayName	string	Required. The human-readable name of the page, unique within the flow.
entryFulfillment	object	The fulfillment to call when the session is entering the page. (id: GoogleCloudDialogflowCxV3Fulfillment)
eventHandlers	array	Handlers associated with the page to handle events such as webhook errors, no match or no input.
form	object	The form associated with the page, used for collecting parameters relevant to the page. (id: GoogleCloudDialogflowCxV3Form)
knowledgeConnectorSettings	object	Optional. Knowledge connector configuration. (id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
transitionRouteGroups	array	Ordered list of TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups.
transitionRoutes	array	A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_flows_pages_get	select	projectsId, locationsId, agentsId, flowsId, pagesId	languageCode	Retrieves the specified page.
projects_locations_agents_flows_pages_list	select	projectsId, locationsId, agentsId, flowsId	languageCode, pageSize, pageToken	Returns the list of all pages in the specified flow.
projects_locations_agents_flows_pages_create	insert	projectsId, locationsId, agentsId, flowsId	languageCode	Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_flows_pages_patch	update	projectsId, locationsId, agentsId, flowsId, pagesId	languageCode, updateMask	Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
projects_locations_agents_flows_pages_delete	delete	projectsId, locationsId, agentsId, flowsId, pagesId	force	Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

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
agentsId	string
flowsId	string
locationsId	string
pagesId	string
projectsId	string
force	boolean
languageCode	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_flows_pages_get

Retrieves the specified page.

SELECT
name,
advancedSettings,
description,
displayName,
entryFulfillment,
eventHandlers,
form,
knowledgeConnectorSettings,
transitionRouteGroups,
transitionRoutes
FROM google.dialogflow.pages
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND pagesId = '{{ pagesId }}' -- required
AND languageCode = '{{ languageCode }}';

projects_locations_agents_flows_pages_list

Returns the list of all pages in the specified flow.

SELECT
name,
advancedSettings,
description,
displayName,
entryFulfillment,
eventHandlers,
form,
knowledgeConnectorSettings,
transitionRouteGroups,
transitionRoutes
FROM google.dialogflow.pages
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND languageCode = '{{ languageCode }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_agents_flows_pages_create

Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

INSERT INTO google.dialogflow.pages (
data__name,
data__displayName,
data__description,
data__entryFulfillment,
data__form,
data__transitionRouteGroups,
data__transitionRoutes,
data__eventHandlers,
data__advancedSettings,
data__knowledgeConnectorSettings,
projectsId,
locationsId,
agentsId,
flowsId,
languageCode
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ entryFulfillment }}',
'{{ form }}',
'{{ transitionRouteGroups }}',
'{{ transitionRoutes }}',
'{{ eventHandlers }}',
'{{ advancedSettings }}',
'{{ knowledgeConnectorSettings }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ flowsId }}',
'{{ languageCode }}'
RETURNING
name,
advancedSettings,
description,
displayName,
entryFulfillment,
eventHandlers,
form,
knowledgeConnectorSettings,
transitionRouteGroups,
transitionRoutes
;

Manifest

# Description fields are for documentation purposes
- name: pages
  props:
    - name: projectsId
      value: string
      description: Required parameter for the pages resource.
    - name: locationsId
      value: string
      description: Required parameter for the pages resource.
    - name: agentsId
      value: string
      description: Required parameter for the pages resource.
    - name: flowsId
      value: string
      description: Required parameter for the pages resource.
    - name: name
      value: string
      description: >
        The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the page, unique within the flow.
        
    - name: description
      value: string
      description: >
        The description of the page. The maximum length is 500 characters.
        
    - name: entryFulfillment
      value: object
      description: >
        The fulfillment to call when the session is entering the page.
        
    - name: form
      value: object
      description: >
        The form associated with the page, used for collecting parameters relevant to the page.
        
    - name: transitionRouteGroups
      value: array
      description: >
        Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
        
    - name: transitionRoutes
      value: array
      description: >
        A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
        
    - name: eventHandlers
      value: array
      description: >
        Handlers associated with the page to handle events such as webhook errors, no match or no input.
        
    - name: advancedSettings
      value: object
      description: >
        Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
        
    - name: knowledgeConnectorSettings
      value: object
      description: >
        Optional. Knowledge connector configuration.
        
    - name: languageCode
      value: string

UPDATE examples

projects_locations_agents_flows_pages_patch

Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

UPDATE google.dialogflow.pages
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__entryFulfillment = '{{ entryFulfillment }}',
data__form = '{{ form }}',
data__transitionRouteGroups = '{{ transitionRouteGroups }}',
data__transitionRoutes = '{{ transitionRoutes }}',
data__eventHandlers = '{{ eventHandlers }}',
data__advancedSettings = '{{ advancedSettings }}',
data__knowledgeConnectorSettings = '{{ knowledgeConnectorSettings }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND pagesId = '{{ pagesId }}' --required
AND languageCode = '{{ languageCode}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
advancedSettings,
description,
displayName,
entryFulfillment,
eventHandlers,
form,
knowledgeConnectorSettings,
transitionRouteGroups,
transitionRoutes;

DELETE examples

projects_locations_agents_flows_pages_delete

Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

DELETE FROM google.dialogflow.pages
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND pagesId = '{{ pagesId }}' --required
AND force = '{{ force }}';