Address Validation API, iki üst düzey özellik içeren bir JSON nesnesi olarak yanıt gövdesi sağlar:
result
,ValidationResult
türünde 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ılmaktadır. responseID
hakkında bilgi için Güncellenen adresleri işleme başlıklı makaleyi inceleyin.
verdict
mülkü
verdict
özelliği, adres doğrulamasının sonuçlarını özetler ve adres denetimi mantığı oluştururken değerlendirilecek ilk özellik olmalıdır.
Özellik, çıkış adresinin kalitesine bağlı olarak çeşitli alanlar döndürebilir. Örneğin, aşağıda iyi kaliteli bir adresin verdict
özelliği gösterilmektedir ve bu özel istek için 4 alan döndürmektedir:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Aşağıdaki bölümlerde verdict
mülkündeki tüm alanlar özetlenmektedir.
Referans kılavuzundaki Sonuç'a bakın. |
Adresin ayrıntı düzeyi
Adres ayrıntı düzeyi, bir adresin veya coğrafi kodun belirliliğini belirlemede kullanılan ayrıntı düzeyini ifade eder. validationGranularity
yanıtındaki adres belirginliği, bir adresin teslim edilebilir olup olmadığına dair önemli bir sinyaldir.
verdict
özelliği şu ayrıntı düzeyi sinyallerini döndürür:
inputGranularity
— Address Validation API'ye gönderilen adresten yakalanan ayrıntı düzeyini tanımlar. İstekteki adres ayrıntısı düzeyi, doğrulama yanıtındaki adres ayrıntısı düzeyini etkiler. Örneğin,inputGranularity
değeriPREMISE
değerinin altında olan bir adres genelliklevalidationGranularity
ilePREMISE
düzeyinin altında kalmasını sağlamaz.validationGranularity
— Address Validation API'nin adresi tam olarak doğrulayabileceği ayrıntı düzeyi. Çoğu durumda,PREMISE
veyaSUB_PREMISE
ayrıntı düzeyi, teslimat olasılığı yüksek olan bir kalite adresini gösterir.geocodeGranularity
— Adresle ilişkili coğrafi kodun ayrıntı düzeyini belirtir. Örneğin, Google kayıtları bir apartman numarasının bulunduğunu belirtiyor ancak büyük bir apartman kompleksindeki söz konusu dairenin kesin konumunu belirtmeyebilir. Bu durumdavalidationGranularity
,SUB_PREMISE
ancakgeocodeGranularity
is
PREMISE" olur.
Referans kılavuzundaki Ayrıntı düzeyi bölümüne bakın. |
Adresin eksiksiz olması
Sonuç, yüksek kaliteli adres sinyali olarak addressComplete
özelliğini döndürür. Bu da özellikle eksik, çözümlenmemiş veya beklenmedik bileşen içermediği anlamına gelir:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Adreste eksik, çözümlenmemiş veya beklenmeyen bileşenler varsa alan false
olarak ayarlanır.
Referans kılavuzundaki Sonuç ve Adres bölümünde addressComplete bölümüne bakın. |
Adres kalitesi
Olası birçok alan, adres bileşenleriyle ilgili sorunları veya tahmin edilen ya da eksik adres bileşenleri gibi bu bileşenlerde yapılan düzenlemeleri gösterir. Örneğin, aşağıdaki verdict
özelliği, onaylanmamış bileşenlere ve eksik addressComplete
alanına sahip bir adresi gösterir:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Referans kılavuzunda Sonuç'a bakın. |
address
ve addressComponent
özellikleri
address
özelliği, istekte sağlanan işlenen adres için biçimlendirmenin yanı sıra adresin yanlış yazılmış kısımları, değiştirilen yanlış kısımlar ve tahmin edilen eksik bölümler dahil olmak üzere adresin bileşen düzeyindeki özetlerini sağlar.
Referans kılavuzunda bkz. Address . |
addressComponent
özelliği, address
adresinin alt bileşenidir. Bu bileşen, Address Validation API'nin işlediği adresin öğelerinin (veya bileşenlerinin) ayrıntılı bir listesini sağlar. API, her bileşen alanının sağladığı ada, türüne ve onay düzeyine göre tanımlanır.
Referans kılavuzunda bkz. addressComponent . |
geocode
mülkü
geocode
özelliği, giriş adresiyle ilişkilendirilmiş coğrafi olarak kodlanmış konumu gösterir. Bu tesis, konumun kendisi hakkında yer kimliği gibi bilgiler sağlar.
Referans kılavuzunda bkz. Geocode . |
metadata
mülkü
Bu özellik, Address Validation API tarafından işlenen her adres için doldurulmayabilir ancak adresin konut, işletme veya Posta Kutusu türünde olup olmadığını gösterir.
Adres Doğrulama API'si kapsamı bölümünü ve Address metadata referansını inceleyin.
|
uspsData
mülkü
Bu özellik, ABD posta adresleri için yararlı bilgiler sağlar.
Ancak, hizmet tarafından doğrulanan her adres için tam olarak doldurulacağı garanti edilmez. Bu nedenle, tek başına adreslerin doğrulanması anlamına geldiği için bu özelliği kullanmamak yerine verdict
ve address
özelliklerini de kontrol edin.
ABD adreslerini işleme ve UspsData referansını inceleyin.
|