列出指定帐号的营业地点。
HTTP 请求
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
要从中提取营业地点的帐号的名称。如果 |
查询参数
参数 | |
---|---|
pageSize |
每页可提取的营业地点数量。默认值为 100,最小值为 1,页面大小上限为 100。 |
pageToken |
如果已指定,则会获取下一个 |
filter |
用于限制要返回的位置的过滤条件。响应仅包含与过滤条件匹配的条目。如果 如需详细了解有效字段和用法示例,请参阅使用位置数据指南。 |
languageCode |
用于获取显示位置属性的 BCP 47 语言代码。如果未提供此语言,将以相应地理位置的语言提供。如果两种语言均不提供,则将以英语提供。 已弃用。2020 年 8 月 15 日之后,此字段将不再应用。而是始终使用营业地点的语言。 |
orderBy |
请求的排序顺序。多个字段应以英文逗号分隔,并遵循 SQL 语法。默认排序顺序是升序。若要指定降序,应添加后缀“desc”。orderBy 的有效字段包括 locationName 和 storeCode。例如:“locationName, storeCode desc”或“locationName”或“storeCode desc” |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
Locations.ListLocations 的响应消息。
JSON 表示法 | |
---|---|
{
"locations": [
{
object ( |
字段 | |
---|---|
locations[] |
营业地点。 |
nextPageToken |
如果营业地点数量超过所请求的页面大小,系统会使用令牌填充此字段,以在后续调用 |
totalSize |
列表中营业地点的大致数量(与分页无关)。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
有关详情,请参阅 OAuth 2.0 概览。