Temel adres doğrulama yanıtını anlama

Adres Doğrulama API'si, iki üst düzey mülk içeren bir JSON nesnesi olarak yanıt gövdesi sağlar:

{
  "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 belgede result nesnesi ele alınmaktadır. responseID hakkında bilgi edinmek için Güncellenen adresleri yönetme başlıklı makaleyi inceleyin.

verdict özelliği

verdict özelliği, adres doğrulama sonuçlarını özetler ve adres kontrolü mantığı oluşturulurken değerlendirilecek ilk özellik olmalıdır. Çıkış adresinin kalitesine bağlı olarak özellik çeşitli alanlar döndürebilir. Örneğin, aşağıda iyi kalitede bir adresin verdict özelliği gösterilmektedir. Bu özellik, söz konusu istek için 4 alan döndürür:

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true,
  "possibleNextAction": "ACCEPT"
}

Aşağıdaki bölümlerde, verdict özelliğindeki tüm alanlar özetlenmektedir.

Referans kılavuzundaki Verdict bölümüne bakın.

Olası sonraki işlem

possibleNextAction özelliği, API yanıtının geri kalanının yorumlayıcı bir özetini sunar. Bu özetin amacı, müşterinizi adresini incelemeye veya düzenlemeye yönlendirmeniz gerekip gerekmediğini belirlemenize yardımcı olmaktır. Daha fazla bilgi için Doğrulama mantığınızı oluşturma konusuna bakın.

Adresin ayrıntı düzeyi

Adres ayrıntı düzeyi, bir adresin veya coğrafi kodun özgüllüğünü belirlemede kullanılan ayrıntı düzeyini ifade eder. validationGranularity yanıttaki adresin ne kadar spesifik olduğu, adresin teslim edilebilir olup olmadığıyla ilgili önemli bir sinyaldir.

verdict özelliği şu ayrıntı düzeyi sinyallerini döndürür:

  • inputGranularity: Address Validation API'ye gönderilen adresten alınan ayrıntı düzeyini açıklar. İstekteki adres ayrıntı düzeyi, doğrulama yanıtındaki adres ayrıntı düzeyini etkiler. Örneğin, inputGranularity seviyesinin altında PREMISE seviyesinin altında bir adres genellikle PREMISE seviyesine validationGranularity ile sonuçlanmaz.
  • validationGranularity: Adres Doğrulama API'sinin adresi tam olarak doğrulayabileceği ayrıntı düzeyi. Çoğu durumda, PREMISE veya SUB_PREMISE ayrıntı düzeyi, teslim edilebilirliği yüksek kaliteli bir adresi gösterir.
  • geocodeGranularity: Adresle ilişkili coğrafi kodun ayrıntı düzeyini açıklar. Örneğin, Google kayıtları bir daire numarasının varlığını gösterebilir ancak büyük bir apartman kompleksindeki söz konusu dairenin tam konumunu göstermeyebilir. Bu durumda, validationGranularity SUB_PREMISE olur ancak geocodeGranularityisPREMISE`.
Referans kılavuzundaki Ayrıntı Düzeyi bölümüne bakın.

Adresin eksiksiz olması

Karar, addressComplete özelliğini yüksek kaliteli bir adresin sinyali olarak döndürür. Bu, özellikle eksik, çözümlenmemiş veya beklenmedik bileşenler olmadığı anlamına gelir:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true,
    "possibleNextAction": "ACCEPT"
}

Adreste eksik, çözümlenmemiş veya beklenmedik bileşenler olduğunda alan false olarak ayarlanır.

Referans kılavuzundaki Verdict (Verdict) ve Adres (Address) bölümlerinde addressComplete simgesine bakın.

Adres kalitesi

Olası alanlardan bazıları, adres bileşenleriyle ilgili sorunları veya adres bileşenlerinde yapılan değişiklikleri (ör. çıkarılan veya eksik adres bileşenleri) gösterir. Örneğin, aşağıdaki verdict özelliği, bileşenleri onaylanmamış bir adresi ve eksik bir addressComplete alanını belirtir:

"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 özelliği, istekte sağlanan işlenmiş adres için biçimlendirme sağlar. Ayrıca, adresin bileşen düzeyindeki özetlerini (ör. adresin yanlış yazılmış kısımları, değiştirilen yanlış kısımlar ve eksik olduğu çıkarılan kısımlar) içerir.

Referans kılavuzundaki Address bölümüne bakın.

addressComponent özelliği, address öğesinin bir alt bileşenidir ve Adres Doğrulama API'sinin işlediği adresin öğelerinin (veya bileşenlerinin) ayrıntılı bir listesini sağlar. API, sağlanan her bileşen alanını adı, türü ve onay düzeyiyle tanımlar.

Referans kılavuzundaki addressComponent bölümüne bakın.

geocode özelliği

geocode özelliği, giriş adresiyle ilişkili coğrafi kodlanmış konumu gösterir. Bu özellik, konumun kendisiyle ilgili ayrıntılar (ör. yer kimliği) sağlar.

Referans kılavuzundaki Geocode bölümüne bakın.

metadata özelliği

Bu özellik, Adres Doğrulama API'si tarafından işlenen her adres için doldurulmayabilir ancak adresin türünün konut, işletme veya posta kutusu olup olmadığını gösterir.

Address Validation API kapsamı ve Address metadata referansına bakın.

uspsData özelliği

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, adresleri doğrulamak için tek yöntem olarak bu mülke güvenmemeli, bunun yerine verdict ve address mülklerini de kontrol etmelisiniz.

ABD adreslerini işleme ve UspsData referansına bakın.
Önceki
Adres doğrulama isteği gönderme
Sonraki
Doğrulama mantığınızı oluşturun