Method: validateAddress

ตรวจสอบที่อยู่

คำขอ HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
ช่อง
address

object (PostalAddress)

ต้องระบุ ที่อยู่กำลังได้รับการตรวจสอบ คุณควรส่งที่อยู่ที่ไม่มีการจัดรูปแบบผ่าน addressLines

ความยาวรวมของช่องในอินพุตนี้ต้องไม่เกิน 280 อักขระ

ดูภูมิภาคที่รองรับได้ที่นี่

ระบบจะสงวนค่า languageCode ในที่อยู่อินพุตไว้สำหรับการใช้งานในอนาคตและจะไม่สนใจในตอนนี้ ระบบจะป้อนข้อมูลที่อยู่ที่ได้รับการตรวจสอบตามภาษาที่ต้องการสำหรับที่อยู่นั้นๆ ตามที่ระบบระบุ

Address Validation API ไม่สนใจค่าใน recipients และ organization ระบบจะทิ้งค่าในช่องเหล่านั้นและไม่แสดงผล โปรดอย่าตั้งค่า
previousResponseId

string

ช่องนี้ต้องว่างเปล่าสำหรับคำขอยืนยันที่อยู่ครั้งแรก หากจำเป็นต้องมีคำขอเพิ่มเติมเพื่อตรวจสอบที่อยู่เดียวให้เสร็จสมบูรณ์ (เช่น หากการเปลี่ยนแปลงที่ผู้ใช้ทำหลังจากการตรวจสอบครั้งแรกต้องได้รับการตรวจสอบอีกครั้ง) คำขอติดตามผลแต่ละรายการจะต้องป้อนข้อมูลในช่องนี้ด้วย responseId จากการตอบกลับครั้งแรกในลำดับการตรวจสอบ
enableUspsCass

boolean

เปิดใช้โหมดที่เข้ากันได้กับ USPS CASS ซึ่งจะส่งผลต่อเฉพาะช่อง google.maps.addressvalidation.v1.ValidationResult.usps_data ของ google.maps.addressvalidation.v1.ValidationResult หมายเหตุ: สำหรับคำขอที่อยู่ในเปอร์โตริโกที่เปิดใช้ CASS ของ USPS คุณต้องระบุ google.type.PostalAddress.region_code ของ address เป็น "PR" หรือระบุ google.type.PostalAddress.administrative_area ของ address เป็น "เปอร์โตริโก" (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) หรือ "PR"

เราขอแนะนำให้ใช้ address แบบคอมโพเนนต์ หรือระบุ google.type.PostalAddress.address_lines อย่างน้อย 2 รายการ โดยให้บรรทัดแรกมีหมายเลขและชื่อถนน ส่วนบรรทัดที่ 2 มีเมือง รัฐ และรหัสไปรษณีย์
languageOptions

object (LanguageOptions)

ไม่บังคับ เวอร์ชันตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจมีการรองรับที่จำกัด และการเปลี่ยนแปลงผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจใช้ร่วมกับเวอร์ชันอื่นๆ ของเวอร์ชันก่อน GA ไม่ได้ ข้อเสนอก่อนเปิดตัวอยู่ภายใต้ข้อกำหนดเฉพาะบริการของ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ที่คำอธิบายสถานะการเปิดตัว

เปิดใช้ Address Validation API เพื่อรวมข้อมูลเพิ่มเติมในการตอบกลับ
sessionToken

string

ไม่บังคับ สตริงที่ระบุเซสชันการเติมข้อความอัตโนมัติเพื่อวัตถุประสงค์ในการเรียกเก็บเงิน ต้องเป็นสตริง Base64 ที่ปลอดภัยสำหรับ URL และชื่อไฟล์ซึ่งมีความยาวไม่เกิน 36 อักขระ ASCII ไม่เช่นนั้น ระบบจะแสดงข้อผิดพลาด INVALID_ARGUMENT

เซสชันจะเริ่มขึ้นเมื่อผู้ใช้ทำการค้นหาแบบเติมข้อความอัตโนมัติ และสิ้นสุดลงเมื่อผู้ใช้เลือกสถานที่และมีการเรียกใช้รายละเอียดสถานที่หรือการยืนยันที่อยู่ เซสชันแต่ละรายการอาจมีคำค้นหาที่ระบบเติมข้อความอัตโนมัติหลายรายการ ตามด้วยคำขอรายละเอียดสถานที่หรือการยืนยันที่อยู่ 1 รายการ ข้อมูลเข้าสู่ระบบที่ใช้สำหรับคำขอแต่ละรายการภายในเซสชันต้องมาจากโปรเจ็กต์ Google Cloud Console เดียวกัน เมื่อเซสชันสิ้นสุดลง โทเค็นจะไม่มีผลอีกต่อไป แอปของคุณจึงต้องสร้างโทเค็นใหม่สำหรับแต่ละเซสชัน หากไม่ใส่พารามิเตอร์ sessionToken หรือคุณใช้โทเค็นเซสชันซ้ำ ระบบจะเรียกเก็บเงินสำหรับเซสชันนั้นราวกับว่าไม่ได้ระบุโทเค็นเซสชัน (ระบบจะเรียกเก็บเงินสำหรับคำขอแต่ละรายการแยกกัน)

หมายเหตุ: การตรวจสอบที่อยู่ใช้ได้เฉพาะในเซสชันที่มี Autocomplete (ใหม่) API เท่านั้น จะใช้กับ Autocomplete API ไม่ได้ ดูรายละเอียดเพิ่มเติมได้ที่ https://developers.google.com/maps/documentation/places/web-service/session-pricing

เนื้อหาการตอบกลับ

การตอบกลับคำขอตรวจสอบที่อยู่

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
ช่อง
result

object (ValidationResult)

ผลการตรวจสอบที่อยู่
responseId

string

UUID ที่ระบุการตอบกลับนี้ หากต้องการตรวจสอบที่อยู่อีกครั้ง UUID นี้ต้องมาพร้อมกับคำขอใหม่

PostalAddress

แสดงที่อยู่ไปรษณีย์ (เช่น สำหรับการนำส่งทางไปรษณีย์หรือที่อยู่สำหรับชำระเงิน) เมื่อระบุที่อยู่ไปรษณีย์แล้ว บริการไปรษณีย์จะส่งสินค้าไปยังสถานที่ตั้ง ตู้ ปณ. หรือที่คล้ายกันได้ ไม่ได้มีไว้เพื่อจำลองสถานที่ตั้งทางภูมิศาสตร์ (ถนน เมือง ภูเขา)

ในการใช้งานทั่วไป ระบบจะสร้างที่อยู่ตามข้อมูลที่ผู้ใช้ป้อนหรือจากการนําเข้าข้อมูลที่มีอยู่ ทั้งนี้ขึ้นอยู่กับประเภทของกระบวนการ

คำแนะนำเกี่ยวกับการป้อนหรือแก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่พร้อมใช้งานแบบหลายภาษา เช่น https://github.com/google/libaddressinput - ผู้ใช้ไม่ควรเห็นองค์ประกอบ UI สำหรับการป้อนหรือแก้ไขช่องนอกประเทศที่ใช้ช่องนั้น

ดูคําแนะนําเพิ่มเติมเกี่ยวกับวิธีใช้สคีมานี้ได้ที่ https://support.google.com/business/answer/6397478

การแสดง JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
ช่อง
revision

integer

การแก้ไขสคีมาของ PostalAddress ค่าที่ไม่ใช่ 0 จะทําให้ API แสดงข้อผิดพลาด INVALID_ARGUMENT
regionCode

string

ไม่บังคับ รหัสภูมิภาค CLDR ของประเทศ/ภูมิภาคของที่อยู่ ดูรายละเอียดได้ที่ https://cldr.unicode.org/ และ https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html เช่น "CH" สำหรับสวิตเซอร์แลนด์ หากไม่ได้ระบุรหัสภูมิภาค ระบบจะอนุมานรหัสจากที่อยู่ เราขอแนะนำให้ระบุรหัสภูมิภาคหากคุณทราบเพื่อประสิทธิภาพที่ดีที่สุด การมีภูมิภาคที่ไม่สอดคล้องกันหรือซ้ำกันอาจทําให้ประสิทธิภาพแย่ลง เช่น หาก addressLines มีภูมิภาคอยู่แล้ว ก็ไม่ต้องระบุรหัสภูมิภาคอีกครั้งในช่องนี้ ดูภูมิภาคที่รองรับได้ในคำถามที่พบบ่อย
languageCode

string

ระบบจะสงวนรหัสภาษาในที่อยู่อินพุตไว้สำหรับการใช้งานในอนาคตและจะไม่สนใจรหัสดังกล่าวในวันนี้ API จะแสดงผลที่อยู่เป็นภาษาที่เหมาะสมกับสถานที่ตั้งของที่อยู่
postalCode

string

ไม่บังคับ รหัสไปรษณีย์ของที่อยู่ บางประเทศไม่ได้ใช้หรือกำหนดให้ต้องระบุรหัสไปรษณีย์ แต่หากใช้รหัสไปรษณีย์ ระบบอาจเรียกใช้การตรวจสอบเพิ่มเติมกับส่วนอื่นๆ ของที่อยู่ (เช่น การตรวจสอบรัฐหรือรหัสไปรษณีย์ในสหรัฐอเมริกา)
sortingCode

string

ไม่บังคับ รหัสการจัดเรียงเพิ่มเติมสำหรับแต่ละประเทศ ซึ่งไม่ได้ใช้ในภูมิภาคส่วนใหญ่ ค่าที่ใช้จะเป็นสตริง เช่น "CEDEX" ตามด้วยตัวเลข (ไม่บังคับ) (เช่น "CEDEX 7") หรือจะเป็นตัวเลขเพียงอย่างเดียวก็ได้ ซึ่งแสดงถึง "รหัสภาค" (จาไมก้า), "ตัวบ่งชี้พื้นที่การนำส่ง" (มาลาวี) หรือ "ตัวบ่งชี้ที่ทำการไปรษณีย์" (โกต-ดิวัวเร)
administrativeArea

string

ไม่บังคับ เขตบริหารย่อยที่สูงที่สุดซึ่งใช้สำหรับที่อยู่ไปรษณีย์ของประเทศหรือภูมิภาค เช่น รัฐ จังหวัด เขต หรือจังหวัด สำหรับสเปน ฟิลด์นี้จะระบุจังหวัด ไม่ใช่แคว้นปกครองตนเอง (เช่น "บาร์เซโลนา" ไม่ใช่ "คาตาโลเนีย") หลายประเทศไม่ได้ใช้เขตบริหารในที่อยู่ไปรษณีย์ เช่น ในสวิตเซอร์แลนด์ คุณควรปล่อยช่องนี้ว่างไว้
locality

string

ไม่บังคับ โดยทั่วไปหมายถึงส่วนเมืองหรืออำเภอของที่อยู่ เช่น เมืองในสหรัฐอเมริกา เทศบาลในอิตาลี เมืองไปรษณีย์ในสหราชอาณาจักร ในภูมิภาคของโลกที่ระบุสถานที่ตั้งไม่ชัดเจนหรือไม่เหมาะกับโครงสร้างนี้ ให้เว้นlocalityว่างไว้และใช้addressLines
sublocality

string

ไม่บังคับ เขตท้องที่ของที่อยู่ เช่น อาจเป็นย่าน เมืองเล็กๆ หรือเขต
addressLines[]

string

ต้องระบุ บรรทัดที่อยู่ที่ไม่เป็นโครงสร้างซึ่งอธิบายที่อยู่ในระดับล่าง

เนื่องจากค่าใน addressLines ไม่มีข้อมูลประเภท และบางครั้งอาจมีหลายค่าในช่องเดียว (เช่น "Austin, TX") คุณจึงควรจัดลำดับบรรทัดให้ชัดเจน ลำดับของบรรทัดที่อยู่ควรเป็น "ลำดับของซองจดหมาย" สำหรับประเทศ/ภูมิภาคของที่อยู่

การแสดงข้อมูลที่มีโครงสร้างขั้นต่ำที่อนุญาตของที่อยู่ประกอบด้วยข้อมูลทั้งหมดที่อยู่ใน addressLines หากไม่ได้ระบุ regionCode ระบบจะอนุมานภูมิภาคจากบรรทัดที่อยู่

เราขอแนะนำให้สร้างที่อยู่ที่มีเฉพาะ addressLines แล้วทำการจับคู่พิกัดภูมิศาสตร์เพื่อจัดการกับที่อยู่ที่ไม่มีโครงสร้างโดยสมบูรณ์ (แทนที่จะเดาว่าส่วนใดของที่อยู่ควรเป็นสถานที่ตั้งหรือเขตบริหาร)
recipients[]

string

โปรดหลีกเลี่ยงการตั้งค่าช่องนี้ ปัจจุบัน Address Validation API ไม่ได้ใช้ แม้ว่าในตอนนี้ API จะไม่ปฏิเสธคำขอที่มีการตั้งค่าช่องนี้ แต่ระบบจะทิ้งข้อมูลดังกล่าวและจะไม่แสดงในคำตอบ
organization

string

โปรดหลีกเลี่ยงการตั้งค่าช่องนี้ ปัจจุบัน Address Validation API ไม่ได้ใช้ แม้ว่าในตอนนี้ API จะไม่ปฏิเสธคำขอที่มีการตั้งค่าช่องนี้ แต่ระบบจะทิ้งข้อมูลดังกล่าวและจะไม่แสดงในคำตอบ

LanguageOptions

เวอร์ชันตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจมีการรองรับที่จำกัด และการเปลี่ยนแปลงผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจใช้ร่วมกับเวอร์ชันอื่นๆ ของเวอร์ชันก่อน GA ไม่ได้ ข้อเสนอก่อนเปิดตัวอยู่ภายใต้ข้อกำหนดเฉพาะบริการของ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ที่คำอธิบายสถานะการเปิดตัว

เปิดใช้ Address Validation API เพื่อรวมข้อมูลเพิ่มเติมในการตอบกลับ

การแสดง JSON 
{
  "returnEnglishLatinAddress": boolean
}
ช่อง
returnEnglishLatinAddress

boolean

ตัวอย่าง: แสดงผล google.maps.addressvalidation.v1.Address เป็นภาษาอังกฤษ ดูรายละเอียดได้ที่ google.maps.addressvalidation.v1.ValidationResult.english_latin_address

ValidationResult

ผลการตรวจสอบที่อยู่

การแสดง JSON 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
ช่อง
verdict

object (Verdict)

แฟล็กคำตัดสินโดยรวม
address

object (Address)

ข้อมูลเกี่ยวกับที่อยู่ ไม่ใช่พิกัดภูมิศาสตร์
geocode

object (Geocode)

ข้อมูลเกี่ยวกับสถานที่ตั้งและสถานที่ที่ที่อยู่ได้รับการจับคู่พิกัดภูมิศาสตร์
metadata

object (AddressMetadata)

ข้อมูลอื่นๆ ที่เกี่ยวข้องกับความสามารถในการนำส่ง เราไม่รับประกันว่า metadata จะแสดงข้อมูลอย่างครบถ้วนสำหรับทุกที่อยู่ซึ่งส่งไปยัง Address Validation API
uspsData

object (UspsData)

Flag ความสามารถในการนำส่งเพิ่มเติมที่ USPS ระบุ มีให้บริการในภูมิภาค US และ PR เท่านั้น
englishLatinAddress

object (Address)

เวอร์ชันตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจมีการรองรับที่จำกัด และการเปลี่ยนแปลงผลิตภัณฑ์และฟีเจอร์เวอร์ชันก่อน GA อาจใช้ร่วมกับเวอร์ชันอื่นๆ ของเวอร์ชันก่อน GA ไม่ได้ ข้อเสนอก่อนเปิดตัวอยู่ภายใต้ข้อกำหนดเฉพาะบริการของ Google Maps Platform ดูข้อมูลเพิ่มเติมได้ที่คำอธิบายสถานะการเปิดตัว

ที่อยู่แปลเป็นภาษาอังกฤษ

ที่อยู่ที่ได้รับการแปลแล้วจะนำมาใช้ซ้ำเป็นอินพุต API ไม่ได้ บริการนี้มีไว้เพื่อให้ผู้ใช้ใช้ภาษาแม่เพื่อยืนยันหรือปฏิเสธการตรวจสอบที่อยู่ที่ให้ไว้ตั้งแต่แรกได้

หากส่วนใดส่วนหนึ่งของที่อยู่ไม่มีคำแปลภาษาอังกฤษ บริการจะแสดงผลส่วนนั้นในภาษาอื่นที่ใช้อักษรละติน ดูคำอธิบายเกี่ยวกับวิธีเลือกภาษาอื่นได้ที่นี่ หากส่วนใดส่วนหนึ่งของที่อยู่ไม่มีคำแปลหรือการถอดเสียงเป็นภาษาที่ใช้อักษรละติน บริการจะแสดงผลส่วนนั้นในภาษาท้องถิ่นที่เชื่อมโยงกับที่อยู่

เปิดใช้เอาต์พุตนี้โดยใช้ Flag google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address

หมายเหตุ: ช่อง google.maps.addressvalidation.v1.Address.unconfirmed_component_types ใน englishLatinAddress และช่อง google.maps.addressvalidation.v1.AddressComponent.confirmation_level ใน englishLatinAddress.address_components ไม่มีข้อมูล

คำตัดสิน

ภาพรวมระดับสูงของผลการตรวจสอบที่อยู่และพิกัดภูมิศาสตร์

การแสดง JSON 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
ช่อง
inputGranularity

enum (Granularity)

ความละเอียดของที่อยู่ input ผลลัพธ์นี้มาจากการแยกวิเคราะห์ที่อยู่อินพุตและไม่ได้ให้สัญญาณการตรวจสอบใดๆ โปรดดูสัญญาณการตรวจสอบที่ validationGranularity ด้านล่าง

เช่น หากที่อยู่ป้อนมีหมายเลขอพาร์ตเมนต์ที่เฉพาะเจาะจง inputGranularity ที่นี่จะเป็น SUB_PREMISE หากเราจับคู่หมายเลขอพาร์ตเมนต์ในฐานข้อมูลไม่ได้หรือหมายเลขอพาร์ตเมนต์ไม่ถูกต้อง validationGranularity อาจมีค่าเป็น PREMISE หรือแย่กว่านั้น
validationGranularity

enum (Granularity)

ระดับความละเอียดที่ API สามารถตรวจสอบที่อยู่ได้อย่างเต็มที่ เช่น validationGranularity ของ PREMISE บ่งบอกว่าสามารถตรวจสอบองค์ประกอบที่อยู่ทั้งหมดที่ระดับ PREMISE หรือต่ำกว่าได้

ผลการตรวจสอบองค์ประกอบที่อยู่แต่ละรายการจะแสดงใน google.maps.addressvalidation.v1.Address.address_components
geocodeGranularity

enum (Granularity)

ข้อมูลเกี่ยวกับความละเอียดของ geocode ซึ่งหมายถึงความหมายเชิงอรรถศาสตร์ของความละเอียดของตำแหน่งที่จับคู่พิกัดภูมิศาสตร์

ซึ่งบางครั้งอาจแตกต่างจาก validationGranularity ด้านบน เช่น ฐานข้อมูลของเราอาจบันทึกหมายเลขอพาร์ตเมนต์ แต่ไม่มีตำแหน่งที่แน่นอนของอพาร์ตเมนต์ภายในอาคารอพาร์ตเมนต์ขนาดใหญ่ ในกรณีนี้ validationGranularity จะกลายเป็น SUB_PREMISE แต่ geocodeGranularity จะกลายเป็น PREMISE
addressComplete

boolean

ระบบจะถือว่าที่อยู่สมบูรณ์หากไม่มีโทเค็นที่ยังไม่ได้รับการแก้ไข ไม่มีองค์ประกอบที่อยู่ที่ไม่คาดคิดหรือขาดหายไป หากไม่ได้ตั้งค่าไว้ แสดงว่าค่าคือ false ดูรายละเอียดเพิ่มเติมในช่อง missingComponentTypes, unresolvedTokens หรือ unexpected
hasUnconfirmedComponents

boolean

ไม่สามารถจัดหมวดหมู่หรือตรวจสอบองค์ประกอบที่อยู่อย่างน้อย 1 รายการ ดูรายละเอียดที่ google.maps.addressvalidation.v1.Address.address_components
hasInferredComponents

boolean

ระบบอนุมาน (เพิ่ม) องค์ประกอบที่อยู่อย่างน้อย 1 รายการที่ไม่ได้อยู่ในอินพุต ดูรายละเอียดที่ google.maps.addressvalidation.v1.Address.address_components
hasReplacedComponents

boolean

มีการเปลี่ยนองค์ประกอบที่อยู่อย่างน้อย 1 รายการ โปรดดูรายละเอียดที่ google.maps.addressvalidation.v1.Address.address_components

รายละเอียด

รายละเอียดต่างๆ ที่ที่อยู่หรือพิกัดภูมิศาสตร์อาจมี เมื่อใช้เพื่อระบุความละเอียดของที่อยู่ ค่าเหล่านี้จะระบุความละเอียดของที่อยู่ที่จะระบุปลายทางการส่งจดหมาย เช่น ที่อยู่อย่าง "123 Main Street, Redwood City, CA, 94061" จะระบุ PREMISE ส่วนที่อยู่อย่าง "Redwood City, CA, 94061" จะระบุ LOCALITY อย่างไรก็ตาม หากไม่พบพิกัดภูมิศาสตร์สําหรับ "123 Main Street" ใน Redwood City พิกัดภูมิศาสตร์ที่แสดงอาจมีความละเอียดระดับ LOCALITY แม้ว่าที่อยู่จะมีความละเอียดมากกว่าก็ตาม

Enum
GRANULARITY_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน
SUB_PREMISE ผลลัพธ์ที่อยู่ต่ำกว่าระดับอาคาร เช่น อพาร์ตเมนต์
PREMISE ผลลัพธ์ระดับอาคาร
PREMISE_PROXIMITY พิกัดภูมิศาสตร์ที่ประมาณตำแหน่งระดับอาคารของที่อยู่
BLOCK ที่อยู่หรือรหัสพิกัดภูมิศาสตร์แสดงถึงบล็อก ใช้เฉพาะในภูมิภาคที่มีการระบุที่อยู่ระดับบล็อก เช่น ญี่ปุ่น
ROUTE รหัสพิกัดภูมิศาสตร์หรือที่อยู่มีความละเอียดตามเส้นทาง เช่น ถนน ทางหลวง หรือทาง
OTHER รายละเอียดอื่นๆ ทั้งหมด ซึ่งจะรวมไว้ในกลุ่มเดียวกันเนื่องจากไม่สามารถนําส่งได้

ที่อยู่

รายละเอียดของที่อยู่หลังการประมวลผล ขั้นตอนหลังการประมวลผลประกอบด้วยการแก้ไขส่วนที่สะกดผิดของที่อยู่ แทนที่ส่วนที่ไม่ถูกต้อง และอนุมานส่วนที่ขาดหายไป

การแสดง JSON 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
ช่อง
formattedAddress

string

ที่อยู่หลังการประมวลผลซึ่งมีการจัดรูปแบบเป็นที่อยู่บรรทัดเดียวตามกฎการจัดรูปแบบที่อยู่ของภูมิภาคที่อยู่ที่ตั้งอยู่

หมายเหตุ: รูปแบบของที่อยู่นี้อาจไม่ตรงกับรูปแบบของที่อยู่ในช่อง postalAddress เช่น postalAddress จะแสดงประเทศเป็นregionCode 2 ตัวอักษรเสมอ เช่น "US" หรือ "NZ" ในทางตรงกันข้าม ฟิลด์นี้ใช้ชื่อประเทศแบบยาว เช่น "สหรัฐอเมริกา" หรือ "นิวซีแลนด์"
postalAddress

object (PostalAddress)

ที่อยู่หลังการประมวลผลที่แสดงเป็นที่อยู่ไปรษณีย์
addressComponents[]

object (AddressComponent)

รายการที่ไม่เรียงลําดับ องค์ประกอบที่อยู่แต่ละรายการของที่อยู่ที่ได้รับการจัดรูปแบบและแก้ไขแล้ว พร้อมข้อมูลการตรวจสอบ ซึ่งจะแสดงข้อมูลสถานะการตรวจสอบของคอมโพเนนต์แต่ละรายการ

องค์ประกอบที่อยู่ไม่ได้จัดเรียงตามลําดับที่เจาะจง อย่าคาดเดาลำดับขององค์ประกอบที่อยู่ในรายการ
missingComponentTypes[]

string

ประเภทของคอมโพเนนต์ที่คาดว่าจะอยู่ในที่อยู่สำหรับจัดส่งที่มีการจัดรูปแบบถูกต้อง แต่ไม่พบคําในอินพุตและไม่สามารถอนุมานได้ ตัวอย่างเช่น ['street_number', 'route'] สำหรับอินพุตอย่าง "Boulder, Colorado, 80301, USA" ดูรายการประเภทที่เป็นไปได้ได้ที่นี่

หมายเหตุ: คุณอาจเห็นประเภทคอมโพเนนต์ที่ขาดหายไปเมื่อคิดว่าได้ระบุคอมโพเนนต์ที่ขาดหายไปแล้ว ตัวอย่างเช่น กรณีนี้อาจเกิดขึ้นเมื่อที่อยู่ป้อนมีชื่ออาคาร แต่ไม่มีหมายเลขพร็อพเพอร์ตี้ ในที่อยู่ "渋谷区渋谷３丁目　Shibuya Stream" ชื่ออาคาร "Shibuya Stream" มีประเภทคอมโพเนนต์เป็น premise แต่ไม่มีหมายเลขพร็อพเพอร์ตี้ ดังนั้น missingComponentTypes จะมี premise
unconfirmedComponentTypes[]

string

ประเภทของคอมโพเนนต์ที่มีอยู่ใน addressComponents แต่ไม่สามารถยืนยันความถูกต้องได้ ช่องนี้มีไว้เพื่อความสะดวก เนื้อหาของช่องนี้เทียบเท่ากับการวนผ่าน addressComponents เพื่อค้นหาประเภทของคอมโพเนนต์ทั้งหมดที่ confirmationLevel ไม่ใช่ CONFIRMED หรือไม่ได้ตั้งค่า Flag inferred เป็น true ดูรายการประเภทที่เป็นไปได้ได้ที่นี่
unresolvedTokens[]

string

โทเค็นในอินพุตที่ไม่สามารถแก้ไขได้ อาจเป็นอินพุตที่ระบบไม่รู้จักว่าเป็นส่วนที่ถูกต้องของที่อยู่ ตัวอย่างเช่น สำหรับอินพุต เช่น "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US" โทเค็นที่ยังไม่ได้รับการแก้ไขอาจมีลักษณะดังนี้ ["Parcel", "0000123123", "&", "0000456456"]

AddressComponent

แสดงองค์ประกอบที่อยู่ เช่น ถนน เมือง หรือรัฐ

การแสดง JSON 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
ช่อง
componentName

object (ComponentName)

ชื่อของคอมโพเนนต์นี้
componentType

string

ประเภทของคอมโพเนนต์ที่อยู่ ดูรายการประเภทที่เป็นไปได้ได้ในตารางที่ 2: ประเภทเพิ่มเติมที่บริการ Places แสดงผล
confirmationLevel

enum (ConfirmationLevel)

บ่งบอกระดับความแน่นอนที่เรามีว่าคอมโพเนนต์นั้นถูกต้อง
inferred

boolean

บ่งบอกว่าคอมโพเนนต์ไม่ได้เป็นส่วนหนึ่งของอินพุต แต่เราอนุมานคอมโพเนนต์นั้นสำหรับสถานที่ตั้งของที่อยู่และเชื่อว่าควรระบุคอมโพเนนต์ดังกล่าวเพื่อให้ได้ที่อยู่แบบสมบูรณ์
spellCorrected

boolean

บ่งบอกการแก้ไขการสะกดผิดในชื่อคอมโพเนนต์ API อาจไม่ได้แจ้งว่าการเปลี่ยนแปลงจากรูปแบบการสะกดคำรูปแบบหนึ่งเป็นรูปแบบอื่นเป็นข้อผิดพลาดเสมอไป เช่น เมื่อเปลี่ยนจาก "centre" เป็น "center" นอกจากนี้ ระบบจะไม่แจ้งการสะกดผิดที่พบบ่อยเสมอไป เช่น เมื่อเปลี่ยน "Amphitheater Pkwy" เป็น "Amphitheatre Pkwy"
replaced

boolean

บ่งบอกว่ามีการแทนที่ชื่อของคอมโพเนนต์ด้วยชื่ออื่นโดยสิ้นเชิง เช่น มีการแทนที่รหัสไปรษณีย์ที่ไม่ถูกต้องด้วยรหัสไปรษณีย์ที่ถูกต้องสำหรับที่อยู่ การเปลี่ยนแปลงนี้ไม่ใช่การเปลี่ยนแปลงที่มองเห็นได้ คอมโพเนนต์อินพุตได้เปลี่ยนเป็นคอมโพเนนต์อื่น
unexpected

boolean

ระบุองค์ประกอบที่อยู่ที่ไม่ควรจะอยู่ในที่อยู่ไปรษณีย์ของภูมิภาคหนึ่งๆ เราจึงเก็บไว้เนื่องจากเป็นส่วนหนึ่งของอินพุต

ComponentName

Wrapper สําหรับชื่อของคอมโพเนนต์

การแสดง JSON 
{
  "text": string,
  "languageCode": string
}
ช่อง
text

string

ข้อความชื่อ เช่น "5th Avenue" สำหรับชื่อถนน หรือ "1253" สำหรับเลขที่ถนน
languageCode

string

รหัสภาษา BCP-47 จะไม่มีข้อมูลนี้หากชื่อคอมโพเนนต์ไม่ได้เชื่อมโยงกับภาษา เช่น เลขที่

ConfirmationLevel

ค่าต่างๆ ที่เป็นไปได้สำหรับระดับการยืนยัน

Enum
CONFIRMATION_LEVEL_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน
CONFIRMED เรายืนยันได้ว่าคอมโพเนนต์นี้มีอยู่และเหมาะสมในบริบทของที่อยู่ส่วนที่เหลือ
UNCONFIRMED_BUT_PLAUSIBLE ไม่สามารถยืนยันคอมโพเนนต์นี้ได้ แต่มีความเป็นไปได้ที่จะมีคอมโพเนนต์นี้อยู่ เช่น หมายเลขถนนที่อยู่ในช่วงตัวเลขที่ถูกต้องซึ่งทราบแล้วบนถนนที่ไม่ทราบหมายเลขบ้านที่เฉพาะเจาะจง
UNCONFIRMED_AND_SUSPICIOUS คอมโพเนนต์นี้ไม่ได้รับการยืนยันและอาจมีข้อมูลไม่ถูกต้อง เช่น ย่านที่ไม่ตรงกับส่วนอื่นของที่อยู่

รหัสพิกัดภูมิศาสตร์

มีข้อมูลเกี่ยวกับสถานที่ที่แปลงพิกัดภูมิศาสตร์ของอินพุต

การแสดง JSON 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
ช่อง
location

object (LatLng)

ตำแหน่งที่ป้อนข้อมูลซึ่งเข้ารหัสพิกัดภูมิศาสตร์แล้ว

เราขอแนะนำให้ใช้รหัสสถานที่แทนการใช้ที่อยู่ พิกัดละติจูด/ลองจิจูด หรือ Plus Codes การใช้พิกัดเมื่อกำหนดเส้นทางหรือคำนวณเส้นทางขับรถจะทำให้ระบบจับจุดกับถนนที่อยู่ใกล้กับพิกัดเหล่านั้นที่สุดเสมอ ถนนนี้อาจไม่ใช่ถนนที่จะนำคุณไปยังจุดหมายอย่างรวดเร็วหรือปลอดภัย และอาจไม่ได้อยู่ใกล้กับจุดเข้าใช้งานของที่พัก นอกจากนี้ เมื่อมีการแปลงพิกัดภูมิศาสตร์กลับ เราไม่รับประกันว่าที่อยู่ที่ได้รับจะตรงกับที่อยู่เดิม
plusCode

object (PlusCode)

Plus Code ที่สอดคล้องกับ location
bounds

object (Viewport)

ขอบเขตของสถานที่ที่ผ่านการเข้ารหัสพิกัดภูมิศาสตร์
featureSizeMeters

number

ขนาดของสถานที่ที่จับคู่พิกัดภูมิศาสตร์เป็นเมตร ค่านี้เป็นอีกวิธีในการวัดความหยาบของตำแหน่งที่ผ่านการเข้ารหัสพิกัดภูมิศาสตร์ แต่วัดจากขนาดจริงแทนความหมายเชิงอรรถศาสตร์
placeId

string

รหัสสถานที่ของสถานที่ที่ข้อมูลนี้เข้ารหัสพิกัดภูมิศาสตร์

ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานที่ได้ที่นี่
placeTypes[]

string

ประเภทสถานที่ที่ระบบจับคู่พิกัดภูมิศาสตร์ของอินพุต เช่น ['locality', 'political'] ดูรายการประเภททั้งหมดได้ที่นี่

LatLng

ออบเจ็กต์ที่แสดงคู่ละติจูด/ลองจิจูด ซึ่งแสดงเป็นคู่ของตัวเลขทศนิยมเพื่อแสดงองศาละติจูดและองศาลองจิจูด วัตถุนี้ต้องเป็นไปตาม มาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงที่ได้รับการทำให้เป็นมาตรฐาน

การแสดง JSON 
{
  "latitude": number,
  "longitude": number
}
ช่อง
latitude

number

ละติจูดเป็นองศา โดยต้องอยู่ในช่วง [-90.0, +90.0]
longitude

number

ลองจิจูดเป็นองศา โดยต้องอยู่ในช่วง [-180.0, +180.0]

PlusCode

Plus Code (http://plus.codes) คือข้อมูลอ้างอิงตำแหน่งที่มี 2 รูปแบบ ได้แก่ โค้ดสากลที่กำหนดสี่เหลี่ยมผืนผ้าขนาด 14x14 เมตร (1/8000 องศา) หรือเล็กกว่านั้น และโค้ดแบบผสมที่ใช้สถานที่อ้างอิงแทนคำนำหน้า

การแสดง JSON 
{
  "globalCode": string,
  "compoundCode": string
}
ช่อง
globalCode

string

รหัส (แบบเต็ม) ทั่วโลกของสถานที่ เช่น "9FWM33GV+HQ" ซึ่งแสดงพื้นที่ 1/8000 องศาคูณ 1/8000 องศา (~14 x 14 เมตร)
compoundCode

string

รหัสแบบผสมของสถานที่ เช่น "33GV+HQ, Ramberg, Norway" ซึ่งมีนามสกุลของรหัสสากลและแทนที่คำนำหน้าด้วยชื่อที่มีการจัดรูปแบบของเอนทิตีอ้างอิง

วิวพอร์ต

วิวพอร์ตละติจูด-ลองจิจูดที่แสดงเป็นจุด low และ high 2 จุดที่ตรงข้ามกันตามแนวทแยงมุม วิวพอร์ตถือเป็นภูมิภาคแบบปิด กล่าวคือ วิวพอร์ตจะมีขอบเขตของตัวเอง ขอบเขตละติจูดต้องอยู่ในช่วง -90 ถึง 90 องศา และขอบเขตลองจิจูดต้องอยู่ในช่วง -180 ถึง 180 องศา กรณีต่างๆ ได้แก่

  • หาก low = high วิวพอร์ตจะประกอบด้วยจุดเดียวนั้น

  • หาก low.longitude > high.longitude ช่วงลองจิจูดจะกลับกัน (วิวพอร์ตตัดเส้นลองจิจูด 180 องศา)

  • หาก low.longitude = -180 องศาและ high.longitude = 180 องศา วิวพอร์ตจะรวมลองจิจูดทั้งหมด

  • หาก low.longitude = 180 องศาและ high.longitude = -180 องศา ช่วงลองจิจูดจะว่างเปล่า

  • หาก low.latitude > high.latitude ช่วงละติจูดจะว่างเปล่า

ต้องป้อนทั้ง low และ high และช่องที่แสดงต้องไม่ว่างเปล่า (ตามที่คำจำกัดความด้านบนระบุไว้) วิวพอร์ตว่างเปล่าจะทำให้เกิดข้อผิดพลาด

ตัวอย่างเช่น วิวพอร์ตนี้ครอบคลุมนครนิวยอร์กโดยสมบูรณ์

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

การแสดง JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
ช่อง
low

object (LatLng)

ต้องระบุ จุดต่ำสุดของวิวพอร์ต
high

object (LatLng)

ต้องระบุ จุดสูงสุดของวิวพอร์ต

AddressMetadata

ข้อมูลเมตาของที่อยู่ เราไม่รับประกันว่า metadata จะแสดงข้อมูลอย่างครบถ้วนสำหรับทุกที่อยู่ซึ่งส่งไปยัง Address Validation API

การแสดง JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
ช่อง
business

boolean

ระบุว่านี่คือที่อยู่ของธุรกิจ หากไม่ได้ตั้งค่าไว้ แสดงว่าไม่ทราบค่า
poBox

boolean

ระบุว่าเป็นที่อยู่ของตู้ ปณ. หากไม่ได้ตั้งค่าไว้ แสดงว่าไม่ทราบค่า
residential

boolean

ระบุว่านี่คือที่อยู่ของที่พักอาศัย หากไม่ได้ตั้งค่าไว้ แสดงว่าไม่ทราบค่า

UspsData

ข้อมูล USPS สำหรับที่อยู่ เราไม่รับประกันว่า uspsData จะแสดงข้อมูลที่อยู่ของสหรัฐอเมริกาหรือเปอร์โตริโกทุกรายการที่ส่งไปยัง Address Validation API อย่างสมบูรณ์ เราขอแนะนำให้ผสานรวมช่องที่อยู่สำรองในการตอบกลับหากคุณใช้ uspsData เป็นส่วนหลักของคำตอบ

การแสดง JSON 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
ช่อง
standardizedAddress

object (UspsAddress)

ที่อยู่แบบมาตรฐานของ USPS
deliveryPointCode

string

รหัสจุดนำส่ง 2 หลัก
deliveryPointCheckDigit

string

หมายเลขตรวจสอบจุดนำส่ง ระบบจะเพิ่มหมายเลขนี้ไว้ที่ส่วนท้ายของ delivery_point_barcode สำหรับจดหมายที่สแกนด้วยเครื่อง การเพิ่มตัวเลขทั้งหมดของ delivery_point_barcode, deliveryPointCheckDigit, postal code และ ZIP+4 เข้าด้วยกันควรให้ผลลัพธ์ที่หารด้วย 10 ได้
dpvConfirmation

string

ค่าที่เป็นไปได้สำหรับการยืนยัน DPV แสดงผลอักขระเดี่ยวหรือไม่แสดงผลค่าใดๆ

  • N: ยืนยันหมายเลขหลักและหมายเลขรองด้วย DPV ไม่สำเร็จ
  • D: ที่อยู่ได้รับการยืนยัน DPV สำหรับหมายเลขหลักเท่านั้น และไม่มีข้อมูลหมายเลขรอง
  • S: ที่อยู่ได้รับการยืนยันผ่าน DPV สำหรับหมายเลขหลักเท่านั้น และมีข้อมูลหมายเลขรองแต่ไม่ได้รับการยืนยัน
  • Y: ที่อยู่ได้รับการยืนยัน DPV สำหรับหมายเลขหลักและหมายเลขรอง
  • ว่าง: หากคำตอบไม่มีค่า dpvConfirmation แสดงว่าไม่มีการส่งที่อยู่เพื่อยืนยัน DPV
dpvFootnote

string

เชิงอรรถจากการตรวจสอบจุดนำส่ง เชิงอรรถหลายรายการอาจต่อท้ายกันไว้ในสตริงเดียวกัน

  • AA: ป้อนที่อยู่ซึ่งตรงกับไฟล์ ZIP+4
  • A1: ที่อยู่ป้อนไม่ตรงกับไฟล์ ZIP+4
  • BB: ตรงกับ DPV (คอมโพเนนต์ทั้งหมด)
  • CC: หมายเลขรองไม่ตรงกันและไม่จําเป็น
  • C1: หมายเลขรองไม่ตรงกัน แต่จำเป็นต้องระบุ
  • N1: ที่อยู่อาคารสูงไม่มีหมายเลขรอง
  • M1: ไม่มีหมายเลขหลัก
  • M3: หมายเลขหลักไม่ถูกต้อง
  • P1: ป้อนที่อยู่ PO, RR หรือ HC ที่ไม่มีหมายเลขกล่อง
  • P3: หมายเลข PO, RR หรือ HC Box ที่ป้อนไม่ถูกต้อง
  • F1: ป้อนที่อยู่ซึ่งตรงกับที่อยู่ของหน่วยทหาร
  • G1: ป้อนที่อยู่ซึ่งตรงกับที่อยู่สำหรับจัดส่งทั่วไป
  • U1: ป้อนที่อยู่ซึ่งตรงกับรหัสไปรษณีย์ที่ไม่ซ้ำกัน
  • PB: ป้อนที่อยู่ซึ่งตรงกับระเบียน PBSA
  • RR: DPV ยืนยันที่อยู่ด้วยข้อมูล PMB
  • R1: ที่อยู่ที่ได้รับการยืนยันจาก DPV โดยไม่มีข้อมูล PMB
  • R7: ระเบียนเส้นทางของผู้ให้บริการ R777 หรือ R779
  • IA: ระบุที่อยู่ที่ได้รับแจ้งแล้ว
  • TA: หมายเลขหลักที่ตรงกันโดยตัดตัวอักษรตามหลังออก
dpvCmra

string

ระบุว่าที่อยู่เป็น CMRA (Commercial Mail Receiving Agency) ซึ่งเป็นธุรกิจส่วนตัวที่รับจดหมายสำหรับลูกค้าหรือไม่ แสดงผลอักขระเดียว

  • Y: ที่อยู่เป็น CMRA
  • N: ที่อยู่ไม่ใช่ CMRA
dpvVacant

string

สถานที่นี้ว่างไหม แสดงผลอักขระเดียว

  • Y: ไม่มีผู้รับในที่อยู่ที่ระบุ
  • N: ที่อยู่มีคนอยู่
dpvNoStat

string

ที่อยู่นี้เป็นที่อยู่ที่ไม่มีสถิติหรือที่อยู่ที่มีการใช้งาน ที่อยู่ที่ไม่มีสถิติคือที่อยู่ที่ไม่มีผู้อยู่อาศัยอย่างต่อเนื่องหรือที่อยู่ที่ไม่ได้อยู่ในบริการของ USPS แสดงผลอักขระเดียว

  • Y: ที่อยู่ไม่ทำงาน
  • N: ที่อยู่ใช้งานได้
dpvNoStatReasonCode

integer

ระบุประเภท NoStat แสดงผลรหัสเหตุผลเป็น int

  • 1: IDA (ที่อยู่สำหรับจัดส่งภายใน) – ที่อยู่ที่ไม่รับจดหมายจาก USPS โดยตรง แต่มีการนำส่งไปยังที่อยู่สำหรับจัดส่งที่ให้บริการแก่ที่อยู่ดังกล่าว
  • 2: CDS - ที่อยู่ซึ่งยังไม่พร้อมใช้งาน เช่น มีการแบ่งที่ดินใหม่ซึ่งมีการระบุแปลงและหมายเลขหลักแล้ว แต่ยังไม่มีโครงสร้างสำหรับการเข้าพัก
  • 3: ที่อยู่ซ้ำกัน - ที่อยู่ที่ไม่ได้ยืนยันด้วย DPV
  • 4: CMZ (วิทยาลัย ทหาร และประเภทอื่นๆ) - รหัสไปรษณีย์ + 4 ระเบียนที่ USPS รวมไว้ในข้อมูล
  • 5: ปกติ - บ่งชี้ที่อยู่ที่ไม่ได้รับการนําส่ง และระบบจะไม่นับที่อยู่ดังกล่าวเป็นการนําส่งที่เป็นไปได้
  • 6: ต้องระบุข้อมูลรอง - ที่อยู่ต้องใช้ข้อมูลรอง
dpvDrop

string

การตั้งค่าสถานะบ่งบอกว่ามีการนำส่งจดหมายไปยังกล่องรับจดหมายเดียวในเว็บไซต์ แสดงผลอักขระเดียว

  • Y: การนำส่งจดหมายไปยังกล่องรับจดหมายแห่งเดียวในสถานที่หนึ่ง
  • N: ไม่ได้นำส่งจดหมายไปยังกล่องรับจดหมายแห่งเดียวในสถานที่ตั้ง
dpvThrowback

string

บ่งบอกว่าไม่ได้นำส่งจดหมายไปยังที่อยู่ แสดงผลอักขระเดียว

  • Y: ไม่ได้นำส่งจดหมายไปยังที่อยู่
  • N: ไปรษณีย์นำส่งไปยังที่อยู่
dpvNonDeliveryDays

string

บ่งบอกว่าการนำส่งจดหมายไม่ได้ดำเนินการทุกวันในสัปดาห์ แสดงผลอักขระเดียว

  • Y: การนำส่งจดหมายไม่ได้ดำเนินการทุกวันในสัปดาห์
  • N: ไม่มีข้อบ่งชี้ว่าการนำส่งจดหมายไม่ได้ดำเนินการทุกวันในสัปดาห์
dpvNonDeliveryDaysValues

integer

จำนวนเต็มที่ระบุวันที่ไม่มีการนำส่ง ซึ่งสามารถตรวจสอบโดยใช้ Flag แบบบิต ดังนี้ 0x40 – วันอาทิตย์เป็นวันที่ไม่มีการนำส่ง 0x20 – วันจันทร์เป็นวันที่ไม่มีการนำส่ง 0x10 – วันอังคารเป็นวันที่ไม่มีการนำส่ง 0x08 – วันพุธเป็นวันที่ไม่มีการนำส่ง 0x04 – วันพฤหัสบดีเป็นวันที่ไม่มีการนำส่ง 0x02 – วันศุกร์เป็นวันที่ไม่มีการนำส่ง 0x01 – วันเสาร์เป็นวันที่ไม่มีการนำส่ง
dpvNoSecureLocation

string

แจ้งว่าเข้าถึงประตูได้ แต่จะไม่มีการทิ้งพัสดุเนื่องจากข้อกังวลด้านความปลอดภัย แสดงผลอักขระเดียว

  • Y: จะไม่มีการนำพัสดุไปไว้ที่หน้าประตูเนื่องจากข้อกังวลด้านความปลอดภัย
  • N: ไม่มีข้อบ่งชี้ว่าจะไม่นำส่งพัสดุเนื่องจากข้อกังวลด้านความปลอดภัย
dpvPbsa

string

บ่งบอกว่าที่อยู่ตรงกับระเบียน PBSA แสดงผลอักขระเดียว

  • Y: ที่อยู่ตรงกับระเบียน PBSA
  • N: ที่อยู่ไม่ตรงกับระเบียน PBSA
dpvDoorNotAccessible

string

แจ้งว่า USPS ไม่สามารถเคาะประตูเพื่อนำส่งจดหมาย แสดงผลอักขระเดียว

  • Y: เข้าถึงประตูไม่ได้
  • N: ไม่มีป้ายระบุว่าประตูเข้าไม่ได้
dpvEnhancedDeliveryCode

string

บ่งบอกว่าที่อยู่ใช้รหัสผลลัพธ์ DPV ได้มากกว่า 1 รหัส แสดงผลอักขระเดียว

  • Y: ที่อยู่ได้รับการยืนยัน DPV สำหรับหมายเลขหลักและหมายเลขรอง
  • N: ยืนยันหมายเลขหลักและหมายเลขรองด้วย DPV ไม่สำเร็จ
  • S: ที่อยู่ได้รับการยืนยัน DPV สำหรับหมายเลขหลักเท่านั้น และข้อมูลหมายเลขรองมีให้แต่ไม่ได้รับการยืนยัน หรือมีการลบอักษรตัวสุดท้าย 1 ตัวในหมายเลขหลักออกเพื่อให้ตรงกับ DPV และจำเป็นต้องใช้ข้อมูลรอง
  • D: ที่อยู่ได้รับการยืนยัน DPV สำหรับหมายเลขหลักเท่านั้น และไม่มีข้อมูลหมายเลขรอง
  • R: ยืนยันที่อยู่แล้ว แต่กำหนดเส้นทางเป็นเส้นทางที่ไม่มีอยู่จริง R777 และ R779 และไม่ได้ระบุการนำส่งของ USPS
carrierRoute

string

รหัสเส้นทางของผู้ให้บริการ รหัส 4 อักขระที่ประกอบด้วยคำนำหน้า 1 อักขระและตัวระบุเส้นทาง 3 หลัก

คำนำหน้า

  • C: เส้นทางของผู้ให้บริการขนส่ง (หรือเส้นทางในเมือง)
  • R: เส้นทางชนบท
  • H: เส้นทางสัญญาทางหลวง
  • B: ส่วนตู้ ปณ.
  • G: หน่วยการนำส่งทั่วไป
carrierRouteIndicator

string

ตัวบ่งชี้การจัดเรียงอัตราเส้นทางของผู้ให้บริการขนส่ง
ewsNoMatch

boolean

ที่อยู่สำหรับจัดส่งจับคู่ได้ แต่ไฟล์ EWS ระบุว่าการจับคู่ที่ตรงกันทั้งหมดจะพร้อมใช้งานในเร็วๆ นี้
postOfficeCity

string

เมืองที่มีที่ทำการไปรษณีย์หลัก
postOfficeState

string

รัฐของที่ทำการไปรษณีย์หลัก
abbreviatedCity

string

เมืองแบบย่อ
fipsCountyCode

string

รหัส FIPS ของเคาน์ตี้
county

string

ชื่อเคาน์ตี้
elotNumber

string

หมายเลขเส้นทางที่ปรับปรุงแล้ว (eLOT)
elotFlag

string

Flag (A/D) ของ eLOT ที่เพิ่มขึ้น/ลดลง
poBoxOnlyPostalCode

boolean

รหัสไปรษณีย์ของตู้ ปณ. เท่านั้น
pmbDesignator

string

ตัวระบุหน่วย PMB (ตู้จดหมายส่วนตัว)
pmbNumber

string

หมายเลข PMB (ตู้จดหมายส่วนตัว)
addressRecordType

string

ประเภทระเบียนที่อยู่ซึ่งตรงกับที่อยู่ที่ป้อน

  • F: FIRM รายการนี้ตรงกับระเบียนบริษัท ซึ่งเป็นการจับคู่ในระดับที่ละเอียดที่สุดสำหรับที่อยู่
  • G: การนำส่งทั่วไป รายการนี้ตรงกับระเบียนการนำส่งทั่วไป
  • H: อาคาร / อพาร์ตเมนต์ รายการนี้ตรงกับระเบียนอาคารหรืออพาร์ตเมนต์
  • P: ที่ทำการไปรษณีย์ ที่อยู่นี้ตรงกับตู้ไปรษณีย์
  • R: เส้นทางชนบทหรือสัญญาทางหลวง: รายการนี้ตรงกับระเบียนเส้นทางชนบทหรือสัญญาทางหลวง ซึ่งทั้ง 2 รายการอาจมีช่วงหมายเลขกล่องที่เกี่ยวข้อง
  • S: RECORD ถนน: รายการนี้ตรงกับ RECORD ถนนซึ่งมีช่วงหมายเลขหลักที่ถูกต้อง
defaultAddress

boolean

ตัวบ่งชี้ที่ระบุว่าพบที่อยู่เริ่มต้น แต่มีที่อยู่เฉพาะเจาะจงมากกว่า
errorMessage

string

ข้อความแสดงข้อผิดพลาดสำหรับการดึงข้อมูล USPS ข้อมูลนี้จะแสดงขึ้นเมื่อการประมวลผลของ USPS ถูกระงับเนื่องจากตรวจพบที่อยู่ที่สร้างขึ้นมา

ฟิลด์ข้อมูล USPS อาจไม่แสดงเมื่อมีข้อผิดพลาดนี้
cassProcessed

boolean

ตัวบ่งชี้ว่าคำขอได้รับการประมวลผล CASS แล้ว

UspsAddress

การนำเสนอที่อยู่ของสหรัฐอเมริกาโดย USPS

การแสดง JSON 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
ช่อง
firstAddressLine

string

บรรทัดที่อยู่แรก
firm

string

ชื่อบริษัท
secondAddressLine

string

ที่อยู่บรรทัดที่ 2
urbanization

string

ชื่อเมืองในเปอร์โตริโก
cityStateZipAddressLine

string

เมือง + รัฐ + รหัสไปรษณีย์
city

string

ชื่อเมือง
state

string

รหัสรัฐ 2 ตัวอักษร
zipCode

string

รหัสไปรษณีย์ เช่น 10009
zipCodeExtension

string

ส่วนขยายรหัสไปรษณีย์ 4 หลัก เช่น 5023