-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
addressvalidation-gen.go
1714 lines (1516 loc) · 79.1 KB
/
addressvalidation-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package addressvalidation provides access to the Address Validation API.
//
// For product documentation, see: https://developers.google.com/maps/documentation/addressvalidation
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/addressvalidation/v1"
// ...
// ctx := context.Background()
// addressvalidationService, err := addressvalidation.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// addressvalidationService, err := addressvalidation.NewService(ctx, option.WithScopes(addressvalidation.MapsPlatformAddressvalidationScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// addressvalidationService, err := addressvalidation.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// addressvalidationService, err := addressvalidation.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package addressvalidation // import "google.golang.org/api/addressvalidation/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "addressvalidation:v1"
const apiName = "addressvalidation"
const apiVersion = "v1"
const basePath = "https://addressvalidation.googleapis.com/"
const basePathTemplate = "https://addressvalidation.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://addressvalidation.mtls.googleapis.com/"
const defaultUniverseDomain = "googleapis.com"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the
// email address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// Private Service:
// https://www.googleapis.com/auth/maps-platform.addressvalidation
MapsPlatformAddressvalidationScope = "https://www.googleapis.com/auth/maps-platform.addressvalidation"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/maps-platform.addressvalidation",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.WithDefaultUniverseDomain(defaultUniverseDomain))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.V1 = NewV1Service(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
V1 *V1Service
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewV1Service(s *Service) *V1Service {
rs := &V1Service{s: s}
return rs
}
type V1Service struct {
s *Service
}
// GoogleGeoTypeViewport: A latitude-longitude viewport, represented as
// two diagonally opposite `low` and `high` points. A viewport is
// considered a closed region, i.e. it includes its boundary. The
// latitude bounds must range between -90 to 90 degrees inclusive, and
// the longitude bounds must range between -180 to 180 degrees
// inclusive. Various cases include: - If `low` = `high`, the viewport
// consists of that single point. - If `low.longitude` >
// `high.longitude`, the longitude range is inverted (the viewport
// crosses the 180 degree longitude line). - If `low.longitude` = -180
// degrees and `high.longitude` = 180 degrees, the viewport includes all
// longitudes. - If `low.longitude` = 180 degrees and `high.longitude` =
// -180 degrees, the longitude range is empty. - If `low.latitude` >
// `high.latitude`, the latitude range is empty. Both `low` and `high`
// must be populated, and the represented box cannot be empty (as
// specified by the definitions above). An empty viewport will result in
// an error. For example, this viewport fully encloses New York City: {
// "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": {
// "latitude": 40.91618, "longitude": -73.70018 } }
type GoogleGeoTypeViewport struct {
// High: Required. The high point of the viewport.
High *GoogleTypeLatLng `json:"high,omitempty"`
// Low: Required. The low point of the viewport.
Low *GoogleTypeLatLng `json:"low,omitempty"`
// ForceSendFields is a list of field names (e.g. "High") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "High") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleGeoTypeViewport) MarshalJSON() ([]byte, error) {
type NoMethod GoogleGeoTypeViewport
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1Address: Details of the post-processed
// address. Post-processing includes correcting misspelled parts of the
// address, replacing incorrect parts, and inferring missing parts.
type GoogleMapsAddressvalidationV1Address struct {
// AddressComponents: 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.
AddressComponents []*GoogleMapsAddressvalidationV1AddressComponent `json:"addressComponents,omitempty"`
// FormattedAddress: The post-processed address, formatted as a
// single-line address following the address formatting rules of the
// region where the address is located.
FormattedAddress string `json:"formattedAddress,omitempty"`
// MissingComponentTypes: 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/requests-geocoding#Types).
MissingComponentTypes []string `json:"missingComponentTypes,omitempty"`
// PostalAddress: The post-processed address represented as a postal
// address.
PostalAddress *GoogleTypePostalAddress `json:"postalAddress,omitempty"`
// UnconfirmedComponentTypes: The types of the components that are
// present in the `address_components` but could not be confirmed to be
// correct. This field is provided for the sake of convenience: its
// contents are equivalent to iterating through the `address_components`
// to find the types of all the components where the confirmation_level
// is not CONFIRMED or the inferred 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).
UnconfirmedComponentTypes []string `json:"unconfirmedComponentTypes,omitempty"`
// UnresolvedTokens: Any tokens in the input that could not be resolved.
// This might be an input that was not recognized as a valid part of an
// address (for example in an input like "123235253253 Main St, San
// Francisco, CA, 94105", the unresolved tokens may look like
// `["123235253253"]` since that does not look like a valid street
// number.
UnresolvedTokens []string `json:"unresolvedTokens,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddressComponents")
// to unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AddressComponents") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1Address) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1Address
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1AddressComponent: Represents an address
// component, such as a street, city, or state.
type GoogleMapsAddressvalidationV1AddressComponent struct {
// ComponentName: The name for this component.
ComponentName *GoogleMapsAddressvalidationV1ComponentName `json:"componentName,omitempty"`
// ComponentType: The type of the address component. See Table 2:
// Additional types returned by the Places service
// (https://developers.google.com/places/web-service/supported_types#table2)
// for a list of possible types.
ComponentType string `json:"componentType,omitempty"`
// ConfirmationLevel: Indicates the level of certainty that we have that
// the component is correct.
//
// Possible values:
// "CONFIRMATION_LEVEL_UNSPECIFIED" - Default value. This value is
// unused.
// "CONFIRMED" - We were able to verify that this component exists and
// makes sense in the context of the rest of the address.
// "UNCONFIRMED_BUT_PLAUSIBLE" - This component could not be
// confirmed, but it is plausible that it exists. For example, a street
// number within a known valid range of numbers on a street where
// specific house numbers are not known.
// "UNCONFIRMED_AND_SUSPICIOUS" - This component was not confirmed and
// is likely to be wrong. For example, a neighborhood that does not fit
// the rest of the address.
ConfirmationLevel string `json:"confirmationLevel,omitempty"`
// Inferred: Indicates that the component was not part of the input, but
// we inferred it for the address location and believe it should be
// provided for a complete address.
Inferred bool `json:"inferred,omitempty"`
// Replaced: Indicates the name of the component was replaced with a
// completely different one, for example a wrong postal code being
// replaced with one that is correct for the address. This is not a
// cosmetic change, the input component has been changed to a different
// one.
Replaced bool `json:"replaced,omitempty"`
// SpellCorrected: Indicates a correction to a misspelling in the
// component name. The API does not always flag changes from one
// spelling variant to another, such as when changing "centre" to
// "center". It also does not always flag common misspellings, such as
// when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy".
SpellCorrected bool `json:"spellCorrected,omitempty"`
// Unexpected: Indicates an address component that is not expected to be
// present in a postal address for the given region. We have retained it
// only because it was part of the input.
Unexpected bool `json:"unexpected,omitempty"`
// ForceSendFields is a list of field names (e.g. "ComponentName") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ComponentName") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1AddressComponent) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1AddressComponent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1AddressMetadata: The metadata for the
// address. `metadata` is not guaranteed to be fully populated for every
// address sent to the Address Validation API.
type GoogleMapsAddressvalidationV1AddressMetadata struct {
// Business: Indicates that this is the address of a business. If unset,
// indicates that the value is unknown.
Business bool `json:"business,omitempty"`
// PoBox: Indicates that the address of a PO box. If unset, indicates
// that the value is unknown.
PoBox bool `json:"poBox,omitempty"`
// Residential: Indicates that this is the address of a residence. If
// unset, indicates that the value is unknown.
Residential bool `json:"residential,omitempty"`
// ForceSendFields is a list of field names (e.g. "Business") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Business") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1AddressMetadata) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1AddressMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1ComponentName: A wrapper for the name of
// the component.
type GoogleMapsAddressvalidationV1ComponentName struct {
// LanguageCode: The BCP-47 language code. This will not be present if
// the component name is not associated with a language, such as a
// street number.
LanguageCode string `json:"languageCode,omitempty"`
// Text: The name text. For example, "5th Avenue" for a street name or
// "1253" for a street number.
Text string `json:"text,omitempty"`
// ForceSendFields is a list of field names (e.g. "LanguageCode") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "LanguageCode") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1ComponentName) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1ComponentName
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1Geocode: Contains information about the
// place the input was geocoded to.
type GoogleMapsAddressvalidationV1Geocode struct {
// Bounds: The bounds of the geocoded place.
Bounds *GoogleGeoTypeViewport `json:"bounds,omitempty"`
// FeatureSizeMeters: The size of the geocoded place, in meters. This is
// another measure of the coarseness of the geocoded location, but in
// physical size rather than in semantic meaning.
FeatureSizeMeters float64 `json:"featureSizeMeters,omitempty"`
// Location: The geocoded location of the input. Using place IDs is
// preferred over using addresses, latitude/longitude coordinates, or
// plus codes. Using coordinates when routing or calculating driving
// directions will always result in the point being snapped to the road
// nearest to those coordinates. This may not be a road that will
// quickly or safely lead to the destination and may not be near an
// access point to the property. Additionally, when a location is
// reverse geocoded, there is no guarantee that the returned address
// will match the original.
Location *GoogleTypeLatLng `json:"location,omitempty"`
// PlaceId: The PlaceID of the place this input geocodes to. For more
// information about Place IDs see here
// (https://developers.google.com/maps/documentation/places/web-service/place-id).
PlaceId string `json:"placeId,omitempty"`
// PlaceTypes: 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/requests-geocoding#Types).
PlaceTypes []string `json:"placeTypes,omitempty"`
// PlusCode: The plus code corresponding to the `location`.
PlusCode *GoogleMapsAddressvalidationV1PlusCode `json:"plusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Bounds") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Bounds") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1Geocode) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1Geocode
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
func (s *GoogleMapsAddressvalidationV1Geocode) UnmarshalJSON(data []byte) error {
type NoMethod GoogleMapsAddressvalidationV1Geocode
var s1 struct {
FeatureSizeMeters gensupport.JSONFloat64 `json:"featureSizeMeters"`
*NoMethod
}
s1.NoMethod = (*NoMethod)(s)
if err := json.Unmarshal(data, &s1); err != nil {
return err
}
s.FeatureSizeMeters = float64(s1.FeatureSizeMeters)
return nil
}
// GoogleMapsAddressvalidationV1LanguageOptions: Preview: This feature
// is in Preview (pre-GA). Pre-GA products and features might have
// limited support, and changes to pre-GA products and features might
// not be compatible with other pre-GA versions. Pre-GA Offerings are
// covered by the Google Maps Platform Service Specific Terms
// (https://cloud.google.com/maps-platform/terms/maps-service-terms).
// For more information, see the launch stage descriptions
// (https://developers.google.com/maps/launch-stages). Enables the
// Address Validation API to include additional information in the
// response.
type GoogleMapsAddressvalidationV1LanguageOptions struct {
// ReturnEnglishLatinAddress: Preview: Return a
// [google.maps.addressvalidation.v1.Address] in English. See
// [google.maps.addressvalidation.v1.ValidationResult.english_latin_addre
// ss] for details.
ReturnEnglishLatinAddress bool `json:"returnEnglishLatinAddress,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "ReturnEnglishLatinAddress") to unconditionally include in API
// requests. By default, fields with empty or default values are omitted
// from API requests. However, any non-pointer, non-interface field
// appearing in ForceSendFields will be sent to the server regardless of
// whether the field is empty or not. This may be used to include empty
// fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "ReturnEnglishLatinAddress") to include in API requests with the JSON
// null value. By default, fields with empty values are omitted from API
// requests. However, any field with an empty value appearing in
// NullFields will be sent to the server as null. It is an error if a
// field in this list has a non-empty value. This may be used to include
// null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1LanguageOptions) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1LanguageOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1PlusCode: Plus code (http://plus.codes)
// is a location reference with two formats: global code defining a
// 14mx14m (1/8000th of a degree) or smaller rectangle, and compound
// code, replacing the prefix with a reference location.
type GoogleMapsAddressvalidationV1PlusCode struct {
// CompoundCode: Place's compound code, such as "33GV+HQ, Ramberg,
// Norway", containing the suffix of the global code and replacing the
// prefix with a formatted name of a reference entity.
CompoundCode string `json:"compoundCode,omitempty"`
// GlobalCode: Place's global (full) code, such as "9FWM33GV+HQ",
// representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).
GlobalCode string `json:"globalCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "CompoundCode") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CompoundCode") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1PlusCode) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1PlusCode
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: The
// request for sending validation feedback.
type GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest struct {
// Conclusion: Required. The outcome of the sequence of validation
// attempts. If this field is set to
// `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will
// be returned.
//
// Possible values:
// "VALIDATION_CONCLUSION_UNSPECIFIED" - This value is unused. If the
// `ProvideValidationFeedbackRequest.conclusion` field is set to
// `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will
// be returned.
// "VALIDATED_VERSION_USED" - The version of the address returned by
// the Address Validation API was used for the transaction.
// "USER_VERSION_USED" - The version of the address provided by the
// user was used for the transaction
// "UNVALIDATED_VERSION_USED" - A version of the address that was
// entered after the last validation attempt but that was not
// re-validated was used for the transaction.
// "UNUSED" - The transaction was abandoned and the address was not
// used.
Conclusion string `json:"conclusion,omitempty"`
// ResponseId: Required. The ID of the response that this feedback is
// for. This should be the response_id from the first response in a
// series of address validation attempts.
ResponseId string `json:"responseId,omitempty"`
// ForceSendFields is a list of field names (e.g. "Conclusion") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Conclusion") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: The
// response for validation feedback. The response is empty if the
// feedback is sent successfully.
type GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// GoogleMapsAddressvalidationV1UspsAddress: USPS representation of a US
// address.
type GoogleMapsAddressvalidationV1UspsAddress struct {
// City: City name.
City string `json:"city,omitempty"`
// CityStateZipAddressLine: City + state + postal code.
CityStateZipAddressLine string `json:"cityStateZipAddressLine,omitempty"`
// Firm: Firm name.
Firm string `json:"firm,omitempty"`
// FirstAddressLine: First address line.
FirstAddressLine string `json:"firstAddressLine,omitempty"`
// SecondAddressLine: Second address line.
SecondAddressLine string `json:"secondAddressLine,omitempty"`
// State: 2 letter state code.
State string `json:"state,omitempty"`
// Urbanization: Puerto Rican urbanization name.
Urbanization string `json:"urbanization,omitempty"`
// ZipCode: Postal code e.g. 10009.
ZipCode string `json:"zipCode,omitempty"`
// ZipCodeExtension: 4-digit postal code extension e.g. 5023.
ZipCodeExtension string `json:"zipCodeExtension,omitempty"`
// ForceSendFields is a list of field names (e.g. "City") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "City") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1UspsAddress) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1UspsAddress
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1UspsData: 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.
type GoogleMapsAddressvalidationV1UspsData struct {
// AbbreviatedCity: Abbreviated city.
AbbreviatedCity string `json:"abbreviatedCity,omitempty"`
// AddressRecordType: Type of the address record that matches the input
// address. * `F`: FIRM. This is a match to a Firm Record, which is the
// finest level of match available for an address. * `G`: GENERAL
// DELIVERY. This is a match to a General Delivery record. * `H`:
// BUILDING / APARTMENT. This is a match to a Building or Apartment
// record. * `P`: POST OFFICE BOX. This is a match to a Post Office Box.
// * `R`: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a
// Rural Route or a Highway Contract record, both of which may have
// associated Box Number ranges. * `S`: STREET RECORD: This is a match
// to a Street record containing a valid primary number range.
AddressRecordType string `json:"addressRecordType,omitempty"`
// CarrierRoute: The carrier route code. A four character code
// consisting of a one letter prefix and a three digit route designator.
// Prefixes: * `C`: Carrier route (or city route) * `R`: Rural route *
// `H`: Highway Contract Route * `B`: Post Office Box Section * `G`:
// General delivery unit
CarrierRoute string `json:"carrierRoute,omitempty"`
// CarrierRouteIndicator: Carrier route rate sort indicator.
CarrierRouteIndicator string `json:"carrierRouteIndicator,omitempty"`
// CassProcessed: Indicator that the request has been CASS processed.
CassProcessed bool `json:"cassProcessed,omitempty"`
// County: County name.
County string `json:"county,omitempty"`
// DefaultAddress: Indicator that a default address was found, but more
// specific addresses exists.
DefaultAddress bool `json:"defaultAddress,omitempty"`
// DeliveryPointCheckDigit: The delivery point check digit. This number
// is added to the end of the delivery_point_barcode for mechanically
// scanned mail. Adding all the digits of the delivery_point_barcode,
// delivery_point_check_digit, postal code, and ZIP+4 together should
// yield a number divisible by 10.
DeliveryPointCheckDigit string `json:"deliveryPointCheckDigit,omitempty"`
// DeliveryPointCode: 2 digit delivery point code
DeliveryPointCode string `json:"deliveryPointCode,omitempty"`
// DpvCmra: Indicates if the address is a CMRA (Commercial Mail
// Receiving Agency)--a private business receiving mail for clients.
// Returns a single character. * `Y`: The address is a CMRA * `N`: The
// address is not a CMRA
DpvCmra string `json:"dpvCmra,omitempty"`
// DpvConfirmation: The possible values for DPV confirmation. Returns a
// single character or returns no value. * `N`: Primary and any
// secondary number information failed to DPV confirm. * `D`: Address
// was DPV confirmed for the primary number only, and the secondary
// number information was missing. * `S`: Address was DPV confirmed for
// the primary number only, and the secondary number information was
// present but not confirmed. * `Y`: Address was DPV confirmed for
// primary and any secondary numbers. * Empty: If the response does not
// contain a `dpv_confirmation` value, the address was not submitted for
// DPV confirmation.
DpvConfirmation string `json:"dpvConfirmation,omitempty"`
// DpvDoorNotAccessible: Flag indicates addresses where USPS cannot
// knock on a door to deliver mail. Returns a single character. * `Y`:
// The door is not accessible. * `N`: No indication the door is not
// accessible.
DpvDoorNotAccessible string `json:"dpvDoorNotAccessible,omitempty"`
// DpvDrop: Flag indicates mail is delivered to a single receptable at a
// site. Returns a single character. * `Y`: The mail is delivered to a
// single receptable at a site. * `N`: The mail is not delivered to a
// single receptable at a site.
DpvDrop string `json:"dpvDrop,omitempty"`
// DpvEnhancedDeliveryCode: Indicates that more than one DPV return code
// is valid for the address. Returns a single character. * `Y`: Address
// was DPV confirmed for primary and any secondary numbers. * `N`:
// Primary and any secondary number information failed to DPV confirm. *
// `S`: Address was DPV confirmed for the primary number only, and the
// secondary number information was present by not confirmed, or a
// single trailing alpha on a primary number was dropped to make a DPV
// match and secondary information required. * `D`: Address was DPV
// confirmed for the primary number only, and the secondary number
// information was missing. * `R`: Address confirmed but assigned to
// phantom route R777 and R779 and USPS delivery is not provided.
DpvEnhancedDeliveryCode string `json:"dpvEnhancedDeliveryCode,omitempty"`
// DpvFootnote: The footnotes from delivery point validation. Multiple
// footnotes may be strung together in the same string. * `AA`: Input
// address matched to the ZIP+4 file * `A1`: Input address was not
// matched to the ZIP+4 file * `BB`: Matched to DPV (all components) *
// `CC`: Secondary number not matched and not required * `C1`: Secondary
// number not matched but required * `N1`: High-rise address missing
// secondary number * `M1`: Primary number missing * `M3`: Primary
// number invalid * `P1`: Input address PO, RR or HC box number missing
// * `P3`: Input address PO, RR, or HC Box number invalid * `F1`: Input
// address matched to a military address * `G1`: Input address matched
// to a general delivery address * `U1`: Input address matched to a
// unique ZIP code * `PB`: Input address matched to PBSA record * `RR`:
// DPV confirmed address with PMB information * `R1`: DPV confirmed
// address without PMB information * `R7`: Carrier Route R777 or R779
// record * `IA`: Informed Address identified * `TA`: Primary number
// matched by dropping a trailing alpha
DpvFootnote string `json:"dpvFootnote,omitempty"`
// DpvNoSecureLocation: Flag indicates door is accessible, but package
// will not be left due to security concerns. Returns a single
// character. * `Y`: The package will not be left due to security
// concerns. * `N`: No indication the package will not be left due to
// security concerns.
DpvNoSecureLocation string `json:"dpvNoSecureLocation,omitempty"`
// DpvNoStat: Is this a no stat address or an active address? No stat
// addresses are ones which are not continuously occupied or addresses
// that the USPS does not service. Returns a single character. * `Y`:
// The address is not active * `N`: The address is active
DpvNoStat string `json:"dpvNoStat,omitempty"`
// DpvNoStatReasonCode: Indicates the NoStat type. Returns a reason code
// as int. * `1`: IDA (Internal Drop Address) – Addresses that do not
// receive mail directly from the USPS but are delivered to a drop
// address that services them. * `2`: CDS - Addresses that have not yet
// become deliverable. For example, a new subdivision where lots and
// primary numbers have been determined, but no structure exists yet for
// occupancy. * `3`: Collision - Addresses that do not actually DPV
// confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4
// records USPS has incorporated into the data. * `5`: Regular -
// Indicates addresses not receiving delivery and the addresses are not
// counted as possible deliveries. * `6`: Secondary Required - The
// address requires secondary information.
DpvNoStatReasonCode int64 `json:"dpvNoStatReasonCode,omitempty"`
// DpvNonDeliveryDays: Flag indicates mail delivery is not performed
// every day of the week. Returns a single character. * `Y`: The mail
// delivery is not performed every day of the week. * `N`: No indication
// the mail delivery is not performed every day of the week.
DpvNonDeliveryDays string `json:"dpvNonDeliveryDays,omitempty"`
// DpvNonDeliveryDaysValues: Integer identifying non-delivery days. It
// can be interrogated using bit flags: 0x40 – Sunday is a
// non-delivery day 0x20 – Monday is a non-delivery day 0x10 –
// Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery
// day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a
// non-delivery day 0x01 – Saturday is a non-delivery day
DpvNonDeliveryDaysValues int64 `json:"dpvNonDeliveryDaysValues,omitempty"`
// DpvPbsa: Indicates the address was matched to PBSA record. Returns a
// single character. * `Y`: The address was matched to PBSA record. *
// `N`: The address was not matched to PBSA record.
DpvPbsa string `json:"dpvPbsa,omitempty"`
// DpvThrowback: Indicates that mail is not delivered to the street
// address. Returns a single character. * `Y`: The mail is not delivered
// to the street address. * `N`: The mail is delivered to the street
// address.
DpvThrowback string `json:"dpvThrowback,omitempty"`
// DpvVacant: Is this place vacant? Returns a single character. * `Y`:
// The address is vacant * `N`: The address is not vacant
DpvVacant string `json:"dpvVacant,omitempty"`
// ElotFlag: eLOT Ascending/Descending Flag (A/D).
ElotFlag string `json:"elotFlag,omitempty"`
// ElotNumber: Enhanced Line of Travel (eLOT) number.
ElotNumber string `json:"elotNumber,omitempty"`
// ErrorMessage: Error message for USPS data retrieval. This is
// populated when USPS processing is suspended because of the detection
// of artificially created addresses. The USPS data fields might not be
// populated when this error is present.
ErrorMessage string `json:"errorMessage,omitempty"`
// EwsNoMatch: The delivery address is matchable, but the EWS file
// indicates that an exact match will be available soon.
EwsNoMatch bool `json:"ewsNoMatch,omitempty"`
// FipsCountyCode: FIPS county code.
FipsCountyCode string `json:"fipsCountyCode,omitempty"`
// LacsLinkIndicator: LACSLink indicator.
LacsLinkIndicator string `json:"lacsLinkIndicator,omitempty"`
// LacsLinkReturnCode: LACSLink return code.
LacsLinkReturnCode string `json:"lacsLinkReturnCode,omitempty"`
// PmbDesignator: PMB (Private Mail Box) unit designator.
PmbDesignator string `json:"pmbDesignator,omitempty"`
// PmbNumber: PMB (Private Mail Box) number;
PmbNumber string `json:"pmbNumber,omitempty"`
// PoBoxOnlyPostalCode: PO Box only postal code.
PoBoxOnlyPostalCode bool `json:"poBoxOnlyPostalCode,omitempty"`
// PostOfficeCity: Main post office city.
PostOfficeCity string `json:"postOfficeCity,omitempty"`
// PostOfficeState: Main post office state.
PostOfficeState string `json:"postOfficeState,omitempty"`
// StandardizedAddress: USPS standardized address.
StandardizedAddress *GoogleMapsAddressvalidationV1UspsAddress `json:"standardizedAddress,omitempty"`
// SuitelinkFootnote: Footnotes from matching a street or highrise
// record to suite information. If business name match is found, the
// secondary number is returned. * `A`: SuiteLink record match, business
// address improved. * `00`: No match, business address is not improved.
SuitelinkFootnote string `json:"suitelinkFootnote,omitempty"`
// ForceSendFields is a list of field names (e.g. "AbbreviatedCity") to
// unconditionally include in API requests. By default, fields with
// empty or default values are omitted from API requests. However, any
// non-pointer, non-interface field appearing in ForceSendFields will be
// sent to the server regardless of whether the field is empty or not.
// This may be used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AbbreviatedCity") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *GoogleMapsAddressvalidationV1UspsData) MarshalJSON() ([]byte, error) {
type NoMethod GoogleMapsAddressvalidationV1UspsData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GoogleMapsAddressvalidationV1ValidateAddressRequest: The request for
// validating an address.
type GoogleMapsAddressvalidationV1ValidateAddressRequest struct {
// Address: Required. The address being validated. Unformatted addresses
// should be submitted via `address_lines`. The total length of the
// fields in this input must not exceed 280 characters. Supported
// regions can be found here
// (https://developers.google.com/maps/documentation/address-validation/coverage).
// The language_code value in the input address is reserved for future
// uses and is ignored today. The validated address result will be
// populated based on the preferred language for the given address, as
// identified by the system. The Address Validation API ignores the
// values in recipients and organization. Any values in those fields
// will be discarded and not returned. Please do not set them.
Address *GoogleTypePostalAddress `json:"address,omitempty"`
// EnableUspsCass: Enables USPS CASS compatible mode. This affects
// _only_ the
// [google.maps.addressvalidation.v1.ValidationResult.usps_data] field
// of [google.maps.addressvalidation.v1.ValidationResult]. Note: for
// USPS CASS enabled requests for addresses in Puerto Rico, a
// [google.type.PostalAddress.region_code] of the `address` must be
// provided as "PR", or an
// [google.type.PostalAddress.administrative_area] of the `address` must
// be provided as "Puerto Rico" (case-insensitive) or "PR". It's
// recommended to use a componentized `address`, or alternatively
// specify at least two [google.type.PostalAddress.address_lines] where
// the first line contains the street number and name and the second
// line contains the city, state, and zip code.
EnableUspsCass bool `json:"enableUspsCass,omitempty"`
// LanguageOptions: Optional. Preview: This feature is in Preview
// (pre-GA). Pre-GA products and features might have limited support,
// and changes to pre-GA products and features might not be compatible
// with other pre-GA versions. Pre-GA Offerings are covered by the
// Google Maps Platform Service Specific Terms
// (https://cloud.google.com/maps-platform/terms/maps-service-terms).
// For more information, see the launch stage descriptions
// (https://developers.google.com/maps/launch-stages). Enables the
// Address Validation API to include additional information in the
// response.
LanguageOptions *GoogleMapsAddressvalidationV1LanguageOptions `json:"languageOptions,omitempty"`
// PreviousResponseId: This field must be empty for the first address
// validation request. If more requests are necessary to fully validate
// a single address (for example if the changes the user makes after the