- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- LocationBias
- LocationRestriction
- 候補
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
指定された入力に対する予測を返します。
HTTP リクエスト
POST https://places.googleapis.com/v1/places:autocomplete
この URL は gRPC Transcoding 構文を使用します。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "input": string, "locationBias": { object ( |
フィールド | |
---|---|
input |
必須。検索するテキスト文字列。 |
locationBias |
省略可。指定した場所にバイアスをかけます。
|
locationRestriction |
省略可。結果を指定した場所に制限します。
|
includedPrimaryTypes[] |
省略可。https://developers.google.com/maps/documentation/places/web-service/place-types のメインの場所タイプ(「レストラン」、「ガソリン スタンド」など)を追加しました。プレイスは、メインのタイプがこのリストに含まれている場合にのみ返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべてのプレイスタイプが返されます。 |
includedRegionCodes[] |
省略可。指定した地域の検索結果のみを含めます。最大 15 個の CLDR の 2 文字の地域コードで指定します。空のセットを指定すると、結果は制限されません。 |
languageCode |
省略可。結果を返す言語。デフォルトは en-US です。 |
regionCode |
省略可。CLDR の 2 文字の地域コードとして指定される地域コード。これは、住所の形式や検索結果のランキングに影響します。また、返される結果に影響する場合もあります。指定したリージョンに結果が制限されることはありません。結果を特定のリージョンに限定するには、 |
origin |
省略可。目的地までの測地線距離を計算する出発地点( |
inputOffset |
省略可。 空の場合、デフォルトで |
includeQueryPredictions |
省略可。true の場合、レスポンスには場所の予測とクエリの予測の両方が含まれます。それ以外の場合、レスポンスは場所の予測のみを返します。 |
sessionToken |
省略可。オートコンプリート セッションを課金目的で識別する文字列。長さが 36 文字以下の ASCII 文字の、URL とファイル名に安全な base64 文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 セッションは、ユーザーがクエリの入力を開始すると開始され、場所を選択して Place Details または Address Validation が呼び出されると終了します。各セッションでは複数のクエリの後に、Place Details または Address Validation リクエストを 1 回行うことができます。セッション内の各リクエストに使用される認証情報は、同じ 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 |
返された結果の名前が人が読める形式で格納されます。施設の検索結果の場合、通常はビジネスの名前と住所です。
このテキストは、Places.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 |
クエリ予測を、クエリを含むメインテキストと、曖昧性除去用の特徴(都市や地域など)を含むセカンダリ テキストに分割します。
|