- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
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 |
Tên của tài khoản để tìm nạp vị trí. Nếu |
Tham số truy vấn
Các tham số | |
---|---|
pageSize |
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 |
Nếu được chỉ định, phương thức này sẽ tìm nạp |
filter |
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 Để 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 |
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 |
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 ( |
Các trường | |
---|---|
locations[] |
Vị trí. |
nextPageToken |
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 |
totalSize |
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.