Method: places.autocomplete

Belirtilen giriş için tahminler 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 metni

İstek içeriği 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,
  "includeFutureOpeningBusinesses": boolean
}
Alanlar
input

string

Zorunlu. Arama yapılacak metin dizesi.

locationBias

object (LocationBias)

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

En fazla bir locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmamışsa sonuçlar IP adresine göre önyargılı olur. Yani IP adresi, kesin olmayan bir konumla eşlenir ve önyargı sinyali olarak kullanılır.

locationRestriction

object (LocationRestriction)

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

En fazla bir locationBias veya locationRestriction ayarlanmalıdır. İkisi de ayarlanmamışsa sonuçlar IP adresine göre önyargılı olur. Yani IP adresi, kesin olmayan bir konumla eşlenir ve önyargı 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) yer alan birincil yer türü (ör. "restaurant" veya "gas_station"), 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 edin. En fazla 15 CLDR iki karakterli bölge kodu belirtilebilir. Boş bir küme sonuçları kısıtlamaz. Hem locationRestriction hem de includedRegionCodes ayarlanırsa sonuçlar kesişim alanında yer alır.

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 içinde kullanılan dil languageCode dilinden farklıysa veya döndürülen yerin yerel dilden languageCode diline çevirisi yoksa sonuçlar farklı dillerde olabilir.

regionCode

string

İsteğe bağlı. CLDR iki karakterli bölge kodu olarak belirtilen bölge kodu. Bu durum, adres biçimlendirmesini ve sonuç sıralamasını etkiler. Ayrıca, hangi sonuçların döndürüleceğini de etkileyebilir. Bu işlem, sonuçları belirtilen bölgeyle kısıtlamaz. Sonuçları bir bölgeyle sınırlamak için region_code_restriction simgesini 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 gösteren, sıfır tabanlı bir Unicode karakteri uzaklığıdır.input İmleç konumu, hangi tahminlerin döndürüleceğini etkileyebilir.

Boşsa varsayılan olarak input uzunluğu kullanılır.

includeQueryPredictions

boolean

İsteğe bağlı. Doğruysa yanıtta hem yer hem de sorgu tahminleri yer alır. 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, URL ve dosya adı için güvenli bir base64 dizesi olmalıdır. Aksi takdirde INVALID_ARGUMENT hatası döndürülür.

Oturum, kullanıcının sorgu yazmaya başlamasıyla başlar, bir yer seçmesi ve Yer Ayrıntıları veya Address Validation'a yönelik bir çağrı yapılmasıyla sona erer. Her oturumda birden fazla sorgu olabilir ve ardından bir Yer Ayrıntıları veya Address Validation isteği gönderilebilir. 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 geçerliliğini kaybeder. 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 Adı Otomatik 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 Adı Otomatik Tamamlama, Yer Ayrıntıları ve Address Validation 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.
includePureServiceAreaBusinesses

boolean

İsteğe bağlı. Alan doğru 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 teslimat yapan ancak işletme adresinde müşterilere hizmet vermeyen işletmelerdir. Örneğin, temizlik veya tesisat hizmeti sunan işletmeler. Bu işletmelerin Google Haritalar'da fiziksel adresi veya konumu yoktur. Places, bu işletmeler için location, plusCode ve konumla ilgili diğer alanları döndürmez.

includeFutureOpeningBusinesses

boolean

İsteğe bağlı. Doğruysa henüz açık olmayan ancak gelecekte açılacak işletmeleri dahil edin.

Yanıt metni

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 sırada sıralanmış bir öneri listesi içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

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

type birleşik alanı.

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

rectangle

object (Viewport)

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

circle

object (Circle)

Bir merkez noktası ve yarıçap ile tanımlanan daire.

LocationRestriction

Aranacak bölge. Sonuçlar, belirtilen bölgeyle sınırlı olacaktı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

type birleşik alanı.

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

rectangle

object (Viewport)

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

circle

object (Circle)

Bir merkez noktası ve yarıçap ile 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

kind birleşik alanı.

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

placePrediction

object (PlacePrediction)

Bir yer için tahmin.

queryPrediction

object (QueryPrediction)

Bir sorgu için tahmin.

PlacePrediction

Yer Adı 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 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 ilişkili kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilir. Bunlar, bir Yer tahminini göstermenin iki farklı yoludur. Kullanıcılar, structuredFormat öğesini text olarak veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.

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

İstek input ve languageCode 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 ek ayırt edici özellikler (ör. şehir veya bölge) içeren ikincil metin olarak ayrılması.

structuredFormat, iki ayrı ancak ilişkili 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 göstermenin iki farklı yoludur. Kullanıcılar, structuredFormat öğesini text olarak 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'de bu Yer için geçerli olan türlerin listesi.

Tür, bir yerin sınıflandırılmasıdır. Paylaşılan türlere sahip yerler benzer özelliklere sahip olur.

distanceMeters

integer

origin belirtilmişse origin konumundan itibaren jeodezik uzunluğu metre cinsinden. Rotalar gibi bazı tahminler bu alanı doldurmayabilir.

FormattableText

Yer veya sorgu tahminini temsil eden metin. Metin olduğu gibi kullanılabilir veya biçimlendirilebilir.

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 nerede eşleştiğini tanımlayan dize aralıklarının listesi. Aralıklar, text belirli bölümlerini biçimlendirmek için kullanılabilir. Eşleşme, dize eşleşmesi dışındaki ölçütlere (ör. yazım düzeltmeleri veya çeviri yazılar) göre belirlendiyse alt dizeler input ile tam olarak eşleşmeyebilir.

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

StringRange

Belirli bir metindeki alt dizeyi tanımlar.

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

integer

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

endOffset

integer

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

StructuredFormat

Bir Yer veya sorgu tahmininin ana metin ve ikincil metin olarak ayrılmış halini içerir.

Yer tahminlerinde ana metin, yerin adını içerir. Sorgu tahminlerinde ana metin, sorguyu içerir.

İkincil metin, yeri daha iyi tanımlamak veya sorguyu daha iyi hale getirmek için ek ayırt edici özellikler (ör. şehir veya bölge) içerir.

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

object (FormattableText)

Yerin veya sorgunun adını gösterir.

secondaryText

object (FormattableText)

Yeri daha iyi tanımlamak veya sorguyu daha ayrıntılı hale getirmek için ek netleştirici özellikleri (ör. şehir veya bölge) 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 (ör. 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 ilişkili kullanıcı arayüzü öğesi göstermek isteyen geliştiriciler bunun yerine structuredFormat kullanabilir. Bunlar, sorgu tahminini göstermenin iki farklı yoludur. Kullanıcılar, structuredFormat öğesini text olarak veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.

İstek input ve languageCode farklı dillerdeyse veya sorgunun bir bölümü yerel dilden languageCode diline çevrilmemişse yanıt karma dillerde olabilir.

structuredFormat

object (StructuredFormat)

Sorgu tahmininin, sorguyu içeren ana metin ve ek netleştirici özellikler (ör. şehir veya bölge) içeren ikincil metin olarak ayrılması.

structuredFormat, iki ayrı ancak ilişkili 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, sorgu tahminini göstermenin iki farklı yoludur. Kullanıcılar, structuredFormat öğesini text olarak veya tam tersi şekilde ayrıştırmaya çalışmamalıdır.