Business Profile Performance API 现已发布!必须执行迁移工作。
查看弃用时间表以及相关说明,了解如何从旧版 v4 API 迁移到新的 v1 API。
请填写此调查问卷,帮助我们更好地了解您支持哪些商家的地点、菜单和菜品属性,从而帮助我们改善食品菜单体验

Google My Business API

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

Google My Business API 提供了一个用于在 Google 上管理营业地点信息的接口。

服务:mybusiness.googleapis.com

如需调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,请在发出 API 请求时使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://mybusiness.googleapis.com

REST 资源:v4.accounts

方法
create
(deprecated)
POST /v4/accounts
在指定父级下创建具有指定名称和类型的帐号。
deleteNotifications
(deprecated)
DELETE /v4/{name=accounts/*/notifications}
清除帐号的 PubSub 通知设置。
generateAccountNumber
(deprecated)
POST /v4/{name=accounts/*}:generateAccountNumber
为此帐号生成帐号。
get
(deprecated)
GET /v4/{name=accounts/*}
获取指定的帐号。
getNotifications
(deprecated)
GET /v4/{name=accounts/*/notifications}
返回帐号的 PubSub 通知设置。
list
(deprecated)
GET /v4/accounts
列出经过身份验证的用户的所有帐号。
listRecommendGoogleLocations GET /v4/{name=accounts/*}:recommendGoogleLocations
列出已推荐到指定商家资料帐号的所有 GoogleLocation
update
(deprecated)
PUT /v4/{name=accounts/*}
更新指定的商家帐号。
updateNotifications
(deprecated)
PUT /v4/{name=accounts/*/notifications}

为帐号指定 Pub 通知设置,以告知商家资料要为哪个主题发送 Pub 通知:

  • 由该帐号管理的营业地点的新评价。

REST 资源:v4.accounts.admins

方法
create
(deprecated)
POST /v4/{parent=accounts/*}/admins
邀请指定用户担任指定帐号的管理员。
delete
(deprecated)
DELETE /v4/{name=accounts/*/admins/*}
从指定帐号中移除指定管理员。
list
(deprecated)
GET /v4/{parent=accounts/*}/admins
列出指定帐号的管理员。
patch
(deprecated)
PATCH /v4/{name=accounts/*/admins/*}
更新指定帐号管理员的管理员。

REST 资源:v4.accounts.invitations

方法
accept
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:accept
接受指定的邀请。
decline
(deprecated)
POST /v4/{name=accounts/*/invitations/*}:decline
拒绝指定的邀请。
list
(deprecated)
GET /v4/{parent=accounts/*}/invitations
列出指定帐号的待处理邀请。

REST 资源:v4.accounts.locations

方法
associate POST /v4/{name=accounts/*/locations/*}:associate
将营业地点与地点 ID 相关联。
batchGet POST /v4/{name=accounts/*}/locations:batchGet
获取指定帐号中的所有指定营业地点。
batchGetReviews POST /v4/{name=accounts/*}/locations:batchGetReviews
返回所有指定营业地点的分页评价列表。
clearAssociation POST /v4/{name=accounts/*/locations/*}:clearAssociation
清除营业地点与其地点 ID 之间的关联。
create POST /v4/{parent=accounts/*}/locations
创建归指定帐号所有的新 location,并将其返回。
delete DELETE /v4/{name=accounts/*/locations/*}
删除营业地点。
fetchVerificationOptions POST /v4/{name=accounts/*/locations/*}:fetchVerificationOptions
报告采用某种语言的所有营业地点符合条件的验证选项。
findMatches POST /v4/{name=accounts/*/locations/*}:findMatches
查找与指定位置匹配的所有可能位置。
get GET /v4/{name=accounts/*/locations/*}
获取指定的位置。
getFoodMenus GET /v4/{name=accounts/*/locations/*/foodMenus}
返回特定营业地点的美食菜单。
getGoogleUpdated GET /v4/{name=accounts/*/locations/*}:googleUpdated
获取指定位置的 Google 更新版本。
getHealthProviderAttributes GET /v4/{name=accounts/*/locations/*/healthProviderAttributes}
返回特定位置的 Health Provider 属性。
getServiceList GET /v4/{name=accounts/*/locations/*/serviceList}
获取营业地点的指定服务列表。
list GET /v4/{parent=accounts/*}/locations
列出指定帐号的营业地点。
patch PATCH /v4/{name=accounts/*/locations/*}
更新指定位置。
reportInsights POST /v4/{name=accounts/*}/locations:reportInsights
返回一个报告,其中包含按地理位置划分的一个或多个指标的数据分析。
transfer
(deprecated)
POST /v4/{name=accounts/*/locations/*}:transfer
将营业地点从该用户拥有的帐号中移到同一用户管理的另一个帐号中。
updateFoodMenus PATCH /v4/{foodMenus.name=accounts/*/locations/*/foodMenus}
更新特定营业地点的美食菜单。
updateHealthProviderAttributes PATCH /v4/{healthProviderAttributes.name=accounts/*/locations/*/healthProviderAttributes}
更新特定营业地点的医疗服务提供方属性。
updateServiceList PATCH /v4/{serviceList.name=accounts/*/locations/*/serviceList}
更新营业地点的指定服务列表。
verify POST /v4/{name=accounts/*/locations/*}:verify
开始对营业地点执行验证流程。

REST 资源:v4.accounts.locations.admins

方法
create
(deprecated)
POST /v4/{parent=accounts/*/locations/*}/admins
邀请指定用户担任指定营业地点的管理员。
delete
(deprecated)
DELETE /v4/{name=accounts/*/locations/*/admins/*}
移除担任指定营业地点管理员的指定管理员。
list
(deprecated)
GET /v4/{parent=accounts/*/locations/*}/admins
列出指定位置的所有管理员。
patch
(deprecated)
PATCH /v4/{name=accounts/*/locations/*/admins/*}
更新指定营业地点管理员的管理员。

REST 资源:v4.accounts.locations.Followers

方法
getMetadata GET /v4/{name=accounts/*/locations/*/followers/metadata}
获取某个地点的关注者设置。

REST 资源:v4.accounts.locations.insuranceNetworks

方法
list GET /v4/{parent=accounts/*/locations/*}/insuranceNetworks
返回 Google 支持的所有保险网络的列表。

REST 资源:v4.accounts.locations.localPosts

方法
create POST /v4/{parent=accounts/*/locations/*}/localPosts
创建与指定营业地点相关联的新本地帖子,并将其返回。
delete DELETE /v4/{name=accounts/*/locations/*/localPosts/*}
删除本地帖子。
get GET /v4/{name=accounts/*/locations/*/localPosts/*}
获取指定的本地帖子。
list GET /v4/{parent=accounts/*/locations/*}/localPosts
返回与某个营业地点相关联的本地帖子列表。
patch PATCH /v4/{name=accounts/*/locations/*/localPosts/*}
更新指定的本地帖子并返回更新后的本地帖子。
reportInsights POST /v4/{name=accounts/*/locations/*}/localPosts:reportInsights
返回与单条商家信息相关的一组本地帖子的数据分析。

REST 资源:v4.accounts.locations.media

方法
create POST /v4/{parent=accounts/*/locations/*}/media
为营业地点创建新的媒体项。
delete DELETE /v4/{name=accounts/*/locations/*/media/*}
删除指定的媒体项。
get GET /v4/{name=accounts/*/locations/*/media/*}
返回所请求媒体项的元数据。
list GET /v4/{parent=accounts/*/locations/*}/media
返回与某个营业地点关联的媒体项列表。
patch PATCH /v4/{name=accounts/*/locations/*/media/*}
更新指定媒体项的元数据。
startUpload POST /v4/{parent=accounts/*/locations/*}/media:startUpload
为上传媒体内容生成 MediaItemDataRef

REST 资源:v4.accounts.locations.media.customers

方法
get GET /v4/{name=accounts/*/locations/*/media/customers/*}
返回请求的客户媒体项的元数据。
list GET /v4/{parent=accounts/*/locations/*}/media/customers
返回与客户贡献的某个营业地点相关联的媒体项列表。

REST 资源:v4.accounts.locations.questions

方法
create POST /v4/{parent=accounts/*/locations/*}/questions
为指定位置添加问题。
delete DELETE /v4/{name=accounts/*/locations/*/questions/*}
删除当前用户撰写的特定问题。
list GET /v4/{parent=accounts/*/locations/*}/questions
返回指定营业地点的分页问题列表及其部分回答。
patch PATCH /v4/{name=accounts/*/locations/*/questions/*}
更新当前用户撰写的特定问题。

REST 资源:v4.accounts.locations.questions.answers

方法
delete DELETE /v4/{parent=accounts/*/locations/*/questions/*}/answers:delete
删除当前用户为某个问题撰写的答案。
list GET /v4/{parent=accounts/*/locations/*/questions/*}/answers
返回指定问题的分页答案列表。
upsert POST /v4/{parent=accounts/*/locations/*/questions/*}/answers:upsert
为用户指定的问题创建答案或更新现有答案。

REST 资源:v4.accounts.locations.reviews

方法
deleteReply DELETE /v4/{name=accounts/*/locations/*/reviews/*}/reply
删除对指定评价的回复。
get GET /v4/{name=accounts/*/locations/*/reviews/*}
返回指定的评价。
list GET /v4/{parent=accounts/*/locations/*}/reviews
返回指定营业地点的分页评价列表。
updateReply PUT /v4/{name=accounts/*/locations/*/reviews/*}/reply
更新指定评价的回复。

REST 资源:v4.accounts.locations.verifications

方法
complete POST /v4/{name=accounts/*/locations/*/verifications/*}:complete
完成 PENDING 验证。
list GET /v4/{parent=accounts/*/locations/*}/verifications
列出营业地点的验证信息,按创建时间排序。

REST 资源:v4.attributes

方法
list GET /v4/attributes
返回适用于具有指定主要类别和国家/地区的营业地点的可用属性列表。

REST 资源:v4.categories

方法
batchGet GET /v4/categories:batchGet
返回指定语言和 G 概念 ID 的业务类别列表。
list GET /v4/categories
返回业务类别列表。

REST 资源:v4.chains

方法
get GET /v4/{name=chains/*}
获取指定的链。
search GET /v4/chains:search
根据连锁店名称搜索连锁店。

REST 资源:v4.googleLocations

方法
report POST /v4/{name=googleLocations/*}:report
报告 GoogleLocation
search POST /v4/googleLocations:search
搜索与指定请求匹配的所有可能的位置。

服务:mybusiness.googleapis.com

如需调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务,请在发出 API 请求时使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://mybusiness.googleapis.com

REST 资源:v1.media

方法
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
上传媒体内容。