Method: geocode.destinations.searchDestinations

Metode ini melakukan pencarian tujuan dan menampilkan daftar tujuan.

Permintaan HTTP

POST https://geocode.googleapis.com/v4alpha/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,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
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 ditentukan 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.

Kolom union primary_query. Kueri untuk tujuan utama. 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. primary_query hanya dapat berupa salah satu dari hal berikut:
place

string

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

object (SearchDestinationsRequest.AddressQuery)

Alamat.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

Lokasi presisi.

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 menampilkan satu hasil jika tujuan utama dapat diidentifikasi secara jelas dari kueri utama. Jika tidak, layanan dapat menampilkan beberapa hasil untuk disambiguasi atau nol hasil.

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 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Kueri alamat. kind hanya dapat berupa salah satu dari berikut:
address

object (PostalAddress)

Alamat dalam format alamat pos.
addressQuery

string

Alamat jalan yang diformat sebagai satu baris.

SearchDestinationsRequest.LocationQuery

Kueri lokasi untuk mengidentifikasi tujuan utama terdekat.

Catatan: Jika kueri lokasi berada di dalam gedung yang berisi sub-tempat, ada kemungkinan bahwa tempat utama yang ditampilkan adalah sub-tempat. Dalam kasus ini, kolom containingPlaces akan menyertakan bangunan.

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

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
Kolom
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

Opsional. Filter yang akan diterapkan ke kandidat tujuan.
Kolom union kind. Kueri lokasi. kind hanya dapat berupa salah satu dari berikut:
location

object (LatLng)

Lokasi LatLng presisi.

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 lapangan, atau dalam memperkasar tujuan yang ditampilkan ke tingkat lapangan.

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 penayangan iklan yang sesuai.

PlaceView.StructureType

Jenis struktur yang diwakili oleh tempat ini.

Enum
STRUCTURE_TYPE_UNSPECIFIED Tidak digunakan.
POINT Lokasi titik.
SECTION Subbagian bangunan.
BUILDING Sebuah 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 dapat ditambahkan di masa mendatang.

Enum
ADDRESSABILITY_UNSPECIFIED Jika tidak ditentukan, layanan akan memilih default yang sesuai.
ANY Kemampuan penayangan iklan bukanlah kriteria pemfilteran. Tujuan ditampilkan terlepas dari apakah alamatnya 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)
    }
  ],
  "parkingOptions": {
    object (Destination.ParkingOptions)
  },
  "arrivalSummary": {
    object (Destination.ArrivalSummary)
  }
}
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 gedung 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.
parkingOptions

object (Destination.ParkingOptions)

Opsi parkir untuk tujuan ini.
arrivalSummary

object (Destination.ArrivalSummary)

Ringkasan yang dibuat AI tentang pengalaman kedatangan di tujuan.

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,
  "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 dapat 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.

Lihat https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types untuk mengetahui detail selengkapnya.
languageCode

string

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

Penanda

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

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

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
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 penggunaan landmark dalam konteks tujuan.
straightLineDistanceMeters

number

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

number

Hanya output. Jarak berjalan kaki dari penanda ini ke tujuan dalam meter.
Kolom union landmark. Tempat terkenal. landmark hanya dapat berupa salah satu dari berikut:
place

object (PlaceView)

Tempat yang mewakili landmark ini.

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 dekat dengan 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 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string,
  "streetViewThumbnail": {
    object (StreetViewThumbnail)
  },
  "streetViewAnnotation": {
    object (ImageAnnotation)
  }
}
Kolom
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}.
streetViewThumbnail

object (StreetViewThumbnail)

Gambar thumbnail Street View yang menampilkan pintu masuk. Gambar dapat diminta dari Street View Static API. Lihat https://developers.google.com/maps/documentation/streetview/request-streetview.
streetViewAnnotation

object (ImageAnnotation)

Anotasi pintu masuk pada streetViewThumbnail yang ditampilkan di atas.

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.

StreetViewThumbnail

Parameter untuk menampilkan thumbnail Google Street View. Parameter ini dapat digunakan untuk meminta gambar Street View dari Street View Static API. Lihat https://developers.google.com/maps/documentation/streetview/request-streetview.

Representasi JSON 
{
  "pano": string,
  "widthPx": integer,
  "heightPx": integer,
  "headingDegree": number,
  "pitchDegree": number,
  "fovDegree": number
}
Kolom
pano

string

ID panorama tertentu.
widthPx

integer

Lebar gambar thumbnail output dalam piksel. Catatan: Saat meminta anotasi bersama thumbnail, nilai tinggi dan lebar ini harus digunakan dalam permintaan API Street View untuk memastikan koordinat anotasi sejajar dengan benar dengan gambar.
heightPx

integer

Tinggi gambar thumbnail output dalam piksel. Catatan: Saat meminta anotasi bersama thumbnail, nilai tinggi dan lebar ini harus digunakan dalam permintaan API Street View untuk memastikan koordinat anotasi sejajar dengan benar dengan gambar.
headingDegree

number

Orientasi horizontal kamera dalam derajat. Rentang [0, 360). 0 menunjukkan Utara dan 90 menunjukkan Timur.
pitchDegree

number

Orientasi vertikal kamera dalam derajat. Rentang [-90, 90]. 0 adalah cakrawala, +90 lurus ke atas, -90 lurus ke bawah.
fovDegree

number

Ruang Pandang Horizontal dalam derajat. Rentang (0, 180]. Mengontrol tingkat zoom. FOV yang lebih kecil berarti zoom yang lebih besar.

ImageAnnotation

Anotasi pada thumbnail gambar, seperti poligon yang menguraikan pintu masuk.

Representasi JSON 
{
  "coordinates": [
    {
      object (ImageAnnotation.Coordinate)
    }
  ]
}
Kolom
coordinates[]

object (ImageAnnotation.Coordinate)

Daftar koordinat yang membentuk poligon pada gambar. Koordinat diurutkan berlawanan arah jarum jam.

ImageAnnotation.Coordinate

Koordinat piksel titik pada gambar. Origin (0,0) adalah sudut kiri atas dari piksel kiri atas gambar, dengan sumbu x mengarah ke kanan dan sumbu y mengarah ke bawah.

Representasi JSON 
{
  "xPx": number,
  "yPx": number
}
Kolom
xPx

number

Koordinat x.
yPx

number

Koordinat y.

Destination.ParkingOptions

Informasi tentang opsi parkir untuk tujuan.

Representasi JSON 
{
  "availability": enum (Destination.ParkingOptions.Availability),
  "onsiteParking": boolean,
  "freeParkingLot": boolean,
  "paidParkingLot": boolean,
  "freeStreetParking": boolean,
  "paidStreetParking": boolean,
  "valetParking": boolean,
  "freeGarageParking": boolean,
  "paidGarageParking": boolean
}
Kolom
availability

enum (Destination.ParkingOptions.Availability)

Ketersediaan tempat parkir untuk tujuan ini.
onsiteParking

boolean

Tempat parkir tersedia di tujuan.
freeParkingLot

boolean

Menawarkan tempat parkir gratis.
paidParkingLot

boolean

Menawarkan tempat parkir berbayar.
freeStreetParking

boolean

Menawarkan tempat parkir di pinggir jalan gratis.
paidStreetParking

boolean

Menawarkan tempat parkir di pinggir jalan berbayar.
valetParking

boolean

Menawarkan parkir valet.
freeGarageParking

boolean

Menawarkan parkir di garasi gratis.
paidGarageParking

boolean

Menawarkan tempat parkir di garasi berbayar.

Destination.ParkingOptions.Availability

Ukuran gabungan seberapa sulit menemukan tempat parkir saat mengunjungi tempat ini.

Nilai baru dapat ditambahkan di masa mendatang.

Enum
AVAILABILITY_UNSPECIFIED Ketersediaan tempat parkir tidak tersedia.
PLENTY Tersedia banyak tempat parkir.
SOMEWHAT_DIFFICULT Tempat parkir agak sulit ditemukan.
DIFFICULT Tempat parkir sangat sulit ditemukan.

Destination.ArrivalSummary

Ringkasan yang dibuat AI tentang pengalaman kedatangan di tujuan.

Representasi JSON 
{
  "text": {
    object (LocalizedText)
  },
  "flagContentUrl": string,
  "disclosureText": {
    object (LocalizedText)
  }
}
Kolom
text

object (LocalizedText)

Ringkasan pengalaman kedatangan di tujuan.
flagContentUrl

string

Link tempat pengguna dapat melaporkan masalah terkait ringkasan.
disclosureText

object (LocalizedText)

Hanya output. Berisi teks pengungkapan untuk ringkasan kedatangan.