docs: [addressvalidation] Update description of the postal address (#…

…4158) * docs: Update some Address Validation API proto descriptions to improve clarity PiperOrigin-RevId: 522445601 Source-Link: googleapis/googleapis@a9a642e Source-Link: googleapis/googleapis-gen@ad764af Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImFkNzY0YWZhZWFlZjMxODYwMzMxNDg2MDU1OGNhYmMxOGE0MWI3MDQifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Update description of the postal address PiperOrigin-RevId: 524372358 Source-Link: googleapis/googleapis@3963623 Source-Link: googleapis/googleapis-gen@9cc6833 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjljYzY4MzM4OGVmNTdlODM1ZTU5N2ZhYTA3OTdiZWNmOTM0MzQ0ZDgifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: danieljbruce <[email protected]> Co-authored-by: Denis DelGrosso <[email protected]>
googleapis · Apr 17, 2023 · 8020de1 · 8020de1
1 parent bacabfb
commit 8020de1
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 18 deletions.
diff --git a/packages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/address.proto b/packages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/address.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -29,22 +29,25 @@ option objc_class_prefix = "GMPAVV1";
 option php_namespace = "Google\\Maps\\AddressValidation\\V1";
 option ruby_package = "Google::Maps::AddressValidation::V1";
 
-// Details of the address parsed from the input.
+// Details of the post-processed address. Post-processing includes
+// correcting misspelled parts of the address, replacing incorrect parts, and
+// inferring missing parts.
 message Address {
-  // The corrected address, formatted as a single-line address following the
-  // address formatting rules of the region where the address is located.
+  // The post-processed address, formatted as a single-line address following
+  // the address formatting rules of the region where the address is located.
   string formatted_address = 2;
 
-  // The validated address represented as a postal address.
+  // The post-processed address represented as a postal address.
   google.type.PostalAddress postal_address = 3;
 
-  // Unordered list. The individual address components of the formatted and corrected address,
-  // along with validation information. This provides information on the
-  // validation status of the individual components.
+  // Unordered list. The individual address components of the formatted and
+  // corrected address, along with validation information. This provides
+  // information on the validation status of the individual components.
   //
   // Address components are not ordered in a particular way. Do not make any
   // assumptions on the ordering of the address components in the list.
-  repeated AddressComponent address_components = 4 [(google.api.field_behavior) = UNORDERED_LIST];
+  repeated AddressComponent address_components = 4
+      [(google.api.field_behavior) = UNORDERED_LIST];
 
   // The types of components that were expected to be present in a correctly
   // formatted mailing address but were not found in the input AND could

diff --git a/...ddressvalidation/protos/google/maps/addressvalidation/v1/address_validation_service.proto b/...ddressvalidation/protos/google/maps/addressvalidation/v1/address_validation_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -175,7 +175,8 @@ message ValidationResult {
   // Information about the location and place that the address geocoded to.
   Geocode geocode = 3;
 
-  // Other information relevant to deliverability.
+  // Other information relevant to deliverability. `metadata` is not guaranteed
+  // to be fully populated for every address sent to the Address Validation API.
   AddressMetadata metadata = 4;
 
   // Extra deliverability flags provided by USPS. Only provided in region `US`

diff --git a/packages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/geocode.proto b/packages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/geocode.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/...ages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/metadata.proto b/...ages/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/metadata.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -26,7 +26,8 @@ option objc_class_prefix = "GMPAVV1";
 option php_namespace = "Google\\Maps\\AddressValidation\\V1";
 option ruby_package = "Google::Maps::AddressValidation::V1";
 
-// The metadata for the address.
+// The metadata for the address. `metadata` is not guaranteed to be fully
+// populated for every address sent to the Address Validation API.
 message AddressMetadata {
   // Indicates that this is the address of a business.
   // If unset, indicates that the value is unknown.

diff --git a/...ges/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/usps_data.proto b/...ges/google-maps-addressvalidation/protos/google/maps/addressvalidation/v1/usps_data.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -56,7 +56,10 @@ message UspsAddress {
   string zip_code_extension = 9;
 }
 
-// The USPS data for the address.
+// The USPS data for the address. `uspsData` is not guaranteed to be fully
+// populated for every US or PR address sent to the Address Validation API. It's
+// recommended to integrate the backup address fields in the response if you
+// utilize uspsData as the primary part of the response.
 message UspsData {
   // USPS standardized address.
   UspsAddress standardized_address = 1;

diff --git a/...essvalidation/samples/generated/v1/snippet_metadata.google.maps.addressvalidation.v1.json b/...essvalidation/samples/generated/v1/snippet_metadata.google.maps.addressvalidation.v1.json
@@ -1,7 +1,7 @@
 {
     "clientLibrary": {
         "name": "nodejs-addressvalidation",
-        "version": "1.0.1",
+        "version": "1.0.2",
         "language": "TYPESCRIPT",
         "apis": [
             {

diff --git a/packages/google-maps-addressvalidation/webpack.config.js b/packages/google-maps-addressvalidation/webpack.config.js
@@ -1,4 +1,4 @@
-// Copyright 2023 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.