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

เปิดใช้โหมดที่เข้ากันได้กับ CASS ของ USPS การดำเนินการนี้จะส่งผลต่อช่อง 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 หรือหากนำโทเค็นเซสชันมาใช้ซ้ำ ระบบจะเรียกเก็บเงินเซสชันเสมือนว่าไม่ได้ให้โทเค็นเซสชันไว้ (แต่ละคำขอจะเรียกเก็บเงินแยกกัน)

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

ไม่บังคับ โดยทั่วไปหมายถึงส่วนเมืองของที่อยู่ ตัวอย่าง: เมืองในสหรัฐอเมริกา, เขตไอที, เมืองไปรษณีย์ของสหราชอาณาจักร ในภูมิภาคของโลกที่ไม่มีการกําหนดสถานที่ตั้งอย่างชัดเจนหรือไม่เหมาะกับโครงสร้างนี้ ให้เว้นว่างสถานที่ตั้งไว้และใช้ addressLines
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)

Flag ความสามารถในการนำส่งเพิ่มเติมที่ 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)

ความละเอียดของที่อยู่ 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

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

string

ประเภทของคอมโพเนนต์ที่มีอยู่ใน addressComponents แต่ไม่สามารถยืนยันความถูกต้องได้ ช่องนี้มีไว้เพื่อความสะดวก: เนื้อหาของช่องจะเทียบเท่ากับการทำซ้ำผ่าน addressComponents เพื่อค้นหาประเภทของคอมโพเนนต์ทั้งหมดที่ confirmationLevel ไม่ใช่ CONFIRMED หรือไม่ได้ตั้งค่าแฟล็ก 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 จะไม่แจ้งการเปลี่ยนแปลงจากรูปแบบการสะกดคำหนึ่งเป็นอีกรูปแบบหนึ่งเสมอ เช่น เมื่อเปลี่ยน "กึ่งกลาง" เป็น "กึ่งกลาง" นอกจากนี้ ระบบอาจไม่แจ้งการสะกดผิดที่พบบ่อยเสมอไป เช่น เมื่อเปลี่ยน "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 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 จะแสดงข้อมูลที่อยู่ของสหรัฐอเมริกาหรือเปอร์โตริโกทุกรายการที่ส่งไปยัง 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: ระเบียน Route 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

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