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 metni aşağıdaki yapıyla birlikte 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,
  "includePureServiceAreaBusinesses": boolean
}
Alanlar
input

string

Zorunlu. Aramanın yapılacağı metin dizesi.

locationBias

object (LocationBias)

İsteğe bağlı. Sonuçları belirli bir konuma yönlendirir.

locationBias veya locationRestriction'ten en fazla biri ayarlanmalıdır. İkisi de ayarlanmamışsa sonuçlar IP adresine göre önyargılı olur. Diğer bir deyişle, IP adresi yanlış bir konumla eşlenir ve önyargılı bir sinyal olarak kullanılır.

locationRestriction

object (LocationRestriction)

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

En fazla locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmazsa sonuçlar IP adresine göre önyargılı olur. Diğer bir deyişle, IP adresi yanlış bir konumla eşlenir ve önyargılı bir sinyal 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) birincil yer türü (ör. "restaurant" veya "gas_station") dahildir veya yalnızca (regions) veya yalnızca (cities). Bir yer yalnızca birincil türü bu listede yer alıyorsa döndürülür. En fazla 5 değer belirtilebilir. Tür belirtilmezse tüm yer türleri döndürülür.

includedRegionCodes[]

string

İsteğe bağlı. Yalnızca belirtilen bölgelerdeki sonuçları dahil eder. Bu bölgeler, en fazla 15 CLDR iki karakterli bölge kodu olarak belirtilir. Boş bir 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 değerine ayarlanır. input'te kullanılan dil languageCode'ten farklıysa veya döndürülen yer için yerel dilden languageCode'e çeviri yoksa sonuçlar karma dillerde olabilir.

regionCode

string

İsteğe bağlı. CLDR iki karakterli 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 sınırlamaz. 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ı. input içindeki imleç konumunu belirten sıfır tabanlı input Unicode karakter ofseti. İmlecin konumu, döndürülen tahminleri 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ıtta yalnızca yer tahminleri döndürülü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 INVALID_ARGUMENT 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 ve ardından bir yer ayrıntıları veya adres doğrulama isteği olabilir. Bir oturumdaki her istek için kullanılan kimlik bilgileri aynı Google Cloud Console projesine ait olmalıdır. Bir oturum sona erdiğinde jeton artık geçerli olmaz. 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, oturum jetonu sağlanmamış gibi ücretlendirilir (her istek ayrı olarak faturalandırılır).

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

  • Tüm yer otomatik tamamlama çağrıları için oturum jetonları kullanın.
  • Her oturum için yeni bir jeton oluşturun. Sürüm 4 UUID kullanılması önerilir.
  • Bir oturumdaki tüm Yer Otomatik 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 gönderdiğinizden emin olun. Aynı jetonun birden fazla oturumda kullanılması, her isteğinin ayrı olarak faturalandırılmasına neden olur.
includePureServiceAreaBusinesses

boolean

İsteğe bağlı. Alan "true" olarak ayarlanmışsa salt hizmet bölgesi işletmelerini dahil edin. Salt hizmet bölgesi işletmesi, müşterileri doğrudan ziyaret eden veya onlara doğrudan hizmet götüren ancak işletme adresinde müşterilere hizmet vermeyen bir işletmedir. Örneğin, temizlik veya tesisatçılık hizmeti sunan işletmeler. Bu işletmelerin Google Haritalar'da fiziksel bir adresi veya konumu yoktur. Yerler, location, plusCode ve bu işletmeler için konumla ilgili diğer alanları içeren alanları döndürmez.

Yanıt gövdesi

places.autocomplete için yanıt prototipi.

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ış önerilerin listesini içerir.

LocationBias

Aranacak bölge. Sonuçlar, belirtilen bölgeye göre taraflı 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

Birlik alanı type.

type yalnızca aşağıdakilerden biri olabilir:

rectangle

object (Viewport)

Kuzeydoğu ve güneybatı köşesi tarafından tanımlanan bir görüntü alanı.

circle

object (Circle)

Merkez noktası ve yarıçapı ile tanımlanan bir 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

Birlik alanı type.

type yalnızca aşağıdakilerden biri olabilir:

rectangle

object (Viewport)

Kuzeydoğu ve güneybatı köşesi tarafından tanımlanan bir görüntü alanı.

circle

object (Circle)

Merkez noktası ve yarıçapı ile tanımlanan bir 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 yalnızca aşağıdakilerden biri olabilir:

placePrediction

object (PlacePrediction)

Bir yerle ilgili 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ı tarafından okunabilir adını içerir. Kuruluş sonuçlarında bu genellikle işletmenin adı ve adresidir.

text, tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. İki ayrı ancak ilgili kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilir. Bunlar, bir yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar, structuredFormat değerini text olarak ayrıştırmaya veya text değerini structuredFormat olarak ayrıştırmaya çalışmamalıdır.

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ı içeren ana metin ve anlam karışıklığını gideren ek özellikleri (şehir veya bölge gibi) içeren ikincil metin olarak 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 kullanabilir. Bunlar, bir yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar, structuredFormat değerini text olarak ayrıştırmaya veya text değerini structuredFormat olarak ayrıştırmaya çalışmamalıdır.

types[]

string

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

Tür, bir yerin kategorisidir. Paylaşılan türleri olan yerler de benzer özelliklere sahiptir.

distanceMeters

integer

origin belirtilmişse origin'ten itibaren jeodezik eğrinin metre cinsinden uzunluğu. Rotalar gibi belirli tahminler bu alanı doldurmayabilir.

FormattableText

Bir yer veya sorgu tahminini temsil eden metin. Metin olduğu gibi veya biçimlendirilmiş olarak 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çütlere göre belirlendiyse (ör. yazım düzeltmeleri veya transliterasyonlar) alt dize, input ile tam olarak eşleşmeyebilir.

Bu değerler, text için 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 sıfır tabanlı ofseti (dahil).

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, yerin adını içerir. Sorgu tahminlerinde ana metin sorguyu içerir.

İkincil metin, yeri daha ayrıntılı olarak tanımlamak veya sorguyu hassaslaştırmak için anlam karışıklığını gideren 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 ayrıntılı olarak tanımlamak veya sorguyu hassaslaştırmak için belirsizliği gideren ek özellikleri (şehir veya bölge gibi) temsil eder.

QueryPrediction

Sorgu otomatik 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. İki ayrı ancak ilgili kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilir. Bunlar, sorgu tahminini temsil etmenin iki farklı yoludur. Kullanıcılar, structuredFormat değerini text olarak ayrıştırmaya veya text değerini structuredFormat olarak ayrıştırmaya çalışmamalıdır.

input ve languageCode istekleri farklı dillerdeyse veya sorgunun bir kısmının yerel dilden languageCode'e çevirisi yoksa karışık dillerde olabilir.

structuredFormat

object (StructuredFormat)

Sorgu tahmininin, sorguyu içeren ana metin ve anlam karışıklığını gideren ek özellikler (şehir veya bölge gibi) içeren ikincil metin olarak 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 değerini text olarak ayrıştırmaya veya text değerini structuredFormat olarak ayrıştırmaya çalışmamalıdır.