Method: accounts.locations.list

Liệt kê các vị trí cho tài khoản đã 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

Tham số
parent

string

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

Tham số truy vấn

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 đó trả về cho locations.list khi có nhiều vị trí hơn số lượng vị trí có thể phù hợp với kích thước trang được yêu cầu.
filter

string

Bộ lọc ràng buộ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 điều kiện ràng buộc sẽ được áp dụng và tất cả cá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 về cách xử lý dữ liệu vị trí.
languageCode
(deprecated)

string

Mã ngôn ngữ BCP 47 để nhận thuộc tính vị trí hiển thị. Nếu ngôn ngữ này không có sẵn, chúng sẽ được cung cấp bằng ngôn ngữ của vị trí. Nếu cả hai tài khoản này đều không có sẵn, 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 còn á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. 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, hậu tố " mô tả" cần được thêm vào. Các trường hợp lệ đối với orderBy là locationName và storeCode. Ví dụ: "locationName, storeCode mô tả" hoặc "locationName" hoặc "nội dung mô tả "storeCode"

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
}
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, 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 tiếp theo tới locations.list. Nếu không có vị trí nào khác, trường này sẽ không xuất hiện trong câu trả lời.
totalSize

integer

Số lượng Vị trí gần đúng trong danh sách, bất kể việc phân trang.

Phạm vi cấp phép

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 bài viết Tổng quan về OAuth 2.0.