Method: accounts.locations.list

Liệt kê các vị trí cho tài khoản được chỉ định.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tên của tài khoản để tìm nạp vị trí.

  • Mã tài khoản cụ thể: Nếu tài khoản thuộc loại AccountType.PERSONAL, thì phản hồi chỉ trả về những vị trí do tài khoản đó trực tiếp sở hữu. Đối với tất cả các loại khác (ví dụ: AccountType.LOCATION_GROUP), phương thức này sẽ trả về tất cả các vị trí có thể truy cập.

  • Ký tự đại diện (-): Việc sử dụng accounts/- giúp xác định người dùng đã xác thực. Phạm vi này mặc định là AccountType.PERSONAL nhưng bao gồm cả các vị trí thuộc sở hữu trực tiếp và gián tiếp (ví dụ: những vị trí có thể truy cập thông qua các nhóm thành viên).

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Số lượng vị trí cần tìm nạp trên mỗi trang. Giá trị mặc định là 10 nếu không được đặt. Kích thước trang tối thiểu là 1 và tối đa là 100.
pageToken

string

Không bắt buộc. Nếu được chỉ định, mã này sẽ tìm nạp page vị trí tiếp theo. Mã thông báo trang được trả về bằng các lệnh gọi trước đó đến locations.list khi có nhiều vị trí hơn mức có thể chứa trong kích thước trang được yêu cầu.
filter

string

Không bắt buộc. Một bộ lọc ràng buộc các vị trí cần trả về. Phản hồi chỉ bao gồm các mục khớp với bộ lọc. Nếu filter trống, thì các quy tắc ràng buộc sẽ được áp dụng và tất cả vị trí (được phân trang) sẽ được truy xuất cho tài khoản được yêu cầu.

Để biết thêm thông tin về các trường hợp lệ và ví dụ về cách sử dụng, hãy xem Hướng dẫn làm việc với dữ liệu vị trí.
orderBy

string

Không bắt buộc. Thứ tự sắp xếp cho yêu cầu. Nhiều trường phải được phân tách bằng dấu phẩy, theo cú pháp SQL. Thứ tự sắp xếp mặc định là tăng dần. Để chỉ định thứ tự giảm dần, bạn nên thêm hậu tố " desc". Các trường hợp lệ cho orderBy là title và storeCode. Ví dụ: "title, storeCode desc" hoặc "title" hoặc "storeCode desc"
readMask

string (FieldMask format)

Bắt buộc. Mặt nạ đọc để chỉ định những trường sẽ được trả về trong phản hồi.

Đây là danh sách tên đầy đủ của các trường, được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Thông báo phản hồi cho Locations.ListLocations.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Trường
locations[]

object (Location)

Vị trí.
nextPageToken

string

Nếu số lượng vị trí vượt quá kích thước trang được yêu cầu, thì trường này sẽ được điền bằng một mã thông báo để tìm nạp trang vị trí tiếp theo trong lệnh gọi tiếp theo đến locations.list. Nếu không còn vị trí nào khác, thì trường này sẽ không xuất hiện trong phản hồi.
totalSize

integer

Số lượng Địa điểm gần đúng trong danh sách, bất kể việc phân trang. Trường này sẽ chỉ được trả về nếu filter được dùng làm tham số truy vấn.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.