プレイス ID

プラットフォームを選択: Android iOS JavaScript ウェブサービス

プレイス ID は、Google プレイスのデータベースおよび Google マップで、特定の場所を一意に識別する ID です。プレイス ID は、次の Maps API へのリクエストで承認されます。

  • Geocoding API ウェブサービス、ジオコーディング サービス、Maps JavaScript API でプレイス ID の住所を取得する。
  • Routes API および Directions API のウェブサービス、ルートサービス、Maps JavaScript API で出発地、目的地、中間地点を指定する。
  • Routes API および Distance Matrix API のウェブサービス、Distance Matrix Service、Maps JavaScript API で出発地と目的地を指定する。
  • Places API ウェブサービス、Places SDK for Android、Places SDK for iOS、プレイス ライブラリで Place Details を取得する。
  • Maps Embed API でプレイス ID パラメータを使用する。
  • マップの URL で検索クエリを取得する。
  • Roads API で制限速度を表示する。
  • 境界線用データドリブン スタイル設定における境界ポリゴンの検索、スタイル設定を行う。

特定のプレイス ID の取得

特定の場所のプレイス ID を検索する場合は、以下のプレイス ID 検索ツールを使用して場所を検索し、ID を取得してください。

または、Maps JavaScript API のドキュメントにあるコードを使用して、プレイス ID 検索ツールを表示することもできます。

概要

プレイス ID は、場所を一意に識別するテキスト表記の ID です。識別子の長さはさまざまです(プレイス ID の長さに上限はありません)。例:

  • ChIJgUbEo8cfqokR5lP9_Wh_DaM
  • GhIJQWDl0CIeQUARxks3icF8U8A
  • EicxMyBNYXJrZXQgU3QsIFdpbG1pbmd0b24sIE5DIDI4NDAxLCBVU0EiGhIYChQKEgnRTo6ixx-qiRHo_bbmkCm7ZRAN
  • EicxMyBNYXJrZXQgU3QsIFdpbG1pbmd0b24sIE5DIDI4NDAxLCBVU0E
  • IhoSGAoUChIJ0U6OoscfqokR6P225pApu2UQDQ

プレイス ID は、お店やサービス、名所、公園、交差点など、ほとんどの場所に利用できます。同じ場所や拠点に、複数のプレイス ID が付与されている場合もあります。プレイス ID は今後変更される可能性があります。

Places API と複数の Google Maps Platform API で、同じプレイス ID を使用できます。たとえば、Places APIMaps JavaScript APIGeocoding APIMaps Embed APIRoads API で、同じプレイス ID を使用して場所を参照することができます。

プレイス ID を使って場所の詳細を取得する

一般的にプレイス ID は、(たとえば Places API、または Maps JavaScript API のプレイス ライブラリを利用して)場所を検索し、返されたプレイス ID で場所の詳細を取得するために使用されます。プレイス ID を保存しておき、その ID を使って後で同じ場所の詳細を取得することも可能です。詳しくは、この後のプレイス ID の保存についての説明をご覧ください。

Places SDK for iOS の使用例

プレイス ID は、場所を一意に識別するテキスト表記の ID です。Places SDK for iOS では、GMSPlace オブジェクトから場所の ID を取得できます。プレイス ID を保存しておくと、後でその ID を使用して GMSPlace オブジェクトを再度取得できます。

ID で場所を取得するには、GMSPlacesClient fetchPlaceFromPlaceID: を呼び出して、次のパラメータを渡します。

  • プレイス ID を含む文字列。
  • 返されるデータ型を指定する 1 つ以上の GMSPlaceField
  • オートコンプリート クエリを完了するために呼び出しが行われた場合は、セッション トークン。それ以外の場合は、nil を渡します。
  • 結果を処理する GMSPlaceResultCallback

API は指定されたコールバック メソッドを呼び出し、GMSPlace オブジェクトを渡します。場所が見つからない場合、プレイス オブジェクトは nil になります。

Swift

// A hotel in Saigon with an attribution.
let placeID = "ChIJV4k8_9UodTERU5KXbkYpSYs"

// Specify the place data types to return.
let fields: GMSPlaceField = GMSPlaceField(rawValue: UInt(GMSPlaceField.name.rawValue) |
  UInt(GMSPlaceField.placeID.rawValue))!

placesClient?.fetchPlace(fromPlaceID: placeID, placeFields: fields, sessionToken: nil, callback: {
  (place: GMSPlace?, error: Error?) in
  if let error = error {
    print("An error occurred: \(error.localizedDescription)")
    return
  }
  if let place = place {
    self.lblName?.text = place.name
    print("The selected place is: \(place.name)")
  }
})

Objective-C

// A hotel in Saigon with an attribution.
NSString *placeID = @"ChIJV4k8_9UodTERU5KXbkYpSYs";

// Specify the place data types to return.
GMSPlaceField fields = (GMSPlaceFieldName | GMSPlaceFieldPlaceID);

[_placesClient fetchPlaceFromPlaceID:placeID placeFields:fields sessionToken:nil callback:^(GMSPlace * _Nullable place, NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"An error occurred %@", [error localizedDescription]);
    return;
  }
  if (place != nil) {
    NSLog(@"The selected place is: %@", [place name]);
  }
}];

プレイス ID を後で使えるように保存する

プレイス ID は、Google Maps Platform 利用規約のセクション 3.2.3(b)で定められているキャッシュ制限の対象外となります。このため、プレイス ID 値は後で使用するために保存しても問題ありません。

保存済みのプレイス ID を更新する

12 か月以上経過しているプレイス ID は、更新することをおすすめします。プレイス ID は無料で更新できます。更新する場合は、fields パラメータの GMSPlaceFieldPlaceID フィールドのみを指定して Place Details リクエストを実行します。これにより、 Places Details - ID Refresh の SKU がトリガーされます。

このリクエストによって NOT_FOUND ステータス コードが返されることもあります。対策として、それぞれのプレイス ID を返した元のリクエストを保存しておくことをおすすめします。プレイス ID が無効になった場合は、リクエストを再発行して新しい結果を取得することができます。この検索結果には、元の場所が含まれているとは限りません。ただし、このリクエストは課金対象です。

プレイス ID 使用時のエラーコード

INVALID_REQUEST ステータス コードは、指定されたプレイス ID が無効であることを意味します。プレイス ID が不完全、または変更され、正しくない場合は、INVALID_REQUEST が返されることがあります。

NOT_FOUND ステータス コードは、指定されたプレイス ID が古くなっていることを意味します。お店やサービスが閉業した場合や移転した場合、プレイス ID が古くなることがあります。プレイス ID は、Google マップのデータベースの大規模な更新によって変わることもあります。そのような場合、場所には新しいプレイス ID が付与され、古い ID は NOT_FOUND レスポンスを返します。

特に、プレイス ID の種類によっては、NOT_FOUND レスポンスが返される場合があります。また、API によって、レスポンスで別のプレイス ID が返される場合もあります。これに該当するのは次のようなプレイス ID です。

  • Google マップ上に正確な住所はないものの、住所の範囲から推定される番地。
  • リクエストで都市や地域区分も指定されている場合の長いルートの区間。
  • 交差点。
  • subpremise タイプの住所コンポーネントが含まれる場所。

ほとんどの場合、こうした場所の ID は長い文字列になります(プレイス ID の長さに上限はありません)。次に例を示します。

EpID4LC14LC_4LCo4LCv4LGN4LCo4LCX4LCw4LGNIC0g4LC44LGI4LCm4LGN4LCs4LC-4LCm4LGNIOCwsOCxi-CwoeCxjeCwoeCxgSAmIOCwteCwv-CwqOCwr-CxjSDgsKjgsJfgsLDgsY0g4LCu4LGG4LCv4LC_4LCo4LGNIOCwsOCxi-CwoeCxjeCwoeCxgSwg4LC14LC_4LCo4LCv4LGNIOCwqOCwl-CwsOCxjSDgsJXgsL7gsLLgsKjgsYAsIOCwsuCwleCxjeCwt-CxjeCwruCwv-CwqOCwl-CwsOCxjSDgsJXgsL7gsLLgsKjgsYAsIOCwuOCwsOCxguCwsOCxjSDgsKjgsJfgsLDgsY0g4LC14LGG4LC44LGN4LCf4LGNLCDgsLjgsK_gsYDgsKbgsL7gsKzgsL7gsKbgsY0sIOCwueCxiOCwpuCwsOCwvuCwrOCwvuCwpuCxjSwg4LCk4LGG4LCy4LCC4LCX4LC-4LCjIDUwMDA1OSwg4LCt4LC-4LCw4LCk4LCm4LGH4LC24LCCImYiZAoUChIJ31l5uGWYyzsR9zY2qk9lDiASFAoSCd9ZebhlmMs7Efc2NqpPZQ4gGhQKEglDz61OZpjLOxHgDJCFY-o1qBoUChIJi37TW2-YyzsRr_uv50r7tdEiCg1MwFcKFS_dyy4