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 เท่านั้น หมายเหตุ: สำหรับคำขอที่เปิดใช้ USPS CASS สำหรับที่อยู่ในเปอร์โตริโก คุณต้องระบุ 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)

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

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

string

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

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

หมายเหตุ: การตรวจสอบที่อยู่ใช้ได้เฉพาะในเซสชันที่มี 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

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

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

คำแนะนำเกี่ยวกับการป้อน / การแก้ไขที่อยู่: - ใช้วิดเจ็ตที่อยู่ที่รองรับการปรับให้เป็นสากล เช่น 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

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

string

ไม่บังคับ สถานที่ตั้งย่อยของที่อยู่ ตัวอย่างเช่น ย่านใกล้เคียง เขตเมือง เขตต่างๆ
addressLines[]

string

ต้องระบุ บรรทัดที่อยู่ที่ไม่มีโครงสร้างซึ่งอธิบายถึงระดับที่ต่ำกว่าของที่อยู่

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

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

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

string

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

string

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

LanguageOptions

ตัวอย่าง: ฟีเจอร์นี้อยู่ในเวอร์ชันตัวอย่าง (ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไป) ผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจมีการรองรับอย่างจำกัด และการเปลี่ยนแปลงในผลิตภัณฑ์และฟีเจอร์ก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอาจใช้ไม่ได้กับเวอร์ชันก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปอื่นๆ ข้อเสนอก่อนเวอร์ชันสำหรับผู้ใช้ทั่วไปจะอยู่ภายใต้ข้อกำหนดเฉพาะของบริการ 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)

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

object (Address)

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

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

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

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

เปิดใช้เอาต์พุตนี้โดยใช้แฟล็ก 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)

รายละเอียดของที่อยู่อินพุต ซึ่งเป็นผลมาจากการแยกวิเคราะห์ที่อยู่อินพุตและไม่ได้ให้สัญญาณสำหรับการตรวจสอบความถูกต้อง ดูสัญญาณการตรวจสอบได้จาก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 ในขณะที่ชื่อ "เรดวูดซิตี, CA, 94061" ระบุ LOCALITY อย่างไรก็ตาม หากเราไม่สามารถค้นหารหัสพิกัดภูมิศาสตร์สำหรับ "123 ถนนสีลม" ในเรดวูดซิตี รหัสพิกัดภูมิศาสตร์ที่แสดงผลอาจมีความละเอียด 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

object (PostalAddress)

ที่อยู่ที่ประมวลผลแล้วซึ่งแสดงเป็นที่อยู่ไปรษณีย์
addressComponents[]

object (AddressComponent)

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

ส่วนประกอบที่อยู่ไม่ได้เรียงลำดับตามวิธีที่ระบุ อย่าคาดเดาใดๆ เกี่ยวกับลำดับขององค์ประกอบที่อยู่ในรายการ
missingComponentTypes[]

string

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

string

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

string

โทเค็นในอินพุตที่แปลงไม่ได้ ซึ่งอาจเป็นอินพุตที่ระบบไม่รู้จักว่าเป็นส่วนที่ถูกต้องของที่อยู่ (เช่น ในข้อมูล เช่น "123235253253 Main St, San Francisco, CA, 94105" โทเค็นที่ยังไม่ได้แก้ไขอาจมีลักษณะดังนี้ ["123235253253"] เนื่องจากดูไม่ใช่เลขที่ถนนที่ถูกต้อง

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 จะไม่แจ้งการเปลี่ยนแปลงจากรูปแบบการสะกดคำหนึ่งเป็นอีกรูปแบบหนึ่งเสมอ เช่น เมื่อเปลี่ยน "กึ่งกลาง" "กึ่งกลาง" นอกจากนี้ จะไม่มีการแจ้งคำสะกดผิดที่พบบ่อยๆ ด้วย เช่น เมื่อเปลี่ยน "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 การใช้พิกัดเมื่อกำหนดเส้นทางหรือคำนวณเส้นทางขับขี่จะทำให้จุดตัดไปบนถนนที่ใกล้กับพิกัดเหล่านั้นมากที่สุดเสมอ ถนนนี้อาจไม่ใช่ถนนที่จะนำไปยังจุดหมายได้อย่างรวดเร็วหรือปลอดภัย และต้องไม่อยู่ใกล้จุดเข้าใช้งานไปยังที่พัก นอกจากนี้ เมื่อตำแหน่งถูกเข้ารหัสพิกัดภูมิศาสตร์แบบย้อนกลับ จะไม่มีการรับประกันว่าที่อยู่ที่ส่งกลับมาจะตรงกับที่อยู่เดิม
plusCode

object (PlusCode)

Plus Code ที่ตรงกับ location
bounds

object (Viewport)

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

number

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

string

PlaceID ของสถานที่ที่ระบุพิกัดทางภูมิศาสตร์นี้

ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานที่ได้ที่นี่
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 รูปแบบ ได้แก่ โค้ดส่วนกลางที่กำหนดขนาด 14mx14m (1/8000 ขององศา) หรือสี่เหลี่ยมผืนผ้าที่เล็กกว่า และโค้ดประกอบ ซึ่งแทนที่คำนำหน้าด้วยตำแหน่งอ้างอิง

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

string

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

string

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

วิวพอร์ต

วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงเป็นเส้นทแยงมุม 2 จุดตรงข้ามกับ low และ high จุด วิวพอร์ตจะถือเป็นพื้นที่ปิด กล่าวคือ มีอาณาเขต ขอบเขตของละติจูดต้องอยู่ระหว่าง -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 อย่างครบถ้วนสำหรับที่อยู่ในสหรัฐอเมริกาหรือที่อยู่ PR ทุกรายการที่ส่งไปยัง 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, รหัสไปรษณีย์ และ 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: ระเบียน Route R777 หรือ R779 ของผู้ให้บริการขนส่ง
  • IA: ระบุที่อยู่ที่ได้รับข้อมูลแล้ว
  • TA: จับคู่หมายเลขหลักโดยทิ้งอัลฟ่าต่อท้าย
dpvCmra

string

ระบุว่าที่อยู่เป็น CMRA (Commercial Mail Receive 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 (วิทยาลัย ทหาร และอื่นๆ) - ไฟล์ ZIP + 4 ระเบียน USPS ได้รวมอยู่ในข้อมูล
  • 5: ปกติ - บ่งบอกว่าที่อยู่ดังกล่าวไม่ได้รับการนำส่ง และระบบไม่นับรวมที่อยู่ดังกล่าวว่าเป็นการส่งที่เป็นไปได้
  • 6: ต้องระบุข้อมูลรอง - ที่อยู่ต้องใช้ข้อมูลรอง
dpvDrop

string

ธงระบุว่ามีการส่งอีเมลไปยังผู้รับเพียงตัวเดียวที่ไซต์ แสดงผลอักขระเดี่ยว

  • Y: อีเมลจะส่งไปยังเว็บไซต์ที่รับเพียง 1 ตัว
  • N: อีเมลไม่ได้ส่งไปยังผู้รับเลยในเว็บไซต์
dpvThrowback

string

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

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

string

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

  • Y: ไม่มีการส่งอีเมลทุกวัน
  • N: ไม่มีข้อบ่งชี้ว่าไม่มีการส่งอีเมลทุกวัน
dpvNonDeliveryDaysValues

integer

จำนวนเต็มที่ระบุวันที่ไม่แสดงโฆษณา อาจมีการตรวจสอบโดยใช้แฟล็กบิตดังนี้ 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: ที่อยู่ได้รับการยืนยันแต่กำหนดให้ใช้กับเส้นทาง Phantom 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

eLOT จากน้อยไปมาก/มากไปน้อย (A/D)
poBoxOnlyPostalCode

boolean

รหัสไปรษณีย์เท่านั้น
pmbDesignator

string

ผู้กำหนดหน่วย PMB (Private Mail Box)
pmbNumber

string

หมายเลข PMB (Private Mail Box)
addressRecordType

string

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

  • F: มั่นคง การจับคู่นี้เป็นการจับคู่กับ Firm Record ซึ่งเป็นการจับคู่ระดับสูงสุดที่มีสำหรับที่อยู่
  • G: การนำส่งทั่วไป รายการนี้ตรงกับระเบียนการส่งทั่วไป
  • H: การสร้าง / อพาร์ตเมนต์ รายการนี้ตรงกับระเบียนอาคารหรืออพาร์ตเมนต์
  • P: กล่องเอกสาร รายการนี้ตรงกับตู้ไปรษณีย์
  • R: สัญญาเส้นทาง RURAL หรือ HIGHWAY CONTRACT: รายการนี้ตรงกับระเบียนเส้นทางชนบทหรือทางหลวงของสัญญาทางหลวง ซึ่งทั้ง 2 รายการนี้อาจมีช่วงหมายเลขกล่องที่เชื่อมโยงกัน
  • S: บันทึกถนน: ข้อมูลนี้ตรงกับ Street 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

ที่อยู่บรรทัดที่สอง
urbanization

string

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

string

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

string

ชื่อเมือง
state

string

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

string

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

string

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