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://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 tài khoản dùng để tìm nạp vị trí. Nếu [Tài khoản] chính [google.tối.accountmanagement.v1.Account] thuộc [AccountType] [google. lưới. sao chép

Tham số truy vấn

Tham 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à kích thước trang tối đa là 100.
pageToken

string

Không bắt buộc. 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

Không bắt buộc. 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í.
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, hậu tố " mô tả" cần được thêm vào. Các trường hợp lệ đối với orderBy là tiêu đề và storeCode. Ví dụ: "tiêu đề, nội dung mô tả storeCode" hoặc "title" [tiêu đề] hoặc "nội dung mô tả "storeCode"
readMask

string (FieldMask format)

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

Đây là danh sách các tên trường đủ điều kiện đượ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 Location.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, 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. Trường này sẽ chỉ được trả về nếu dùng filter 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 bài viết Tổng quan về OAuth 2.0.