Place Details（新版）、Nearby Search（新版）、Text Search（新版） メソッドを呼び出す場合は、レスポンスで返すフィールドを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。
レスポンス フィールド マスクを作成して、フィールド リストを指定します。次に、パラメータ $fields または fields を使用するか、HTTP または gRPC ヘッダー X-Goog-FieldMask を使用して、レスポンス フィールド マスクをいずれかのメソッドに渡します。
フィールド マスキングは、不要なデータをリクエストしないようにするための優れた設計手法です。これにより、不要な処理時間と課金が発生するのを防ぐことができます。
レスポンス フィールド マスクを定義する
レスポンス フィールド マスクは、パスのカンマ区切りのリストです。各パスは、 レスポンス メッセージの一意のフィールドを指定します。パスは、 トップレベル レスポンス メッセージを受け取り、指定されたフィールドへのドット区切りパスを使用します。
フィールドパスを次のように作成します。
topLevelField[.secondLevelField][.thirdLevelField][...]
フィールドマスク * を使用すると、すべてのフィールドをリクエストできます。
フィールド マスクの作成方法については、 field_mask.proto.
使用するフィールド マスクを決定する
使用するフィールド マスクを決定する方法は次のとおりです。
- フィールド マスク「*」を使用してすべてのフィールドをリクエストします。
- レスポンスのフィールドの階層を確認し、必要なフィールドを特定します。
- フィールド階層を使用してフィールド マスクを作成します。
Nearby Search（新版）とテキスト検索（新版）のレスポンス フィールド マスクを定義する
Nearby Search（新版）とテキスト検索（新版）は、レスポンスの places フィールドに Place オブジェクトの配列を返します。これらの API の場合、places は最上位レベルです。
フィールドで確認できます。
たとえば、テキスト検索（新版）からの完全なレスポンス オブジェクトを表示するには:
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'テキスト検索（新版）からの完全なレスポンス オブジェクト 呼び出しの形式は次のとおりです。
{ "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" }, ... }, ... ] }
したがって、これらの API のフィールド マスクは次の形式で指定します。
places[.secondLevelField][.thirdLevelField][...]
formattedAddress フィールドと displayName フィールドのみを返す場合は、次のように設定します。
フィールド マスクを使用して以下を行います。
places.formattedAddress,places.displayName
displayName を指定すると、次の text フィールドと language フィールドの両方が含まれます。
displayName。text フィールドのみが必要な場合は、フィールド マスクを次のように設定します。
places.formattedAddress,places.displayName.text
Place Details（新版）のレスポンス フィールド マスクを定義する
Place Details は、次の形式で 1 つのプレイス オブジェクトを返します。
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "types": [ "locality", "political" ], "formattedAddress": "Trinidad, CA 95570, USA", "displayName": { "text": "Trinidad", "languageCode": "en" } ... }
したがって、この API のフィールド マスクを指定するには、返す Place オブジェクトのフィールドを指定します。
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
gRPC 呼び出し
gRPC の場合は、レスポンス フィールド マスクを含む変数を設定します。次に、kubectl の「get」コマンドに その変数をリクエストに渡します。
const ( fieldMask = "places.formattedAddress,places.displayName" )
フィールドパスに関する考慮事項
レスポンスに必要なフィールドのみを含めます。必要なフィールドのみを返す:
- 処理時間を短縮し、レイテンシの低い結果が返されます。
- 今後 API にレスポンス フィールドが追加され、それらの新しいフィールドに追加の計算時間が必要な場合でも、安定したレイテンシ パフォーマンスが確保されます。もし すべてのフィールドを選択するか、最上位の すべての新しいフィールドを更新すると、パフォーマンスの低下が 自動的に追加されます
- レスポンス サイズが小さくなるため、ネットワークの規模が拡大する スループットが向上します
- 不要なデータをリクエストしないようにする。これにより、 無駄な処理時間や料金が発生しません