Recursos de superfície (Dialogflow)

Explorar no Dialogflow

Clique em Continue para importar a amostra de recursos do Surface para o Dialogflow. Depois, siga as etapas abaixo para implantar e testar a amostra:

  1. Digite um nome de agente e crie um novo agente do Dialogflow para a amostra.
  2. Depois que a importação do agente terminar, clique em Go to agent.
  3. No menu de navegação principal, acesse Fulfillment.
  4. Ative o Editor in-line e clique em Implantar. O editor contém a amostra o código-fonte.
  5. No menu de navegação principal, acesse Integrações e clique em Google Google Assistente.
  6. Na janela modal exibida, ative a opção Mudanças na visualização automática e clique em Testar. para abrir o simulador do Actions.
  7. No simulador, insira Talk to my test app para testar a amostra.
Continuar

Suas ações podem aparecer em várias plataformas, incluindo opções somente de áudio (alto-falantes inteligentes), áudio e superfícies de exibição (como smart displays e dispositivos móveis).

Para projetar e criar conversas que funcionem bem em todas as plataformas, use plataformas para controlar e definir o escopo de suas conversas corretamente.

Mostrar recursos para ações

O Actions on Google permite controlar se os usuários podem invocar ou não sua ação com base na superfície que usam. Se os usuários tentarem invocar sua ação em uma plataforma incompatível, ele recebe uma mensagem de erro informando que o dispositivo está sem suporte.

Você define o suporte à superfície da ação no projeto do Actions.

Sua Ação pode aparecer em várias plataformas que com o Google Assistente, como smartphones (Android e iOS) e Dispositivos Google Home.

Recursos da superfície do ambiente de execução

Você pode fornecer a experiência do usuário com recursos de superfície de execução de duas maneiras principais:

  • Ramificação de resposta: apresenta respostas diferentes aos usuários, mas com as mesmas mesma estrutura e fluxo para a conversa em diferentes superfícies. Para por exemplo, uma ação climática pode mostrar um card com uma imagem em um smartphone e tocar um arquivo de áudio no Google Home, mas o fluxo da conversa é o mesmo. em várias superfícies.

  • Ramificação de conversas: oferece aos usuários opções completamente diferentes. conversa em cada plataforma. Por exemplo, se você estiver criando um serviço de app, forneça um fluxo de reorganização no Google Home, mas um de montagem do carrinho em smartphones. Para fazer a ramificação da conversa, defina o escopo acionamento de intents do Dialogflow para determinados recursos de superfície com o Dialogflow contextos de negócios diferentes. As intents reais do Dialogflow não são acionadas, a menos que uma solicitação que a capacidade da superfície seja atendida.

  • Conversas em várias plataformas: apresente os usuários em uma conversa. que passa para outra superfície no meio da conversa. Por exemplo, se Um usuário invoca sua ação com imagens em uma plataforma somente de áudio como o Google Em casa, você pode criar uma ação para procurar outra superfície com recursos visuais recursos e levar a conversa para lá, se possível.

Ramificação de resposta

Sempre que o fulfillment recebe uma solicitação do Google Assistente, você Pode consultar as seguintes plataformas (por exemplo, o Google Home ou um smartphone Android) recursos:

Node.js

const hasScreen =
  conv.surface.capabilities.has('actions.capability.SCREEN_OUTPUT');
  // OR conv.screen;
const hasAudio =
  conv.surface.capabilities.has('actions.capability.AUDIO_OUTPUT');
const hasMediaPlayback =
  conv.surface.capabilities.has('actions.capability.MEDIA_RESPONSE_AUDIO');
const hasWebBrowser =
  conv.surface.capabilities.has('actions.capability.WEB_BROWSER');
// Interactive Canvas must be enabled in your project to see this
const hasInteractiveCanvas =
  conv.surface.capabilities.has('actions.capability.INTERACTIVE_CANVAS');
index.js

Java

boolean hasScreen = request.hasCapability(Capability.SCREEN_OUTPUT.getValue());
boolean hasAudio = request.hasCapability(Capability.AUDIO_OUTPUT.getValue());
boolean hasMediaPlayback = request.hasCapability(Capability.MEDIA_RESPONSE_AUDIO.getValue());
boolean hasWebBrowser = request.hasCapability(Capability.WEB_BROWSER.getValue());
// Interactive Canvas must be enabled in your project to see this
boolean hasInteractiveCanvas = request.hasCapability("INTERACTIVE_CANVAS");
MyActionsApp.java

Node.js

const hasScreen =
  conv.surface.capabilities.has('actions.capability.SCREEN_OUTPUT');
  // OR conv.screen;
const hasAudio =
  conv.surface.capabilities.has('actions.capability.AUDIO_OUTPUT');
const hasMediaPlayback =
  conv.surface.capabilities.has('actions.capability.MEDIA_RESPONSE_AUDIO');
const hasWebBrowser =
  conv.surface.capabilities.has('actions.capability.WEB_BROWSER');
// Interactive Canvas must be enabled in your project to see this
const hasInteractiveCanvas =
  conv.surface.capabilities.has('actions.capability.INTERACTIVE_CANVAS');
index.js

Java

boolean hasScreen = request.hasCapability(Capability.SCREEN_OUTPUT.getValue());
boolean hasAudio = request.hasCapability(Capability.AUDIO_OUTPUT.getValue());
boolean hasMediaPlayback = request.hasCapability(Capability.MEDIA_RESPONSE_AUDIO.getValue());
boolean hasWebBrowser = request.hasCapability(Capability.WEB_BROWSER.getValue());
// Interactive Canvas must be enabled in your project to see this
boolean hasInteractiveCanvas = request.hasCapability("INTERACTIVE_CANVAS");
MyActionsApp.java

JSON

O JSON abaixo descreve uma solicitação de webhook.

{
  "responseId": "206a66fb-a572-4cfc-9e41-8e2eb62fdf18-712767ed",
  "queryResult": {
    "queryText": "Current capabilities",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "Webhook failed for intent: Current Capabilities",
    "fulfillmentMessages": [
      {
        "text": {
          "text": [
            "Webhook failed for intent: Current Capabilities"
          ]
        }
      }
    ],
    "outputContexts": [
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_media_response_audio"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_account_linking"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_web_browser"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/google_assistant_input_type_touch"
      }
    ],
    "intent": {
      "name": "projects/df-surface-caps-kohler/agent/intents/4e191eef-ba17-4f68-8a97-85a43cbc9ed1",
      "displayName": "Current Capabilities"
    },
    "intentDetectionConfidence": 1,
    "languageCode": "en"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "user": {
        "locale": "en-US",
        "userVerificationStatus": "VERIFIED"
      },
      "conversation": {
        "conversationId": "ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ",
        "type": "ACTIVE",
        "conversationToken": "[]"
      },
      "inputs": [
        {
          "intent": "actions.intent.TEXT",
          "rawInputs": [
            {
              "inputType": "TOUCH",
              "query": "Current capabilities"
            }
          ],
          "arguments": [
            {
              "name": "text",
              "rawText": "Current capabilities",
              "textValue": "Current capabilities"
            }
          ]
        }
      ],
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.ACCOUNT_LINKING"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          },
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          }
        ]
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            },
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            },
            {
              "name": "actions.capability.WEB_BROWSER"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ"
}

JSON

O JSON abaixo descreve uma solicitação de webhook.

{
  "user": {
    "locale": "en-US",
    "userVerificationStatus": "VERIFIED"
  },
  "conversation": {
    "conversationId": "ABwppHENuB8dw7LgVquXnW5Bmy9hwu1Qz4bsaL7uIb9vDSBYPAFhFgsMWnMV6m4JEDgaUWz9FUVuIhQqWh1KZ_jjTwKEIlza",
    "type": "NEW"
  },
  "inputs": [
    {
      "intent": "actions.intent.TEXT",
      "rawInputs": [
        {
          "inputType": "TOUCH",
          "query": "Current capabilities"
        }
      ],
      "arguments": [
        {
          "name": "text",
          "rawText": "Current capabilities",
          "textValue": "Current capabilities"
        }
      ]
    }
  ],
  "surface": {
    "capabilities": [
      {
        "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
      },
      {
        "name": "actions.capability.SCREEN_OUTPUT"
      },
      {
        "name": "actions.capability.WEB_BROWSER"
      },
      {
        "name": "actions.capability.ACCOUNT_LINKING"
      },
      {
        "name": "actions.capability.AUDIO_OUTPUT"
      }
    ]
  },
  "availableSurfaces": [
    {
      "capabilities": [
        {
          "name": "actions.capability.WEB_BROWSER"
        },
        {
          "name": "actions.capability.AUDIO_OUTPUT"
        },
        {
          "name": "actions.capability.SCREEN_OUTPUT"
        }
      ]
    }
  ]
}

Ramificação de conversas

Para que as intents do Dialogflow sejam acionadas somente em determinados recursos, contextos predefinidos do Dialogflow. Sempre que uma intent é correspondida, o Dialogflow gera contextos automaticamente com base no conjunto de capacidades da superfície que o dispositivo tem disponível. É possível especificar um ou mais desses contextos como "contextos de entrada" para suas intents. Isso permite bloquear o acionamento de intents com base na modalidade.

Por exemplo, se você só quiser que uma intent seja acionada em dispositivos com saída de tela, É possível definir um contexto de entrada na intent como actions_capability_screen_output.

Os seguintes contextos estão disponíveis:

  • actions_capability_audio_output: o dispositivo tem um alto-falante.
  • actions_capability_screen_output: o dispositivo tem uma tela de saída.
  • actions_capability_media_response_audio: o dispositivo oferece suporte à reprodução de conteúdo de mídia.
  • actions_capability_web_browser: o dispositivo é compatível com um navegador da Web. (Este no momento não está disponível para smart displays.

Confira um exemplo de intent que só será acionada em superfícies com telas:

Conversas em várias plataformas

A qualquer momento durante o fluxo da ação, é possível verificar se o usuário tem outras com uma capacidade específica. Se outra plataforma com a solicitação estiver disponível, será possível transferir a conversa para essa nova superfície.

O fluxo de uma transferência de superfície vai funcionar da seguinte maneira:

  1. Conferir se o usuário tem uma plataforma disponível

    No gerenciador de webhooks, consulte se o usuário tem uma plataforma disponíveis com uma capacidade específica. Essa superfície precisa estar vinculada mesma Conta do Google da plataforma de origem.

    Node.js

    const screenAvailable =
  conv.available.surfaces.capabilities.has(
    'actions.capability.SCREEN_OUTPUT');
    index.js

    Java

    String screen = Capability.SCREEN_OUTPUT.getValue();
boolean screenAvailable = false;
for (Surface surface : request.getAvailableSurfaces()) {
  for (com.google.api.services.actions_fulfillment.v2.model.Capability capability :
      surface.getCapabilities()) {
    if (capability.getName().equals(screen)) {
      screenAvailable = true;
      break;
    }
  }
}
    MyActionsApp.java

    Node.js

    const screenAvailable =
  conv.available.surfaces.capabilities.has(
    'actions.capability.SCREEN_OUTPUT');
    index.js

    Java

    String screen = Capability.SCREEN_OUTPUT.getValue();
boolean screenAvailable = false;
for (Surface surface : request.getAvailableSurfaces()) {
  for (com.google.api.services.actions_fulfillment.v2.model.Capability capability :
      surface.getCapabilities()) {
    if (capability.getName().equals(screen)) {
      screenAvailable = true;
      break;
    }
  }
}
    MyActionsApp.java

    JSON

    O JSON abaixo descreve uma solicitação de webhook.

    {
  "responseId": "206a66fb-a572-4cfc-9e41-8e2eb62fdf18-712767ed",
  "queryResult": {
    "queryText": "Current capabilities",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "Webhook failed for intent: Current Capabilities",
    "fulfillmentMessages": [
      {
        "text": {
          "text": [
            "Webhook failed for intent: Current Capabilities"
          ]
        }
      }
    ],
    "outputContexts": [
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_media_response_audio"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_account_linking"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_web_browser"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ/contexts/google_assistant_input_type_touch"
      }
    ],
    "intent": {
      "name": "projects/df-surface-caps-kohler/agent/intents/4e191eef-ba17-4f68-8a97-85a43cbc9ed1",
      "displayName": "Current Capabilities"
    },
    "intentDetectionConfidence": 1,
    "languageCode": "en"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "user": {
        "locale": "en-US",
        "userVerificationStatus": "VERIFIED"
      },
      "conversation": {
        "conversationId": "ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ",
        "type": "ACTIVE",
        "conversationToken": "[]"
      },
      "inputs": [
        {
          "intent": "actions.intent.TEXT",
          "rawInputs": [
            {
              "inputType": "TOUCH",
              "query": "Current capabilities"
            }
          ],
          "arguments": [
            {
              "name": "text",
              "rawText": "Current capabilities",
              "textValue": "Current capabilities"
            }
          ]
        }
      ],
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.ACCOUNT_LINKING"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          },
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          }
        ]
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            },
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            },
            {
              "name": "actions.capability.WEB_BROWSER"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/df-surface-caps-kohler/agent/sessions/ABwppHG7pYytu-kJGJApvrFTk2iNkshy-NLsjlzJg2ntVbxZkoz-rdFch3Fd8Vmlgf0VxmNSK1woelx1otayGwCnE8gzAQ"
}

    JSON

    O JSON abaixo descreve uma solicitação de webhook.

    {
  "user": {
    "locale": "en-US",
    "userVerificationStatus": "VERIFIED"
  },
  "conversation": {
    "conversationId": "ABwppHENuB8dw7LgVquXnW5Bmy9hwu1Qz4bsaL7uIb9vDSBYPAFhFgsMWnMV6m4JEDgaUWz9FUVuIhQqWh1KZ_jjTwKEIlza",
    "type": "NEW"
  },
  "inputs": [
    {
      "intent": "actions.intent.TEXT",
      "rawInputs": [
        {
          "inputType": "TOUCH",
          "query": "Current capabilities"
        }
      ],
      "arguments": [
        {
          "name": "text",
          "rawText": "Current capabilities",
          "textValue": "Current capabilities"
        }
      ]
    }
  ],
  "surface": {
    "capabilities": [
      {
        "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
      },
      {
        "name": "actions.capability.SCREEN_OUTPUT"
      },
      {
        "name": "actions.capability.WEB_BROWSER"
      },
      {
        "name": "actions.capability.ACCOUNT_LINKING"
      },
      {
        "name": "actions.capability.AUDIO_OUTPUT"
      }
    ]
  },
  "availableSurfaces": [
    {
      "capabilities": [
        {
          "name": "actions.capability.WEB_BROWSER"
        },
        {
          "name": "actions.capability.AUDIO_OUTPUT"
        },
        {
          "name": "actions.capability.SCREEN_OUTPUT"
        }
      ]
    }
  ]
}
  2. Solicitar a transferência do usuário para a nova plataforma

    Se houver uma plataforma disponível com os recursos necessários, a ação vai precisa perguntar ao usuário se ele quer transferir a conversa.

    Node.js

    if (conv.screen) {
  conv.ask(`You're already on a screen device.`);
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Current Capabilities',
    'Check Audio Capability',
    'Check Screen Capability',
    'Check Media Capability',
    'Check Web Capability',
  ]));
  return;
} else if (screenAvailable) {
  const context =
    `Let's move you to a screen device for cards and other visual responses`;
  const notification = 'Try your Action here!';
  const capabilities = ['actions.capability.SCREEN_OUTPUT'];
  return conv.ask(new NewSurface({context, notification, capabilities}));
} else {
  conv.ask('It looks like there is no screen device ' +
    'associated with this user.');
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Current Capabilities',
    'Check Audio Capability',
    'Check Screen Capability',
    'Check Media Capability',
    'Check Web Capability',
  ]));
};
    index.js

    Java

    ResponseBuilder responseBuilder = getResponseBuilder(request);
if (request.hasCapability(Capability.SCREEN_OUTPUT.getValue())) {
  responseBuilder.add("You're already on a screen device");
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Transfer surface",
        "Check Audio Capability",
        "Check Screen Capability",
        "Check Media Capability",
        "Check Web Capability",
      });
  return responseBuilder.build();
} else if (screenAvailable) {
  responseBuilder.add(
      new NewSurface()
          .setContext("Let's move you to a screen device for cards and other visual responses")
          .setNotificationTitle("Try your Action here!")
          .setCapabilities(Collections.singletonList(screen)));
  return responseBuilder.build();
} else {
  responseBuilder.add("It looks like there is no screen device associated with this user.");
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Transfer surface",
        "Check Audio Capability",
        "Check Screen Capability",
        "Check Media Capability",
        "Check Web Capability",
      });
  return responseBuilder.build();
}
    MyActionsApp.java

    Node.js

    if (conv.screen) {
  conv.ask(`You're already on a screen device.`);
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Transfer surface',
    'Current capabilities',
  ]));
  return;
} else if (screenAvailable) {
  const context =
    `Let's move you to a screen device for cards and other visual responses`;
  const notification = 'Try your Action here!';
  const capabilities = ['actions.capability.SCREEN_OUTPUT'];
  return conv.ask(new NewSurface({context, notification, capabilities}));
} else {
  conv.ask('It looks like there is no screen device ' +
    'associated with this user.');
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Transfer surface',
    'Current capabilities',
  ]));
};
    index.js

    Java

    ResponseBuilder responseBuilder = getResponseBuilder(request);
if (request.hasCapability(Capability.SCREEN_OUTPUT.getValue())) {
  responseBuilder.add("You're already on a screen device");
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Current capabilities", "Transfer surface",
      });
  return responseBuilder.build();
} else if (screenAvailable) {
  responseBuilder.add(
      new NewSurface()
          .setContext("Let's move you to a screen device for cards and other visual responses")
          .setNotificationTitle("Try your Action here!")
          .setCapabilities(Collections.singletonList(screen)));
  return responseBuilder.build();
} else {
  responseBuilder.add("It looks like there is no screen device associated with this user.");
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Current capabilities", "Transfer surface",
      });
  return responseBuilder.build();
}
    MyActionsApp.java

    JSON

    O JSON abaixo descreve uma resposta do webhook.

    {
  "payload": {
    "google": {
      "expectUserResponse": true,
      "systemIntent": {
        "intent": "actions.intent.NEW_SURFACE",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.NewSurfaceValueSpec",
          "capabilities": [
            "actions.capability.SCREEN_OUTPUT"
          ],
          "context": "Let's move you to a screen device for cards and other visual responses",
          "notificationTitle": "Try your Action here!"
        }
      }
    }
  }
}

    JSON

    O JSON abaixo descreve uma resposta do webhook.

    {
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "possibleIntents": [
        {
          "intent": "actions.intent.NEW_SURFACE",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.NewSurfaceValueSpec",
            "capabilities": [
              "actions.capability.SCREEN_OUTPUT"
            ],
            "context": "Let's move you to a screen device for cards and other visual responses",
            "notificationTitle": "Try your Action here!"
          }
        }
      ]
    }
  ]
}
  3. Processar a resposta do usuário

    Com base na resposta do usuário à sua solicitação, a ação facilitará a transferência ou o controle de retorno da conversa à plataforma original. De qualquer forma, a próxima solicitação para seu endpoint vai conter o actions.intent.NEW_SURFACE Portanto, você deve criar uma intent que seja acionada nesse evento com uma gerenciador correspondente no webhook. No código do gerenciador, você deve verificar se a transferência foi bem-sucedida ou não.

    Node.js

    app.intent('Transfer Surface - NEW_SURFACE', (conv, input, newSurface) => {
  if (newSurface.status === 'OK') {
    conv.ask('Welcome to a screen device!');
    conv.ask(new BasicCard({
      title: `You're on a screen device!`,
      text: `Screen devices support basic cards and other visual responses!`,
    }));
  } else {
    conv.ask(`Ok, no problem.`);
  }
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Current Capabilities',
    'Check Audio Capability',
    'Check Screen Capability',
    'Check Media Capability',
    'Check Web Capability',
  ]));
});
    index.js

    Java

    @ForIntent("Transfer Surface - NEW_SURFACE")
public ActionResponse newSurface(ActionRequest request) {
  ResponseBuilder responseBuilder = getResponseBuilder(request);
  Map<String, Object> newSurfaceStatus = request.getArgument("NEW_SURFACE").getExtension();
  if (newSurfaceStatus.get("status").equals("OK")) {
    responseBuilder.add("Welcome to a screen device!");
    responseBuilder.add(
        new BasicCard()
            .setTitle("You're on a screened device!")
            .setFormattedText("Screen devices support basic cards and other visual responses!"));
  } else {
    responseBuilder.add("Ok, no problem.");
  }
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Transfer surface",
        "Check Audio Capability",
        "Check Screen Capability",
        "Check Media Capability",
        "Check Web Capability",
      });
  return responseBuilder.build();
}
    MyActionsApp.java

    Node.js

    app.intent('actions.intent.NEW_SURFACE', (conv) => {
  if (conv.arguments.get('NEW_SURFACE').status === 'OK') {
    conv.ask('Welcome to a screen device!');
    conv.ask(new BasicCard({
      title: `You're on a screen device!`,
      text: `Screen devices support basic cards and other visual responses!`,
    }));
  } else {
    conv.ask(`Ok, no problem.`);
  }
  conv.ask('What else would you like to try?');
  conv.ask(new Suggestions([
    'Transfer surface',
    'Current capabilities',
  ]));
});
    index.js

    Java

    @ForIntent("actions.intent.NEW_SURFACE")
public ActionResponse newSurface(ActionRequest request) {
  ResponseBuilder responseBuilder = getResponseBuilder(request);
  Map<String, Object> newSurfaceStatus = request.getArgument("NEW_SURFACE").getExtension();
  if (newSurfaceStatus.get("status").equals("OK")) {
    responseBuilder.add("Welcome to a screen device!");
    responseBuilder.add(
        new BasicCard()
            .setTitle("You're on a screened device!")
            .setFormattedText("Screen devices support basic cards and other visual responses!"));
  } else {
    responseBuilder.add("Ok, no problem.");
  }
  responseBuilder.add("What else would you like to try?");
  responseBuilder.addSuggestions(
      new String[] {
        "Current capabilities", "Transfer surface",
      });
  return responseBuilder.build();
}
    MyActionsApp.java

    JSON

    O JSON abaixo descreve uma solicitação de webhook.

    {
  "responseId": "94b74485-cd7a-4b3b-b96a-fec15f3a496c-712767ed",
  "queryResult": {
    "queryText": "actions_intent_NEW_SURFACE",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "Webhook failed for intent: Transfer Surface - NEW_SURFACE",
    "fulfillmentMessages": [
      {
        "text": {
          "text": [
            "Webhook failed for intent: Transfer Surface - NEW_SURFACE"
          ]
        }
      }
    ],
    "outputContexts": [
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_capability_web_browser"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_capability_media_response_audio"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_capability_account_linking"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/google_assistant_input_type_voice"
      },
      {
        "name": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q/contexts/actions_intent_new_surface",
        "parameters": {
          "NEW_SURFACE": {
            "@type": "type.googleapis.com/google.actions.v2.NewSurfaceValue",
            "status": "OK"
          },
          "text": ""
        }
      }
    ],
    "intent": {
      "name": "projects/df-surface-caps-kohler/agent/intents/9db3798d-bdac-4dc8-a8e7-52349a3af0e8",
      "displayName": "Transfer Surface - NEW_SURFACE"
    },
    "intentDetectionConfidence": 1,
    "languageCode": "en"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "user": {
        "locale": "en-US",
        "userVerificationStatus": "VERIFIED"
      },
      "conversation": {
        "conversationId": "ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q",
        "type": "ACTIVE",
        "conversationToken": "[]"
      },
      "inputs": [
        {
          "intent": "actions.intent.NEW_SURFACE",
          "rawInputs": [
            {
              "inputType": "VOICE"
            }
          ],
          "arguments": [
            {
              "name": "NEW_SURFACE",
              "extension": {
                "@type": "type.googleapis.com/google.actions.v2.NewSurfaceValue",
                "status": "OK"
              }
            },
            {
              "name": "text"
            }
          ]
        }
      ],
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          },
          {
            "name": "actions.capability.ACCOUNT_LINKING"
          }
        ]
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            },
            {
              "name": "actions.capability.WEB_BROWSER"
            },
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/df-surface-caps-kohler/agent/sessions/ABwppHEfQy-JgH7nmiW5gHWiDEyvqNRSPv9zkd3qTVF7F8G8YXJFI2_yal335Co0Z-_N5oUBTmVO_DJUlQONqd5lUgZz-Q"
}

    JSON

    O JSON abaixo descreve uma solicitação de webhook.

    {
  "user": {
    "locale": "en-US",
    "userVerificationStatus": "VERIFIED"
  },
  "conversation": {
    "conversationId": "ABwppHENAOzBH5swn9iKb5QgUliTw4JLu5f86gS373tGtNvYcz1C3qHdorjcIb77o_PUleXGzIEFdPsl3-kmIAARvx67A7Ym",
    "type": "NEW"
  },
  "inputs": [
    {
      "intent": "actions.intent.NEW_SURFACE",
      "rawInputs": [
        {
          "inputType": "VOICE"
        }
      ],
      "arguments": [
        {
          "name": "NEW_SURFACE",
          "extension": {
            "@type": "type.googleapis.com/google.actions.v2.NewSurfaceValue",
            "status": "OK"
          }
        },
        {
          "name": "text"
        }
      ]
    }
  ],
  "surface": {
    "capabilities": [
      {
        "name": "actions.capability.SCREEN_OUTPUT"
      },
      {
        "name": "actions.capability.ACCOUNT_LINKING"
      },
      {
        "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
      },
      {
        "name": "actions.capability.AUDIO_OUTPUT"
      },
      {
        "name": "actions.capability.WEB_BROWSER"
      }
    ]
  },
  "availableSurfaces": [
    {
      "capabilities": [
        {
          "name": "actions.capability.WEB_BROWSER"
        },
        {
          "name": "actions.capability.AUDIO_OUTPUT"
        },
        {
          "name": "actions.capability.SCREEN_OUTPUT"
        }
      ]
    }
  ]
}