- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- LocationBias
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- LocationRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 候補
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- PlacePrediction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FormattableText
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- StringRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- StructuredFormat
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- QueryPrediction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
指定された入力に対する予測を返します。
HTTP リクエスト
POST https://places.googleapis.com/v1/places:autocomplete
この URL は gRPC Transcoding 構文を使用します。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "input": string, "locationBias": { object ( |
フィールド | |
---|---|
input |
必須。検索するテキスト文字列。 |
locationBias |
省略可。指定した場所を優先して結果にバイアスをかけることができます。 設定できるのは、 |
locationRestriction |
省略可。指定した場所に結果を絞り込みます。 設定できるのは、 |
includedPrimaryTypes[] |
省略可。テーブル A またはテーブル B のメインの場所タイプ(「レストラン」や「gas_station」など)をプレイスタイプ(https://developers.google.com/maps/documentation/places/web-service/place-types)、のみ(地域)、のみ(都市)に含めます。プレイスは、その主要なタイプがこのリストに含まれている場合にのみ返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべてのプレイスタイプが返されます。 |
includedRegionCodes[] |
省略可。指定した地域の結果のみを含めます。CLDR の 2 文字の地域コードを最大 15 個指定します。セットが空の場合、結果は制限されません。 |
languageCode |
省略可。結果を返す言語。デフォルトは en-US です。 |
regionCode |
省略可。2 文字の CLDR 地域コードとして指定された地域コード。これは、住所の形式や結果のランキングに影響するほか、返される結果にも影響する場合があります。指定したリージョンに結果が制限されることはありません。結果をリージョンに制限するには、 |
origin |
省略可。目的地までの測地距離を計算する原点( |
inputOffset |
省略可。 空の場合、デフォルトで |
includeQueryPredictions |
省略可。true の場合、レスポンスにはプレイスとクエリの両方の予測が含まれます。それ以外の場合、レスポンスはプレイスの予測のみを返します。 |
sessionToken |
省略可。請求処理のために予測入力セッションを識別する文字列。URL とファイル名セーフ、長さが 36 文字以下の base64 文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 セッションは、ユーザーがクエリの入力を開始すると開始され、場所を選択して Place Details または Address Validation が呼び出されると終了します。各セッションは複数のクエリを含み、その後に 1 つの Place Details リクエストまたは Address Validation リクエストが続きます。セッション内の各リクエストに使用される認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリはセッションごとに新しいトークンを生成する必要があります。 次のガイドラインに従うことをおすすめします。
|
レスポンスの本文
Places.Autocomplete のレスポンス プロトコル。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"suggestions": [
{
object ( |
フィールド | |
---|---|
suggestions[] |
関連性の高い順に並べられた候補のリストが含まれます。 |
LocationBias
検索する地域。指定した地域を中心に結果に偏りが生じる可能性があります。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
rectangle |
北東と南西の角によって定義されるビューポート。 |
circle |
中心点と半径で定義される円。 |
LocationRestriction
検索する地域。結果は指定したリージョンに限定されます。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
rectangle |
北東と南西の角によって定義されるビューポート。 |
circle |
中心点と半径で定義される円。 |
候補
予測入力の候補の結果。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
placePrediction |
場所の予測。 |
queryPrediction |
クエリの予測。 |
PlacePrediction
Place Autocomplete の予測結果。
JSON 表現 |
---|
{ "place": string, "placeId": string, "text": { object ( |
フィールド | |
---|---|
place |
候補として表示された場所のリソース名。この名前は、場所の名前を受け入れる他の API で使用できます。 |
placeId |
候補として表示された場所の一意の識別子。この ID は、プレイス ID を受け入れる他の API で使用できます。 |
text |
返された結果の、人が読める形式の名前が含まれます。ビジネスの確立の結果の場合は、通常、ビジネスの名前と住所になります。
このテキストは、place.get から返される
|
structuredFormat |
場所の予測結果を、場所の名前を含むメインテキストと、曖昧さをなくすその他の特徴(都市や地域など)を含むサブテキストに分けます。
|
types[] |
https://developers.google.com/maps/documentation/places/web-service/place-types のテーブル A またはテーブル B から、このプレイスに適用されるタイプのリスト。 タイプとは、プレイスの分類です。共通のタイプがある場所には、同じような特性があります。 |
distanceMeters |
|
FormattableText
場所またはクエリの予測を表すテキスト。テキストはそのまま使用することも、書式付きで使用できます。
JSON 表現 |
---|
{
"text": string,
"matches": [
{
object ( |
フィールド | |
---|---|
text |
そのまま使用できるテキスト、または |
matches[] |
これらの値は、 |
StringRange
指定されたテキスト内の部分文字列を識別します。
JSON 表現 |
---|
{ "startOffset": integer, "endOffset": integer } |
フィールド | |
---|---|
startOffset |
文字列の最初の Unicode 文字のゼロベースのオフセット(両端を含む)。 |
endOffset |
最後の Unicode 文字のゼロベースのオフセット(この値を含まない)。 |
StructuredFormat
場所またはクエリの予測をメインテキストとセカンダリ テキストに分けて格納します。
場所の予測では、メインテキストに場所の具体的な名前が含まれます。クエリの予測の場合、メインテキストにクエリが含まれます。
サブテキストには、場所を特定したりクエリを絞り込んだりするための、曖昧さを取り除くその他の対象物(都市や地域など)が含まれています。
JSON 表現 |
---|
{ "mainText": { object ( |
フィールド | |
---|---|
mainText |
場所またはクエリの名前を表します。 |
secondaryText |
場所をさらに詳しく特定したり、クエリを絞り込んだりするための、曖昧さを取り除く追加の対象物(都市や地域など)を表します。 |
QueryPrediction
Query Autocomplete 予測の予測結果。
JSON 表現 |
---|
{ "text": { object ( |
フィールド | |
---|---|
text |
予測されたテキスト。このテキストはプレイスを表すのではなく、検索エンドポイント(テキスト検索など)で使用できるテキストクエリを表します。
リクエスト |
structuredFormat |
クエリ予測を、クエリを含むメインテキストと、曖昧性を除去する追加の特徴(都市や地域など)を含むセカンダリ テキストに分けて分類します。
|