Method: accounts.locations.list

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要从中获取营业地点的账号的名称。

  • 特定账号 ID：如果账号类型为 AccountType.PERSONAL，则响应仅返回该账号直接拥有的营业地点。对于所有其他类型（例如 AccountType.LOCATION_GROUP），它会返回所有可访问的位置。

  • 通配符 (-)：使用 accounts/- 可标识经过身份验证的用户。此范围默认为 AccountType.PERSONAL，但同时包含直接和间接拥有的位置（例如，可通过成员群组访问的位置）。

查询参数

参数
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 Overview。