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

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

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

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

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 (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, รามเบิร์ก, นอร์เวย์" ซึ่งมีส่วนต่อท้ายของรหัสสากล และแทนที่คำนำหน้าด้วยชื่อที่มีการจัดรูปแบบของเอนทิตีอ้างอิง

วิวพอร์ต

วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงเป็นแนวทแยงมุม 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, รหัสไปรษณีย์ และ 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 ของที่อยู่ไม่ถูกต้อง
  • F1: ที่อยู่ที่ป้อนตรงกับที่อยู่ทางทหาร
  • G1: ที่อยู่ที่ป้อนตรงกับที่อยู่สำหรับจัดส่งทั่วไป
  • U1: ที่อยู่ที่ป้อนตรงกับรหัสไปรษณีย์ที่ไม่ซ้ำกัน
  • PB: ที่อยู่อินพุตตรงกับระเบียน PBSA
  • RR: DPV ยืนยันที่อยู่ซึ่งมีข้อมูล PMB
  • R1: DPV ยืนยันที่อยู่โดยไม่มีข้อมูล PMB
  • R7: ระเบียนเส้นทางผู้ให้บริการ R777 หรือ R779
  • IA: ระบุที่อยู่ที่ได้รับทราบข้อมูลแล้ว
  • TA: หมายเลขหลักที่ตรงกันโดยการวางเครื่องหมายอัลฟ่าต่อท้าย
dpvCmra

string

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

  • 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

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

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

string

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

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

string

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

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

integer

จำนวนเต็มที่ระบุวันที่ไม่ได้นำส่ง สามารถสืบสวนได้โดยใช้ธงบิต 0x40 – วันอาทิตย์เป็นวันที่ไม่ได้นำส่ง ขนาด 0x02 – วันจันทร์เป็นวันที่ไม่ได้นำส่ง 0x10 – วันอังคารเป็นวันที่ไม่ได้นำส่ง 0x08 โดยวันพุธเป็นวันที่ไม่ได้นำส่ง 0x04 – วันพฤหัสบดีเป็นวันที่นำส่งไม่ได้ ขนาด 0x02 – วันเสาร์เป็นวันที่ไม่ได้นำส่ง 0x01 – วันเสาร์เป็นวันที่ไม่ได้นำส่ง 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 สำหรับหมายเลขหลักเท่านั้น และข้อมูลหมายเลขรองแสดงโดยยังไม่ได้รับการยืนยัน หรือมีการตัดทอนอัลฟ่าเดี่ยวๆ ในหมายเลขหลักเพื่อจับคู่กับ 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

หมายเลข Enhanced Line of Travel (eLOT)

elotFlag

string

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

poBoxOnlyPostalCode

boolean

รหัสไปรษณีย์สำหรับตู้ ปณ. เท่านั้น

pmbDesignator

string

ตัวกำหนดหน่วย PMB (กล่องจดหมายส่วนตัว)

pmbNumber

string

หมายเลข PMB (กล่องจดหมายส่วนตัว)

addressRecordType

string

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

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