Method: places.autocomplete

Verilen girişle ilgili tahminleri döndürür.

HTTP isteği

POST https://places.googleapis.com/v1/places:autocomplete

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi
{
  "input": string,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "includedPrimaryTypes": [
    string
  ],
  "includedRegionCodes": [
    string
  ],
  "languageCode": string,
  "regionCode": string,
  "origin": {
    object (LatLng)
  },
  "inputOffset": integer,
  "includeQueryPredictions": boolean,
  "sessionToken": string
}
Alanlar
input

string

Zorunlu. Arama yapılacak metin dizesi.

locationBias

object (LocationBias)

İsteğe bağlı. Belirtilen konum için yanlılık sonuçları.

En fazla locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmazsa sonuçlar IP adresine göre ağırlıklandırılır, yani IP adresi tam olmayan bir konumla eşlenir ve ağırlık verme sinyali olarak kullanılır.

locationRestriction

object (LocationRestriction)

İsteğe bağlı. Sonuçları belirtilen bir konumla sınırlandırın.

En fazla locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmazsa sonuçlar IP adresine göre ağırlıklandırılır, yani IP adresi tam olmayan bir konumla eşlenir ve ağırlık verme sinyali olarak kullanılır.

includedPrimaryTypes[]

string

İsteğe bağlı. Yer Türleri'nde (https://developers.google.com/maps/documentation/places/web-service/place-types) ya da yalnızca (bölgeler) veya yalnızca (şehirler) A Tablosu veya Tablo B'deki birincil Yer türü (örneğin, "restoran" veya "gaz_station") eklendi. Bir Yer yalnızca birincil türü bu listede yer alıyorsa döndürülür. En fazla 5 değer belirtilebilir. Herhangi bir tür belirtilmezse tüm Yer türleri döndürülür.

includedRegionCodes[]

string

İsteğe bağlı. En fazla 15 CLDR iki karakterli bölge kodu olarak belirtilen, yalnızca belirtilen bölgelerdeki sonuçları dahil edin. Boş küme sonuçları kısıtlamaz. Hem locationRestriction hem de includedRegionCodes ayarlanırsa sonuçlar kesişim alanında bulunur.

languageCode

string

İsteğe bağlı. Sonuçların döndürüleceği dil. Varsayılan olarak en-US kullanılır. input dilindeki dil languageCode dilinden farklıysa veya döndürülen Yerin yerel dilden languageCode diline çevirisi yoksa sonuçlar karışık dilde olabilir.

regionCode

string

İsteğe bağlı. İki karakterli CLDR bölge kodu olarak belirtilen bölge kodu. Bu, adres biçimlendirmesini, sonuç sıralamasını etkiler ve hangi sonuçların döndürüleceğini etkileyebilir. Bu işlem, sonuçları belirtilen bölgeyle kısıtlamaz. Sonuçları bir bölgeyle kısıtlamak için region_code_restriction işlevini kullanın.

origin

object (LatLng)

İsteğe bağlı. Hedefe olan jeodezik mesafenin hesaplanacağı başlangıç noktası (distanceMeters olarak döndürülür). Bu değer atlanırsa jeodezik mesafe döndürülmez.

inputOffset

integer

İsteğe bağlı. İmlecin input içindeki konumunu gösteren sıfır tabanlı Unicode karakter farkı: input. İmleç konumu, hangi tahminlerin döndürüleceğini etkileyebilir.

Boşsa varsayılan olarak input uzunluğuna ayarlanır.

includeQueryPredictions

boolean

İsteğe bağlı. Doğru ise, yanıt hem Yer hem de sorgu tahminlerini içerir. Aksi takdirde, yanıt yalnızca Yer tahminleri döndürür.

sessionToken

string

İsteğe bağlı. Faturalandırma amacıyla bir Otomatik Tamamlama oturumunu tanımlayan dize. En fazla 36 ASCII karakter uzunluğunda bir URL ve dosya adı güvenli base64 dizesi olmalıdır. Aksi takdirde bir GEÇERSİZ_BAĞ_DEĞ_SAY hatası döndürülür.

Oturum, kullanıcı bir sorgu yazmaya başladığında başlar ve kullanıcı bir yer seçip Yer Ayrıntıları ya da Adres Doğrulama çağrısı yapıldığında sona erer. Her oturumda birden fazla sorgu olabilir. Ardından bir Yer Ayrıntıları veya Adres Doğrulama isteği gelebilir. Bir oturumdaki her istek için kullanılan kimlik bilgileri aynı Google Cloud Console projesine ait olmalıdır. Oturum sona erdiğinde jeton artık geçerli olmaz. Bu nedenle uygulamanız her oturum için yeni bir jeton oluşturmalıdır. sessionToken parametresi atlanırsa veya bir oturum jetonunu yeniden kullanırsanız oturum, herhangi bir oturum jetonu sağlanmamış gibi ücretlendirilir (her istek ayrı olarak faturalandırılır).

Aşağıdaki yönergeleri öneririz:

  • Tüm Otomatik Yer Tamamlama çağrıları için oturum jetonları kullanın.
  • Her oturum için yeni bir jeton oluşturun. Sürüm 4 UUID'sinin kullanılması önerilir.
  • Bir oturumdaki tüm Otomatik Yer Tamamlama, Yer Ayrıntıları ve Adres Doğrulama istekleri için kullanılan kimlik bilgilerinin aynı Cloud Console projesine ait olduğundan emin olun.
  • Her yeni oturum için benzersiz bir oturum jetonu ilettiğinizden emin olun. Aynı jetonun birden fazla oturum için kullanılması, her isteğin ayrı olarak faturalandırılır.

Yanıt gövdesi

places.autocomplete için yanıt protokolü.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Alanlar
suggestions[]

object (Suggestion)

Alaka düzeyine göre azalan düzende sıralanmış bir öneri listesini içerir.

LocationBias

Aranacak bölge. Sonuçlar, belirtilen bölge etrafında yanlı olabilir.

JSON gösterimi
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Alanlar

Birleştirme alanı type.

type şunlardan yalnızca biri olabilir:

rectangle

object (Viewport)

Kuzeydoğu ve güneybatı köşesiyle tanımlanan görünüm.

circle

object (Circle)

Bir merkez noktası ve yarıçapla tanımlanan daire.

LocationRestriction

Aranacak bölge. Sonuçlar, belirtilen bölgeyle sınırlandırılır.

JSON gösterimi
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Alanlar

Birleştirme alanı type.

type şunlardan yalnızca biri olabilir:

rectangle

object (Viewport)

Kuzeydoğu ve güneybatı köşesiyle tanımlanan görünüm.

circle

object (Circle)

Bir merkez noktası ve yarıçapla tanımlanan daire.

Öneri

Otomatik tamamlama önerisi sonucu.

JSON gösterimi
{

  // Union field kind can be only one of the following:
  "placePrediction": {
    object (PlacePrediction)
  },
  "queryPrediction": {
    object (QueryPrediction)
  }
  // End of list of possible types for union field kind.
}
Alanlar

Birleştirme alanı kind.

kind şunlardan yalnızca biri olabilir:

placePrediction

object (PlacePrediction)

Bir yer için tahmin.

queryPrediction

object (QueryPrediction)

Bir sorgu için tahmin.

PlacePrediction

Yer Otomatik Tamamlama tahmini için tahmin sonuçları.

JSON gösterimi
{
  "place": string,
  "placeId": string,
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  },
  "types": [
    string
  ],
  "distanceMeters": integer
}
Alanlar
place

string

Önerilen yerin kaynak adı. Bu ad, yer adlarını kabul eden diğer API'lerde kullanılabilir.

placeId

string

Önerilen yerin benzersiz tanımlayıcısı. Bu tanımlayıcı, Yer Kimliklerini kabul eden diğer API'lerde kullanılabilir.

text

object (FormattableText)

Döndürülen sonucun kullanıcılar tarafından okunabilen adını içerir. Kuruluş sonuçlarında genellikle işletme adı ve adresi kullanılır.

text, tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. Ayrı ancak alakalı iki kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat öğesini kullanmak isteyebilir. Bunlar, yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text olarak ayrıştırmaya çalışmamalıdır. Bunun tersi de geçerlidir.

Bu metin, places.get tarafından döndürülen displayName metninden farklı olabilir.

input ve languageCode isteği farklı dillerdeyse veya Yerin yerel dilden languageCode diline çevirisi yoksa karma dilde olabilir.

structuredFormat

object (StructuredFormat)

Yer tahmininin, Yerin adını ve belirsizliği önleyen ek özellikleri (şehir veya bölge gibi) içeren ikincil metne göre dökümü.

structuredFormat, iki ayrı ancak birbiriyle alakalı kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. Tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine text kullanmayı tercih edebilir. Bunlar, yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text olarak ayrıştırmaya çalışmamalıdır. Bunun tersi de geçerlidir.

types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types adresindeki A veya B tablosundan bu Yer için geçerli olan türlerin listesi.

Tür, bir Yerin sınıflandırılmasıdır. Paylaşılan türleri olan yerler de benzer özelliklere sahiptir.

distanceMeters

integer

origin belirtilmişse jeodezinin metre cinsinden uzunluğu origin belirtilir. Rotalar gibi belirli tahminler bu alanı doldurmayabilir.

FormattableText

Bir yer veya sorgu tahminini temsil eden metin. Metin olduğu veya biçimlendirildiği şekilde kullanılabilir.

JSON gösterimi
{
  "text": string,
  "matches": [
    {
      object (StringRange)
    }
  ]
}
Alanlar
text

string

Olduğu gibi kullanılabilecek veya matches ile biçimlendirilmiş metin.

matches[]

object (StringRange)

Giriş isteğinin text içinde nerede eşleştiğini tanımlayan dize aralıklarının listesi. Aralıklar, text öğesinin belirli bölümlerini biçimlendirmek için kullanılabilir. Eşleşme, dize eşleştirme dışındaki ölçütler (örneğin, yazım düzeltmeleri veya harf çevirisiler) tarafından belirlendiyse alt dizeler, input tam eşleşmeleri olmayabilir.

Bu değerler, text öğesinin Unicode karakter ofsetleridir. Aralıkların, artan ofset değerlerine göre sıralanacağı garanti edilir.

StringRange

Belirli bir metinde bir alt dizeyi tanımlar.

JSON gösterimi
{
  "startOffset": integer,
  "endOffset": integer
}
Alanlar
startOffset

integer

Dizenin ilk Unicode karakterinin (dahil) sıfır tabanlı uzaklığı.

endOffset

integer

Son Unicode karakterinin sıfır tabanlı uzaklığı (hariç).

StructuredFormat

Yer veya sorgu tahmininin ana metin ve ikincil metne dökümünü içerir.

Yer tahminlerinde, ana metin Yer'in adını içerir. Sorgu tahminleri için ana metin sorguyu içerir.

İkincil metin, Yeri daha iyi tanımlamak veya sorguyu hassaslaştırmak için anlaşılacak ek özellikler (şehir veya bölge gibi) içerir.

JSON gösterimi
{
  "mainText": {
    object (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Alanlar
mainText

object (FormattableText)

Yerin veya sorgunun adını temsil eder.

secondaryText

object (FormattableText)

Yeri daha iyi tanımlamak veya sorguyu hassaslaştırmak için, ayırt edici ek özellikleri (şehir veya bölge gibi) temsil eder.

QueryPrediction

Otomatik Sorgu Tamamlama tahmini için tahmin sonuçları.

JSON gösterimi
{
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Alanlar
text

object (FormattableText)

Tahmin edilen metin. Bu metin bir yeri değil, arama uç noktasında (örneğin, Metin Arama) kullanılabilecek bir metin sorgusunu temsil eder.

text, tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. Ayrı ancak alakalı iki kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat öğesini kullanmak isteyebilir. Bunlar, sorgu tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text olarak ayrıştırmaya çalışmamalıdır. Bunun tersi de geçerlidir.

input ve languageCode isteği farklı dillerdeyse veya sorgunun bir bölümünün yerel dilden languageCode diline çevirisi yoksa karma dillerde olabilir.

structuredFormat

object (StructuredFormat)

Sorgu tahmininin, sorguyu ve netleştirmeyi sağlayan ek özellikleri (ör. şehir veya bölge) içeren ikincil metne ve sorguyu içeren ana metne dökümü.

structuredFormat, iki ayrı ancak birbiriyle alakalı kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. Tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine text kullanmayı tercih edebilir. Bunlar, sorgu tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text olarak ayrıştırmaya çalışmamalıdır. Bunun tersi de geçerlidir.