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://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

Tham số đường dẫn

Các tham số
parent

string

Tên của tài khoản để tìm nạp vị trí. Nếu Account có giá trị AccountType CÁ tính, thì chỉ những Vị trí mà Tài khoản sở hữu trực tiếp mới được trả về, nếu không, giá trị này sẽ trả về tất cả các vị trí có thể truy cập từ Tài khoản, theo cách trực tiếp hoặc gián tiếp.

Tham số truy vấn

Các tham số
pageSize

integer

Số lượng vị trí cần tìm nạp trên mỗi trang. Giá trị mặc định là 100, tối thiểu là 1 và kích thước trang tối đa là 100.
pageToken

string

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

string

Bộ lọc ràng buộc các vị trí 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, các quy tắc ràng buộc sẽ được áp dụng và tất cả vị trí (đã 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í.
languageCode
(deprecated)

string

Mã ngôn ngữ BCP 47 để tải các thuộc tính vị trí hiển thị. Nếu không có ngôn ngữ này, các dịch vụ sẽ được cung cấp bằng ngôn ngữ của vị trí. Nếu không có lựa chọn nào, chúng sẽ được cung cấp bằng tiếng Anh.

Không dùng nữa. Sau ngày 15 tháng 8 năm 2020, trường này sẽ không áp dụng nữa. Thay vào đó, ngôn ngữ của vị trí sẽ luôn được sử dụng.
orderBy

string

Thứ tự sắp xếp cho yêu cầu. Bạn phải phân tách nhiều trường 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 phải thêm hậu tố " Tìm". Các trường hợp lệ cho orderBy là locationName và storeCode. Ví dụ: "locationName, storeCode description" hoặc "locationName" hoặc "storeCode description"

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

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:

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

Biểu diễn dưới dạng JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Các 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 sẵn một mã thông báo để tìm nạp trang vị trí tiếp theo trong lệnh gọi đến locations.list tiếp theo. Nếu không có 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ể cách phân trang.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.