Method: accounts.locations.list

列出指定账号的营业地点。

HTTP 请求

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

要从中提取营业地点的账号的名称。如果 Account 的类型为 AccountType 个人，则系统只会返回该账号直接拥有的营业地点，否则会返回该账号中的所有可访问营业地点（直接或间接）。

查询参数

参数
pageSize

integer

每页要提取的营业地点数量。默认值为 100，最小值为 1，页面大小上限为 100。
pageToken

string

如果指定，它将提取下 page 个营业地点。当营业地点数量超出了所请求的页面大小所允许的数量时，之前对 locations.list 的调用便会返回页面令牌。
filter

string

限制要返回的位置的过滤条件。响应仅包含与过滤条件匹配的条目。如果 filter 为空，则系统会应用限制条件，并为所请求的账号检索所有营业地点（已分页）。

如需详细了解有效字段和用法示例，请参阅使用位置数据指南。
languageCode
(deprecated)

string

获取显示位置属性的 BCP 47 语言代码。如果未提供这种语言，则会以相应地理位置所用的语言提供。如果这两种付款方式都无法提供，我们将以英文提供。

已弃用。2020 年 8 月 15 日之后，系统将不再应用此字段。系统会始终使用营业地点的语言。
orderBy

string

请求的排序顺序。多个字段应以英文逗号分隔，并遵循 SQL 语法。默认排序顺序为升序。要指定降序，在后面添加后缀“desc ”。orderBy 的有效字段是 locationName 和 storeCode。例如：“locationName, storeCode desc”或“locationName”或“storeCode desc”

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

Locations.ListLocations 的响应消息。

JSON 表示法 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
字段
locations[]

object (Location)

营业地点。
nextPageToken

string

如果营业地点数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 locations.list 时获取下一页营业地点。如果没有其他营业地点，此字段将不会显示在响应中。
totalSize

integer

列表中的大致地理位置数量（不考虑分页）。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

如需了解详情，请参阅 OAuth 2.0 概览。