注册为 Business Messages 合作伙伴后,您可以启用 对话式互动模型, 代表业务职能的实体,例如网站支持和品牌 位置。
当用户在 Google 搜索或 Google 地图上找到您管理的品牌时, 搜索结果中会显示聊天选项。用户点击 Chat 后, 可以向品牌代理发送消息这个代理可让您接收和回复 。
注册为合作伙伴
注册成为 Business Messages 合作伙伴、为品牌创建代理, 并利用为代理提供支持的 API,您可以实现消息传递 改善客户服务、销售和其他业务应用的用户体验。
- 打开 Business Communications 开发者控制台。
- 在 Business Messages 下方,点击创建合作伙伴账号。
输入合作伙伴信息的值:
字段 值 您的姓名 您的全名 合作伙伴名称 您的组织名称 合作伙伴网站 您的组织网站 区域 您要托管 Business Messages 服务的区域
查看并接受 Business Messages 服务条款。
点击创建。
您现在已注册为 Business Messages 合作伙伴,可以使用 Business Messages 和 Business Communications API。Business Messages API 向用户发送消息,而 Business Communications API 管理代理。
创建服务账号
为了安全地对 Business Messages API 和 Business Communications API 的 API 调用进行身份验证,您需要拥有服务账号密钥和 oauth2l 命令行工具。
- 在 Business Communications 开发者控制台首页,点击合作伙伴账号设置。
- 在左侧导航栏中,点击 服务账号。
点击创建密钥,然后点击创建。
您的浏览器会下载服务账号密钥。将您的服务账号密钥存储在安全、私密的位置。错误做法 公开分享您的密钥。您稍后需要使用此密钥访问 Business Message API 和 Business Communication API。
设置您的 Webook
现在,Business Messages 和 Business Communications API 已启用,您可以 必须指定您的网络钩子网址 接收消息。
- 在 Business Communications 开发者控制台中打开账号设置。
- 请确保选择了正确的合作伙伴账号。
- 在 Business Messages 网络钩子网址部分,点击配置。
- 在网络钩子端点网址部分,输入 webhook 的网址,以“https://”开头。
- 记下您的
clientToken
值。您需要使用它来验证您收到的消息是否来自 Google。 配置 webhook,以接受带有指定
POST
clientToken
参数,并发送包含纯文本的200 OK
响应secret
参数的值作为响应正文。例如,如果您的 webhook 收到具有以下正文内容的
POST
请求{ "clientToken":"SJENCPGJESMGUFPY", "secret":"0123456789" }
网络钩子应确认
clientToken
值;如果clientToken
为 正确,则返回200 OK
响应,并将0123456789
作为响应正文。在控制台中,点击验证。
Business Messages 验证您的 webhook 后,对话框将关闭。
请参阅 示例:更新网络钩子网址 了解如何使用 Business Communication API 配置您的网络钩子。
获取合作伙伴信息
要获取您当前的合作伙伴信息, Communications API 与您的合作伙伴 ID 相关联。
运行以下命令。将 PARTNER_ID 替换为您的合作伙伴 ID。
# This code gets the partner. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/get # Replace the __PARTNER_ID__ # Make sure a service account key file exists at ./service_account_key.json curl -X GET \ "https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
更新合作伙伴信息
如需更新合作伙伴信息,您可以使用 Business Communications 开发者控制台的账号设置页面或运行以下命令。
将 将 PARTNER_ID 替换为您的合作伙伴 ID(可在 Business Communications 开发者控制台中找到合作伙伴 ID),并将 将 UPDATED_FIELDS 替换为更新的字段名称。
# This code updates the partner entity. # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/partners/patch # Replace the __PARTNER_ID__, __UPDATED_FIELDS__, __FIELD_NAME__, __FIELD_VALUE__ # Make sure a service account key file exists at ./service_account_key.json curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/partners/__PARTNER_ID__?updateMask=__UPDATED_FIELDS__" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \ -d '{ "__FIELD_NAME__": "__FIELD_VALUE__" }'
如需了解格式设置和值选项,请参阅 partners.patch
。
示例:更新显示名称
curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/brands/12345/partners/67890?updateMask=displayName" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \ -d "{ 'displayName': 'XYZ Messaging', }"
示例:更新网络钩子网址
curl -X PATCH \ "https://businesscommunications.googleapis.com/v1/partners/12345?updateMask=productCapabilities" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/business-communications" \ -H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \ -d "{ 'productCapabilities': [ { 'product': 'BUSINESS_MESSAGES', 'businessMessagesCapability': { 'webhookUrl': 'https://xyz.messaging.com/webhook', }, }, ], }"
后续步骤
您现在是已注册的合作伙伴并且已启用了 API,可以开始 使用 Business Messages 进行开发。如需快速入门,请参阅 创建您的第一个代理。