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

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string
displayName	string
entryFulfillment	object	(id: GoogleCloudDialogflowCxV3Fulfillment)
eventHandlers	array
form	object	(id: GoogleCloudDialogflowCxV3Form)
knowledgeConnectorSettings	object	(id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
transitionRouteGroups	array
transitionRoutes	array

projects_locations_agents_flows_pages_list

Name	Datatype	Description
name	string
advancedSettings	object	(id: GoogleCloudDialogflowCxV3AdvancedSettings)
description	string
displayName	string
entryFulfillment	object	(id: GoogleCloudDialogflowCxV3Fulfillment)
eventHandlers	array
form	object	(id: GoogleCloudDialogflowCxV3Form)
knowledgeConnectorSettings	object	(id: GoogleCloudDialogflowCxV3KnowledgeConnectorSettings)
transitionRouteGroups	array
transitionRoutes	array

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
projects_locations_agents_flows_pages_list	select	projectsId, locationsId, agentsId, flowsId	pageSize, languageCode, pageToken
projects_locations_agents_flows_pages_create	insert	projectsId, locationsId, agentsId, flowsId	languageCode
projects_locations_agents_flows_pages_patch	update	projectsId, locationsId, agentsId, flowsId, pagesId	updateMask, languageCode
projects_locations_agents_flows_pages_delete	delete	projectsId, locationsId, agentsId, flowsId, pagesId	force

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

Successful response

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

Successful response

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 pageSize = '{{ pageSize }}'
AND languageCode = '{{ languageCode }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_flows_pages_create

No description available.

INSERT INTO google.dialogflow.pages (
data__eventHandlers,
data__form,
data__displayName,
data__transitionRouteGroups,
data__knowledgeConnectorSettings,
data__name,
data__transitionRoutes,
data__description,
data__entryFulfillment,
data__advancedSettings,
projectsId,
locationsId,
agentsId,
flowsId,
languageCode
)
SELECT 
'{{ eventHandlers }}',
'{{ form }}',
'{{ displayName }}',
'{{ transitionRouteGroups }}',
'{{ knowledgeConnectorSettings }}',
'{{ name }}',
'{{ transitionRoutes }}',
'{{ description }}',
'{{ entryFulfillment }}',
'{{ advancedSettings }}',
'{{ 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: "{{ projectsId }}"
    description: Required parameter for the pages resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the pages resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the pages resource.
  - name: flowsId
    value: "{{ flowsId }}"
    description: Required parameter for the pages resource.
  - name: eventHandlers
    value:
      - name: "{{ name }}"
        event: "{{ event }}"
        targetPage: "{{ targetPage }}"
        triggerFulfillment:
          returnPartialResponses: {{ returnPartialResponses }}
          generators:
            - inputParameters: "{{ inputParameters }}"
              generator: "{{ generator }}"
              outputParameter: "{{ outputParameter }}"
          webhook: "{{ webhook }}"
          enableGenerativeFallback: {{ enableGenerativeFallback }}
          setParameterActions:
            - parameter: "{{ parameter }}"
              value: "{{ value }}"
          tag: "{{ tag }}"
          advancedSettings:
            loggingSettings:
              enableInteractionLogging: {{ enableInteractionLogging }}
              enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
              enableStackdriverLogging: {{ enableStackdriverLogging }}
            audioExportGcsDestination:
              uri: "{{ uri }}"
            speechSettings:
              useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
              models: "{{ models }}"
              endpointerSensitivity: {{ endpointerSensitivity }}
              noSpeechTimeout: "{{ noSpeechTimeout }}"
            dtmfSettings:
              maxDigits: {{ maxDigits }}
              finishDigit: "{{ finishDigit }}"
              interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
              enabled: {{ enabled }}
              endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
          messages:
            - playAudio:
                audioUri: "{{ audioUri }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              toolCall:
                tool: "{{ tool }}"
                action: "{{ action }}"
                inputParameters: "{{ inputParameters }}"
              knowledgeInfoCard: "{{ knowledgeInfoCard }}"
              endInteraction: "{{ endInteraction }}"
              conversationSuccess:
                metadata: "{{ metadata }}"
              channel: "{{ channel }}"
              text:
                text:
                  - "{{ text }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              telephonyTransferCall:
                phoneNumber: "{{ phoneNumber }}"
              responseType: "{{ responseType }}"
              payload: "{{ payload }}"
              outputAudioText:
                text: "{{ text }}"
                ssml: "{{ ssml }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              mixedAudio:
                segments:
                  - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    audio: "{{ audio }}"
                    uri: "{{ uri }}"
              liveAgentHandoff:
                metadata: "{{ metadata }}"
          conditionalCases:
            - cases: "{{ cases }}"
        targetFlow: "{{ targetFlow }}"
        targetPlaybook: "{{ targetPlaybook }}"
  - name: form
    value:
      parameters:
        - required: {{ required }}
          isList: {{ isList }}
          redact: {{ redact }}
          displayName: "{{ displayName }}"
          advancedSettings:
            loggingSettings:
              enableInteractionLogging: {{ enableInteractionLogging }}
              enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
              enableStackdriverLogging: {{ enableStackdriverLogging }}
            audioExportGcsDestination:
              uri: "{{ uri }}"
            speechSettings:
              useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
              models: "{{ models }}"
              endpointerSensitivity: {{ endpointerSensitivity }}
              noSpeechTimeout: "{{ noSpeechTimeout }}"
            dtmfSettings:
              maxDigits: {{ maxDigits }}
              finishDigit: "{{ finishDigit }}"
              interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
              enabled: {{ enabled }}
              endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
          entityType: "{{ entityType }}"
          fillBehavior:
            initialPromptFulfillment:
              returnPartialResponses: {{ returnPartialResponses }}
              generators:
                - inputParameters: "{{ inputParameters }}"
                  generator: "{{ generator }}"
                  outputParameter: "{{ outputParameter }}"
              webhook: "{{ webhook }}"
              enableGenerativeFallback: {{ enableGenerativeFallback }}
              setParameterActions:
                - parameter: "{{ parameter }}"
                  value: "{{ value }}"
              tag: "{{ tag }}"
              advancedSettings:
                loggingSettings: "{{ loggingSettings }}"
                audioExportGcsDestination: "{{ audioExportGcsDestination }}"
                speechSettings: "{{ speechSettings }}"
                dtmfSettings: "{{ dtmfSettings }}"
              messages:
                - playAudio:
                    audioUri: "{{ audioUri }}"
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                  toolCall:
                    tool: "{{ tool }}"
                    action: "{{ action }}"
                    inputParameters: "{{ inputParameters }}"
                  knowledgeInfoCard: "{{ knowledgeInfoCard }}"
                  endInteraction: "{{ endInteraction }}"
                  conversationSuccess:
                    metadata: "{{ metadata }}"
                  channel: "{{ channel }}"
                  text:
                    text: "{{ text }}"
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                  telephonyTransferCall:
                    phoneNumber: "{{ phoneNumber }}"
                  responseType: "{{ responseType }}"
                  payload: "{{ payload }}"
                  outputAudioText:
                    text: "{{ text }}"
                    ssml: "{{ ssml }}"
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                  mixedAudio:
                    segments: "{{ segments }}"
                  liveAgentHandoff:
                    metadata: "{{ metadata }}"
              conditionalCases:
                - cases: "{{ cases }}"
            repromptEventHandlers:
              - name: "{{ name }}"
                event: "{{ event }}"
                targetPage: "{{ targetPage }}"
                triggerFulfillment:
                  returnPartialResponses: {{ returnPartialResponses }}
                  generators: "{{ generators }}"
                  webhook: "{{ webhook }}"
                  enableGenerativeFallback: {{ enableGenerativeFallback }}
                  setParameterActions: "{{ setParameterActions }}"
                  tag: "{{ tag }}"
                  advancedSettings: "{{ advancedSettings }}"
                  messages: "{{ messages }}"
                  conditionalCases: "{{ conditionalCases }}"
                targetFlow: "{{ targetFlow }}"
                targetPlaybook: "{{ targetPlaybook }}"
          defaultValue: "{{ defaultValue }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: transitionRouteGroups
    value:
      - "{{ transitionRouteGroups }}"
  - name: knowledgeConnectorSettings
    value:
      targetFlow: "{{ targetFlow }}"
      dataStoreConnections:
        - dataStore: "{{ dataStore }}"
          documentProcessingMode: "{{ documentProcessingMode }}"
          dataStoreType: "{{ dataStoreType }}"
      triggerFulfillment:
        returnPartialResponses: {{ returnPartialResponses }}
        generators:
          - inputParameters: "{{ inputParameters }}"
            generator: "{{ generator }}"
            outputParameter: "{{ outputParameter }}"
        webhook: "{{ webhook }}"
        enableGenerativeFallback: {{ enableGenerativeFallback }}
        setParameterActions:
          - parameter: "{{ parameter }}"
            value: "{{ value }}"
        tag: "{{ tag }}"
        advancedSettings:
          loggingSettings:
            enableInteractionLogging: {{ enableInteractionLogging }}
            enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
            enableStackdriverLogging: {{ enableStackdriverLogging }}
          audioExportGcsDestination:
            uri: "{{ uri }}"
          speechSettings:
            useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
            models: "{{ models }}"
            endpointerSensitivity: {{ endpointerSensitivity }}
            noSpeechTimeout: "{{ noSpeechTimeout }}"
          dtmfSettings:
            maxDigits: {{ maxDigits }}
            finishDigit: "{{ finishDigit }}"
            interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
            enabled: {{ enabled }}
            endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
        messages:
          - playAudio:
              audioUri: "{{ audioUri }}"
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
            toolCall:
              tool: "{{ tool }}"
              action: "{{ action }}"
              inputParameters: "{{ inputParameters }}"
            knowledgeInfoCard: "{{ knowledgeInfoCard }}"
            endInteraction: "{{ endInteraction }}"
            conversationSuccess:
              metadata: "{{ metadata }}"
            channel: "{{ channel }}"
            text:
              text:
                - "{{ text }}"
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
            telephonyTransferCall:
              phoneNumber: "{{ phoneNumber }}"
            responseType: "{{ responseType }}"
            payload: "{{ payload }}"
            outputAudioText:
              text: "{{ text }}"
              ssml: "{{ ssml }}"
              allowPlaybackInterruption: {{ allowPlaybackInterruption }}
            mixedAudio:
              segments:
                - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                  audio: "{{ audio }}"
                  uri: "{{ uri }}"
            liveAgentHandoff:
              metadata: "{{ metadata }}"
        conditionalCases:
          - cases: "{{ cases }}"
      enabled: {{ enabled }}
      targetPage: "{{ targetPage }}"
  - name: name
    value: "{{ name }}"
  - name: transitionRoutes
    value:
      - name: "{{ name }}"
        targetPage: "{{ targetPage }}"
        condition: "{{ condition }}"
        description: "{{ description }}"
        targetFlow: "{{ targetFlow }}"
        intent: "{{ intent }}"
        triggerFulfillment:
          returnPartialResponses: {{ returnPartialResponses }}
          generators:
            - inputParameters: "{{ inputParameters }}"
              generator: "{{ generator }}"
              outputParameter: "{{ outputParameter }}"
          webhook: "{{ webhook }}"
          enableGenerativeFallback: {{ enableGenerativeFallback }}
          setParameterActions:
            - parameter: "{{ parameter }}"
              value: "{{ value }}"
          tag: "{{ tag }}"
          advancedSettings:
            loggingSettings:
              enableInteractionLogging: {{ enableInteractionLogging }}
              enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
              enableStackdriverLogging: {{ enableStackdriverLogging }}
            audioExportGcsDestination:
              uri: "{{ uri }}"
            speechSettings:
              useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
              models: "{{ models }}"
              endpointerSensitivity: {{ endpointerSensitivity }}
              noSpeechTimeout: "{{ noSpeechTimeout }}"
            dtmfSettings:
              maxDigits: {{ maxDigits }}
              finishDigit: "{{ finishDigit }}"
              interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
              enabled: {{ enabled }}
              endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
          messages:
            - playAudio:
                audioUri: "{{ audioUri }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              toolCall:
                tool: "{{ tool }}"
                action: "{{ action }}"
                inputParameters: "{{ inputParameters }}"
              knowledgeInfoCard: "{{ knowledgeInfoCard }}"
              endInteraction: "{{ endInteraction }}"
              conversationSuccess:
                metadata: "{{ metadata }}"
              channel: "{{ channel }}"
              text:
                text:
                  - "{{ text }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              telephonyTransferCall:
                phoneNumber: "{{ phoneNumber }}"
              responseType: "{{ responseType }}"
              payload: "{{ payload }}"
              outputAudioText:
                text: "{{ text }}"
                ssml: "{{ ssml }}"
                allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              mixedAudio:
                segments:
                  - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    audio: "{{ audio }}"
                    uri: "{{ uri }}"
              liveAgentHandoff:
                metadata: "{{ metadata }}"
          conditionalCases:
            - cases: "{{ cases }}"
  - name: description
    value: "{{ description }}"
  - name: entryFulfillment
    value:
      returnPartialResponses: {{ returnPartialResponses }}
      generators:
        - inputParameters: "{{ inputParameters }}"
          generator: "{{ generator }}"
          outputParameter: "{{ outputParameter }}"
      webhook: "{{ webhook }}"
      enableGenerativeFallback: {{ enableGenerativeFallback }}
      setParameterActions:
        - parameter: "{{ parameter }}"
          value: "{{ value }}"
      tag: "{{ tag }}"
      advancedSettings:
        loggingSettings:
          enableInteractionLogging: {{ enableInteractionLogging }}
          enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
          enableStackdriverLogging: {{ enableStackdriverLogging }}
        audioExportGcsDestination:
          uri: "{{ uri }}"
        speechSettings:
          useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
          models: "{{ models }}"
          endpointerSensitivity: {{ endpointerSensitivity }}
          noSpeechTimeout: "{{ noSpeechTimeout }}"
        dtmfSettings:
          maxDigits: {{ maxDigits }}
          finishDigit: "{{ finishDigit }}"
          interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
          enabled: {{ enabled }}
          endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
      messages:
        - playAudio:
            audioUri: "{{ audioUri }}"
            allowPlaybackInterruption: {{ allowPlaybackInterruption }}
          toolCall:
            tool: "{{ tool }}"
            action: "{{ action }}"
            inputParameters: "{{ inputParameters }}"
          knowledgeInfoCard: "{{ knowledgeInfoCard }}"
          endInteraction: "{{ endInteraction }}"
          conversationSuccess:
            metadata: "{{ metadata }}"
          channel: "{{ channel }}"
          text:
            text:
              - "{{ text }}"
            allowPlaybackInterruption: {{ allowPlaybackInterruption }}
          telephonyTransferCall:
            phoneNumber: "{{ phoneNumber }}"
          responseType: "{{ responseType }}"
          payload: "{{ payload }}"
          outputAudioText:
            text: "{{ text }}"
            ssml: "{{ ssml }}"
            allowPlaybackInterruption: {{ allowPlaybackInterruption }}
          mixedAudio:
            segments:
              - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                audio: "{{ audio }}"
                uri: "{{ uri }}"
          liveAgentHandoff:
            metadata: "{{ metadata }}"
      conditionalCases:
        - cases: "{{ cases }}"
  - name: advancedSettings
    value:
      loggingSettings:
        enableInteractionLogging: {{ enableInteractionLogging }}
        enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
        enableStackdriverLogging: {{ enableStackdriverLogging }}
      audioExportGcsDestination:
        uri: "{{ uri }}"
      speechSettings:
        useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
        models: "{{ models }}"
        endpointerSensitivity: {{ endpointerSensitivity }}
        noSpeechTimeout: "{{ noSpeechTimeout }}"
      dtmfSettings:
        maxDigits: {{ maxDigits }}
        finishDigit: "{{ finishDigit }}"
        interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
        enabled: {{ enabled }}
        endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
  - name: languageCode
    value: "{{ languageCode }}"

UPDATE examples

projects_locations_agents_flows_pages_patch

No description available.

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

DELETE examples

projects_locations_agents_flows_pages_delete

No description available.

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 }}'
;