Khi gọi các phương thức Thông tin chi tiết về địa điểm (Mới), Tìm kiếm địa điểm lân cận (Mới) hoặc Tìm kiếm bằng văn bản (Mới), bạn phải chỉ định những trường mà bạn muốn được trả về trong phản hồi. Không có danh sách mặc định của các trường được trả về. Nếu bạn bỏ qua danh sách này, các phương thức sẽ trả về lỗi.
Bạn có thể xem danh sách đầy đủ các trường dữ liệu được hỗ trợ và SKU tương ứng trong phần Trường dữ liệu của địa điểm (Mới). Để biết thông tin về các trường dành riêng cho từng API, hãy xem những nội dung sau:
- Thông số FieldMask của thông tin chi tiết về địa điểm (Mới)
- Tham số FieldMask của chiến dịch Tìm kiếm lân cận (Mới)
- Thông số FieldMask của tính năng Tìm kiếm văn bản (Mới)
Bạn chỉ định danh sách trường bằng cách tạo mặt nạ trường phản hồi. Sau đó, bạn truyền mặt nạ trường phản hồi đến một trong hai phương thức bằng cách sử dụng tham số $fields hoặc fields hoặc bằng cách sử dụng tiêu đề HTTP hoặc gRPC X-Goog-FieldMask.
Việc che trường là một phương pháp thiết kế hiệu quả để đảm bảo rằng bạn không yêu cầu dữ liệu không cần thiết, giúp tránh thời gian xử lý và phí thanh toán không cần thiết.
Xác định mặt nạ trường phản hồi
Mặt nạ trường phản hồi là một danh sách đường dẫn được phân tách bằng dấu phẩy, trong đó mỗi đường dẫn chỉ định một trường duy nhất trong nội dung phản hồi. Đường dẫn bắt đầu từ thông báo phản hồi cấp cao nhất và sử dụng đường dẫn được phân tách bằng dấu chấm đến trường đã chỉ định.
Tạo đường dẫn trường như sau:
topLevelField[.secondLevelField][.thirdLevelField][...]
Bạn có thể yêu cầu tất cả các trường bằng cách sử dụng mặt nạ trường *.
Để biết thêm thông tin về cách tạo mặt nạ trường, hãy xem field_mask.proto.
Xác định mặt nạ trường cần sử dụng
Sau đây là cách xác định mặt nạ trường mà bạn muốn sử dụng:
- Yêu cầu tất cả các trường bằng cách sử dụng mặt nạ trường
*. - Xem hệ phân cấp của các trường trong phản hồi và xác định những trường bạn muốn.
- Tạo mặt nạ trường bằng hệ phân cấp trường.
Xác định mặt nạ trường phản hồi cho tính năng Tìm kiếm lân cận (Mới) và Tìm kiếm bằng văn bản (Mới)
Tìm kiếm lân cận (Mới) và Tìm kiếm bằng văn bản (Mới) trả về một mảng các đối tượng Địa điểm trong trường places của phản hồi. Đối với các API này, places là trường cấp cao nhất của phản hồi.
Ví dụ: để xem đối tượng phản hồi đầy đủ từ một Tìm kiếm văn bản (Mới):
curl -X POST -d '{
"textQuery" : "Spicy Vegetarian Food in Sydney, Australia"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: API_KEY' \
-H 'X-Goog-FieldMask: *' \
'https://places.googleapis.com/v1/places:searchText'Đối tượng phản hồi đầy đủ từ lệnh gọi Tìm kiếm văn bản (Mới) có dạng:
{ "places": [ { "name": "places/ChIJs5ydyTiuEmsR0fRSlU0C7k0", "id": "ChIJs5ydyTiuEmsR0fRSlU0C7k0", "types": [ "vegetarian_restaurant", "vegan_restaurant", "meal_takeaway", "restaurant", "food", "point_of_interest", "establishment" ], "nationalPhoneNumber": "0433 479 794", "internationalPhoneNumber": "+61 433 479 794", "formattedAddress": "29 King St, Sydney NSW 2000, Australia", "displayName": { "text": "Spiced @ Barangaroo", "languageCode": "en" }, ... }, ... ] }
Do đó, bạn chỉ định mặt nạ trường cho các API này ở dạng:
places[.secondLevelField][.thirdLevelField][...]
Nếu bạn chỉ muốn trả về các trường formattedAddress và displayName, hãy đặt mặt nạ trường thành:
places.formattedAddress,places.displayName
Việc chỉ định displayName bao gồm cả trường text và language của displayName. Nếu bạn chỉ muốn trường text, hãy đặt mặt nạ trường thành:
places.formattedAddress,places.displayName.text
Xác định mặt nạ trường phản hồi cho Chi tiết về địa điểm (Mới)
Thông tin chi tiết về địa điểm trả về một đối tượng Địa điểm duy nhất ở dạng:
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "types": [ "locality", "political" ], "formattedAddress": "Trinidad, CA 95570, USA", "displayName": { "text": "Trinidad", "languageCode": "en" } ... }
Do đó, bạn chỉ định mặt nạ trường cho API này bằng cách chỉ định các trường của đối tượng Địa điểm mà bạn muốn trả về:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: formattedAddress,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Lệnh gọi gRPC
Đối với gRPC, hãy đặt một biến chứa mặt nạ trường phản hồi. Sau đó, bạn có thể truyền biến đó đến yêu cầu.
const ( fieldMask = "places.formattedAddress,places.displayName" )
Những điều cần cân nhắc về đường dẫn trường
Chỉ đưa vào nội dung phản hồi những trường mà bạn yêu cầu. Chỉ trả về các trường mà bạn cần:
- Giảm thời gian xử lý, nhờ đó kết quả được trả về với độ trễ thấp hơn.
- Đảm bảo hiệu suất độ trễ ổn định nếu API thêm các trường phản hồi khác trong tương lai và các trường mới đó cần thêm thời gian tính toán. Nếu chọn tất cả các trường hoặc nếu chọn tất cả các trường ở cấp cao nhất, bạn có thể thấy hiệu suất giảm khi tất cả các trường mới tự động được đưa vào phản hồi.
- Kết quả là kích thước phản hồi nhỏ hơn, giúp tăng thông lượng mạng.
- Đảm bảo rằng bạn không yêu cầu dữ liệu không cần thiết, giúp tránh thời gian xử lý và các khoản phí không cần thiết.