Package google.maps.places.v1

インデックス

場所

Places API のサービス定義。注: すべてのリクエスト(Autocomplete リクエストを除く)で、リクエスト プロトコル(all/*)の外部に設定されたフィールドマスクが必要です(想定されていません)。フィールドマスクは、HTTP ヘッダー X-Goog-FieldMask で設定できます。https://developers.google.com/maps/documentation/places/web-service/choose-fields をご覧ください。

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

指定された入力の予測を返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

写真の参照文字列を使用して写真メディアを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

リソース名(places/{place_id} 形式の文字列)に基づいてプレイスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

場所の近くの場所を検索する。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

テキストクエリに基づく場所の検索。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

AddressDescriptor

場所の関連する説明。近くのランドマークと正確な包含エリアのランキング セットと、ターゲット ロケーションとの関係が含まれます。

フィールド
landmarks[]

Landmark

近くのランドマークのランキング リスト。最も目立つ近くのランドマークが最初に表示されます。

areas[]

Area

含まれるエリアまたは隣接するエリアのランキング リスト。最も認識しやすく正確なエリアが最初にランク付けされます。

地域

エリア情報と、そのエリアとターゲット ロケーションの関係。

エリアには、場所の説明に役立つ正確な地域の下位区分、近隣地域、大規模な複合施設が含まれます。

フィールド
name

string

エリアのリソース名。

place_id

string

エリアの Place ID。

display_name

LocalizedText

エリアの表示名。

containment

Containment

対象の場所とエリア間の空間関係を定義します。

封じ込め

対象の場所とエリア間の空間関係を定義します。

列挙型
CONTAINMENT_UNSPECIFIED 制限は指定されていません。
WITHIN ターゲット ロケーションはエリア内の中央付近にある。
OUTSKIRTS ターゲット ロケーションがエリア領域内にあり、端に近い。
NEAR 対象の場所はエリアの外部にあるが、近くにある。

ランドマーク

ランドマークの基本情報と、ランドマークとターゲット ロケーションの関係。

ランドマークとは、場所を説明するために使用できる目立つ場所です。

フィールド
name

string

ランドマークのリソース名。

place_id

string

ランドマークの Place ID。

display_name

LocalizedText

ランドマークの表示名。

types[]

string

このランドマークのタイプタグのセット。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types をご覧ください。

spatial_relationship

SpatialRelationship

ターゲット ロケーションとランドマーク間の空間関係を定義します。

straight_line_distance_meters

float

ターゲットの中心点とランドマークの中心点間の直線距離(メートル単位)。状況によっては、この値が travel_distance_meters より長くなることがあります。

travel_distance_meters

float

ターゲットからランドマークまでの道路網上の移動距離(メートル単位)(既知の場合)。この値は、徒歩、車、自転車などの移動手段は考慮していません。

SpatialRelationship

ターゲット ロケーションとランドマーク間の空間関係を定義します。

列挙型
NEAR 以下に具体的な関係がない場合、これがデフォルトの関係になります。
WITHIN ランドマークに空間ジオメトリがあり、ターゲットがその境界内にある。
BESIDE ターゲットがランドマークに直接隣接している。
ACROSS_THE_ROAD ターゲットが道路の反対側にあるランドマークの真向かいにある場合。
DOWN_THE_ROAD ランドマークと同じ経路上にあるが、隣接していない、または向かい側にない。
AROUND_THE_CORNER ランドマークと同じ経路上にはないものの、1 回曲がれば到達できる場所。
BEHIND ランドマークの構造物に近いが、道路の入口からは遠い。

AuthorAttribution

UGC データの作成者に関する情報。PhotoReview で使用。

フィールド
display_name

string

Photo または Review の作成者の名前。

uri

string

Photo または Review の作成者の URI。

photo_uri

string

Photo または Review の作成者のプロフィール写真の URI。

AutocompletePlacesRequest

AutocompletePlaces のリクエスト プロトコル。

フィールド
input

string

必須。検索するテキスト文字列。

location_bias

LocationBias

省略可。指定された場所を優先するよう結果にバイアスを設定します。

location_bias または location_restriction のいずれかを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスは不正確な位置にマッピングされ、バイアス シグナルとして使用されます。

location_restriction

LocationRestriction

省略可。結果を指定されたロケーションに制限します。

location_bias または location_restriction のいずれかを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスは不正確な位置にマッピングされ、バイアス シグナルとして使用されます。

included_primary_types[]

string

省略可。プレイスタイプ(https://developers.google.com/maps/documentation/places/web-service/place-types))に含まれる主なプレイスタイプ(「restaurant」や「gas_station」など)、または (regions) のみ、(cities) のみ。場所が返されるのは、その主なタイプがこのリストに含まれている場合のみです。最大 5 つの値を指定できます。タイプを指定しない場合は、すべての場所のタイプが返されます。

included_region_codes[]

string

省略可。指定した地域の結果のみを表示します。指定は、最大 15 個の CLDR 2 文字の地域コードで指定します。空のセットは結果を制限しません。location_restrictionincluded_region_codes の両方が設定されている場合、結果は交差領域に配置されます。

language_code

string

省略可。結果を返す言語。デフォルトは en-US です。input で使用されている言語が language_code と異なる場合や、返された場所にローカル言語から language_code への翻訳がない場合、結果が複数の言語で表示されることがあります。

region_code

string

省略可。地域コード(CLDR の 2 文字の地域コードで指定)。これは住所のフォーマット、結果のランキングに影響し、返される結果にも影響する可能性があります。指定したリージョンに結果が制限されることはありません。結果をリージョンに制限するには、region_code_restriction を使用します。

origin

LatLng

省略可。目的地までの測地線距離を計算する出発地点(distance_meters として返されます)。この値を省略すると、測地線距離は返されません。

input_offset

int32

省略可。input 内のカーソル位置を示す 0 ベースの Unicode 文字オフセット input。カーソルの位置が、返される予測に影響する可能性があります。

空の場合、デフォルトの input の長さになります。

include_query_predictions

bool

省略可。true の場合、レスポンスには場所とクエリの予測の両方が含まれます。それ以外の場合、レスポンスは場所の予測のみを返します。

session_token

string

省略可。請求目的で Autocomplete セッションを識別する文字列。URL とファイル名に安全な base64 文字列で、ASCII 文字で 36 文字以内にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択し、Place Details または住所の検証が呼び出されると終了します。セッションによっては、複数の検索語句が入力された後に、1 つの Place Details リクエストまたは Address Validation リクエストが送信される場合もあります。セッション内の各リクエストに使用する認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。session_token パラメータを省略する場合や、セッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます(各リクエストが個別に課金されます)。

次のガイドラインに従うことをおすすめします。

  • すべての Place Autocomplete 呼び出しにセッション トークンを使用します。
  • セッションごとに新しいトークンを生成します。バージョン 4 の UUID を使用することをおすすめします。
  • セッション内のすべての Place Autocomplete、Place Details、Address Validation リクエストに使用される認証情報が、同じ Cloud コンソール プロジェクトに属していることを確認します。
  • 新しいセッションごとに固有のセッション トークンを渡すようにしてください。複数のセッションで同じトークンを使用すると、リクエストごとに課金されます。
include_pure_service_area_businesses

bool

省略可。このフィールドが true に設定されている場合は、純粋な非店舗型ビジネスを含めます。純粋な非店舗型ビジネスは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。清掃サービスや配管工事などのビジネスが該当します。これらのビジネスには、Google マップに物理的な住所または所在地がありません。これらのビジネス拠点については、Places から locationplus_code などの位置情報関連のフィールドが返されません。

LocationBias

検索するリージョン。結果は、指定した地域を中心に偏る可能性があります。

フィールド

共用体フィールド type

type は次のいずれかになります。

rectangle

Viewport

北東と南西の角で定義されたビューポート。

circle

Circle

中心点と半径で定義された円。

LocationRestriction

検索するリージョン。結果は指定されたリージョンに制限されます。

フィールド

共用体フィールド type

type は次のいずれかになります。

rectangle

Viewport

北東と南西の角で定義されたビューポート。

circle

Circle

中心点と半径で定義された円。

AutocompletePlacesResponse

AutocompletePlaces のレスポンス プロトコル。

フィールド
suggestions[]

Suggestion

関連性の高い順に並べられた候補のリストが含まれます。

候補

オートコンプリートの候補結果。

フィールド

共用体フィールド kind

kind は次のいずれかになります。

place_prediction

PlacePrediction

場所の予測。

query_prediction

QueryPrediction

クエリの予測。

FormattableText

場所またはクエリの予測を表すテキスト。テキストはそのまま使用することも、書式設定することもできます。

フィールド
text

string

そのまま使用するか、matches でフォーマットできるテキスト。

matches[]

StringRange

入力リクエストが text で一致した場所を特定する文字列範囲のリスト。範囲を使用すると、text の特定の部分をフォーマットできます。一致が文字列の一致以外の条件(スペル修正や文字変換など)によって決定された場合、部分文字列は input と完全に一致しないことがあります。

これらの値は、text の Unicode 文字オフセットです。範囲は、オフセット値の昇順で並べ替えられます。

PlacePrediction

Place Autocomplete の予測結果。

フィールド
place

string

候補のプレイスのリソース名。この名前は、場所の名前を受け入れる他の API で使用できます。

place_id

string

候補として表示されたプレイス固有の ID。この識別子は、プレイス ID を受け入れる他の API で使用できます。

text

FormattableText

返された結果の読みやすい名前が含まれます。法人の場合は通常、法人名と住所です。

text は、単一の UI 要素を表示するデベロッパーにおすすめです。2 つの別個の(ただし関連する)UI 要素を表示する場合は、代わりに structured_format を使用できます。これらは、プレイスの予測を表現する 2 つの異なる方法です。structured_formattext に解析したり、その逆を行ったりしないでください。

このテキストは、GetPlace から返される display_name とは異なる場合があります。

リクエスト inputlanguage_code の言語が異なる場合や、場所にローカル言語から language_code への翻訳がない場合は、複数の言語が混在する場合があります。

structured_format

StructuredFormat

場所の予測を、場所の名前を含むメインテキストと、あいまいさを解消する追加の特徴(都市や地域など)を含むセカンダリ テキストに分類したものです。

structured_format は、2 つの別個の(ただし関連する)UI 要素を表示するデベロッパーに推奨されます。単一の UI 要素を表示する場合は、代わりに text を使用することをおすすめします。これらは、プレイスの予測を表現する 2 つの異なる方法です。structured_formattext に解析したり、その逆を行ったりしないでください。

types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types の表 A または表 B で、この場所に適用されるタイプのリスト。

タイプは、プレイスの分類です。タイプを共有する場所は、類似の特性を持つことになります。

distance_meters

int32

origin が指定されている場合、origin からの測地線の長さ(メートル単位)。ルートなどの特定の予測では、このフィールドに値が入力されない場合があります。

QueryPrediction

クエリのオートコンプリート予測の予測結果。

フィールド
text

FormattableText

予測されたテキスト。このテキストはプレイスを表すものではなく、検索エンドポイント(Text Search など)で使用できるテキスト クエリを表します。

text は、単一の UI 要素を表示するデベロッパーにおすすめです。2 つの別個の(ただし関連する)UI 要素を表示する場合は、代わりに structured_format を使用できます。これらは、クエリ予測を表現する 2 つの異なる方法です。structured_formattext に解析したり、その逆を行ったりしないでください。

リクエスト inputlanguage_code の言語が異なる場合や、クエリの一部にローカル言語から language_code への翻訳がない場合は、複数の言語が混在する場合があります。

structured_format

StructuredFormat

クエリの予測を、クエリを含むメインテキストと、曖昧さを解消する追加の特徴(都市や地域など)を含むセカンダリ テキストに分類したものです。

structured_format は、2 つの別個の(ただし関連する)UI 要素を表示するデベロッパーに推奨されます。単一の UI 要素を表示する場合は、代わりに text を使用することをおすすめします。これらは、クエリ予測を表現する 2 つの異なる方法です。structured_formattext に解析したり、その逆を行ったりしないでください。

StringRange

指定したテキスト内の部分文字列を特定します。

フィールド
start_offset

int32

文字列の最初の Unicode 文字のオフセット(0 から始まる)(この文字を含む)。

end_offset

int32

最後の Unicode 文字のゼロベースのオフセット(この値は含まれない)。

StructuredFormat

場所またはクエリの予測がメインテキストとセカンダリ テキストに分類されています。

場所の予測の場合、メインテキストには場所の具体的な名前が含まれます。クエリ予測の場合、メインテキストにクエリが含まれます。

セカンダリ テキストには、場所をより明確に特定したり、クエリを絞り込んだりするための追加の特徴(都市や地域など)が含まれています。

フィールド
main_text

FormattableText

プレイスまたはクエリの名前を表します。

secondary_text

FormattableText

プレイスの詳細な識別やクエリの絞り込みに役立つ、あいまいさを解消する追加の特徴(都市や地域など)を表します。

サークル

LatLng を中心とする円と半径。

フィールド
center

LatLng

必須。緯度と経度を中央に配置します。

緯度の範囲は [-90.0, 90.0] 内にする必要があります。経度の範囲は [-180.0, 180.0] 内にする必要があります。

radius

double

必須。半径はメートル単位で測定されます。半径は [0.0, 50000.0] の範囲内にする必要があります。

ContentBlock

個別に配信できるコンテンツのブロック。

フィールド
topic

string

コンテンツのトピック(「概要」、「レストラン」など)。

content

LocalizedText

トピックに関連するコンテンツ。

references

References

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

このコンテンツ ブロックに関連する参照。

ContextualContent

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所のクエリに関連するコンテンツ。

フィールド
reviews[]

Review

この場所に関するクチコミのリスト(場所のクエリに関連するもの)。

photos[]

Photo

この場所の写真に関する情報(参照情報を含む)で、場所のクエリに関連するもの。

justifications[]

Justification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の正当性。

理由

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の正当性。理由は、その場所がエンドユーザーにとって興味深い理由を説明します。

フィールド

共用体フィールド justification

justification は次のいずれかになります。

review_justification

ReviewJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

business_availability_attributes_justification

BusinessAvailabilityAttributesJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

BusinessAvailabilityAttributesJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。BusinessAvailabilityAttributes の正当な理由。エンドユーザーが興味を持つ可能性のあるビジネスの属性がいくつか表示されます。

フィールド
takeout

bool

テイクアウトを提供しているかどうか。

delivery

bool

配送サービスを提供しているかどうか。

dine_in

bool

店内での飲食が可能かどうか。

ReviewJustification

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

ユーザー レビューの正当な理由。これにより、エンドユーザーの関心を引くユーザー レビューのセクションがハイライト表示されます。たとえば、検索クエリが「薪焼きピザ」の場合、レビューの理由では、検索クエリに関連するテキストがハイライト表示されます。

フィールド
highlighted_text

HighlightedText

review

Review

ハイライト表示されたテキストが生成されたレビュー。

HighlightedText

配置によってハイライト表示されたテキスト。これはレビュー自体のサブセットです。ハイライト表示する正確な単語は、HighlightedTextRange でマークされます。テキスト内の複数の単語がハイライト表示される場合があります。

フィールド
text

string

highlighted_text_ranges[]

HighlightedTextRange

ハイライト表示されたテキストの範囲のリスト。

HighlightedTextRange

ハイライト表示されたテキストの範囲。

フィールド
start_index

int32

end_index

int32

EVChargeOptions

プレイス内にホストされている EV 充電スタンドに関する情報。用語は https://afdc.energy.gov/fuels/electricity_infrastructure.html に準拠しています。1 つのポートで一度に 1 台の車を充電できます。1 つのポートには 1 つ以上のコネクタがあります。1 つの充電スタンドには 1 つ以上のポートがあります。

フィールド
connector_count

int32

この充電スタンドのコネクタの数。ただし、一部の充電スタンドには複数のコネクタが設置されているものの、一度に充電できる車は 1 台のみであるため、コネクタの数は同時に充電できる車の合計数よりも多い場合があります。

connector_aggregation[]

ConnectorAggregation

同じタイプと同じ充電レートのコネクタを含む EV 充電コネクタの集計リスト。

ConnectorAggregation

[type、max_charge_rate_kw] でグループ化された EV 充電情報。同じタイプで最大充電率が同じコネクタの EV 充電の集計値(kW)が表示されます。

フィールド
type

EVConnectorType

この集計の接続タイプ。

max_charge_rate_kw

double

集約内の各コネクタの静的最大充電率(kW)。

count

int32

この集計内のコネクタ数。

availability_last_update_time

Timestamp

この集計内のコネクタの可用性情報が最後に更新されたときのタイムスタンプ。

available_count

int32

この集計で現在使用可能なコネクタの数。

out_of_service_count

int32

この集計で現在使用できないコネクタの数。

EVConnectorType

電気自動車の充電コネクタの種類の詳細については、http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107 をご覧ください。

列挙型
EV_CONNECTOR_TYPE_UNSPECIFIED コネクタが指定されていません。
EV_CONNECTOR_TYPE_OTHER その他のコネクタの種類。
EV_CONNECTOR_TYPE_J1772 J1772 タイプ 1 コネクタ。
EV_CONNECTOR_TYPE_TYPE_2 IEC 62196 タイプ 2 コネクタ。MENNEKES とも呼ばれます。
EV_CONNECTOR_TYPE_CHADEMO CHAdeMO タイプのコネクタ。
EV_CONNECTOR_TYPE_CCS_COMBO_1 充電システム(AC と DC)。SAE に基づく。Type-1 J-1772 コネクタ
EV_CONNECTOR_TYPE_CCS_COMBO_2 充電システム(AC と DC)。Type-2 Mennekes コネクタに基づく
EV_CONNECTOR_TYPE_TESLA 汎用 TESLA コネクタ。これは北米では NACS ですが、世界中の他の地域では NACS 以外(CCS Combo 2(CCS2)や GB/T など)である場合があります。この値は、実際のコネクタタイプを表すというよりは、テスラ所有の充電スタンドでテスラ ブランドの車両を充電できるかどうかを表します。
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T GB/T タイプは、中国の GB/T 規格に対応しています。このタイプには、すべての GB_T タイプが含まれます。
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET コンセントの種類が不明。
EV_CONNECTOR_TYPE_NACS North American Charging System(NACS): SAE J3400 として標準化されています。

FuelOptions

ガソリンスタンドで利用できる燃料に関する最新情報。この情報は定期的に更新されます。

フィールド
fuel_prices[]

FuelPrice

このガソリンスタンドで提供されている各種類の燃料の直近の価格。ガソリンスタンドに設置されている燃料の種類ごとに 1 つのエントリがあります。順序は重要ではありません。

FuelPrice

特定の種類の燃料価格情報。

フィールド
type

FuelType

燃料の種類。

price

Money

燃料の価格。

update_time

Timestamp

ガソリン価格が最後に更新された日時。

FuelType

燃料の種類。

列挙型
FUEL_TYPE_UNSPECIFIED 燃料の種類が指定されていません。
DIESEL ディーゼル燃料。
DIESEL_PLUS ディーゼルと燃料。
REGULAR_UNLEADED レギュラー無鉛。
MIDGRADE 中間グレード。
PREMIUM Premium を
SP91 SP 91。
SP91_E10 SP 91 E10。
SP92 SP 92。
SP95 SP 95。
SP95_E10 SP95 E10。
SP98 SP 98。
SP99 SP 99。
SP100 SP 100。
LPG 液化石油ガス。
E80 E 80。
E85 E 85.
E100 E 100.
METHANE メタン。
BIO_DIESEL バイオディーゼル。
TRUCK_DIESEL トラックのディーゼル。

GetPhotoMediaRequest

写真リソース名を使用して場所の写真を取得するリクエスト。

フィールド
name

string

必須。写真メディアのリソース名(places/{place_id}/photos/{photo_reference}/media 形式)。

プレイス オブジェクトの photos.name フィールドで返される写真のリソース名は、places/{place_id}/photos/{photo_reference} の形式です。写真メディアのリソース名を取得するには、写真リソースの末尾に /media を追加する必要があります。

max_width_px

int32

省略可。画像の最大幅(ピクセル単位)を指定します。画像が指定された値より小さい場合は、元の画像が返されます。画像のいずれかのサイズが指定サイズより大きい場合は、元のアスペクト比を維持しながら、2 つのサイズのうち小さい方に合わせて画像が拡大されます。max_height_px プロパティと max_width_px プロパティの両方では、1 ~ 4, 800 の整数を指定できます。値が許容範囲内に入っていない場合、INVALID_ARGUMENT エラーが返されます。

max_height_px または max_width_px の少なくとも 1 つを指定する必要があります。max_height_px と max_width_px のどちらも指定されていない場合、INVALID_ARGUMENT エラーが返されます。

max_height_px

int32

省略可。画像の高さの最大値(ピクセル単位)を指定します。画像が指定された値より小さい場合は、元の画像が返されます。画像のいずれかのサイズが指定サイズより大きい場合は、元のアスペクト比を維持しながら、2 つのサイズのうち小さい方に合わせて画像が拡大されます。max_height_px プロパティと max_width_px プロパティの両方では、1 ~ 4, 800 の整数を指定できます。値が許容範囲内に入っていない場合、INVALID_ARGUMENT エラーが返されます。

max_height_px または max_width_px の少なくとも 1 つを指定する必要があります。max_height_px と max_width_px のどちらも指定されていない場合、INVALID_ARGUMENT エラーが返されます。

skip_http_redirect

bool

省略可。設定すると、デフォルトの HTTP リダイレクト動作をスキップし、テキスト形式(HTTP ユースケースの場合は JSON 形式など)のレスポンスをレンダリングします。設定されていない場合、HTTP リダイレクトが発行され、呼び出しが画像メディアにリダイレクトされます。このオプションは、HTTP 以外のリクエストでは無視されます。

GetPlaceRequest

リソース名(places/{place_id} 形式の文字列)に基づいてプレイスを取得するためのリクエスト。

フィールド
name

string

必須。場所のリソース名(places/{place_id} 形式)。

language_code

string

省略可。優先言語が設定されている場合は、その言語で場所の詳細が表示されます。

現在サポートされている言語の一覧: https://developers.google.com/maps/faq#languagesupport

region_code

string

省略可。リクエストの送信元のロケーションの Unicode 国/リージョン コード(CLDR)。このパラメータは、地域固有の場所の名前など、場所の詳細を表示するために使用されます(利用可能な場合)。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。詳細については、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。

現在、3 桁の地域コードはサポートされていません。

session_token

string

省略可。請求目的で Autocomplete セッションを識別する文字列。URL とファイル名に安全な base64 文字列で、ASCII 文字で 36 文字以内にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択し、Place Details または住所の検証が呼び出されると終了します。セッションによっては、複数の検索語句が入力された後に、1 つの Place Details リクエストまたは Address Validation リクエストが送信される場合もあります。セッション内の各リクエストに使用する認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。session_token パラメータを省略する場合や、セッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます(各リクエストが個別に課金されます)。

次のガイドラインに従うことをおすすめします。

  • すべての Place Autocomplete 呼び出しにセッション トークンを使用します。
  • セッションごとに新しいトークンを生成します。バージョン 4 の UUID を使用することをおすすめします。
  • セッション内のすべての Place Autocomplete、Place Details、Address Validation リクエストに使用される認証情報が、同じ Cloud コンソール プロジェクトに属していることを確認します。
  • 新しいセッションごとに固有のセッション トークンを渡すようにしてください。複数のセッションで同じトークンを使用すると、リクエストごとに課金されます。

写真

場所の写真に関する情報。

フィールド
name

string

ID。この場所の写真を表す参照。この場所の写真の再検索に使用できます(API の「リソース」名: places/{place_id}/photos/{photo})。

width_px

int32

使用可能な最大幅(ピクセル単位)。

height_px

int32

使用可能な最大高さ(ピクセル単位)。

author_attributions[]

AuthorAttribution

この写真の作成者。

flag_content_uri

string

写真に関する問題を報告できるリンク。

google_maps_uri

string

Google マップに写真を表示するためのリンク。

PhotoMedia

Places API の写真メディア。

フィールド
name

string

写真メディアのリソース名(places/{place_id}/photos/{photo_reference}/media 形式)。

photo_uri

string

写真をレンダリングするために使用できる有効期間の短い URI。

場所

プレイスを表すすべての情報。

フィールド
name

string

このプレイスのリソース名(places/{place_id} 形式)。プレイスの検索に使用できます。

id

string

場所の一意の識別子。

display_name

LocalizedText

場所のローカライズされた名前。人が読める短い説明として適しています。例: 「Google Sydney」、「Starbucks」、「Pyrmont」など。

types[]

string

この結果のタイプタグのセット。たとえば、「political」や「locality」などです。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types の表 A と表 B をご覧ください。

primary_type

string

指定された結果のプライマリ タイプ。このタイプは、Places API でサポートされているタイプのいずれかである必要があります。たとえば、「レストラン」、「カフェ」、「空港」などです。1 つの場所に設定できるプライマリ タイプは 1 つだけです。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types の表 A と表 B をご覧ください。

primary_type_display_name

LocalizedText

プライマリ タイプの表示名(該当する場合はリクエスト言語にローカライズ)。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types の表 A と表 B をご覧ください。

national_phone_number

string

場所の電話番号(国内形式)。

international_phone_number

string

場所の電話番号(国際形式)。

formatted_address

string

この場所の完全な住所(人が読める形式)。

short_formatted_address

string

この場所の短い、人が読める形式の住所。

address_components[]

AddressComponent

地域レベルごとに繰り返されるコンポーネント。address_components[] 配列については、次の点に注意してください。- 住所コンポーネントの配列には、formatted_address よりも多くのコンポーネントが含まれている場合があります。- この配列には、formatted_address に含まれているもの以外の住所を持つ行政区画が、すべて含まれているとは限りません。特定の住所を含むすべての行政区画を取得するには、リバース ジオコーディングを使用して住所の緯度と経度をパラメータとしてリクエストに渡します。- レスポンスの形式は、リクエスト間で同じになるとは限りません。特に、address_components の数はリクエストされた住所によって異なり、同じ住所でも将来的に変わる可能性があります。コンポーネントは、配列内の位置が変わる場合があります。コンポーネントのタイプは変わる場合があります。特定のコンポーネントが以降のレスポンスに含まれない場合があります。

plus_code

PlusCode

場所の Plus Code の緯度/経度。

location

LatLng

この場所の位置。

viewport

Viewport

平均サイズの地図に場所を表示するのに適したビューポート。このビューポートは、ビジネスの物理的な境界やサービス提供エリアとして使用しないでください。

rating

double

この場所のユーザー レビューに基づく 1.0 ~ 5.0 の評価。

google_maps_uri

string

この場所の詳細情報を提供する URL。

website_uri

string

当該の場所の公式ウェブサイト(ビジネスのホームページなど)。チェーンに属する場所(IKEA 店舗など)の場合は、通常、チェーン全体ではなく個々の店舗のウェブサイトを指定します。

reviews[]

Review

この場所に関するクチコミのリスト(関連性の高い順に並べ替えられます)。返されるレビューは最大 5 件です。

regular_opening_hours

OpeningHours

通常の営業時間。場所が年中無休(24 時間営業)の場合は、close フィールドは設定されません。[open][google.maps.places.v1.Place.OpeningHours.Period.open] 期間に値が 0[day][Point.day]、値が 0[hour][Point.hour]、値が 0[minute][Point.minute] が含まれており、[hour][Point.hour] が含まれていなければ、クライアントはこれを年中無休であると判断できます。

time_zone

TimeZone

IANA タイムゾーン データベースのタイムゾーン。例: 「America/New_York」。

photos[]

Photo

この場所の写真に関する情報(参照情報を含む)。返却できる写真は最大 10 枚です。

adr_format_address

string

場所の住所(adr マイクロフォーマット): http://microformats.org/wiki/adr

business_status

BusinessStatus

場所の営業状況。

price_level

PriceLevel

場所の価格帯。

attributions[]

Attribution

この結果とともに表示する必要があるデータ プロバイダのセット。

icon_mask_base_uri

string

アイコン マスクへの URL の切り捨て。ユーザーは、タイプ サフィックス(「.svg」や「.png」など)を末尾に追加することで、さまざまなアイコンタイプにアクセスできます。

icon_background_color

string

icon_mask の背景色(16 進数形式)。例: #909CE1。

current_opening_hours

OpeningHours

次の 7 日間(今日を含む)の営業時間。期間はリクエストの日付の午前 0 時から 6 日後の午後 11 時 59 分までです。このフィールドには、特別な営業時間がある日付に設定された、すべての営業時間の special_days サブフィールドが含まれます。

current_secondary_opening_hours[]

OpeningHours

ビジネスの営業時間に関する情報など、今後 7 日間のエントリの配列が含まれます。副業は、ビジネスのメインの営業時間とは異なります。たとえば、レストランはドライブスルーの時間帯やデリバリーの時間帯を副業時間として指定できます。このフィールドに、営業時間の種類のサブフィールドが入力されます。このサブフィールドは、場所の種類に基づいて、事前定義された営業時間の種類のリスト(DRIVE_THROUGH、PICKUP、TAKEOUT など)から取得されます。このフィールドには、特別な営業時間がある日付に設定された、すべての営業時間の special_days サブフィールドが含まれます。

regular_secondary_opening_hours[]

OpeningHours

ビジネスの通常の第 2 営業時間に関する情報のエントリの配列が含まれます。副業は、ビジネスのメインの営業時間とは異なります。たとえば、レストランはドライブスルーの時間帯やデリバリーの時間帯を副業時間として指定できます。このフィールドに入力された値は、type サブフィールドに反映されます。このサブフィールドには、場所のタイプに基づいて、営業時間の種類(DRIVE_THROUGH、PICKUP、TAKEOUT など)の定義済みリストから値が取得されます。

editorial_summary

LocalizedText

場所の概要が含まれています。概要はテキストによる概要で構成され、該当する場合は言語コードも含まれます。概要のテキストはそのまま表示する必要があり、変更や改変はできません。

payment_options

PaymentOptions

施設で利用できるお支払い方法。お支払い方法のデータが利用できない場合は、お支払い方法のフィールドが設定解除されます。

parking_options

ParkingOptions

スポットで提供されている駐車場のオプション。

sub_destinations[]

SubDestination

場所に関連するサブ デスティネーションのリスト。

fuel_options

FuelOptions

ガソリンスタンドで利用できる燃料に関する最新情報。この情報は定期的に更新されます。

ev_charge_options

EVChargeOptions

電気自動車の充電オプションに関する情報。

generative_summary

GenerativeSummary

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の AI 生成の概要。

area_summary

AreaSummary

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所が存在するエリアの AI 生成の概要。

containing_places[]

ContainingPlace

現在の場所が含まれる場所のリスト。

address_descriptor

AddressDescriptor

場所の住所記述子。住所記述子には、ランドマークやエリアを使用して場所を説明するのに役立つ追加情報が含まれます。住所記述子の地域別の対応状況については、https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage をご覧ください。

price_range

PriceRange

場所に関連付けられた価格帯。

utc_offset_minutes

int32

この場所のタイムゾーンが現在 UTC からずれている分数。分単位で表記され、X 時間 15 分など、1 時間未満のオフセットがあるタイムゾーンをサポートします。

user_rating_count

int32

この場所のクチコミの合計数(テキストあり / なし)。

takeout

bool

ビジネスがテイクアウトに対応しているかどうかを指定します。

delivery

bool

ビジネスが配達に対応しているかどうかを指定します。

dine_in

bool

ビジネスが屋内席または屋外席のいずれに対応しているかを指定します。

curbside_pickup

bool

店舗が店頭受け取りをサポートしているかどうかを指定します。

reservable

bool

場所で予約がサポートされているかどうかを指定します。

serves_breakfast

bool

朝食を提供しているかどうかを指定します。

serves_lunch

bool

ランチを提供しているかどうかを指定します。

serves_dinner

bool

ディナーを提供しているかどうかを指定します。

serves_beer

bool

ビールを提供しているかどうかを指定します。

serves_wine

bool

ワインが提供されているかどうかを指定します。

serves_brunch

bool

ブランチを提供しているかどうかを指定します。

serves_vegetarian_food

bool

ベジタリアン料理を提供しているかどうかを指定します。

outdoor_seating

bool

屋外席がある。

live_music

bool

ライブ音楽を提供する場所。

menu_for_children

bool

キッズメニューがある。

serves_cocktails

bool

カクテルを提供する場所。

serves_dessert

bool

デザートを提供している場所。

serves_coffee

bool

コーヒーを提供する場所。

good_for_children

bool

子供連れに適した場所です。

allows_dogs

bool

犬の同伴が許可されている場所。

restroom

bool

トイレがある。

good_for_groups

bool

グループに対応している場所。

good_for_watching_sports

bool

スポーツ観戦に適した場所。

accessibility_options

AccessibilityOptions

場所で利用できるユーザー補助オプションに関する情報。

pure_service_area_business

bool

場所が純粋な非店舗型ビジネスかどうかを示します。純粋な非店舗型ビジネスは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。清掃サービスや配管工事などのビジネスが該当します。これらのビジネスには、Google マップに物理的な住所や所在地が登録されていない場合があります。

AccessibilityOptions

場所で利用できるユーザー補助オプションに関する情報。

フィールド
wheelchair_accessible_parking

bool

車椅子対応の駐車場がある。

wheelchair_accessible_entrance

bool

車椅子対応の入り口がある。

wheelchair_accessible_restroom

bool

車椅子対応のトイレあり。

wheelchair_accessible_seating

bool

車椅子対応の座席がある。

AddressComponent

フォーマットされた住所を構成する構造化コンポーネント(この情報が利用可能な場合)。

フィールド
long_text

string

住所コンポーネントの説明または名前。たとえば、オーストラリアの国コードの住所コンポーネントの long_name は「Australia」になります。

short_text

string

住所コンポーネントの略称(略称がある場合)。たとえば、オーストラリアの国の国コードは「AU」です。

types[]

string

住所コンポーネントのタイプを示す配列。

language_code

string

このコンポーネントの書式設定に使用される言語(CLDR 表記)。

AreaSummary

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所が存在するエリアの AI 生成の概要。

フィールド
content_blocks[]

ContentBlock

エリアの概要を構成するコンテンツ ブロック。各ブロックには、その地域に関する個別のトピックがあります。

flag_content_uri

string

ユーザーが概要に関する問題を報告できるリンク。

アトリビューション

この場所のデータ プロバイダに関する情報。

フィールド
provider

string

プレイスのデータ プロバイダの名前。

provider_uri

string

場所のデータ プロバイダの URI。

BusinessStatus

場所の営業状況。

列挙型
BUSINESS_STATUS_UNSPECIFIED デフォルト値。この値は使用されません。
OPERATIONAL 営業中である。現在営業中とは限らない。
CLOSED_TEMPORARILY 施設は臨時休業中です。
CLOSED_PERMANENTLY 施設が閉業している。

ContainingPlace

この場所が存在する場所に関する情報。

フィールド
name

string

この場所が属する場所のリソース名。

id

string

この場所が属するプレイス ID。

GenerativeSummary

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

場所の AI 生成の概要。

フィールド
overview

LocalizedText

場所の概要。

overview_flag_content_uri

string

概要の概要で問題を報告できるリンク。

description

LocalizedText

場所の詳細な説明。

description_flag_content_uri

string

ユーザーが問題を報告し、説明の概要を入力できるリンク。

references

References

概要の説明の生成に使用される参照。

OpeningHours

場所の営業時間に関する情報。

フィールド
periods[]

Period

1 週間のうち、この場所が営業している期間。期間は、場所のローカル タイムゾーンの日曜日から時系列で指定します。値が空(存在しないわけではない)場合は、改装のため臨時休業中など、営業していない場所を示します。

weekday_descriptions[]

string

この場所の営業時間を説明するローカライズされた文字列(曜日ごとに 1 つの文字列)。時間が不明な場合や、ローカライズされたテキストに変換できなかった場合は空になります。例: 「日: 18:00 ~ 06:00」

secondary_hours_type

SecondaryHoursType

副業時間のタイプを識別するために使用されるタイプ文字列。

special_days[]

SpecialDay

返された営業時間の範囲内にある特別な日の構造化情報。特別な日は、クリスマスなど、場所の営業時間に影響する可能性がある日です。例外的な営業時間がある場合は、current_opening_hours と current_secondary_opening_hours に設定します。

next_open_time

Timestamp

現在の営業時間の次の開始日(最大 7 日後)。このフィールドには、リクエストの処理時に営業時間の期間が有効でない場合のみ値が入力されます。

next_close_time

Timestamp

現在の営業時間の終了日(最大 7 日後)。このフィールドには、リクエストの処理時に営業時間帯が有効な場合にのみ値が入力されます。

open_now

bool

営業時間の期間が現在有効かどうか。通常の営業時間と現在の営業時間の場合、このフィールドは営業しているかどうかを示します。サブ営業時間と現在のサブ営業時間の場合、このフィールドは、この場所のサブ営業時間が有効かどうかを示します。

期間

場所が open_now ステータスのままである期間。

フィールド
open

Point

営業を開始する時間。

close

Point

閉店が開始される時刻。

ポイント

ステータス変更ポイント。

フィールド
date

Date

場所のローカル タイムゾーンでの日付。

truncated

bool

このエンドポイントが切り捨てられたかどうか。切り捨てが発生するのは、実際の時間が、返される時間の範囲外にある場合です。この場合、時間はこれらの境界まで切り捨てられます。これにより、リクエストの日付の午前 0 時から 24 時間以内のデータが返されます。

day

int32

0 ~ 6 の整数で表される曜日。0 は日曜日、1 は月曜日、など

hour

int32

24 時間形式の時間。範囲は 0 ~ 23 です。

minute

int32

分。範囲は 0 ~ 59 です。

SecondaryHoursType

副業時間の種類を識別するために使用されるタイプ。

列挙型
SECONDARY_HOURS_TYPE_UNSPECIFIED 2 番目の時間帯のタイプが指定されていない場合のデフォルト値。
DRIVE_THROUGH 銀行、レストラン、薬局の営業時間。
HAPPY_HOUR ハッピーアワー。
DELIVERY 配達時間。
TAKEOUT テイクアウトの営業時間。
KITCHEN キッチンの時間。
BREAKFAST 朝食の時間。
LUNCH 昼休み。
DINNER 夕食の時間。
BRUNCH ブランチの時間帯。
PICKUP 集荷時間。
ACCESS 保管場所の利用時間。
SENIOR_HOURS シニア向けの特別営業時間。
ONLINE_SERVICE_HOURS オンライン サービスの提供時間。

SpecialDay

返された営業時間の範囲内にある特別な日の構造化情報。特別な日とは、クリスマスなど、場所の営業時間に影響する可能性がある日です。

フィールド
date

Date

特別な日の日付。

ParkingOptions

場所の駐車オプションに関する情報。駐車場は複数のオプションを同時にサポートできます。

フィールド
free_parking_lot

bool

駐車場が無料。

paid_parking_lot

bool

有料駐車場あり。

free_street_parking

bool

路上駐車場が無料です。

paid_street_parking

bool

有料の路上駐車場あり。

valet_parking

bool

係員による駐車サービスあり。

free_garage_parking

bool

屋内駐車場を無料で利用できます。

paid_garage_parking

bool

有料の屋内駐車場を利用できます。

PaymentOptions

施設で利用できるお支払い方法。

フィールド
accepts_credit_cards

bool

クレジット カードによる支払いに対応している場所。

accepts_debit_cards

bool

デビットカードによる支払いが可能です。

accepts_cash_only

bool

支払い方法として現金のみが利用できます。この属性が設定されている場所でも、他の支払い方法を受け付けている場合があります。

accepts_nfc

bool

店舗で NFC 決済が利用可能。

PlusCode

Plus Code(http://plus.codes)は、2 つの形式の場所の参照情報です。14 m x 14 m(8000 分の 1)以下の長方形を定義するグローバル コードと、接頭辞を参照地に置き換えた複合コードです。

フィールド
global_code

string

場所のグローバル(完全)コード(「9FWM33GV+HQ」など)。8000 分の 1 x 8000 分の 1 度(約 14 メートル x 14 メートル)のエリアを表します。

compound_code

string

場所の複合コード(「33GV+HQ, Ramberg, Norway」など)。グローバル コードの接尾辞が含まれ、接頭辞は参照エンティティの形式付きの名前に置き換えられています。

SubDestination

サブ デスティネーションとは、メインのデスティネーションに関連付けられた特定の場所です。空港、国立公園、大学、スタジアムなど、広大な場所や複雑な場所を検索しているユーザーに、より具体的な目的地を提示できます。たとえば、空港のサブ デスティネーションには、関連するターミナルや駐車場が含まれます。サブデスティネーションから返される場所 ID と場所リソース名は、その後の Place Details(新規)リクエストで使用して、サブデスティネーションの表示名や位置情報などの詳細情報を取得できます。

フィールド
name

string

サブデスティネーションのリソース名。

id

string

サブデスティネーションのプレイス ID。

ポリライン

ルート ポリライン。エンコードされたポリラインのみをサポートします。これは文字列として渡すことができ、圧縮が含まれており、損失は最小限に抑えられます。これは Routes API のデフォルト出力です。

フィールド
共用体フィールド polyline_type。ポリラインのタイプをカプセル化します。Routes API の出力はデフォルトで encoded_polyline になります。polyline_type は次のいずれかになります。
encoded_polyline

string

Routes API のデフォルトで返されるエンコードされたポリラインエンコーダデコーダのツールをご覧ください。

PriceLevel

場所の価格帯。

列挙型
PRICE_LEVEL_UNSPECIFIED 場所の料金レベルが指定されていないか不明です。
PRICE_LEVEL_FREE 場所が無料サービスを提供している。
PRICE_LEVEL_INEXPENSIVE 低価格のサービスを提供している。
PRICE_LEVEL_MODERATE 手頃な価格のサービスを提供する場所。
PRICE_LEVEL_EXPENSIVE 高額なサービスを提供している。
PRICE_LEVEL_VERY_EXPENSIVE 非常に高価なサービスを提供している場所。

PriceRange

場所に関連付けられた価格帯。end_price は未設定にすることもできます。この場合、上限のない範囲を指定します(例: 「$100 以上」)。

フィールド
start_price

Money

価格帯の下限(両端を含む)。価格はこの金額以上である必要があります。

end_price

Money

価格帯の上限(この値は含まれません)。価格はこの金額より低くする必要があります。

参照

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

生成コンテンツが関連付けられている参照。

フィールド
reviews[]

Review

参照として使用できるレビュー。

places[]

string

参照先の場所のリソース名のリスト。この名前は、Place リソース名を受け入れる他の API で使用できます。

確認

場所のレビューに関する情報。

フィールド
name

string

このプレイスレビューを表す参照。このプレイスレビューを再度検索するために使用できます(API の「リソース」名: places/{place_id}/reviews/{review})。

relative_publish_time_description

string

書式設定された最近の時点の文字列。レビューの時点を現在の時刻と比較して、言語と国に適した形式で表します。

text

LocalizedText

ローカライズされたレビューのテキスト。

original_text

LocalizedText

レビューのテキスト(元の言語)。

rating

double

1.0 ~ 5.0 の数値(星の数)。

author_attribution

AuthorAttribution

このレビューの投稿者。

publish_time

Timestamp

レビューのタイムスタンプ。

flag_content_uri

string

ユーザーがレビューに関する問題を報告できるリンク。

google_maps_uri

string

Google マップでクチコミを表示するためのリンク。

RouteModifiers

ルートの計算時に満たす一連のオプション条件をカプセル化します。

フィールド
avoid_tolls

bool

省略可。true に設定すると、合理的な場合は有料道路を避け、有料道路を含まないルートを優先します。DRIVETWO_WHEELER TravelMode にのみ適用されます。

avoid_highways

bool

省略可。true に設定すると、合理的な場合は高速道路を回避し、高速道路を含まないルートを優先します。DRIVETWO_WHEELER TravelMode にのみ適用されます。

avoid_ferries

bool

省略可。true に設定すると、フェリーが含まれないルートを優先し、フェリーが含まれるルートを回避します。DRIVETWO_WHEELER TravelMode にのみ適用されます。

avoid_indoor

bool

省略可。true に設定すると、合理的な場合は屋内を避けてルートを設定し、屋内ナビゲーションを含まないルートを優先します。WALK TravelMode にのみ適用されます。

RoutingParameters

レスポンス内のプレイスへのルート計算を構成するパラメータ(ルート上(結果のランキングに影響)と結果の所要時間の計算の両方)。

フィールド
origin

LatLng

省略可。ポリラインで定義された起点をオーバーライドする明示的なルーティング起点。デフォルトでは、ポリラインの始点が使用されます。

travel_mode

TravelMode

省略可。移動手段。

route_modifiers

RouteModifiers

省略可。ルート修飾子。

routing_preference

RoutingPreference

省略可。ルーティングの概要の計算方法を指定します。サーバーは、選択したルーティング設定を使用してルートを計算しようとします。トラフィック アウェア ルーティングの設定は、DRIVE または TWO_WHEELER travelMode でのみ使用できます。

RoutingPreference

ルートの計算時に考慮する要素を指定する値のセット。

列挙型
ROUTING_PREFERENCE_UNSPECIFIED ルーティングの優先順位が指定されていません。デフォルトは TRAFFIC_UNAWARE です。
TRAFFIC_UNAWARE リアルタイムの交通状況を考慮せずにルートを計算します。交通状況が重要でない、または適用されない場合に適しています。この値を使用すると、レイテンシが最も低くなります。注: TravelModeDRIVETWO_WHEELER の場合、ルートと所要時間は、現在の道路状況ではなく、道路網と平均的な交通状況(時間的な要素を考慮に入れない)に基づいて選択されます。そのため、一時的に通行止めとなっている道路がルートに含まれることがあります。道路網における状況の変化、平均的な交通状況の最新情報、サービスの分散性などにより、リクエストの結果が時間の経過とともに変化する可能性があります。また、結果は、ほぼ同等のルートでも、時刻やリクエストの頻度によって異なる場合があります。
TRAFFIC_AWARE リアルタイムの交通状況を考慮してルートを計算します。TRAFFIC_AWARE_OPTIMAL とは対照的に、レイテンシを大幅に削減するために最適化が適用されます。
TRAFFIC_AWARE_OPTIMAL ほとんどのパフォーマンス最適化を適用せずに、リアルタイムの交通状況を考慮してルートを計算します。この値を使用すると、レイテンシが最も高くなります。

RoutingSummary

ルーティングの出発地からレスポンスの場所までの所要時間と距離、およびその場所から目的地までの 2 番目の区間(リクエストされた場合)。注: リクエストに routingParameters.origin パラメータまたは searchAlongRouteParameters.polyline.encodedPolyline パラメータを含めずにフィールドマスクに routingSummaries を追加すると、エラーが発生します。

フィールド
legs[]

Leg

旅行の区間。

設定した出発地から移動時間と距離を計算する場合、legs には、出発地から目的地までの所要時間と距離を含む単一の区間が含まれます。経路沿いで検索を行うと、legs には 2 つの区間が含まれます。1 つは出発地から場所への区間、もう 1 つは場所から目的地への区間です。

directions_uri

string

指定されたルート概要のウェイポイントを使用して Google マップで経路を表示するためのリンク。このリンクで生成されたルートが、ルーティングの概要の生成に使用されたルートと同じであるとは限りません。このリンクは、リクエストで指定された情報(routingParameterssearchAlongRouteParameters など)を使用して、ルート案内リンクを生成します。

区間は、ある場所から別の場所へのルートの 1 つの部分です。

フィールド
duration

Duration

この区間の所要時間。

distance_meters

int32

この旅行区間の距離。

SearchNearbyRequest

付近を検索するためのリクエスト プロトコル。

フィールド
language_code

string

場所の詳細は、優先言語で表示されます(利用可能な場合)。言語コードが指定されていないか認識されない場合は、任意の言語の場所の詳細が返されます。そのような詳細が存在する場合は、英語が優先されます。

現在サポートされている言語の一覧: https://developers.google.com/maps/faq#languagesupport

region_code

string

リクエストの送信元のロケーションの Unicode 国/リージョン コード(CLDR)。このパラメータは、地域固有の場所の名前など、場所の詳細を表示するために使用されます(利用可能な場合)。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。

詳細については、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。

現在、3 桁の地域コードはサポートされていません。

included_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types に記載されている、含まれる場所のタイプ(「restaurant」や「gas_station」など)。

表 A の中から最大 50 種類を指定できます。

競合するタイプ(included_types と excluded_types の両方に同じタイプが含まれている)がある場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定してプレイスタイプを指定した場合、すべての制限を満たすプレイスのみが返されます。たとえば、{included_types = ["restaurant"], excluded_primary_types = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。

excluded_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types の除外対象の場所のタイプ(例: 「restaurant」や「gas_station」)。

表 A の中から最大 50 種類を指定できます。

クライアントが included_types(レストランなど)と excluded_types(カフェなど)の両方を指定した場合、レスポンスにはレストランでカフェではない場所が含まれます。レスポンスには、included_types の 1 つ以上と一致し、excluded_types のいずれにも一致しない場所が含まれます。

競合するタイプ(included_types と excluded_types の両方に同じタイプが含まれている)がある場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定してプレイスタイプを指定した場合、すべての制限を満たすプレイスのみが返されます。たとえば、{included_types = ["restaurant"], excluded_primary_types = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。

included_primary_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types に記載されている主な場所の種類(「restaurant」や「gas_station」など)が含まれている。1 つの場所に関連付けることができるのは、サポートされている種類のテーブルから 1 つの主な種類のみです。

表 A の中から最大 50 種類を指定できます。

競合するプライマリ タイプ(included_primary_types と excluded_primary_types の両方にタイプが存在する場合)がある場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定してプレイスタイプを指定した場合、すべての制限を満たすプレイスのみが返されます。たとえば、{included_types = ["restaurant"], excluded_primary_types = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。

excluded_primary_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types から除外された主なプレイスタイプ(「restaurant」や「gas_station」など)。

表 A の中から最大 50 種類を指定できます。

競合するプライマリ タイプ(included_primary_types と excluded_primary_types の両方にタイプが存在する場合)がある場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定してプレイスタイプを指定した場合、すべての制限を満たすプレイスのみが返されます。たとえば、{included_types = ["restaurant"], excluded_primary_types = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。

max_result_count

int32

返される結果の最大数。1 ~ 20(デフォルト)の範囲で指定してください。数値が設定されていない場合は、上限にフォールバックします。数値が負の値に設定されているか、上限を超えている場合は、INVALID_ARGUMENT エラーが返されます。

location_restriction

LocationRestriction

必須。検索するリージョン。

rank_preference

RankPreference

レスポンスで結果をランク付けする方法。

routing_parameters

RoutingParameters

省略可。検索結果へのルーティングに影響するパラメータ。

LocationRestriction

検索するリージョン。

フィールド

共用体フィールド type

type は次のいずれかになります。

circle

Circle

中心点と半径で定義された円。

RankPreference

レスポンスで結果をランク付けする方法。

列挙型
RANK_PREFERENCE_UNSPECIFIED RankPreference の値が設定されていません。デフォルトでは、人気度によるランキングが使用されます。
DISTANCE 距離で結果をランク付けします。
POPULARITY 人気度順に結果をランク付けします。

SearchNearbyResponse

付近を検索のレスポンス プロトコル。

フィールド
places[]

Place

場所の種類、場所の数、特定の地域の制限など、ユーザーの要件を満たす場所のリスト。

routing_summaries[]

RoutingSummary

ルーティングの概要のリスト。各エントリは、places フィールドの同じインデックス内の対応する場所に関連付けられます。いずれかの場所でルーティングの概要が利用できない場合は、空のエントリが含まれます。このリストには、リクエストされた場所のリストと同じ数のエントリが必要です。

SearchTextRequest

SearchText のリクエスト プロトコル。

フィールド
text_query

string

必須。テキスト検索用のテキストクエリ。

language_code

string

場所の詳細は、優先言語で表示されます(利用可能な場合)。言語コードが指定されていないか認識されない場合は、任意の言語の場所の詳細が返されます。そのような詳細が存在する場合は、英語が優先されます。

現在サポートされている言語の一覧: https://developers.google.com/maps/faq#languagesupport

region_code

string

リクエストの送信元のロケーションの Unicode 国/リージョン コード(CLDR)。このパラメータは、地域固有の場所の名前など、場所の詳細を表示するために使用されます(利用可能な場合)。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。

詳細については、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。

現在、3 桁の地域コードはサポートされていません。

rank_preference

RankPreference

レスポンスで結果をランク付けする方法。

included_type

string

リクエストされたスポットタイプ。サポートされているタイプの一覧: https://developers.google.com/maps/documentation/places/web-service/place-types。含めることができるのは 1 つのタイプのみです。

open_now

bool

現在営業中の場所に検索を制限するために使用します。デフォルトは false です。

min_rating

double

平均ユーザー評価がこの上限を下回る結果を除外します。有効な値は、0.5 のケイデンスで 0 ~ 5 の範囲(0、0.5、1.0、...、5.0)の浮動小数点数である必要があります。入力評価は 0.5 の最も近い数値に切り上げられます(天井)。たとえば、評価が 0.6 の場合、評価が 1.0 未満の結果はすべて除外されます。

max_result_count
(deprecated)

int32

非推奨: 代わりに、page_size を使用してください。

ページごとに返される結果の最大数。利用可能な結果の数が max_result_count より大きい場合、next_page_token が返されます。このトークンは page_token に渡して、後続のリクエストで結果の次のページを取得できます。0 または値が指定されていない場合は、デフォルトの 20 が使用されます。最大値は 20 です。20 を超える値は 20 に強制変換されます。負の値を指定すると、INVALID_ARGUMENT エラーが返されます。

max_result_countpage_size の両方が指定されている場合、max_result_count は無視されます。

page_size

int32

省略可。ページごとに返される結果の最大数。利用可能な結果の数が page_size より大きい場合、next_page_token が返されます。このトークンは page_token に渡して、後続のリクエストで結果の次のページを取得できます。0 または値が指定されていない場合は、デフォルトの 20 が使用されます。最大値は 20 です。20 を超える値は 20 に設定されます。負の値を指定すると、INVALID_ARGUMENT エラーが返されます。

max_result_countpage_size の両方が指定されている場合、max_result_count は無視されます。

page_token

string

省略可。前回の TextSearch 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページネーションを行う場合、TextSearch に指定する page_tokenpage_sizemax_result_count 以外のすべてのパラメータは、ページトークンを提供した最初の呼び出しと一致している必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

price_levels[]

PriceLevel

特定の価格帯としてマークされている宿泊施設に検索を限定するために使用します。料金レベルは自由に組み合わせて選択できます。デフォルトでは、すべての価格帯が選択されます。

strict_type_filtering

bool

included_type の厳格な型フィルタを設定するために使用します。true に設定すると、同じタイプの結果のみが返されます。デフォルトは false です。

location_bias

LocationBias

検索するリージョン。この位置はバイアスとして機能し、指定した位置の周辺の結果が返される可能性があります。location_restriction と同時に設定することはできません。

location_restriction

LocationRestriction

検索するリージョン。この場所は制限として機能し、指定された場所外の結果は返されません。location_bias と同時に設定することはできません。

ev_options

EVOptions

省略可。場所検索リクエストで検索可能な EV オプションを設定します。

routing_parameters

RoutingParameters

省略可。結果へのルーティング用の追加パラメータ。

search_along_route_parameters

SearchAlongRouteParameters

省略可。ルート沿いの検索用の追加パラメータ proto。

include_pure_service_area_businesses

bool

省略可。このフィールドが true に設定されている場合は、純粋な非店舗型ビジネスを含めます。純粋な非店舗型ビジネスは、客先に出向いてサービスを提供し、ビジネス拠点の住所では接客しないビジネスです。清掃サービスや配管工事などのビジネスが該当します。これらのビジネスには、Google マップに物理的な住所または所在地がありません。これらのビジネス拠点については、Places から locationplus_code などの位置情報関連のフィールドが返されません。

EVOptions

場所の検索リクエストで検索可能な EV オプション。

フィールド
minimum_charging_rate_kw

double

省略可。最低限必要な充電速度(キロワット)。指定した料金より低い充電料金の場所は除外されます。

connector_types[]

EVConnectorType

省略可。優先される EV コネクタの種類のリスト。リストに表示されているコネクタ タイプをサポートしていない場所は除外されます。

LocationBias

検索するリージョン。この位置はバイアスとして機能し、指定した位置の周辺の結果が返される可能性があります。

フィールド

共用体フィールド type

type は次のいずれかになります。

rectangle

Viewport

北東と南西の角で定義された長方形のボックス。rectangle.high() は、長方形ビューポートの北東の点である必要があります。rectangle.low() は長方形ビューポートの南西の端である必要があります。rectangle.low().latitude()rectangle.high().latitude() より大きくすることはできません。この場合、緯度の範囲は空になります。長方形ビューポートの幅は 180 度以下にする必要があります。

circle

Circle

中心点と半径で定義された円。

LocationRestriction

検索するリージョン。この場所は制限として機能し、指定された場所外の結果は返されません。

フィールド

共用体フィールド type

type は次のいずれかになります。

rectangle

Viewport

北東と南西の角で定義された長方形のボックス。rectangle.high() は、長方形ビューポートの北東の点である必要があります。rectangle.low() は長方形ビューポートの南西の端である必要があります。rectangle.low().latitude()rectangle.high().latitude() より大きくすることはできません。この場合、緯度の範囲は空になります。長方形ビューポートの幅は 180 度以下にする必要があります。

RankPreference

レスポンスで結果をランク付けする方法。

列挙型
RANK_PREFERENCE_UNSPECIFIED 「ニューヨークのレストラン」などのカテゴリ検索の場合、デフォルトは RELEVANCE です。「Mountain View, CA」などのカテゴリ外のクエリの場合は、rankPreference を未設定のままにすることをおすすめします。
DISTANCE 距離で結果をランク付けします。
RELEVANCE 結果は関連性に基づいてランク付けされます。並べ替え順序は通常のランキング スタックによって決定されます。

SearchAlongRouteParameters

検索するルートを定義する、Routes API から事前計算されたポリラインを指定します。ルート沿いの検索は、locationBias リクエスト オプションまたは locationRestriction リクエスト オプションを使用して検索結果をバイアスする方法と似ています。ただし、locationBias オプションと locationRestriction オプションでは地域を指定して検索結果を偏らせることができますが、このオプションではルート沿いに結果を偏らせることができます。

結果は指定されたルートに沿っているとは限らず、ポリラインで定義された検索エリア内で、出発地から目的地までの最小迂回時間に基づいて、locationBias または locationRestriction でランク付けされます。特に、指定されたポリラインで出発地から目的地までの最適なルートが定義されていない場合、結果は代替ルート上にある可能性があります。

フィールド
polyline

Polyline

必須。ルートのポリライン。

SearchTextResponse

SearchText のレスポンス プロトコル。

フィールド
places[]

Place

ユーザーのテキスト検索条件に一致する場所のリスト。

routing_summaries[]

RoutingSummary

ルーティングの概要のリスト。各エントリは、places フィールドの同じインデックス内の対応する場所に関連付けられます。いずれかの場所でルーティングの概要が利用できない場合は、空のエントリが含まれます。このリストには、リクエストされた場所のリストと同じ数のエントリが含まれます。

contextual_contents[]

ContextualContent

試験運用版: 詳しくは、https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative をご覧ください。

コンテキスト コンテンツのリスト。各エントリは、場所フィールドの同じインデックス内の対応する場所に関連付けられています。リクエスト内の text_query に関連するコンテンツが優先されます。いずれかの場所でコンテキスト コンテンツが利用できない場合は、コンテキスト コンテンツ以外のコンテンツが返されます。この場所でコンテンツを利用できない場合にのみ空になります。このリストには、リクエストされた場所のリストと同じ数のエントリが含まれます。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドが省略されるか空の場合、後続のページはありません。

search_uri

string

リンクを使用すると、ユーザーはリクエストで指定したテキスト クエリを使用して Google マップで検索できます。

TravelMode

移動手段のオプション。これらのオプションは、Routes API が提供する機能に対応しています。

列挙型
TRAVEL_MODE_UNSPECIFIED 移動手段が指定されていません。デフォルトは DRIVE です。
DRIVE 乗用車で移動する。
BICYCLE 自転車で移動する。search_along_route_parameters ではサポートされていません。
WALK 歩いて移動する。search_along_route_parameters ではサポートされていません。
TWO_WHEELER スクーターやオートバイなど、あらゆる種類の原動機付き 2 輪車。これは、人力による交通機関を対象とする BICYCLE の移動手段とは異なります。search_along_route_parameters ではサポートされていません。二輪車が一般的な多くの国と地域に記載されている国でのみサポートされます。