Skip to content

Commit

Permalink
docs: Document that PREMISE_PROXIMITY is a valid value for an address…
Browse files Browse the repository at this point in the history
… granularity (#3506)

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 493546802

Source-Link: https://togithub.com/googleapis/googleapis/commit/2592f50ec97486ad3bee438350dbac2e8f478f7f

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/a31ebbb51b9c946eacbd2666366e4a48521a5b8e
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImEzMWViYmI1MWI5Yzk0NmVhY2JkMjY2NjM2NmU0YTQ4NTIxYTViOGUifQ==

BEGIN_NESTED_COMMIT
chore: Enable requesting numeric enums in "transport=rest" responses for services supporting this (Java, Go, Python, PHP, TypeScript, C#, and Ruby), even if they do not yet turn on REST transport
chore: disallow "transport=rest" for services where numeric enums are not confirmed to be supported (except in PHP and Java)
PiperOrigin-RevId: 493113566

Source-Link: https://togithub.com/googleapis/googleapis/commit/758f0d1217d9c7fe398aa5efb1057ce4b6409e55

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/78bd8f05e1276363eb14eae70e91fe4bc20703ab
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6Ijc4YmQ4ZjA1ZTEyNzYzNjNlYjE0ZWFlNzBlOTFmZTRiYzIwNzAzYWIifQ==
END_NESTED_COMMIT
BEGIN_NESTED_COMMIT
feat!: remove deprecated fields `highrise` and `multi_family`
docs: minor documentation updates

PiperOrigin-RevId: 487257549

Source-Link: https://togithub.com/googleapis/googleapis/commit/9df6fcaf991f1b05de7fb4e1a1211755d346a40f

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/e2b3cfca29024cf4cb9247564a89818b86bc8542
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImUyYjNjZmNhMjkwMjRjZjRjYjkyNDc1NjRhODk4MThiODZiYzg1NDIifQ==
END_NESTED_COMMIT
  • Loading branch information
gcf-owl-bot[bot] authored Dec 7, 2022
1 parent e117ac7 commit bbaa0c0
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 160 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,21 @@ message Address {
// The validated address represented as a postal address.
google.type.PostalAddress postal_address = 3;

// The individual address components of the formatted and corrected address,
// 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
// 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
// not be inferred. Components of this type are not present in
// `formatted_address`, `postal_address`, or `address_components`. An
// example might be `['street_number', 'route']` for an input like
// "Boulder, Colorado, 80301, USA." The list of possible types can be found
// [here](https://developers.google.com/maps/documentation/geocoding/overview#Types).
// "Boulder, Colorado, 80301, USA". The list of possible types can be found
// [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
repeated string missing_component_types = 5;

// The types of the components that are present in the `address_components`
Expand All @@ -65,8 +64,8 @@ message Address {
// [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED]
// or the
// [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred]
// flag is not set to `true`.The list of possible types can be found
// [here](https://developers.google.com/maps/documentation/geocoding/overview#Types).
// flag is not set to `true`. The list of possible types can be found
// [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
repeated string unconfirmed_component_types = 6;

// Any tokens in the input that could not be resolved. This might be an
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ service AddressValidation {
option (google.api.default_host) = "addressvalidation.googleapis.com";

// Validates an address.
rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse) {
rpc ValidateAddress(ValidateAddressRequest)
returns (ValidateAddressResponse) {
option (google.api.http) = {
post: "/v1:validateAddress"
body: "*"
Expand All @@ -52,7 +53,8 @@ service AddressValidation {
// same address, and should be called once the transaction is concluded. This
// should only be sent once for the sequence of `ValidateAddress` requests
// needed to validate an address fully.
rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse) {
rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest)
returns (ProvideValidationFeedbackResponse) {
option (google.api.http) = {
post: "/v1:provideValidationFeedback"
body: "*"
Expand All @@ -65,7 +67,7 @@ message ValidateAddressRequest {
// Required. The address being validated. Unformatted addresses should be
// submitted via [`address_lines`][google.type.PostalAddress.address_lines].
//
// The total length of the fields in this input must not exceed 300
// The total length of the fields in this input must not exceed 280
// characters.
//
// Supported regions can be found in the
Expand All @@ -80,7 +82,8 @@ message ValidateAddressRequest {
// [recipients][google.type.PostalAddress.recipients] and
// [organization][google.type.PostalAddress.organization]. Any values in those
// fields will be discarded and not returned. Please do not set them.
google.type.PostalAddress address = 1 [(google.api.field_behavior) = REQUIRED];
google.type.PostalAddress address = 1
[(google.api.field_behavior) = REQUIRED];

// This field must be empty for the first address validation request. If
// more requests are necessary to fully validate a single address (for
Expand Down Expand Up @@ -149,7 +152,8 @@ message ProvideValidationFeedbackRequest {
// `INVALID_ARGUMENT` error will be returned.
ValidationConclusion conclusion = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The ID of the response that this feedback is for. This should be the
// Required. The ID of the response that this feedback is for. This should be
// the
// [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id]
// from the first response in a series of address validation attempts.
string response_id = 2 [(google.api.field_behavior) = REQUIRED];
Expand All @@ -158,9 +162,7 @@ message ProvideValidationFeedbackRequest {
// The response for validation feedback.
//
// The response is empty if the feedback is sent successfully.
message ProvideValidationFeedbackResponse {

}
message ProvideValidationFeedbackResponse {}

// The result of validating an address.
message ValidationResult {
Expand Down Expand Up @@ -202,7 +204,7 @@ message Verdict {
PREMISE = 2;

// A geocode that should be very close to the building-level location of
// the address. Only used for geocodes and not for addresses.
// the address.
PREMISE_PROXIMITY = 3;

// The address or geocode indicates a block. Only used in regions which
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ message Geocode {

// The type(s) of place that the input geocoded to. For example,
// `['locality', 'political']`. The full list of types can be found
// [here](https://developers.google.com/maps/documentation/geocoding/overview#Types).
// [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
repeated string place_types = 7;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,6 @@ option ruby_package = "Google::Maps::AddressValidation::V1";

// The metadata for the address.
message AddressMetadata {
// Indicates that this address is a high-rise building.
// If unset, indicates that the value is unknown.
//
// DEPRECATED: Please use
// [`address_record_type`](google.maps.addressvalidation.v1.ValidationResult.usps_data.address_record_type)
// instead. This field will be removed with the GA release.
optional bool highrise = 1 [deprecated = true];

// Indicates that this is the address of a business.
// If unset, indicates that the value is unknown.
optional bool business = 2;
Expand All @@ -44,12 +36,6 @@ message AddressMetadata {
// If unset, indicates that the value is unknown.
optional bool po_box = 3;

// Indicates that the address is of a multi-family building.
// If unset, indicates that the value is unknown.
//
// DEPRECATED: this field will be removed with the GA release.
optional bool multi_family = 4 [deprecated = true];

// Indicates that this is the address of a residence.
// If unset, indicates that the value is unknown.
optional bool residential = 6;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ message UspsData {
string dpv_no_stat = 8;

// The carrier route code.
// A four character code--a one letter prefix and a three digit route
// designator.
// A four character code consisting of a one letter prefix and a three digit
// route designator.
//
// Prefixes:
//
Expand Down Expand Up @@ -210,7 +210,7 @@ message UspsData {
// processing is suspended because of the detection of artificially created
// addresses.
//
// The USPS data fields may not be populated when this error is present.
// The USPS data fields might not be populated when this error is present.
string error_message = 27;

// Indicator that the request has been CASS processed.
Expand Down
18 changes: 0 additions & 18 deletions packages/google-maps-addressvalidation/protos/protos.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

76 changes: 0 additions & 76 deletions packages/google-maps-addressvalidation/protos/protos.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit bbaa0c0

Please sign in to comment.