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

Các tham số
parent

string

Bắt buộc. Tên của tài khoản để tìm nạp vị trí. Nếu [Account] mẹ [google.mybusiness.accountmanagement.v1.Account] thuộc [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, thì chỉ những Vị trí do Tài khoản sở hữu trực tiếp mới được trả về. Nếu không, dữ liệu này sẽ trả về tất cả vị trí có thể truy cập từ Tài khoản (dù trực tiếp hay gián tiếp).

Tham số truy vấn

Các 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. 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 đó đế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

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

string

Không bắt buộc. 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à title và storeCode. Ví dụ: "title, storeCode description" hoặc "title" hoặc "storeCode description"
readMask

string (FieldMask format)

Bắt buộc. Đọc mặt nạ để chỉ định những trường 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
}
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. 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 Tổng quan về OAuth 2.0.