इस गाइड में बताया गया है कि अपने Chat ऐप्लिकेशन के लिए, डायलॉग कैसे लागू किए जा सकते हैं.
डायलॉग, कार्ड-आधारित इंटरफ़ेस होते हैं. इन्हें चैट ऐप्लिकेशन, लोगों से इंटरैक्ट करने के लिए खोलते हैं. कई चरणों वाली प्रक्रियाओं को पूरा करने में उपयोगकर्ताओं की मदद करने के लिए, ऐप्लिकेशन क्रम में चलने वाले डायलॉग खोल सकते हैं.
डायलॉग, उपयोगकर्ता के कई तरह के इंटरैक्शन के लिए काम के होते हैं. इनमें ये शामिल हैं:
- उपयोगकर्ताओं से जानकारी इकट्ठा करना
- वेब सेवाओं से उपयोगकर्ताओं की पुष्टि करना
- Chat ऐप्लिकेशन की सेटिंग कॉन्फ़िगर की जा रही हैं
ज़रूरी शर्तें
Node.js
- Google Workspace खाता होना चाहिए, जिससे Google Chat को ऐक्सेस किया जा सके.
- Chat ऐप्लिकेशन. Chat ऐप्लिकेशन बनाने के लिए, इस क्विकस्टार्ट का पालन करें.
- किसी स्लैश कमांड के जवाब में कोई डायलॉग खोलने पर, Chat ऐप्लिकेशन के लिए कॉन्फ़िगर किया गया स्लैश कमांड.
Apps Script
- Google Workspace खाता होना चाहिए, जिससे Google Chat को ऐक्सेस किया जा सके.
- Chat ऐप्लिकेशन. Chat ऐप्लिकेशन बनाने के लिए, इस क्विकस्टार्ट का पालन करें.
- Rhino रनटाइम का इस्तेमाल करें. V8 रनटाइम का इस्तेमाल न करें.
- किसी स्लैश कमांड के जवाब में कोई डायलॉग खोलने पर, Chat ऐप्लिकेशन के लिए कॉन्फ़िगर किया गया स्लैश कमांड.
Python
- Google Workspace खाता होना चाहिए, जिससे Google Chat को ऐक्सेस किया जा सके.
- Chat ऐप्लिकेशन. Chat ऐप्लिकेशन बनाने के लिए, इस क्विकस्टार्ट का पालन करें.
- किसी स्लैश कमांड के जवाब में कोई डायलॉग खोलने पर, Chat ऐप्लिकेशन के लिए कॉन्फ़िगर किया गया स्लैश कमांड.
डायलॉग की सुविधा कैसे काम करती है
जब कोई उपयोगकर्ता कार्ड पर मौजूद बटन पर क्लिक करता है या स्लैश कमांड भेजता है, तो Chat ऐप्लिकेशन, उपयोगकर्ता से इंटरैक्ट करने के लिए एक डायलॉग खोल सकता है.
इस डायलॉग बॉक्स की मदद से, उपयोगकर्ताओं को टेक्स्ट-इनपुट फ़ील्ड जैसे विजेट की मदद से जानकारी डालने की सुविधा दी जाती है. उपयोगकर्ताओं से बहुत सारी जानकारी इकट्ठा करते समय, चैट ऐप्लिकेशन एक क्रम में चलने वाले डायलॉग खोल सकते हैं.
काम पूरा हो जाने पर, Chat ऐप्लिकेशन को वे वैल्यू मिलेंगी जो उपयोगकर्ताओं को डायलॉग में JSON के तौर पर डाली जाएंगी. उपयोगकर्ताओं को बताएं कि मैसेज या कार्ड से जवाब देकर उनका इंटरैक्शन पूरा हुआ है.
कोई डायलॉग बॉक्स खोलना
आपका Chat ऐप्लिकेशन, किसी उपयोगकर्ता को दिखाने के लिए एक डायलॉग बॉक्स खोल सकता है:
- कार्ड पर मौजूद बटन पर क्लिक करें.
- स्लैश कमांड जारी करना.
जब कोई उपयोगकर्ता डायलॉग बॉक्स का अनुरोध करता है, तो आपके Chat ऐप्लिकेशन को इंटरैक्शन इवेंट मिलता है. इसमें:
isDialogEventtrueहै.DialogEventTypeसे पता चलता है कि कोई उपयोगकर्ता एक डायलॉग (REQUEST_DIALOG), डायलॉग (SUBMIT_DIALOG) में किसी बटन पर क्लिक कर रहा है या डायलॉग (CANCEL_DIALOG) में से किसी बटन पर क्लिक कर रहा है या नहीं.
उदाहरण के लिए, जब कोई उपयोगकर्ता कोई डायलॉग खोलता है, तो आपके Chat ऐप्लिकेशन को इस तरह का इंटरैक्शन इवेंट मिलता है:
JSON
{
"type": enum (EventType),
"eventTime": string,
"threadKey": string,
"message": {
object (Message)
},
"user": {
object (User)
},
"space": {
object (Space)
},
"action": {
object (FormAction)
},
"configCompleteRedirectUrl": string,
"isDialogEvent": true,
"dialogEventType": "REQUEST_DIALOG",
"common": {
object (CommonEventObject)
}
}
आपका Chat ऐप्लिकेशन, एक डायलॉग बॉक्स खोल सकता है. ऐसा करने के लिए, आपको "type": "DIALOG" का ActionResponse
DialogAction मिलेगा, जिसमें डायलॉग का JSON ब्यौरा शामिल होगा:
JSON
{
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "contactName"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
}
कार्ड बटन पर हुए क्लिक के जवाब में कोई डायलॉग खोलें
कार्ड बटन को डायलॉग बॉक्स खोलने के लिए, यह जानकारी दें:
onClick.action.functionउस फ़ंक्शन के नाम के तौर पर होता है जिससे डायलॉग खुलता है.OPEN_DIALOGके तौर परonClick.action.interaction. इस प्रॉपर्टी से Google Chat को पता चलता है कि Chat ऐप्लिकेशन एक डायलॉग खोलना चाहता है.
जब कोई उपयोगकर्ता किसी कार्ड पर किसी बटन पर क्लिक करता है, तो आपके Chat ऐप्लिकेशन को एक इंटरैक्शन इवेंट मिलता है. इस इवेंट में:
EventTypeCARD_CLICKEDहै.DialogEventTypeREQUEST_DIALOGहै.common.invokedFunctionयह फ़ंक्शन का नाम है, जो क्लिक किए गए कार्ड बटन कीonClickप्रॉपर्टी में मौजूद है.
डायलॉग बॉक्स खोलने के लिए, इससे जवाब दें:
"type": "DIALOG"में सेActionResponse.- A
DialogActionजिसमें डायलॉग की JSON जानकारी शामिल होती है.
इस उदाहरण में, कोई Chat ऐप्लिकेशन एक कार्ड से MESSAGE इंटरैक्शन इवेंट पर जवाब देता है, जिसमें एक बटन होता है जिससे एक डायलॉग बॉक्स खुलता है:
Node.js
/**
* Responds to messages that have links whose URLs
* match URL patterns configured for link previews.
*
* @param {Object} event The event object from Chat
* API.
*
* @return {Object} Response from the Chat app
* attached to the message with the previewed link.
*/
exports.onMessage = function onMessage(req, res) {
// Store the Google Chat event as a variable.
const event = req.body;
if (req.method === "GET" || !event.message) {
res.send("Hello! This function is meant to be used in a Google Chat " +
"Space.");
}
// Responds with a card that prompts the user to add a contact
else {
res.json({
"cardsV2": [{
"cardId": "addContact",
"card": {
"header": {
"title": "Rolodex",
"subtitle": "Manage your contacts!",
"imageUrl": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"imageType": "CIRCLE"
},
"sections": [
{
"widgets": [
{
"buttonList": {
"buttons": [
{
"text": "Add Contact",
"onClick": {
"action": {
"function": "openDialog",
"interaction": "OPEN_DIALOG"
}
}
}
]
}
}
]
}
]
}
}]
});
}
// Respond to button clicks on attached cards
if (event.type === "CARD_CLICKED") {
if (event.common.invokedFunction === "openDialog") {
openDialog(event);
};
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "name"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
});
};
}
}
Apps Script
/**
* Responds to a MESSAGE event in Google Chat with a card with a button
* that opens a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in response to a card's button click.
*/
function onMessage(event) {
return {
"cardsV2": [{
"cardId": "addContact",
"card": {
"header": {
"title": "Rolodex",
"subtitle": "Manage your contacts!",
"imageUrl": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"imageType": "CIRCLE"
},
"sections": [
{
"widgets": [
{
"buttonList": {
"buttons": [
{
"text": "Add Contact",
"onClick": {
"action": {
"function": "openDialog",
"interaction": "OPEN_DIALOG"
}
}
}
]
},
"horizontalAlignment": "CENTER"
}
]
}
]
}
}]
};
}
/**
* Responds to a CARD_CLICKED event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onCardClick(event) {
if (event.common.invokedFunction === "openDialog") {
return openDialog(event);
}
}
/**
* Opens a dialog in Google Chat.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in Google Chat.
*/
function openDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "contactName"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
};
}
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes the /createContact
slash command by opening a dialog.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if request.get('type') == 'CARD_CLICKED':
if request.get('common', dict()).get('invokedFunction') == 'open_dialog':
return open_dialog(request)
else:
return {
'cardsV2': [{
'cardId': 'addContact',
'card': {
'header': {
'title': 'Rolodex',
'subtitle': 'Manage your contacts!',
'imageUrl': 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
'imageType': 'CIRCLE'
},
'sections': [
{
'widgets': [
{
'buttonList': {
'buttons': [
{
'text': 'Add Contact',
'onClick': {
'action': {
'function': 'open_dialog',
'interaction': 'OPEN_DIALOG'
}
}
}
]
}
}
]
}
]
}
}]
}
def open_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a dialog in Google Chat.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Name',
'type': 'SINGLE_LINE',
'name': 'name'
}
},
{
'textInput': {
'label': 'Address',
'type': 'MULTIPLE_LINE',
'name': 'address'
}
},
{
'decoratedText': {
'text': 'Add to favorites',
'switchControl': {
'controlType': 'SWITCH',
'name': 'saveFavorite'
}
}
},
{
'decoratedText': {
'text': 'Merge with existing contacts',
'switchControl': {
'controlType': 'SWITCH',
'name': 'mergeContact',
'selected': True
}
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Next',
'onClick': {
'action': {
'function': 'open_sequential_dialog'
}
}
}
]
}
}
]
}
]
}
}
}
}
}
स्लैश कमांड के जवाब में कोई डायलॉग बॉक्स खोलें
जब कोई उपयोगकर्ता स्लैश कमांड वाला डायलॉग बॉक्स खोलता है, तो आपके Chat ऐप्लिकेशन को एक इंटरैक्शन इवेंट मिलता है. इसमें:
EventTypeMESSAGEहै.DialogEventTypeREQUEST_DIALOGहै.
डायलॉग बॉक्स खोलने के लिए, इससे जवाब दें:
"type": "DIALOG"में सेActionResponse.- ऐसा
DialogActionजिसमें डायलॉग की JSON जानकारी शामिल होती है.
इस उदाहरण में, Chat ऐप्लिकेशन एक डायलॉग बॉक्स खोलकर, /createContact स्लैश कमांड का जवाब देता है:
Node.js
/**
* Responds to messages that have links whose URLs
* match URL patterns configured for link previews.
*
* @param {Object} event The event object from Chat
* API.
*
* @return {Object} Response from the Chat app
* attached to the message with the previewed link.
*/
exports.onMessage = function onMessage(req, res) {
// Store the Google Chat event as a variable.
const event = req.body;
if (req.method === "GET" || !event.message) {
res.send("Hello! This function is meant to be used in a Google Chat " +
"Space.");
}
// Checks for the presence of event.message.slashCommand.
// If the slash command is "/help", responds with a text message.
// If the slash command is "/createContact", opens a dialog.
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case 1: // /help
res.json({"text": "Contact bot helps you update your address book!"});
case 2: // /createContact
openDialog(event);
}
}
};
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "name"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
});
};
Apps Script
/**
* Responds to a MESSAGE event in Google Chat that includes the /createContact
* slash command by opening a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in response to a slash command.
*/
function onMessage(event) {
// Checks for the presence of event.message.slashCommand.
// If the slash command is "/help", responds with a text message.
// If the slash command is "/createContact", opens a dialog.
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case 1: // /help
return {"text": "Contact bot helps you update your address book!"}
case 2: // /createContact
return openDialog(event);
}
}
}
/**
* Opens a dialog in Google Chat.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in Google Chat.
*/
function openDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "contactName"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
};
}
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes the /createContact
slash command by opening a dialog.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a slash command.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if slash_command := request.get('message', dict()).get('slashCommand'):
command_id = slash_command['commandId']
if command_id == 1:
return {'text': 'Contact bot helps you update your address book!'}
elif command_id == 2:
return open_dialog(request)
def open_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a dialog in Google Chat.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a slash command.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Name',
'type': 'SINGLE_LINE',
'name': 'name'
}
},
{
'textInput': {
'label': 'Address',
'type': 'MULTIPLE_LINE',
'name': 'address'
}
},
{
'decoratedText': {
'text': 'Add to favorites',
'switchControl': {
'controlType': 'SWITCH',
'name': 'saveFavorite'
}
}
},
{
'decoratedText': {
'text': 'Merge with existing contacts',
'switchControl': {
'controlType': 'SWITCH',
'name': 'mergeContact',
'selected': True
}
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Next',
'onClick': {
'action': {
'function': 'open_sequential_dialog'
}
}
}
]
}
}
]
}
]
}
}
}
}
}
क्रम में चलने वाले डायलॉग खोलना
जब उपयोगकर्ता इंटरैक्शन के लिए एक से ज़्यादा डायलॉग की ज़रूरत होती है, तो SUBMIT_DIALOG
DialogEventType के जवाब में, क्रम में अगले डायलॉग पर वापस जाकर, दूसरा डायलॉग खोला जा सकता है.
डायलॉग अपडेट करने वाले कार्ड बटन में, डायलॉग पहले से खुला हुआ है. इसलिए, ऐसा
onClick.action.interaction न करें
जिस तरह किसी बातचीत में शामिल कार्ड से डायलॉग खोलते समय किया जाता है. इसके बजाय, सिर्फ़
onClick.action.function को उस फ़ंक्शन के नाम के तौर पर दिखाएं जिससे अगला डायलॉग खुलता है.
जब लोग डायलॉग में मौजूद किसी बटन पर क्लिक करते हैं, तो आपके Chat ऐप्लिकेशन को एक इंटरैक्शन इवेंट मिलता है. इस इवेंट में:
EventTypeCARD_CLICKEDहै.DialogEventTypeSUBMIT_DIALOGहै.
खुले हुए डायलॉग का कॉन्टेंट बदलने के लिए, नए डायलॉग बॉक्स से जवाब दें.
इस उदाहरण में, कोई चैट ऐप्लिकेशन
एक डायलॉग बटन से क्लिक करने पर CARD_CLICKED इंटरैक्शन इवेंट का जवाब देता है. इसके लिए, कोई दूसरा डायलॉग बॉक्स खोला जाता है:
Node.js
// Respond to button clicks on attached cards
if (event.type === "CARD_CLICKED") {
// Open the first dialog.
if (event.common.invokedFunction === "openDialog") {
openDialog(event);
}
// Open the second dialog.
if (event.common.invokedFunction === "openSequentialDialog") {
openSequentialDialog(event);
}
}
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "name"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
});
};
/**
* Opens a second dialog that lets users add more contact details.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openSequentialDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Notes",
"type": "MULTIPLE_LINE",
"name": "notes"
}
},
{
"selectionInput": {
"type": "RADIO_BUTTON",
"label": "Contact type",
"name": "contactType",
"items": [
{
"text": "Work",
"value": "Work",
"selected": false
},
{
"text": "Personal",
"value": "Personal",
"selected": false
}
]
}
},
{
"buttonList": {
"buttons": [
{
"text": "Submit",
"onClick": {
"action": {
"function": "confirmDialogSuccess",
"parameters": [
{
"key": "confirmDialogSuccess",
"value": "confirmDialogSuccess"
}
]
}
}
}
]
},
"horizontalAlignment": "END"
}
]
}
]
}
}
}
}
});
}
Apps Script
/**
* Responds to a CARD_CLICKED event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onCardClick(event) {
// When a user clicks a card, the Chat app checks to see which function to run.
if (event.common.invokedFunction === "openDialog") {
return openDialog(event);
}
if (event.common.invokedFunction === "openSequentialDialog") {
return openSequentialDialog(event);
}
}
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "contactName"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
// Specifies which function to run
// in response to the card click.
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
};
}
/**
* Opens a second dialog that lets users add more contact details.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openSequentialDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Notes",
"type": "MULTIPLE_LINE",
"name": "notes"
}
},
{
"selectionInput": {
"type": "RADIO_BUTTON",
"label": "Contact type",
"name": "contactType",
"items": [
{
"text": "Work",
"value": "Work",
"selected": false
},
{
"text": "Personal",
"value": "Personal",
"selected": false
}
]
}
},
{
"buttonList": {
"buttons": [
{
"text": "Submit",
"onClick": {
"action": {
// Specifies which function to run
// in response to the card click.
"function": "receiveDialog",
"parameters": [
{
"key": "receiveDialog",
"value": "receiveDialog"
}
]
}
}
}
]
},
"horizontalAlignment": "END"
}
]
}
]
}
}
}
}
};
}
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes the /createContact
slash command by opening a dialog.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if request.get('type') == 'CARD_CLICKED':
if invoked_function := request.get('common', dict()).get('invokedFunction'):
if invoked_function == 'open_dialog':
return open_dialog(request)
elif invoked_function == 'open_sequential_dialog':
return open_dialog(request)
def open_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a dialog in Google Chat.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Name',
'type': 'SINGLE_LINE',
'name': 'name'
}
},
{
'textInput': {
'label': 'Address',
'type': 'MULTIPLE_LINE',
'name': 'address'
}
},
{
'decoratedText': {
'text': 'Add to favorites',
'switchControl': {
'controlType': 'SWITCH',
'name': 'saveFavorite'
}
}
},
{
'decoratedText': {
'text': 'Merge with existing contacts',
'switchControl': {
'controlType': 'SWITCH',
'name': 'mergeContact',
'selected': True
}
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Next',
'onClick': {
'action': {
'function': 'open_sequential_dialog'
}
}
}
]
}
}
]
}
]
}
}
}
}
}
def open_sequential_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a second dialog that lets users add more contact details.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Notes',
'type': 'MULTIPLE_LINE',
'name': 'notes'
}
},
{
'selectionInput': {
'type': 'RADIO_BUTTON',
'label': 'Contact type',
'name': 'contactType',
'items': [
{
'text': 'Work',
'value': 'Work',
'selected': False
},
{
'text': 'Personal',
'value': 'Personal',
'selected': False
}
]
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Submit',
'onClick': {
'action': {
'function': 'receiveDialog',
'parameters': [
{
'key': 'receiveDialog',
'value': 'receiveDialog'
}
]
}
}
}
]
},
'horizontalAlignment': 'END'
}
]
}
]
}
}
}
}
}
डायलॉग से फ़ॉर्म डेटा पाएं
जब उपयोगकर्ता किसी डायलॉग बॉक्स पर मौजूद बटन पर क्लिक करते हैं, तो उनका डाला गया डेटा Chat ऐप्लिकेशन में सबमिट हो जाता है. आपके Chat ऐप्लिकेशन को एक इंटरैक्शन इवेंट मिलता है. इसमें:
EventTypeCARD_CLICKEDहै.DialogEventTypeSUBMIT_DIALOGहै.
डायलॉग में उपयोगकर्ता जो डेटा डालते हैं वह इंटरैक्शन इवेंट पर Event.common.formInputs के तौर पर उपलब्ध होता है.
यह एक मैप होता है, जिसमें हर डायलॉग विजेट के लिए असाइन किए गए स्ट्रिंग आईडी होते हैं और हर विजेट के लिए वैल्यू
उपयोगकर्ता इनपुट दिखाती हैं. अलग-अलग ऑब्जेक्ट, अलग-अलग
इनपुट डेटा टाइप दिखाते हैं. उदाहरण के लिए,
Event.common.formInputs.stringInputs
स्ट्रिंग इनपुट दिखाता है.
जब कोई उपयोगकर्ता कोई डायलॉग सबमिट करता है, तो आपके Chat ऐप्लिकेशन को Google Chat से इस तरह का इंटरैक्शन इवेंट मिलता है:
JSON
{
"type": enum (EventType),
"eventTime": string,
"threadKey": string,
"message": {
object (Message)
},
"user": {
object (User)
},
"space": {
object (Space)
},
"action": {
object (FormAction)
},
"configCompleteRedirectUrl": string,
// Indicates that this event is dialog-related.
"isDialogEvent": true,
// Indicates that a user clicked a button, and all data
// they entered in the dialog is included in Event.common.formInputs.
"dialogEventType": "SUBMIT_DIALOG",
"common": {
"userLocale": string,
"hostApp": enum (HostApp),
"platform": enum (Platform),
"timeZone": {
object (TimeZone)
},
// Represents user data entered in a dialog.
"formInputs": {
// Represents user data entered for a specific field in a dialog.
"NAME": {
// Represents string data entered in a dialog, like text input fields
// and check boxes.
"stringInputs": {
// An array of strings entered by the user in a dialog.
"value": [
string
]
}
}
},
"parameters": {
string: string,
...
},
"invokedFunction": string
}
}
आपका Chat ऐप्लिकेशन, उपयोगकर्ता की डाली गई पहली वैल्यू को event.common.formInputs.NAME.stringInputs.value[0] पर ऐक्सेस कर सकता है. यहां NAME, TextInput विजेट का name फ़ील्ड है.
डायलॉग फ़ॉर्म का डेटा मिलने के बाद, Chat ऐप्लिकेशन को रसीद स्वीकार करके, मैसेज या कार्ड से जवाब देकर या गड़बड़ी का मैसेज देकर जवाब देना चाहिए. ये सभी काम ActionResponse के जवाब के तौर पर किए जाते हैं:
- रसीद स्वीकार करने के लिए,
ActionResponseका इस्तेमाल करके जवाब दें जिसमें"actionStatus": "OK"है. इससे, जवाब पोस्ट किए बिना डायलॉग बंद हो जाता है. - मैसेज या कार्ड से जवाब देने के लिए,
ActionResponseका इस्तेमाल करें, जिसमेंNEW_MESSAGE,UPDATE_MESSAGEयाUPDATE_USER_MESSAGE_CARDSकाResponseTypeहो. ज़्यादा जानकारी के लिए, डायलॉग का जवाब दें देखें. - गड़बड़ी का मैसेज देने के लिए,
ActionResponseका इस्तेमाल करके जवाब दें, जिसमें"actionStatus": "ERROR MESSAGE"हो.
इस उदाहरण में, "name" वैल्यू की मौजूदगी की जांच की गई है. कोई गड़बड़ी होने पर, Chat ऐप्लिकेशन गड़बड़ी का मैसेज दिखाता है. अगर डेटा मौजूद है, तो Chat ऐप्लिकेशन, फ़ॉर्म का डेटा मिल जाने पर यह स्वीकार करता है. साथ ही, डायलॉग बॉक्स को बंद कर देता है.
Node.js
/**
* Checks for a form input error, the absence of
* a "name" value, and returns an error if absent.
* Otherwise, confirms successful receipt of a dialog.
*
* Confirms successful receipt of a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {Object} open a Dialog in Google Chat.
*/
function receiveDialog(event) {
// Checks to make sure the user entered a name
// in a dialog. If no name value detected, returns
// an error message. Any "actionStatus" value other than "OK"
// gets returned as an error.
if (event.common.formInputs.WIDGET_NAME.stringInputs.value[0] === "") {
res.json({
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "Don't forget to name your new contact!"
}
}
});
// Otherwise the Chat app indicates that it received
// form data from the dialog. An "actionStatus" of "OK" is
// interpreted as code 200, and the dialog closes.
} else {
res.json({
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "OK"
}
}
});
}
}
Apps Script
/**
* Checks for a form input error, the absence of
* a "name" value, and returns an error if absent.
* Otherwise, confirms successful receipt of a dialog.
*
* Confirms successful receipt of a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in Google Chat.
*/
function receiveDialog(event) {
// Checks to make sure the user entered a name
// in a dialog. If no name value detected, returns
// an error message. Any "actionStatus" value other than "OK"
// gets returned as an error.
if (event.common.formInputs.WIDGET_NAME [""].stringInputs.value[0] === "") {
return {
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "Don't forget to name your new contact!"
}
}
};
// Otherwise the Chat app indicates that it received
// form data from the dialog. An "actionStatus" of "OK" is
// interpreted as code 200, and the dialog closes.
} else {
return {
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "OK"
}
}
};
}
}
Python
def receive_dialog(event: Mapping[str, Any]) -> Mapping[str, Any]:
"""Checks for a form input error, the absence of a "name" value, and returns
an error if absent. Otherwise, confirms successful receipt of a dialog.
Args:
event (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: the response.
"""
if common := event.get('common'):
if form_inputs := common.get('formInputs'):
if contact_name := form_inputs.get('WIDGET_NAME'):
if string_inputs := contact_name.get('stringInputs'):
if name := string_inputs.get('value')[0]:
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': 'OK'
}
}
}
else:
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': 'Don\'t forget to name your new contact!'
}
}
}
किसी डायलॉग का जवाब देना
आपके पास डायलॉग का जवाब देने के लिए, नए मैसेज का या किसी मौजूदा मैसेज को अपडेट करने का विकल्प होता है.
नए मैसेज वाले डायलॉग का जवाब दें
डायलॉग फ़ॉर्म सबमिट करने पर नए मैसेज का जवाब देने के लिए, Chat ऐप्लिकेशन ActionResponse वाला NEW_MESSAGE टाइप दिखाता है. साथ ही, इसमें मार्कअप भी दिखता है, जिसमें नए मैसेज के कॉन्टेंट की जानकारी होती है. यह जवाब मिलने पर, डायलॉग बंद हो जाता है और नया मैसेज पोस्ट कर दिया जाता है.
यह कोड, एक डायलॉग के JSON रिस्पॉन्स का उदाहरण है. Chat ऐप्लिकेशन से नया मैसेज बनाने के लिए, इस कोड को भेजा जाता है:
JSON
{
"actionResponse": "NEW_MESSAGE",
"text": "This message is a reply to a dialog form submission.",
"cardsV2": [
{
"cardId" : "reply-card-id",
"card" : {
"header": {
"title": "Reply card title"
},
"sections": [
{
"widgets" : [
{
"textParagraph": {
"text": "Reply card message"
}
}
]
}
]
}
}
]
}
Chat ऐप्लिकेशन, आसान मैसेज या कार्ड का इस्तेमाल करके, एसिंक्रोनस तरीके से भी जवाब दे सकता है. ऐसा करने के लिए, किसी सेवा खाते से पुष्टि करें. इसके बाद, Google Chat API का इस्तेमाल करके, spaces.messages.create को कॉल करके एसिंक्रोनस जवाब भेजें.
मैसेज के अपडेट वाले डायलॉग का जवाब दें
जब अपडेट किए गए मैसेज वाले डायलॉग का जवाब दिया जाता है, तो मौजूदा ऐप्लिकेशन मैसेज को अपडेट किया जा सकता है. इसके अलावा, लिंक की झलक को अपडेट किया जा सकता है.
ऐप्लिकेशन के मैसेज
Chat ऐप्लिकेशन के भेजे गए मौजूदा मैसेज के अपडेट के साथ डायलॉग फ़ॉर्म सबमिट करने पर जवाब देने के लिए, यह ActionResponse का UPDATE_MESSAGE टाइप दिखाता है.
जवाब में
मार्कअप
शामिल होता है, जो अपडेट किए गए मैसेज का कॉन्टेंट दिखाता है. यह जवाब मिलने पर, डायलॉग बंद हो जाता है और मैसेज में नया कॉन्टेंट अपडेट हो जाता है.
यह कोड, एक डायलॉग के JSON रिस्पॉन्स का उदाहरण है. Chat ऐप्लिकेशन, ऐप्लिकेशन के मौजूदा मैसेज को अपडेट करने के लिए, इस कोड को भेजता है:
JSON
{
"actionResponse": "UPDATE_MESSAGE",
"text": "This message has been updated with new content in response to a dialog form submission.",
"cardsV2": [
{
"cardId" : "updated-card-id",
"card" : {
"header": {
"title": "Updated card title"
},
"sections": [
{
"widgets" : [
{
"textParagraph": {
"text": "Updated card message"
}
}
]
}
]
}
}
]
}
Chat ऐप्लिकेशन, Google Chat API का इस्तेमाल करके, एसिंक्रोनस तरीके से ऐप्लिकेशन मैसेज को अपडेट भी कर सकता है.
लिंक की झलक देखने की सुविधा
डायलॉग फ़ॉर्म सबमिशन के जवाब में नए कॉन्टेंट के साथ लिंक की झलक
को अपडेट करने के लिए, Chat ऐप्लिकेशन
UPDATE_USER_MESSAGE_CARDS का
ActionResponse
दिखाता है. जवाब में उन नए कार्ड के
मार्कअप शामिल होते हैं जिनसे लिंक की झलक अपडेट की गई हैं. यह जवाब मिलने पर, डायलॉग बंद हो जाता है और लिंक की झलक नए कार्ड से अपडेट हो जाती हैं.
यह कोड, Chat ऐप्लिकेशन से भेजे गए डायलॉग के JSON रिस्पॉन्स का उदाहरण है. इसका इस्तेमाल, लिंक की झलक को नए कार्ड से अपडेट करने के लिए किया जाता है:
JSON
{
"actionResponse": "UPDATE_USER_MESSAGE_CARDS",
"cardsV2": [
{
"cardId" : "updated-card-id",
"card" : {
"header": {
"title": "Updated card title"
},
"sections": [
{
"widgets" : [
{
"textParagraph": {
"text": "Updated card message"
}
}
]
}
]
}
}
]
}
उदाहरण के लिए: Chat ऐप्लिकेशन को मैनेज करने वाले संपर्क को Rolodex
इस उदाहरण में, Chat ऐप्लिकेशन एक डायलॉग खोलता है, ताकि उपयोगकर्ता किसी संपर्क के बारे में जानकारी जोड़ सके. जैसे: नाम, ईमेल, और पता:
Node.js
/**
* Responds to messages that have links whose URLs
* match URL patterns configured for link previews.
*
* @param {Object} event The event object from Chat
* API.
*
* @return {Object} Response from the Chat app
* attached to the message with the previewed link.
*/
exports.onMessage = function onMessage(req, res) {
// Store the Google Chat event as a variable.
const event = req.body;
if (req.method === "GET" || !event.message) {
res.send("Hello! This function is meant to be used in a Google Chat " +
"Space.");
}
// Checks for the presence of event.message.slashCommand.
// If the slash command is "/help", responds with a text message.
// If the slash command is "/createContact", opens a dialog.
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case 1: // /help
res.json({"text": "Contact bot helps you update your address book!"});
case 2: // /createContact
openDialog(event);
}
}
// If the Chat app doesn"t detect a slash command, it responds
// with a card that prompts the user to add a contact
else {
res.json({
"cardsV2": [{
"cardId": "addContact",
"card": {
"header": {
"title": "Rolodex",
"subtitle": "Manage your contacts!",
"imageUrl": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"imageType": "CIRCLE"
},
"sections": [
{
"widgets": [
{
"buttonList": {
"buttons": [
{
"text": "Add Contact",
"onClick": {
"action": {
"function": "openDialog",
"interaction": "OPEN_DIALOG"
}
}
}
]
}
}
]
}
]
}
}]
});
}
// Respond to button clicks on attached cards
if (event.type === "CARD_CLICKED") {
if (event.common.invokedFunction === "openDialog") {
openDialog(event);
}
if (event.common.invokedFunction === "openSequentialDialog") {
openSequentialDialog(event);
}
if (event.common.invokedFunction === "confirmDialogSuccess") {
confirmDialogSuccess(event);
}
}
};
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "name"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
});
};
/**
* Opens a second dialog that lets users add more contact details.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openSequentialDialog(event) {
res.json({
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Notes",
"type": "MULTIPLE_LINE",
"name": "notes"
}
},
{
"selectionInput": {
"type": "RADIO_BUTTON",
"label": "Contact type",
"name": "contactType",
"items": [
{
"text": "Work",
"value": "Work",
"selected": false
},
{
"text": "Personal",
"value": "Personal",
"selected": false
}
]
}
},
{
"buttonList": {
"buttons": [
{
"text": "Submit",
"onClick": {
"action": {
"function": "confirmDialogSuccess",
"parameters": [
{
"key": "confirmDialogSuccess",
"value": "confirmDialogSuccess"
}
]
}
}
}
]
},
"horizontalAlignment": "END"
}
]
}
]
}
}
}
}
});
}
/**
* Checks for a form input error, the absence of
* a "name" value, and returns an error if absent.
* Otherwise, confirms successful receipt of a dialog.
*
* Confirms successful receipt of a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in Google Chat.
*/
function receiveDialog(event) {
// Checks to make sure the user entered a name
// in a dialog. If no name value detected, returns
// an error message. Any "actionStatus" value other than "OK"
// gets returned as an error.
if (event.common.formInputs.contactName.stringInputs.value[0] === "") {
res.json({
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "Don't forget to name your new contact!"
}
}
});
// Otherwise the Chat app indicates that it received
// form data from the dialog. An "actionStatus" of "OK" is
// interpreted as code 200, and the dialog closes.
} else {
res.json({
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "OK"
}
}
});
}
}
Apps Script
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes the /createContact
slash command by opening a dialog.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if request.get('type') == 'CARD_CLICKED':
invoked_function = request.get('common', dict()).get('invokedFunction')
if invoked_function == 'open_dialog':
return open_dialog(request)
elif invoked_function == 'open_sequential_dialog':
return open_dialog(request)
elif invoked_function == "receive_dialog":
return receive_dialog(request)
else:
return {
'cardsV2': [{
'cardId': 'addContact',
'card': {
'header': {
'title': 'Rolodex',
'subtitle': 'Manage your contacts!',
'imageUrl': 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
'imageType': 'CIRCLE'
},
'sections': [
{
'widgets': [
{
'buttonList': {
'buttons': [
{
'text': 'Add Contact',
'onClick': {
'action': {
'function': 'open_dialog',
'interaction': 'OPEN_DIALOG'
}
}
}
]
}
}
]
}
]
}
}]
}
def open_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a dialog in Google Chat.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Name',
'type': 'SINGLE_LINE',
'name': 'name'
}
},
{
'textInput': {
'label': 'Address',
'type': 'MULTIPLE_LINE',
'name': 'address'
}
},
{
'decoratedText': {
'text': 'Add to favorites',
'switchControl': {
'controlType': 'SWITCH',
'name': 'saveFavorite'
}
}
},
{
'decoratedText': {
'text': 'Merge with existing contacts',
'switchControl': {
'controlType': 'SWITCH',
'name': 'mergeContact',
'selected': True
}
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Next',
'onClick': {
'action': {
'function': 'open_sequential_dialog'
}
}
}
]
}
}
]
}
]
}
}
}
}
}
def open_sequential_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a second dialog that lets users add more contact details.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Notes',
'type': 'MULTIPLE_LINE',
'name': 'notes'
}
},
{
'selectionInput': {
'type': 'RADIO_BUTTON',
'label': 'Contact type',
'name': 'contactType',
'items': [
{
'text': 'Work',
'value': 'Work',
'selected': False
},
{
'text': 'Personal',
'value': 'Personal',
'selected': False
}
]
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Submit',
'onClick': {
'action': {
'function': 'receive_dialog',
'parameters': [
{
'key': 'receiveDialog',
'value': 'receiveDialog'
}
]
}
}
}
]
},
'horizontalAlignment': 'END'
}
]
}
]
}
}
}
}
}
def receive_dialog(event: Mapping[str, Any]) -> Mapping[str, Any]:
"""Checks for a form input error, the absence of a "name" value, and returns
an error if absent. Otherwise, confirms successful receipt of a dialog.
Args:
event (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: the response.
"""
if event.get('common', dict()) \
.get('formInputs', dict()).get('contactName', dict()) \
.get('stringInputs').get('value', list()):
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': 'OK'
}
}
}
else:
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': "Don't forget to name your new contact!"
}
}
}
सीमाएं और ध्यान
इन डायलॉग की सीमाओं और बातों का ध्यान रखें:
- कार्ड v1, जो अब काम नहीं करते हैं, डायलॉग के साथ काम नहीं करते. इसके बजाय कार्ड v2 का इस्तेमाल करें.
onChangeAction-SwitchControlजैसे कुछ कार्ड विजेट की प्रॉपर्टी, जो विजेट बदलने के लिएActionके बारे में बताती है. जैसे, स्विच बदलना.- किसी डायलॉग को खोलने, सबमिट करने या रद्द करने के लिए, Chat ऐप्लिकेशन से
DialogEventTypeवाले डायलॉग के साथ ही एक साथ जवाब देने की ज़रूरत होती है. इसी वजह से, एसिंक्रोनस आर्किटेक्चर से बने Chat ऐप्लिकेशन में डायलॉग काम नहीं करते. जैसे, Cloud Pub/Sub या Create Message API वाला तरीका. अगर आपका ऐप्लिकेशन एसिंक्रोनस आर्किटेक्चर का इस्तेमाल करता है, तो डायलॉग के बजाय कार्ड मैसेज का इस्तेमाल करें.
समस्या हल करें
जब Google Chat ऐप्लिकेशन या कार्ड पर कोई गड़बड़ी दिखती है, तो Chat के इंटरफ़ेस पर "कोई गड़बड़ी हुई" या "आपके अनुरोध पर कार्रवाई नहीं की जा सकी" मैसेज दिखता है. कभी-कभी Chat के यूज़र इंटरफ़ेस (यूआई) में गड़बड़ी का कोई मैसेज नहीं दिखता. हालांकि, Chat ऐप्लिकेशन या कार्ड से कोई अनचाहा नतीजा मिलता है. उदाहरण के लिए, हो सकता है कि आपको कार्ड का कोई मैसेज न दिखे.
हालांकि, हो सकता है कि Chat के यूज़र इंटरफ़ेस (यूआई) में गड़बड़ी का कोई मैसेज न दिखे, लेकिन गड़बड़ी के मैसेज लॉग करने की सुविधा चालू होने पर, आपको गड़बड़ियों को ठीक करने में मदद मिलेगी. गड़बड़ियों को देखने, डीबग करने, और ठीक करने में मदद पाने के लिए, Google Chat की गड़बड़ियों को ठीक करना और उन्हें हल करना लेख पढ़ें.