Address Validation API, iki üst düzey mülk içeren bir JSON nesnesi olarak yanıt gövdesi sağlar:
result
,ValidationResult
türündeki bir nesneresponseID
{
"result": {
// Validation verdict.
"verdict": {},
// Address details determined by the API.
"address": {},
// The geocode generated for the input address.
"geocode": {},
// Information indicating if the address is a business, residence, etc.
"metadata": {},
// Information about the address from the US Postal Service
// ("US" and "PR" addresses only).
"uspsData": {},
},
// A unique identifier generated for every request to the API.
"responseId": "ID"
}
Bu dokümanda result
nesnesine odaklanılmıştır. responseID
hakkında bilgi edinmek için Güncellenen adresleri işleme başlıklı makaleyi inceleyin.
verdict
mülkü
verdict
mülkü, adres doğrulama sonuçlarını özetler ve adres kontrol mantığı oluştururken değerlendirilecek ilk mülk olmalıdır.
Özellik, çıkış adresinin kalitesine bağlı olarak çeşitli alanlar döndürebilir. Örneğin, aşağıdaki örnekte iyi kalitede bir adresin verdict
mülkü gösterilmektedir. Bu adres için 4 alan döndürülür:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Aşağıdaki bölümlerde, verdict
mülkünde bulunan tüm alanlar özetlenmiştir.
Referans kılavuzundaki Verdict bölümüne bakın. |
Adresin ayrıntı düzeyi
Adres ayrıntı düzeyi, bir adresin veya coğrafi kodun özgünlüğünü belirlemek için kullanılan ayrıntı düzeyini ifade eder. validationGranularity
yanıtındaki adres özgüllüğü, bir adresin teslim edilip edilemeyeceğine dair önemli bir sinyaldir.
verdict
mülkü aşağıdaki ayrıntı düzeyi sinyallerini döndürür:
inputGranularity
: Address Validation API'ye gönderilen adresten alınan ayrıntı düzeyini belirtir. İstekte belirtilen adres ayrıntı düzeyi, doğrulama yanıtındaki adres ayrıntı düzeyini etkiler. Örneğin,PREMISE
seviyesinin altındainputGranularity
olan bir adres genelliklevalidationGranularity
ilePREMISE
seviyesinde sonuçlanmaz.validationGranularity
: Adres Doğrulama API'sinin adresi tam olarak doğrulayabileceği ayrıntı düzeyi. Çoğu durumdaPREMISE
veyaSUB_PREMISE
ayrıntı düzeyi, teslim edilebilecek nitelikte bir adresi gösterir.geocodeGranularity
: Adresle ilişkili coğrafi kodla ilgili ayrıntı düzeyini belirtir. Örneğin, Google kayıtları bir apartman numarasının varlığını gösterebilir ancak büyük bir apartman kompleksindeki söz konusu apartmanın tam konumunu göstermeyebilir. Bu durumda,validationGranularity
SUB_PREMISE
,geocodeGranularity
iseis
PREMISE` olur.
Referans kılavuzundaki Ayrıntı düzeyi bölümüne bakın. |
Adresin eksiksiz olması
Sonuç, addressComplete
mülkünü yüksek kaliteli bir adres sinyali olarak döndürür. Bu, adresin eksik, çözülmemiş veya beklenmedik bileşenleri olmadığı anlamına gelir:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Adreste eksik, çözülmemiş veya beklenmeyen bileşenler varsa alan false
olarak ayarlanır.
Referans kılavuzundaki Verdict ve Adres bölümünün altında addressComplete bölümüne bakın. |
Adres kalitesi
Bazı alanlar, adres bileşenleriyle ilgili sorunları veya bu bileşenlerde yapılan düzenlemeleri (ör. tahmin edilen veya eksik adres bileşenleri) gösterir. Örneğin, aşağıdaki verdict
mülkü, doğrulanmamış bileşenleri ve eksik addressComplete
alanı olan bir adresi gösterir:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Referans kılavuzundaki Verdict bölümüne bakın. |
address
ve addressComponent
özellikleri
address
mülkü, istekte sağlanan işlenmiş adresin biçimlendirmesini ve adresin yanlış yazılmış bölümleri, yanlış bölümlerin değiştirilmesi ve eksik bölümlerin tahmin edilmesi dahil olmak üzere adresin bileşen düzeyinde özetlerini sağlar.
Referans kılavuzundaki Address bölümüne bakın. |
addressComponent
mülkü, Address Validation API'nin işlediği adresin öğelerinin (veya bileşenlerinin) ayrıntılı bir listesini sağlayan address
'nin bir alt bileşenidir. API, her bileşen alanını adı, türü ve onay düzeyine göre tanımlar.
Referans kılavuzundaki addressComponent bölümüne bakın. |
geocode
mülkü
geocode
mülkü, giriş adresiyle ilişkili coğrafi kodlanmış konumu gösterir. Bu özellik, konumla ilgili ayrıntıları (ör. yer kimliği) sağlar.
Referans kılavuzundaki Geocode bölümüne bakın. |
metadata
mülkü
Bu özellik, Address Validation API tarafından işlenen her adres için doldurulmayabilir ancak adresin ikamet, işletme veya posta kutusu türü olup olmadığını belirtir.
Address Validation API kapsamı ve Address metadata referansına bakın.
|
uspsData
mülkü
Bu mülk, ABD posta adresleri için yararlı bilgiler sağlar.
Ancak hizmet tarafından doğrulanan her adres için bu alanın tam olarak doldurulacağı garanti edilmez. Bu nedenle, adresleri doğrulamak için tek yöntem olarak bu mülke güvenmemeli, bunun yerine verdict
ve address
'yi de kontrol etmelisiniz.
ABD adreslerini işleme bölümüne ve UspsData referansına bakın.
|