目的地を検索する

欧州経済領域(EEA)のデベロッパー

Destination は、ユーザーが到達またはナビゲーションしようとしている特定の場所を指します。Destination には、ナビゲーション ポイント、ランドマーク、入り口、建物の輪郭など、場所に関連する情報のコレクションも含まれます。

Geocoding API の SearchDestinations メソッドを使用すると、住所、プレイス ID、緯度と経度の座標など、さまざまな入力条件に基づいて、さまざまな目的地に関する詳細情報を取得できます。

目的地の検索リクエスト

目的地の検索リクエストは、次の形式の URL に対する HTTP POST リクエストです。

https://geocode.googleapis.com/v4/geocode/destinations

すべてのパラメータを JSON リクエスト本文またはヘッダーで POST リクエストの一部として渡します。次に例を示します。

curl -X POST -d '{
  "place": "places/ChIJY8sv5-i2j4AR_S6BlDDR42w"
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: *" \
https://geocode.googleapis.com/v4/geocode/destinations

目的地の検索場所は、次の 3 つの方法のいずれかで指定できます。

  • 住所
  • プレイス ID
  • 緯度と経度の座標

住所で目的地を検索する

アドレスは非構造化文字列として指定できます。住所のジオコーディングでは、緯度と経度の座標や、住所を表さないその他の非構造化文字列は解決されません。このような文字列を使用するリクエストはサポートされておらず、エラー レスポンスや未指定の動作が発生する可能性があります。サポートされていないクエリの例を次に示します。

クエリタイプ 例
緯度と経度の座標。代わりに位置情報クエリを使用してください。 "37.422131,-122.084801"
1 つのクエリに複数の場所、道路、都市の名前が含まれているなど、コンセプトや制約が多すぎる 「マーケット ストリート サンフランシスコ サンノゼ空港」
Google マップに表示されない住所要素 "C/O John Smith 123 Main Street"
"P.O. Box 13 San Francisco"
ビジネス、チェーン、カテゴリの名前と、それらのエンティティが利用できない場所を組み合わせたもの 「テキサス州ダラス近くのテスコ」
複数の解釈が可能な曖昧なクエリ 「充電器のドロップオフ」
現在使用されていない過去の名前 "Middlesex United Kingdom"
地理空間以外の要素または意図 「ベンチュラ港には何隻のボートがありますか?」
非公式の名前やバニティ名 「ジェンガ」
「ヘルター スケルター」
大きな行政区画(都市、都道府県、国) "New York City"
"California"
"USA"
特定の住所のないルート 「1st Ave., NYC, NY"
"I-95"
curl -X POST -d '{
  "addressQuery": {
    "addressQuery": "601 S Bernardo Ave, Sunnyvale, CA 94087, USA"
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: *" \
https://geocode.googleapis.com/v4/geocode/destinations

または postalAddress として:

curl -X POST -d '{
  "addressQuery": {
    "address": {
      "addressLines": ["601 S Bernardo Ave"],
      "locality": "Sunnyvale",
      "postalCode": "94087",
      "administrativeArea": "CA",
      "regionCode": "US"
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: *" \
https://geocode.googleapis.com/v4/geocode/destinations

通常、HTML フォームでキャプチャされた住所コンポーネントを処理する場合は、postalAddress 形式を使用します。

プレイス ID で目的地を検索する

プレイス ID を指定して、目的地を取得できます。

curl -X POST -d '{
  "place": "places/ChIJY8sv5-i2j4AR_S6BlDDR42w"
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: *" \
https://geocode.googleapis.com/v4/geocode/destinations

サポートされているプレイス ID

Search Destinations メソッドは、ナビゲーション可能な特定の目的地を表すプレイス ID で最も効果を発揮します。establishment、point_of_interest、premise、street_address、subpremise などのタイプのプレイス ID は、一般的にサポートされています。個別の場所を表していないプレイス ID(住所の範囲から推測されるプレイス ID(例: 「10-20 Main St」)、特定の番号のないルートのセクション、Plus Codes など)はサポートされていません。エリアが大きすぎる結果(「太平洋」など)のプレイス ID もサポートされていません。

Search Destinations で Autocomplete(新版)を使用する

互換性を確保するには、Autocomplete(新版)を使用して、Search Destinations で使用するプレイス ID を検索します。Autocomplete(新版)を使用する場合は、includedPrimaryTypes パラメータを使用して、結果をタイプでフィルタする必要があります。次の推奨フィルタを使用して Autocomplete(新版)から返されるプレイス ID は、Search Destinations でサポートされています。

"includedPrimaryTypes": [ "establishment", "point_of_interest", "premise", "street_address", "subpremise" ]

また、Autocomplete(新版)リクエストで include_pure_service_area_businesses フラグを true に設定しないでください。

場所で目的地を検索する

緯度と経度の座標を指定して目的地を検索できます。

curl -X POST -d '{
  "locationQuery": {
    "location": {
      "latitude": 37.37348780,
      "longitude": -122.05678064
    }
  }
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: *" \
https://geocode.googleapis.com/v4/geocode/destinations

OAuth を使用してリクエストを行う

Geocoding API v4 は、認証に OAuth 2.0 をサポートしています。Geocoding API で OAuth を使用するには、OAuth トークンに正しいスコープを割り当てる必要があります。Geocoding API は、Destinations メソッドで使用する次のスコープをサポートしています。

  • https://www.googleapis.com/auth/maps-platform.geocode - すべての Geocoding API メソッドで使用します。

また、すべての Geocoding API メソッドに一般的な https://www.googleapis.com/auth/cloud-platform スコープを使用することもできます。このスコープは、すべてのメソッドへのアクセスを許可する一般的なスコープであるため、開発時には便利ですが、本番環境では使用できません。

詳細と例については、OAuth を使用するをご覧ください。

目的地の検索レスポンス

Search Destinations のレスポンスには、その場所に関する豊富な地域密着型のコンテキストが含まれています。

Search Destinations レスポンス内の PlaceView オブジェクト(primary、containingPlaces 内のアイテム、landmarks など)は、フィールドを使用して場所のタイプを示します。

  • types: 場所のタイプを示す文字列の配列。
  • primaryType: 場所の主なタイプを示す文字列。

types と primaryType の両方に指定できる文字列値は、[Place Types (New)] ページの表 A と表 B から取得されます。

このセクションでは、主なレスポンス フィールドについて説明します。すべてのレスポンス フィールドの詳細については、API リファレンスをご覧ください。

primary

リクエストのクエリで特定されたメインの場所。

addressComponents

この住所に適用される個々のコンポーネントを含む配列。

通常、各住所コンポーネントには次のフィールドがあります。

  • types[] は住所コンポーネントのタイプを示す配列です。サポートされているタイプのリストをご覧ください。
  • longText は、ジオコーダが返した住所コンポーネントの説明または名前です。
  • shortText は、住所コンポーネントの略称です(略称がある場合)。たとえば、アラスカ州の住所コンポーネントの場合は、longText には「Alaska」が設定され、shortText には 2 文字の郵便略称を使用して「AK」が設定されます。
  • languageCode は、このコンポーネントのフォーマットに使用される言語です(CLDR 表記)。

containingPlaces

メインの目的地が属する、より大きなエンティティ(店舗が入っているショッピング モールなど)。

subDestinations

メインの目的地内のより具体的な場所(建物内のアパートなど)。

entrances

entrances[] 配列内のオブジェクトには、次のフィールドがあります。

  • displayName

    入口の対人可読な名前("South Bernardo Avenue" や "5th Avenue" など)を含む LocalizedText オブジェクト(利用可能な場合)。

  • location

    場所への出入り口の位置を定義する緯度と経度の座標ペア。

  • entrance_tags[]

    入り口の特徴を記述する入り口タグの配列。 次の値を使用できます。

    • "PREFERRED"

    このエントランスから、返された場所に物理的にアクセスできる可能性が高いことを示します。1 つの場所に複数の優先エントランスを設定できます。このタグがない入口は、物理的には同じ建物にありますが、必ずしもその場所へのアクセスを提供するとは限りません。

    たとえば、返された場所がショッピング モール内のレストランの場合、"PREFERRED" の入り口はレストラン自体に通じる入り口になります。返された他の入り口は、ショッピング モール内の他のレストランへの入り口など、建物の他の入り口になります。

    返された場所が建物自体の場合、"PREFERRED" の入り口は建物の「メイン」部分につながる入り口になります。たとえば、ショッピング センターでは、"PREFERRED" の入り口はメインのホワイエ エリアにアクセスできる入り口になりますが、建物の側面にある店舗にのみアクセスできる入り口は、"PREFERRED" の入り口にはなりません。

  • streetViewThumbnail、streetViewAnnotation

    ストリートビュー Static API のパラメータ。これらの場所に関連する画像を表示できます。これらのフィールドの詳細についてはこちらをご覧ください。

structureType

この場所が表す構造のタイプ。

  • POINT

    ポイント ロケーション。

  • SECTION

    建物の一部。

  • BUILDING

    建物。

  • GROUNDS

    大学のキャンパス、アパート・マンション、ショッピング モールなど、通常は複数の建物を含む広いエリア。

ジオコーディング レスポンスの navigationPoints フィールドには、場所へのナビゲーションに役立つポイントのリストが含まれています。具体的には、道路網で場所との間でルートを設定する際に、始点または終点として使用する必要があります。

各ナビゲーション ポイントには次の値が含まれます。

  • navigationPointToken は、navigationPoints フィールドのコンテキスト情報を含むトークンです。このトークンをルーティング API とナビゲーション API に送信して、アプリのルートと河川のエクスペリエンスを改善できます。詳しくは、ナビゲーション ポイント トークンを使用してルートを設定するをご覧ください。
  • location には、ナビゲーション ポイントの緯度と経度の値が含まれます。この位置は常に道路網に非常に近く、場所へのナビゲーションや場所からのナビゲーションの理想的な出発点または終点となります。このポイントは、場所が位置する道路の側を明確に示すために、意図的に道路の中心線から少しずらされています。
  • travelModes は、ナビゲーション ポイントにアクセスできる移動手段のリストです。
    • "DRIVE" は、運転ルートに対応する移動手段です。
    • "WALK" は、徒歩経路に対応する移動モードです。
  • usages は、ナビゲーション ポイントでサポートされている用途のリストです。用途は次のとおりです。
    • "DROPOFF"
    • "PICKUP"
    • "PARKING"

乗車と降車には、移動モードが DRIVE で、用途が PICKUP または DROPOFF のナビゲーション ポイントを使用します。乗車地点または降車地点が利用できない場合は、最上位の運転ナビゲーション ポイントを使用します。

  • altitude_meters には、WGS-84 楕円体を基準としたナビゲーション ポイントの高度(メートル単位)が格納されます。道路セグメントが垂直方向に積み重なっている場合は、altitude_meters フィールドを使用して、システムがナビゲートする最適な道路セグメントを選択します。

landmarks

ユーザーが目的地の周辺を把握するのに役立つ、付近の場所。

各ランドマークには次のフィールドが含まれます。

  • place は、このランドマークを表す PlaceView オブジェクトです。
  • relationalDescription は、目的地とランドマークの関係を人が読める形式で記述したものです(「エンパイア ステート ビルの近く」、「ホワイト ハウスの向かい」など)。
  • tags[] は、目的地のコンテキストでランドマークをどのように使用できるかを説明するタグの配列です。
    • "ADDRESS": 目的地のおおよその現在地を特定するために使用できる、地域的に有名な場所。
    • "ARRIVAL": 目的地に到着するのに役立つ場所。目的地に近づいたときのナビゲーションに役立ちます。
  • straightLineDistanceMeters は、このランドマークから目的地までの直線距離(メートル単位)です。
  • travelDistanceMeters は、このランドマークから目的地までの徒歩距離(メートル単位)です。

arrivalSummary

AI を活用した分析情報が到着をサポートします。AI を活用した要約をご覧ください。

parkingOptions

駐車場の詳細情報。

回答の形式

SearchDestinations は、次の JSON 形式の SearchDestinationsResponse を返します。

{
  "destinations": [
    {
      "primary": {
        "place": "places/ChIJY8sv5-i2j4AR_S6BlDDR42w",
        "displayName": {
          "text": "Arby's",
          "languageCode": "en"
        },
        "primaryType": "fast_food_restaurant",
        "types": [
          "fast_food_restaurant",
          "sandwich_shop",
          "deli",
          "meal_takeaway",
          "food_delivery",
          "american_restaurant",
          "restaurant",
          "food_store",
          "store",
          "food",
          "point_of_interest",
          "establishment"
        ],
        "formattedAddress": "Arby's, 601 S Bernardo Ave, Sunnyvale, CA 94087, USA",
        "postalAddress": {
          "regionCode": "US",
          "languageCode": "en",
          "postalCode": "94087",
          "administrativeArea": "CA",
          "locality": "Sunnyvale",
          "addressLines": [
            "601 S Bernardo Ave"
          ]
        },
        "structureType": "BUILDING",
        "location": {
          "latitude": 37.3734545,
          "longitude": -122.05693269999998
        },
        "displayPolygon": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.056930138027,
                37.3735253692531
              ],
              [
                -122.056960139391,
                37.3735372663597
              ],
              [
                -122.056994129366,
                37.3734828786847
              ],
              [
                -122.056969677395,
                37.3734731161089
              ],
              [
                -122.057061762447,
                37.3733261309656
              ],
              [
                -122.056979388817,
                37.3732935577128
              ],
              [
                -122.056798860285,
                37.3735818838642
              ],
              [
                -122.056875858081,
                37.3736121235316
              ],
              [
                -122.056930138027,
                37.3735253692531
              ]
            ]
          ]
        }
      },
      "containingPlaces": [
        {
          "place": "places/ChIJYfdAFum2j4ARIcL2tjME3Sw",
          "displayName": {
            "text": "Cherry Chase Shopping Center",
            "languageCode": "en"
          },
          "primaryType": "shopping_mall",
          "types": [
            "shopping_mall",
            "point_of_interest",
            "establishment"
          ],
          "formattedAddress": "Cherry Chase Shopping Center, 663 S Bernardo Ave, Sunnyvale, CA 94087, USA",
          "postalAddress": {
            "regionCode": "US",
            "languageCode": "en",
            "postalCode": "94087-1020",
            "administrativeArea": "CA",
            "locality": "Sunnyvale",
            "addressLines": [
              "663 S Bernardo Ave"
            ]
          },
          "structureType": "GROUNDS",
          "location": {
            "latitude": 37.3731231,
            "longitude": -122.0578211
          },
          "displayPolygon": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  -122.057112227103,
                  37.3714618008523
                ],
                [
                  -122.057076849821,
                  37.3715743611411
                ],
                [
                  -122.056963607756,
                  37.3719081793948
                ],
                [
                  -122.056865279559,
                  37.3722026053835
                ],
                [
                  -122.056687872374,
                  37.3727258358476
                ],
                [
                  -122.056580005889,
                  37.3730511370747
                ],
                [
                  -122.056498845827,
                  37.3732994782583
                ],
                [
                  -122.056338259713,
                  37.3737878663325
                ],
                [
                  -122.056618678291,
                  37.373887693582
                ],
                [
                  -122.056912102521,
                  37.3740010327191
                ],
                [
                  -122.057532418159,
                  37.3742476426462
                ],
                [
                  -122.057673926626,
                  37.3742441740031
                ],
                [
                  -122.057735663106,
                  37.3742328516943
                ],
                [
                  -122.057766531332,
                  37.3742220604378
                ],
                [
                  -122.057797572967,
                  37.37420520725
                ],
                [
                  -122.057828267759,
                  37.3741852342085
                ],
                [
                  -122.058060299297,
                  37.3740060842535
                ],
                [
                  -122.058199726081,
                  37.3737861673422
                ],
                [
                  -122.05836707267,
                  37.373524542556
                ],
                [
                  -122.058569622393,
                  37.3732018598683
                ],
                [
                  -122.0587638478,
                  37.3728890198039
                ],
                [
                  -122.058934661823,
                  37.3726036257774
                ],
                [
                  -122.059164956851,
                  37.3722498383629
                ],
                [
                  -122.058997784906,
                  37.3721804442035
                ],
                [
                  -122.057936479838,
                  37.3717605636234
                ],
                [
                  -122.057495827092,
                  37.3715860151634
                ],
                [
                  -122.057112227103,
                  37.3714618008523
                ]
              ]
            ]
          }
        }
      ],
      "landmarks": [
        {
          "place": {
            "place": "places/ChIJXXTe7Oi2j4ARoMTA-D6Hjpg",
            "displayName": {
              "text": "Chase Bank",
              "languageCode": "en"
            },
            "primaryType": "bank",
            "types": [
              "bank",
              "atm",
              "finance",
              "point_of_interest",
              "establishment"
            ],
            "formattedAddress": "Chase Bank, 1234 W El Camino Real, Sunnyvale, CA 94087, USA",
            "postalAddress": {
              "regionCode": "US",
              "languageCode": "en",
              "postalCode": "94087",
              "administrativeArea": "CA",
              "locality": "Sunnyvale",
              "addressLines": [
                "1234 W El Camino Real"
              ]
            },
            "structureType": "POINT",
            "location": {
              "latitude": 37.373579,
              "longitude": -122.05752700000001
            }
          },
          "relationalDescription": {
            "text": "Near Chase Bank",
            "languageCode": "en"
          },
          "tags": [
            "ARRIVAL",
            "ADDRESS"
          ],
          "straightLineDistanceMeters": 61.182193756103516,
          "travelDistanceMeters": 63.075645446777344
        },
        {
          "place": {
            "place": "places/ChIJteQ0Fum2j4ARGi3tqK4Zm14",
            "displayName": {
              "text": "Safeway",
              "languageCode": "en"
            },
            "primaryType": "grocery_store",
            "types": [
              "grocery_store",
              "butcher_shop",
              "florist",
              "deli",
              "supermarket",
              "bakery",
              "food_delivery",
              "market",
              "manufacturer",
              "food_store",
              "store",
              "food",
              "service",
              "point_of_interest",
              "establishment"
            ],
            "formattedAddress": "Safeway, 639 S Bernardo Ave, Sunnyvale, CA 94087, USA",
            "postalAddress": {
              "regionCode": "US",
              "languageCode": "en",
              "postalCode": "94087",
              "administrativeArea": "CA",
              "locality": "Sunnyvale",
              "addressLines": [
                "639 S Bernardo Ave"
              ]
            },
            "structureType": "POINT",
            "location": {
              "latitude": 37.3727912,
              "longitude": -122.0581172
            }
          },
          "relationalDescription": {
            "text": "Around the corner from Safeway",
            "languageCode": "en"
          },
          "tags": [
            "ARRIVAL",
            "ADDRESS"
          ],
          "straightLineDistanceMeters": 158.65606689453125,
          "travelDistanceMeters": 131.1669921875
        },
        {
          "place": {
            "place": "places/ChIJu-PSYui2j4ARNiwOwBApGqk",
            "displayName": {
              "text": "Oil Changers",
              "languageCode": "en"
            },
            "types": [
              "car_repair",
              "service",
              "point_of_interest",
              "establishment"
            ],
            "formattedAddress": "Oil Changers, 1240 W El Camino Real, Sunnyvale, CA 94087, USA",
            "postalAddress": {
              "regionCode": "US",
              "languageCode": "en",
              "postalCode": "94087",
              "administrativeArea": "CA",
              "locality": "Sunnyvale",
              "addressLines": [
                "1240 W El Camino Real"
              ]
            },
            "structureType": "POINT",
            "location": {
              "latitude": 37.3743054,
              "longitude": -122.0584272
            }
          },
          "relationalDescription": {
            "text": "Down the road from Oil Changers",
            "languageCode": "en"
          },
          "tags": [
            "ARRIVAL"
          ],
          "straightLineDistanceMeters": 140.52459716796875,
          "travelDistanceMeters": 143.24220275878906
        },
        {
          "place": {
            "place": "places/ChIJKRbl5oG3j4ARwuvPGUmtCj0",
            "displayName": {
              "text": "Apni Mandi Farmers Market Sunnyvale",
              "languageCode": "en"
            },
            "primaryType": "grocery_store",
            "types": [
              "grocery_store",
              "cake_shop",
              "supermarket",
              "asian_grocery_store",
              "indian_restaurant",
              "meal_takeaway",
              "bakery",
              "manufacturer",
              "wholesaler",
              "restaurant",
              "food_store",
              "store",
              "food",
              "point_of_interest",
              "establishment"
            ],
            "formattedAddress": "Apni Mandi Farmers Market Sunnyvale, 1111 W El Camino Real, Sunnyvale, CA 94087, USA",
            "postalAddress": {
              "regionCode": "US",
              "languageCode": "en",
              "postalCode": "94087-1056",
              "administrativeArea": "CA",
              "locality": "Sunnyvale",
              "addressLines": [
                "1111 W El Camino Real"
              ]
            },
            "structureType": "POINT",
            "location": {
              "latitude": 37.3737199,
              "longitude": -122.0522958
            }
          },
          "relationalDescription": {
            "text": "Near Apni Mandi Farmers Market Sunnyvale",
            "languageCode": "en"
          },
          "tags": [
            "ADDRESS"
          ],
          "straightLineDistanceMeters": 410.37435913085938,
          "travelDistanceMeters": 479.49893188476562
        },
        {
          "place": {
            "place": "places/ChIJ8enMlui2j4AR2xXK5EHDhBs",
            "displayName": {
              "text": "Starbird Chicken",
              "languageCode": "en"
            },
            "primaryType": "chicken_restaurant",
            "types": [
              "chicken_restaurant",
              "fast_food_restaurant",
              "restaurant",
              "food",
              "point_of_interest",
              "establishment"
            ],
            "formattedAddress": "Starbird Chicken, 1241 W El Camino Real, Sunnyvale, CA 94087, USA",
            "postalAddress": {
              "regionCode": "US",
              "languageCode": "en",
              "postalCode": "94087-1028",
              "administrativeArea": "CA",
              "locality": "Sunnyvale",
              "addressLines": [
                "1241 W El Camino Real"
              ]
            },
            "structureType": "BUILDING",
            "location": {
              "latitude": 37.3746764,
              "longitude": -122.05708860000001
            },
            "displayPolygon": {
              "coordinates": [
                [
                  [
                    -122.057003840785,
                    37.3747648209809
                  ],
                  [
                    -122.057136852459,
                    37.3747919153144
                  ],
                  [
                    -122.057205005705,
                    37.3745815131859
                  ],
                  [
                    -122.057071994114,
                    37.3745544186944
                  ],
                  [
                    -122.057003840785,
                    37.3747648209809
                  ]
                ]
              ],
              "type": "Polygon"
            }
          },
          "relationalDescription": {
            "text": "Near Starbird Chicken",
            "languageCode": "en"
          },
          "tags": [
            "ADDRESS"
          ],
          "straightLineDistanceMeters": 87.348007202148438,
          "travelDistanceMeters": 214.08084106445312
        }
      ],
      "entrances": [
        {
          "displayName": {
            "text": "South Bernardo Avenue",
            "languageCode": "en"
          },
          "location": {
            "latitude": 37.3735328,
            "longitude": -122.05694879999999
          },
          "tags": [
            "PREFERRED"
          ],
          "place": "places/ChIJY8sv5-i2j4AR_S6BlDDR42w"
        }
      ],
      "navigationPoints": [
        {
          "navigationPointToken": "ChIJeMt61tqvQkARWT2716SDXsASEgljyy_n6LaPgBH9LoGUMNHjbBoSCWPLL-foto-AEf0ugZQw0eNsIhIJhf5y6ei2j4ARz7yBW5KAPI4",
          "location": {
            "latitude": 37.3738659,
            "longitude": -122.05693620000001
          },
          "travelModes": [
            "DRIVE",
            "WALK"
          ],
          "usages": [
            "PARKING"
          ]
        }
      ]
    }
  ]
}

必須パラメータ

  • API リクエストには、目的地を検索する住所、場所、位置を指定する次の 3 つのパラメータのいずれかが含まれている必要があります。
    • addressQuery - 検索するアドレス。
    • place - 検索する場所のプレイス ID。
    • locationQuery - 検索する場所の緯度と経度の座標。
  • FieldMask

    レスポンス フィールド マスクを作成して、レスポンスで返すフィールドのリストを指定します。レスポンス フィールド マスクをメソッドに渡すには、URL パラメータ $fields または fields を使用するか、HTTP ヘッダー X-Goog-FieldMask を使用します。たとえば、次のリクエストでは、メインの目的地の入口、ナビゲーション ポイント、プレイス ID のみが返されます。

      curl -X POST -d '{"place": "places/ChIJG3kh4hq6j4AR_XuFQnV0_t8"}' \
        -H "X-Goog-Api-Key: API_KEY" \
        -H "Content-Type: application/json" \
        -H "X-Goog-FieldMask: destinations.entrances,destinations.navigationPoints,destinations.primary.place" \
        https://geocode.googleapis.com/v4/geocode/destinations
      

    レスポンスで返されるフィールドのデフォルト リストはありません。フィールド マスクを省略すると、メソッドはエラーを返します。すべてのフィールドを返すには、フィールド マスクを * に設定します。詳細については、返すフィールドの選択をご覧ください。

オプション パラメータ

  • travelModes

    返される navigationPoints のタイプを指定します。 他の移動手段のナビゲーション ポイントは除外されます。 travelModes が設定されていない場合は、すべての移動モードのナビゲーション ポイントが返される可能性があります。

  • languageCode

    結果を返す言語。

    • サポートされている言語の一覧をご覧ください。サポート対象の言語は頻繁に更新されるため、このリストで網羅されていない場合があります。
    • languageCode が指定されていない場合、API はデフォルトでその場所の現地の言語と文字を使用します。無効な言語コードを指定すると、API は INVALID_ARGUMENT エラーを返します。
    • API は、ユーザーと現地の人の両方が読み取れる番地を提供するように最善を尽くします。この目標を達成するため、住所は現地語で返されます。必要に応じて、ユーザーが読み取れる文字に変換され、優先言語が考慮されます。その他の住所はすべて、優先言語で返されます。住所コンポーネントはすべて同じ言語で返されます。この言語は、最初のコンポーネントから選択されます。
    • 優先言語で名前が利用できない場合、API は最も近い一致を使用します。
    • 優先言語は、API が返す結果のセットと、それらが返される順序にわずかに影響します。ジオコーダは、言語によって略語を異なる方法で解釈します。たとえば、道路の種類を表す略語や、ある言語では有効でも別の言語では有効でない類義語などです。
  • regionCode

    2 文字の CLDR コード値としての地域コード。デフォルト値はありません。ほとんどの CLDR コードは ISO 3166-1 コードと同じです。

    住所をジオコーディング(前方ジオコーディング)する場合、このパラメータは、サービスから指定された地域への結果に影響を与えますが、完全に制限するわけではありません。場所またはプレイスをジオコーディングする場合(リバース ジオコーディングまたはプレイス ジオコーディング)、このパラメータを使用して住所の形式を設定できます。いずれの場合も、このパラメータは適用される法律に基づいて結果に影響する可能性があります。

  • placeFilter

    locationQuery 検索の結果をフィルタして、要件に合う結果(建物である目的地のみ、明確な住所がある目的地のみなど)を返すことができます。

    構造の粒度でフィルタする

    structureType フィルタを使用すると、クエリによって返される構造の種類を指定できます。

    • 建物の分離: "structureType": "BUILDING" を使用して、地図上に建物の輪郭を表示したり、特定の建物の詳細を取得したりできます。
    • 複合施設の理解: "structureType": "GROUNDS" を使用して、プライマリ結果が全体的な敷地になるようにします。これは、大学のキャンパスやショッピング モールなどの広いエリアをクエリする場合に便利です。
    • ユニット/セクションに焦点を当てる: "structureType": "SECTION" を使用して、建物内のセクションを識別します。

    有用な住所を確保する

    すべての場所に明確な番地があるわけではありません。addressability フィルタを使用すると、結果に表示される住所の品質を管理できます。

    • "addressability": "PRIMARY" を使用すると、メインの目的地に必ず番地レベルの住所または名前が表示されるようになります。これは、明確な住所が不可欠なナビゲーションや表示の目的に役立ちます。
    • サブ目的地の住所を許可する: メインの場所に住所がないが、その中のユニット(建物内のアパートなど)に住所がある場合、"addressability": "WEAK" は、少なくともメインの場所またはそのサブ目的地のいずれかに住所があることを確認します。
    • 任意の結果: 住所の有無がユースケースに関連しない場合は、"addressability": "ANY" を使用します。建物の外形やナビゲーション ポイントなどの幾何学的属性のみが必要な場合は、この方法を強くおすすめします。これにより、結果の精度が向上します。
    例: 住所指定可能な建物のフィルタリング
    curl -X POST -d '{
      "locationQuery": {
        "location": {
          "latitude": 37.37348780,
          "longitude": -122.05678064
        },
        "placeFilter": {
          "structureType": "BUILDING",
          "addressability": "PRIMARY"
        }
      },
      "languageCode": "en"
    }' \\
    -H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \\
    -H "X-Goog-FieldMask: place" \\
    https://geocode.googleapis.com/v4/geocode/destinations
    
  • の負荷

    試験運用版: effort パラメータは試験運用版です。/v4alpha/ チャネルを使用して HTTP リクエストを作成します。リリース ステージ チャンネルの詳細。

    宛先クエリを解決するときに適用する処理 Effort の量を指定します(主に addressQuery の解決に影響します)。

    • EFFORT_UNSPECIFIED - デフォルト値。LOW のエフォートと同じように動作します。
    • LOW - 最速のレスポンス時間を重視して最適化します。複雑な住所に対して拡張検索や曖昧性除去を行いません。
    • MEDIUM - 速度と精度のバランスを取ります。ほとんどのリクエストは、標準の低レイテンシで返されます。曖昧な住所や複雑な住所の場合、精度を向上させるために追加の処理が適用されます。これには数秒かかることがあります。ユーザーが短い一時停止を許容できるインタラクティブなワークフローに推奨されます。
    • HIGH - 不完全な住所、非公式な住所、複雑な住所の名前解決の精度を最大化します。レスポンス時間が大幅に長くなる可能性があります。バックグラウンド、バッチ、ロジスティクス ディスパッチのワークフローに推奨されます。

    たとえば、次のリクエストでは、"effort": "HIGH" を使用して宛先アドレスのクエリを解決します。

    curl -X POST -d '{
      "addressQuery": {
        "addressQuery": "Flat 4B, Sunrise Apartments, opposite Central Mall, Andheri West, Mumbai"
      },
      "effort": "HIGH"
    }' \
    -H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
    -H "X-Goog-FieldMask: *" \
    https://geocode.googleapis.com/v4alpha/geocode/destinations
    

    レイテンシの予測、レート制限、推奨される統合パターンについて詳しくは、精度の高いジオコーディングをご覧ください。