Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Page.
A Dialogflow CX conversation (session) can be described and visualized as a
state machine. The states of a CX session are represented by pages.
For each flow, you define many pages, where your combined pages can handle a
complete conversation on the topics the flow is designed for. At any given
moment, exactly one page is the current page, the current page is considered
active, and the flow associated with that page is considered active. Every
flow has a special start page. When a flow initially becomes active, the
start page page becomes the current page. For each conversational turn, the
current page will either stay the same or transition to another page.
You configure each page to collect information from the end-user that is
relevant for the conversational state represented by the page.
For more information, see thePage guide.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.Page
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the page. Required for thePages.UpdatePagemethod.Pages.CreatePagepopulates the name automatically. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
↳ display_name
string
Required. The human-readable name of the page, unique within the flow.
↳ description
string
The description of the page. The maximum length is 500 characters.
The form associated with the page, used for collecting parameters relevant to the page.
↳ transition_route_groups
array
Ordered list ofTransitionRouteGroupsadded 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
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 thetransition route groupswith intent specified. * * TransitionRoutes defined in flow with intent specified. * * TransitionRoutes defined in thetransition route groupswith intent specified. * * TransitionRoutes defined in the page with only condition specified. * * TransitionRoutes defined in thetransition route groupswith only condition specified.
Required for thePages.UpdatePagemethod.Pages.CreatePagepopulates the name automatically.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
Returns
Type
Description
string
setName
The unique identifier of the page.
Required for thePages.UpdatePagemethod.Pages.CreatePagepopulates the name automatically.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Required. The human-readable name of the page, unique within the flow.
Returns
Type
Description
string
setDisplayName
Required. The human-readable name of the page, unique within the flow.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
The description of the page. The maximum length is 500 characters.
Returns
Type
Description
string
setDescription
The description of the page. The maximum length is 500 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEntryFulfillment
The fulfillment to call when the session is entering the page.
Ordered list ofTransitionRouteGroupsadded 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
Ordered list ofTransitionRouteGroupsadded 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getTransitionRoutes
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class Page (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Page)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.Page)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.Page)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.Page)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.Page)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.Page)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.Page)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.Page)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.Page) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Page.\n\nA Dialogflow CX conversation (session) can be described and visualized as a\nstate machine. The states of a CX session are represented by pages.\n\nFor each flow, you define many pages, where your combined pages can handle a\ncomplete conversation on the topics the flow is designed for. At any given\nmoment, exactly one page is the current page, the current page is considered\nactive, and the flow associated with that page is considered active. Every\nflow has a special start page. When a flow initially becomes active, the\nstart page page becomes the current page. For each conversational turn, the\ncurrent page will either stay the same or transition to another page.\nYou configure each page to collect information from the end-user that is\nrelevant for the conversational state represented by the page.\nFor more information, see the\n[Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.Page`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique identifier of the page.\n\nRequired for the\n[Pages.UpdatePage](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.PagesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_PagesClient__updatePage__) method.\n[Pages.CreatePage](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.PagesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_PagesClient__createPage__)\npopulates the name automatically.\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/flows/\u003cFlowID\u003e/pages/\u003cPageID\u003e`.\n\n### setName\n\nThe unique identifier of the page.\n\nRequired for the\n[Pages.UpdatePage](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.PagesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_PagesClient__updatePage__) method.\n[Pages.CreatePage](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.PagesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_PagesClient__createPage__)\npopulates the name automatically.\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/flows/\u003cFlowID\u003e/pages/\u003cPageID\u003e`.\n\n### getDisplayName\n\nRequired. The human-readable name of the page, unique within the flow.\n\n### setDisplayName\n\nRequired. The human-readable name of the page, unique within the flow.\n\n### getDescription\n\nThe description of the page. The maximum length is 500 characters.\n\n### setDescription\n\nThe description of the page. The maximum length is 500 characters.\n\n### getEntryFulfillment\n\nThe fulfillment to call when the session is entering the page.\n\n### hasEntryFulfillment\n\n### clearEntryFulfillment\n\n### setEntryFulfillment\n\nThe fulfillment to call when the session is entering the page.\n\n### getForm\n\nThe form associated with the page, used for collecting parameters\nrelevant to the page.\n\n### hasForm\n\n### clearForm\n\n### setForm\n\nThe form associated with the page, used for collecting parameters\nrelevant to the page.\n\n### getTransitionRouteGroups\n\nOrdered list of\n[`TransitionRouteGroups`](/php/docs/reference/cloud-dialogflow-cx/latest/V3.TransitionRouteGroup)\nadded to the page. Transition route groups must be unique within a page. If\nthe page links both flow-level transition route groups and agent-level\ntransition route groups, the flow-level ones will have higher priority and\nwill be put before the agent-level ones.\n\n- If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -\\\u003e page's transition route group -\\\u003e flow's transition routes.\n- If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/flows/\u003cFlowID\u003e/transitionRouteGroups/\u003cTransitionRouteGroupID\u003e` or `projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/transitionRouteGroups/\u003cTransitionRouteGroupID\u003e` for agent-level groups.\n\n### setTransitionRouteGroups\n\nOrdered list of\n[`TransitionRouteGroups`](/php/docs/reference/cloud-dialogflow-cx/latest/V3.TransitionRouteGroup)\nadded to the page. Transition route groups must be unique within a page. If\nthe page links both flow-level transition route groups and agent-level\ntransition route groups, the flow-level ones will have higher priority and\nwill be put before the agent-level ones.\n\n- If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -\\\u003e page's transition route group -\\\u003e flow's transition routes.\n- If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/flows/\u003cFlowID\u003e/transitionRouteGroups/\u003cTransitionRouteGroupID\u003e` or `projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/transitionRouteGroups/\u003cTransitionRouteGroupID\u003e` for agent-level groups.\n\n### getTransitionRoutes\n\nA list of transitions for the transition rules of this page.\n\nThey route the conversation to another page in the same flow, or another\nflow.\nWhen we are in a certain page, the TransitionRoutes are evaluated in the\nfollowing order:\n\n- TransitionRoutes defined in the page with intent specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Page#_Google_Cloud_Dialogflow_Cx_V3_Page__getTransitionRouteGroups__) with intent specified.\n- TransitionRoutes defined in flow with intent specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Flow#_Google_Cloud_Dialogflow_Cx_V3_Flow__getTransitionRouteGroups__) with intent specified.\n- TransitionRoutes defined in the page with only condition specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Page#_Google_Cloud_Dialogflow_Cx_V3_Page__getTransitionRouteGroups__) with only condition specified.\n\n### setTransitionRoutes\n\nA list of transitions for the transition rules of this page.\n\nThey route the conversation to another page in the same flow, or another\nflow.\nWhen we are in a certain page, the TransitionRoutes are evaluated in the\nfollowing order:\n\n- TransitionRoutes defined in the page with intent specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Page#_Google_Cloud_Dialogflow_Cx_V3_Page__getTransitionRouteGroups__) with intent specified.\n- TransitionRoutes defined in flow with intent specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Flow#_Google_Cloud_Dialogflow_Cx_V3_Flow__getTransitionRouteGroups__) with intent specified.\n- TransitionRoutes defined in the page with only condition specified.\n- TransitionRoutes defined in the [transition route\n groups](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Page#_Google_Cloud_Dialogflow_Cx_V3_Page__getTransitionRouteGroups__) with only condition specified.\n\n### getEventHandlers\n\nHandlers associated with the page to handle events such as webhook errors,\nno match or no input.\n\n### setEventHandlers\n\nHandlers associated with the page to handle events such as webhook errors,\nno match or no input.\n\n### getAdvancedSettings\n\nHierarchical advanced settings for this page. The settings exposed at the\nlower level overrides the settings exposed at the higher level.\n\n### hasAdvancedSettings\n\n### clearAdvancedSettings\n\n### setAdvancedSettings\n\nHierarchical advanced settings for this page. The settings exposed at the\nlower level overrides the settings exposed at the higher level.\n\n### getKnowledgeConnectorSettings\n\nOptional. Knowledge connector configuration.\n\n### hasKnowledgeConnectorSettings\n\n### clearKnowledgeConnectorSettings\n\n### setKnowledgeConnectorSettings\n\nOptional. Knowledge connector configuration."]]
