Method: accounts.locations.list

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

HTTP 请求

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要从中提取营业地点的帐号的名称。如果父级 [帐号] [google.mybusiness.accountmanagement.v1.Account] 的类型为 [帐号类型] [google.mybusiness.accountmanagement.v1.Account.AccountType]，系统只会返回该帐号直接拥有的营业地点，否则将返回帐号中的所有可访问的营业地点（无论直接还是间接）。

查询参数

参数
pageSize

integer

可选。每页可提取的营业地点数量。如果未设置，默认值为 10。最小值为 1，页面大小上限为 100。
pageToken

string

可选。如果已指定，则会获取下一个 page 营业地点。当位置数量超出所请求的页面大小可容纳的数量时，之前对 locations.list 的调用会返回页面令牌。
filter

string

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

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

string

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

string (FieldMask format)

必需。读取掩码以指定将在响应中返回的字段。

这是以逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。

请求正文

请求正文必须为空。

响应正文

Locations.ListLocations 的响应消息。

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

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

object (Location)

营业地点。
nextPageToken

string

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

integer

列表中营业地点的大致数量（与分页无关）。只有在将 filter 用作查询参数时，才会返回此字段。

授权范围

需要以下 OAuth 作用域：

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

有关详情，请参阅 OAuth 2.0 概览。