Place Details (New) メソッド、 Nearby Search (New) メソッド、 Text Search (New) メソッドを呼び出す際には、レスポンスで返すフィールドを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。
フィールド リストを指定するには、レスポンス フィールド マスクを作成します。次に、パラメータ $fields
または fields
を使用するか、HTTP または gRPC ヘッダー X-Goog-FieldMask
を使用して、レスポンス フィールド マスクをメソッドに渡します。
不要なデータをリクエストしないようにするには、フィールド マスキングを使用することをおすすめします。これにより、不要な処理時間と課金を回避できます。
レスポンス フィールド マスクを定義する
レスポンス フィールド マスクは、パスのカンマ区切りのリストです。各パスは、レスポンス メッセージ内の一意のフィールドを指定します。パスは、トップレベルのレスポンス メッセージから始まり、指定されたフィールドへのドット区切りパスを使用します。
フィールドパスを次のように作成します。
topLevelField[.secondLevelField][.thirdLevelField][...]
*
のフィールド マスクを使用して、すべてのフィールドをリクエストできます。
フィールド マスクの作成方法について詳しくは、field_mask.proto をご覧ください。
使用するフィールド マスクを決定する
使用するフィールド マスクを指定する方法は次のとおりです。
- フィールド マスク「*」を使用して、すべてのフィールドをリクエストします。
- レスポンスのフィールドの階層を確認し、必要なフィールドを決定します。
- フィールド階層を使用してフィールド マスクを作成します。
Nearby Search(New)と Text Search(New)のレスポンス フィールド マスクを定義する
Nearby Search(New)と Text Search(New)は、レスポンスの places
フィールドで Place オブジェクトの配列を返します。これらの API の場合、places
はレスポンスの最上位フィールドです。
たとえば、Text Search(New)からの完全なレスポンス オブジェクトを表示するには、次のようにします。
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'
Text Search(New)呼び出しからの完全なレスポンス オブジェクトは、次の形式になります。
{ "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
を指定すると、displayName
の text
フィールドと language
フィールドの両方が含まれます。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 のフィールド マスクを指定するには、返す場所オブジェクトのフィールドを指定します。
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 の場合は、レスポンス フィールド マスクを含む変数を設定します。その変数をリクエストに渡すことができます。
const ( fieldMask = "places.formattedAddress,places.displayName" )
フィールドパスに関する考慮事項
必要なフィールドのみをレスポンスに含めます。必要なフィールドのみを返します。
- 処理時間を短縮して、低レイテンシで結果が返される。
- API で今後さらにレスポンス フィールドが追加され、それらの新しいフィールドで余分な計算時間が必要な場合に、安定したレイテンシ パフォーマンスが保証されます。すべてのフィールドを選択したり、トップレベルですべてのフィールドを選択した場合は、レスポンスに新しいフィールドがすべて自動的に追加されるため、パフォーマンスが低下する可能性があります。
- レスポンス サイズが小さくなり、ネットワーク スループットが向上します。
- 不要なデータをリクエストしないようにする。不要な処理時間と課金を回避できます。