Method: geocode.destinations.searchDestinations

Metode ini melakukan pencarian tujuan dan menampilkan daftar tujuan.

Permintaan HTTP

POST https://geocode.googleapis.com/v4beta/geocode/destinations

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of mutually exclusive fields.
}
Kolom
travelModes[]

enum (NavigationPoint.TravelMode)

Opsional. Moda transportasi untuk memfilter titik navigasi. Hal ini memengaruhi kolom navigationPoints yang ditampilkan dalam respons. Jika kosong, titik navigasi semua moda transportasi akan ditampilkan.
languageCode

string

Opsional. Bahasa yang digunakan untuk menampilkan hasil.
regionCode

string

Opsional. Kode wilayah. Kode wilayah, yang ditetapkan sebagai nilai dua karakter ccTLD ("domain level teratas"). Parameter ini memengaruhi hasil berdasarkan hukum yang berlaku. Parameter ini juga memengaruhi, tetapi tidak sepenuhnya membatasi, hasil dari layanan.

Membuat kueri untuk tujuan utama. Lokasi ini dapat berupa tempat, alamat yang ditentukan sepenuhnya, atau lokasi LatLng. Beberapa tempat dan alamat dengan informasi minimal tidak akan dapat dijadikan tujuan.

Tujuan dibuat berdasarkan kueri utama yang ditentukan.

Catatan: hanya tempat dan alamat yang dapat memiliki tujuan navigasi yang didukung. Misalnya, tempat yang mewakili rumah atau kompleks apartemen dapat digunakan sebagai kueri utama, tetapi tempat yang mewakili lokalitas atau wilayah administratif tidak dapat digunakan sebagai kueri utama. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
place

string

Nama resource tempat, dalam format places/{placeId}.
addressQuery

object (SearchDestinationsRequest.AddressQuery)

Alamat.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

Lokasi presisi.
Akhir kolom yang saling eksklusif.

Isi respons

Pesan respons untuk DestinationService.SearchDestinations.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
Kolom
destinations[]

object (Destination)

Daftar tujuan.

Layanan akan menampilkan satu hasil jika tujuan utama dapat diidentifikasi secara jelas dari kueri utama. Jika tidak, layanan mungkin menampilkan beberapa hasil untuk disambiguasi atau tidak menampilkan hasil sama sekali.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

SearchDestinationsRequest.AddressQuery

Alamat yang ingin Anda telusuri. Tetapkan alamat sesuai dengan format yang digunakan oleh layanan pos nasional untuk negara yang bersangkutan.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of mutually exclusive fields.
}
Kolom
Kueri alamat. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
address

object (PostalAddress)

Alamat dalam format alamat pos.
addressQuery

string

Alamat jalan yang diformat sebagai satu baris.
Akhir kolom yang saling eksklusif.

SearchDestinationsRequest.LocationQuery

Kueri lokasi untuk mengidentifikasi tujuan utama di sekitar.

Catatan: jika kueri lokasi berada di dalam bangunan yang berisi sub-premis, tempat utama yang ditampilkan mungkin adalah sub-premis. Dalam kasus ini, kolom containingPlaces akan menyertakan bangunan.

Representasi JSON 
{
  "placeFilter": {
    object (SearchDestinationsRequest.LocationQuery.PlaceFilter)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (LatLng)
  }
  // End of mutually exclusive fields.
}
Kolom
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

Opsional. Filter yang akan diterapkan ke kandidat tujuan.
Kueri lokasi. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
location

object (LatLng)

Lokasi LatLng yang akurat.
Akhir kolom yang saling eksklusif.

SearchDestinationsRequest.LocationQuery.PlaceFilter

Filter yang akan diterapkan ke kandidat tujuan.

Representasi JSON 
{
  "structureType": enum (PlaceView.StructureType),
  "addressability": enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)
}
Kolom
structureType

enum (PlaceView.StructureType)

Opsional. Jika ditentukan, semua tujuan dijamin memiliki tempat utama dengan jenis struktur ini. Hal ini dapat mengakibatkan pemfilteran beberapa tujuan, atau pengaburan/penyempurnaan tujuan yang ditampilkan.

Misalnya, jika GROUNDS ditentukan, semua tujuan yang ditampilkan akan memiliki tempat utama dengan jenis struktur GROUNDS. Hal ini dapat mengakibatkan pemfilteran beberapa tujuan yang bukan bagian dari area, atau dalam memperluas tujuan yang ditampilkan ke tingkat area.

Penggunaan lain dari kolom ini adalah untuk mengekstrak poligon tampilan bangunan dengan lebih mudah. Misalnya, jika BUILDING ditentukan, poligon tampilan tempat utama akan ditujukan untuk bangunan di lokasi yang ditentukan.
addressability

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

Opsional. Jika ditentukan, hanya menampilkan tujuan yang memenuhi kriteria kemampuan alamat yang sesuai.

PlaceView.StructureType

Jenis struktur yang diwakili oleh tempat ini.

Enum
STRUCTURE_TYPE_UNSPECIFIED Tidak digunakan.
POINT Lokasi titik.
SECTION Subbagian bangunan.
BUILDING Bangunan.
GROUNDS Area luas yang biasanya berisi beberapa bangunan, seperti kampus universitas, kompleks apartemen, atau pusat perbelanjaan.

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

Menentukan opsi untuk pemfilteran kemampuan alamat. Nilai baru mungkin akan ditambahkan pada masa mendatang.

Enum
ADDRESSABILITY_UNSPECIFIED Jika tidak ditentukan, layanan akan memilih default yang sesuai.
ANY Kemampuan untuk dijangkau bukanlah kriteria pemfilteran. Tujuan ditampilkan terlepas dari apakah tujuan tersebut dapat dijangkau atau tidak.
PRIMARY Semua tujuan yang ditampilkan akan memiliki tempat utama dengan alamat atau nama tingkat jalan.
WEAK Semua tujuan yang ditampilkan akan memiliki tempat utama atau subtujuan dengan alamat atau nama tingkat jalan.

Destination

Tujuan. Hal ini mencakup tempat utama, tempat terkait, pintu masuk, dan titik navigasi.

Representasi JSON 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
Kolom
primary

object (PlaceView)

Tempat utama yang diidentifikasi oleh primary_query dalam permintaan.
containingPlaces[]

object (PlaceView)

Tempat yang kurang presisi yang berisi tempat utama. Misalnya, kompleks apartemen yang berisi bangunan ini.
subDestinations[]

object (PlaceView)

Sub-tujuan yang lebih presisi dari tempat utama. Misalnya, unit yang terdapat dalam bangunan.

Catatan: dibandingkan dengan SubDestination yang ditampilkan oleh Places API, daftar sub-tujuan ini lebih lengkap, dan setiap sub-tujuan berisi lebih banyak informasi.
landmarks[]

object (Landmark)

Tempat terkenal yang dapat digunakan untuk menginformasikan lokasi tujuan atau membantu kedatangan.
entrances[]

object (Entrance)

Pintu masuk untuk tujuan ini.
navigationPoints[]

object (NavigationPoint)

Titik navigasi untuk tujuan ini.

PlaceView

Merepresentasikan tampilan Tempat di Places API. API ini juga memberikan informasi tambahan khusus untuk tujuan, seperti jenis struktur dan poligon tampilan.

Dalam beberapa kasus, PlaceView dengan ID tempat yang sama mungkin berbeda dari yang ditampilkan oleh Places API untuk kolom types dan displayName.

Representasi JSON 
{
  "place": string,
  "placeId": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  },
  "addressComponents": [
    {
      object (PlaceView.AddressComponent)
    }
  ]
}
Kolom
place

string

Nama resource Tempat ini, dalam format places/{placeId}. Dapat digunakan untuk mencari Tempat.
placeId

string

ID unik tempat.
displayName

object (LocalizedText)

Deskripsi tempat yang dapat dibaca manusia. Misalnya, "Gerbang B", "McDonalds"
primaryType

string

Jenis tempat utama untuk tempat ini. Lihat https://developers.google.com/maps/documentation/places/web-service/place-types untuk mengetahui daftar kemungkinan nilai.

Catatan: Kolom ini tidak selalu diisi. Bersiaplah untuk menggunakan kolom types dalam situasi tersebut.
types[]

string

Semua jenis tempat terkait dari tempat ini. Lihat https://developers.google.com/maps/documentation/places/web-service/place-types untuk mengetahui daftar kemungkinan nilai.
formattedAddress

string

Alamat satu baris.
postalAddress

object (PostalAddress)

Alamat terstruktur.
structureType

enum (PlaceView.StructureType)

Jenis struktur yang sesuai dengan tempat ini.
location

object (LatLng)

Lokasi tempat ini. Untuk tempat dengan poligon tampilan, ini dapat merepresentasikan tempat yang baik untuk menempatkan penanda di peta.
displayPolygon

object (Struct format)

Garis batas poligon tempat dalam format GeoJSON, menggunakan format RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Catatan: Format RFC 7946 mendukung MultiPolygon, sehingga satu objek displayPolygon dapat mewakili beberapa poligon.
addressComponents[]

object (PlaceView.AddressComponent)

Komponen berulang untuk setiap tingkat lokalitas.

PlaceView.AddressComponent

Komponen terstruktur yang membentuk alamat yang diformat, jika informasi ini tersedia.

Representasi JSON 
{
  "longText": string,
  "shortText": string,
  "types": [
    string
  ],
  "languageCode": string
}
Kolom
longText

string

Deskripsi teks lengkap atau nama komponen alamat. Misalnya, komponen alamat untuk negara Australia mungkin memiliki nama panjang "Australia".
shortText

string

Nama tekstual yang disingkat untuk komponen alamat, jika tersedia. Misalnya, komponen alamat untuk negara Australia mungkin memiliki nama pendek "AU".
types[]

string

Array yang menunjukkan jenis komponen alamat.

Nilai ini diambil dari tabel Jenis alamat dan jenis komponen alamat yang digunakan oleh Places API: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
languageCode

string

Bahasa yang digunakan untuk memformat komponen ini, dalam notasi CLDR.

Penanda

Tempat terkenal digunakan untuk menginformasikan lokasi tujuan atau membantu pengguna tiba di tujuan.

Representasi JSON 
{
  "relationalDescription": {
    object (LocalizedText)
  },
  "tags": [
    enum (Landmark.Tag)
  ],
  "straightLineDistanceMeters": number,
  "travelDistanceMeters": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": {
    object (PlaceView)
  }
  // End of mutually exclusive fields.
}
Kolom
relationalDescription

object (LocalizedText)

Deskripsi yang dapat dibaca manusia tentang hubungan tujuan dengan tempat terkenal. Misalnya: "Dekat Empire State Building" atau "Di seberang Gedung Putih".
tags[]

enum (Landmark.Tag)

Tag yang menjelaskan cara menggunakan tempat terkenal dalam konteks tujuan.
straightLineDistanceMeters

number

Hanya output. Jarak garis lurus dari tempat terkenal ini ke tujuan dalam meter.
travelDistanceMeters

number

Hanya output. Jarak berjalan kaki dari tempat terkenal ini ke tujuan dalam meter.
Tempat terkenal. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
place

object (PlaceView)

Tempat yang mewakili tempat terkenal ini.
Akhir kolom yang saling eksklusif.

Landmark.Tag

Daftar semua kemungkinan tag yang menjelaskan cara menggunakan tempat terkenal dalam konteks tujuan.

Jika alamat memiliki tag ADDRESS dan ARRIVAL, berarti tempat terkenal tersebut terkenal secara lokal dan dekat dengan tujuan.

Enum
TAG_UNSPECIFIED Tidak digunakan.
ADDRESS Tempat yang terkenal secara lokal yang dapat digunakan untuk mengidentifikasi lokasi umum tujuan. Biasanya dalam jarak beberapa ratus meter dari tujuan. Data ini mirip dengan tempat terkenal yang ditampilkan oleh fitur Deskripsi Alamat Geocoding API: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Tempat yang dapat digunakan untuk membantu tiba di tujuan. Berguna untuk navigasi setelah Anda berada di dekat tujuan. Misalnya, tempat terkenal ini mungkin adalah tempat yang berada di seberang jalan dari tujuan. Tempat terkenal dengan tag ini biasanya lebih dekat ke tujuan daripada tempat terkenal dengan tag ADDRESS.

Pintu Masuk

Pintu masuk adalah satu pasangan koordinat lintang/bujur yang menentukan lokasi titik masuk dan keluar untuk suatu tempat.

Representasi JSON 
{
  "displayName": {
    object (LocalizedText)
  },
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
Kolom
displayName

object (LocalizedText)

Nama yang dapat dibaca manusia, misalnya, "Gerbang B", "Pintu Masuk Selatan", "Pintu Masuk 5th Ave".
location

object (LatLng)

Lokasi pintu masuk.
tags[]

enum (Entrance.Tag)

Daftar tag yang mendeskripsikan pintu masuk.
place

string

Struktur tempat pintu masuk ini berada secara fisik, dalam format places/{placeId}.

Entrance.Tag

Karakteristik yang mendeskripsikan pintu masuk.

Enum
TAG_UNSPECIFIED Tidak digunakan.
PREFERRED

Pintu masuk kemungkinan menyediakan akses fisik ke tempat utama di tujuan yang ditampilkan. Suatu tempat dapat memiliki beberapa pintu masuk pilihan. Jika pintu masuk tidak memiliki tag ini, berarti pintu masuk tersebut secara fisik berada di bangunan yang sama dengan tempat utama, tetapi tidak selalu menyediakan akses ke tempat tersebut.

Misalnya, jika tempat utama adalah restoran di ruko, pintu masuk "PREFERRED" adalah pintu masuk yang kemungkinan mengarah ke restoran itu sendiri, sedangkan pintu masuk lain yang ditampilkan adalah pintu masuk lain untuk bangunan tersebut, seperti pintu masuk ke restoran lain di ruko.

Jika tempat utama adalah bangunan itu sendiri, pintu masuk PREFERRED akan menjadi pintu masuk yang mengarah ke bagian "utama" bangunan. Misalnya, di pusat perbelanjaan, pintu masuk PREFERRED adalah pintu masuk yang memungkinkan akses ke area lobi utama, tetapi jika pintu masuk hanya menyediakan akses ke toko di sisi bangunan, pintu masuk tersebut bukan pintu masuk PREFERRED.

Catatan: pintu masuk PREFERRED mungkin tidak menyediakan akses ke tempat utama, dan pintu masuk non-PREFERRED mungkin menyediakan akses ke tempat utama.