Method: places.autocomplete

Belirli bir giriş için 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

İsteğin gövdesi, aşağıdaki yapıya sahip veriler 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ı. Belirli bir yerle ilgili önyargı sonuçları.

En fazla locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmazsa sonuçlara IP adresine göre ağırlık verilir, 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ı belirli bir konumla sınırlandır.

En fazla locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmazsa sonuçlara IP adresine göre ağırlık verilir, 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ı. https://developers.google.com/maps/documentation/places/web-service/place-types adresindeki birincil yer türü (örneğin, "restoran" veya "gas_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. Hiçbir 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 edin (en fazla 15 CLDR iki karakterli bölge koduyla 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 dilinde kullanılan dil languageCode dilinden farklıysa veya döndürülen yerin yerel dilden languageCode diline çevirisi yoksa sonuçlar karışık olabilir.

regionCode

string

İsteğe bağlı. CLDR iki karakterli bölge kodu olarak belirtilen bölge kodu. Bu, adres biçimlendirmesini ve 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 özelliğini 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ı. İmleç konumunu input olarak gösteren, input sıfır tabanlı Unicode karakter ofseti. İmleç konumu, hangi tahminlerin döndürüleceğini etkileyebilir.

Boş bırakılırsa varsayılan olarak input uzunluğu 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 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ı veya 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 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; uygulamanızın her oturum için yeni bir jeton oluşturması gerekir. sessionToken parametresi atlanırsa veya bir oturum jetonunu yeniden kullanırsanız 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ını kullanın.
  • Her oturum için yeni bir jeton oluşturun. Sürüm 4 UUID kullanmanız ö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 ilettiğinizden emin olun. Aynı jetonun birden fazla oturumda kullanılması, her isteğin ayrı ayrı faturalandırılmasına neden olur.

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 öneriler listesi içerir.

LocationBias

Aranacak bölge. Sonuçlar, belirtilen bölge çevresinde sapma gösterebilir.

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)

Bir kuzeydoğu ve güneybatı köşesiyle tanımlanan görüntü alanı.

circle

object (Circle)

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

LocationRestriction

Aranacak bölge. Sonuçlar, belirtilen bölgeyle kısıtlanı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)

Bir kuzeydoğu ve güneybatı köşesiyle tanımlanan görüntü alanı.

circle

object (Circle)

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

Öneri

Otomatik tamamlama öneri 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

Otomatik Yer 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ı için bu genellikle işletme adı ve adresidir.

text, tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. İki ayrı ancak birbiriyle alakalı kullanıcı arayüzü öğeleri göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilirler. Bunlar, bir yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.

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

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

structuredFormat

object (StructuredFormat)

Yer tahmininin, Yerin adını içeren ana metin ve belirsizleştirilmiş ek özellikler (şehir veya bölge gibi) içeren ikincil metin olarak dökümü.

structuredFormat, birbiriyle alakalı iki ayrı 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 edebilirler. Bunlar, bir yer tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.

types[]

string

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

Tür, Yer için yapılan bir kategorilendirmedir. Ortak türlere sahip yerler de benzer özelliklere sahiptir.

distanceMeters

integer

origin belirtilmişse origin ile mesafenin metre cinsinden jeodezik 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çimlendirilebilecek metin.

matches[]

object (StringRange)

Giriş isteğinin text içinde eşleştiği yeri 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 bir ölçüte göre belirlendiyse (örneğin, yazım düzeltmeleri veya harf çevirileri) alt dizeler input ile tam eşleşmeler olmayabilir.

Bu değerler, text özelliğinin Unicode karakter ofsetleridir. Aralıkların, artan ofset değerleriyle sıralanması garanti edilir.

StringRange

Belirli bir metin içindeki bir alt dizeyi tanımlar.

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

integer

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

endOffset

integer

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

StructuredFormat

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

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

İkincil metin, Yeri daha iyi tanımlamak veya sorguyu ayrıntılandırmak için açıklayıcı 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 ayrıntılandırmak için açıklayıcı 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ılabilen bir metin sorgusunu temsil etmektedir.

text, tek bir kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler için önerilir. İki ayrı ancak birbiriyle alakalı kullanıcı arayüzü öğeleri göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilirler. Bunlar, bir sorgu tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.

input ve languageCode isteği farklı dillerdeyse veya sorgunun bir kısmının yerel dilden languageCode diline çevirisi yoksa karma dillerde olabilir.

structuredFormat

object (StructuredFormat)

Sorgu tahmininin, sorguyu içeren ana metin ve kesinleştirici ek özellikler (şehir veya bölge gibi) içeren ikincil metin olarak dökümü.

structuredFormat, birbiriyle alakalı iki ayrı 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 edebilirler. Bunlar, bir sorgu tahminini temsil etmenin iki farklı yoludur. Kullanıcılar structuredFormat öğesini text veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.