/
proximitybeacon-gen.go
3249 lines (2960 loc) · 131 KB
/
proximitybeacon-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
// Package proximitybeacon provides access to the Google Proximity Beacon API.
//
// See https://developers.google.com/beacons/proximity/
//
// Usage example:
//
// import "google.golang.org/api/proximitybeacon/v1beta1"
// ...
// proximitybeaconService, err := proximitybeacon.New(oauthHttpClient)
package proximitybeacon // import "google.golang.org/api/proximitybeacon/v1beta1"
import (
"bytes"
"encoding/json"
"errors"
"fmt"
context "golang.org/x/net/context"
ctxhttp "golang.org/x/net/context/ctxhttp"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// 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 _ = ctxhttp.Do
const apiId = "proximitybeacon:v1beta1"
const apiName = "proximitybeacon"
const apiVersion = "v1beta1"
const basePath = "https://proximitybeacon.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and modify your beacons
UserlocationBeaconRegistryScope = "https://www.googleapis.com/auth/userlocation.beacon.registry"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Beaconinfo = NewBeaconinfoService(s)
s.Beacons = NewBeaconsService(s)
s.Namespaces = NewNamespacesService(s)
s.V1beta1 = NewV1beta1Service(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Beaconinfo *BeaconinfoService
Beacons *BeaconsService
Namespaces *NamespacesService
V1beta1 *V1beta1Service
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewBeaconinfoService(s *Service) *BeaconinfoService {
rs := &BeaconinfoService{s: s}
return rs
}
type BeaconinfoService struct {
s *Service
}
func NewBeaconsService(s *Service) *BeaconsService {
rs := &BeaconsService{s: s}
rs.Attachments = NewBeaconsAttachmentsService(s)
rs.Diagnostics = NewBeaconsDiagnosticsService(s)
return rs
}
type BeaconsService struct {
s *Service
Attachments *BeaconsAttachmentsService
Diagnostics *BeaconsDiagnosticsService
}
func NewBeaconsAttachmentsService(s *Service) *BeaconsAttachmentsService {
rs := &BeaconsAttachmentsService{s: s}
return rs
}
type BeaconsAttachmentsService struct {
s *Service
}
func NewBeaconsDiagnosticsService(s *Service) *BeaconsDiagnosticsService {
rs := &BeaconsDiagnosticsService{s: s}
return rs
}
type BeaconsDiagnosticsService struct {
s *Service
}
func NewNamespacesService(s *Service) *NamespacesService {
rs := &NamespacesService{s: s}
return rs
}
type NamespacesService struct {
s *Service
}
func NewV1beta1Service(s *Service) *V1beta1Service {
rs := &V1beta1Service{s: s}
return rs
}
type V1beta1Service struct {
s *Service
}
// AdvertisedId: Defines a unique identifier of a beacon as broadcast by
// the device.
type AdvertisedId struct {
// Id: The actual beacon identifier, as broadcast by the beacon
// hardware. Must be
// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
// HTTP requests, and will be so encoded (with padding) in responses.
// The base64 encoding should be of the binary byte-stream and not any
// textual (such as hex) representation thereof. Required.
Id string `json:"id,omitempty"`
// Type: Specifies the identifier type. Required.
//
// Possible values:
// "TYPE_UNSPECIFIED"
// "EDDYSTONE"
// "IBEACON"
// "ALTBEACON"
// "EDDYSTONE_EID"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *AdvertisedId) MarshalJSON() ([]byte, error) {
type noMethod AdvertisedId
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// AttachmentInfo: A subset of attachment information served via the
// `beaconinfo.getforobserved` method, used when your users encounter
// your beacons.
type AttachmentInfo struct {
// Data: An opaque data container for client-provided data.
Data string `json:"data,omitempty"`
// NamespacedType: Specifies what kind of attachment this is. Tells a
// client how to interpret the `data` field. Format is namespace/type,
// for example scrupulous-wombat-12345/welcome-message
NamespacedType string `json:"namespacedType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Data") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *AttachmentInfo) MarshalJSON() ([]byte, error) {
type noMethod AttachmentInfo
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Beacon: Details of a beacon device.
type Beacon struct {
// AdvertisedId: The identifier of a beacon as advertised by it. This
// field must be populated when registering. It may be empty when
// updating a beacon record because it is ignored in updates. When
// registering a beacon that broadcasts Eddystone-EID, this field should
// contain a "stable" Eddystone-UID that identifies the beacon and links
// it to its attachments. The stable Eddystone-UID is only used for
// administering the beacon.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
// BeaconName: Resource name of this beacon. A beacon name has the
// format "beacons/N!beaconId" where the beaconId is the base16 ID
// broadcast by the beacon and N is a code for the beacon's type.
// Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for
// AltBeacon. This field must be left empty when registering. After
// reading a beacon, clients can use the name for future operations.
BeaconName string `json:"beaconName,omitempty"`
// Description: Free text used to identify and describe the beacon.
// Maximum length 140 characters. Optional.
Description string `json:"description,omitempty"`
// EphemeralIdRegistration: Write-only registration parameters for
// beacons using Eddystone-EID (remotely resolved ephemeral ID) format.
// This information will not be populated in API responses. When
// submitting this data, the `advertised_id` field must contain an ID of
// type Eddystone-UID. Any other ID type will result in an error.
EphemeralIdRegistration *EphemeralIdRegistration `json:"ephemeralIdRegistration,omitempty"`
// ExpectedStability: Expected location stability. This is set when the
// beacon is registered or updated, not automatically detected in any
// way. Optional.
//
// Possible values:
// "STABILITY_UNSPECIFIED"
// "STABLE"
// "PORTABLE"
// "MOBILE"
// "ROVING"
ExpectedStability string `json:"expectedStability,omitempty"`
// IndoorLevel: The indoor level information for this beacon, if known.
// As returned by the Google Maps API. Optional.
IndoorLevel *IndoorLevel `json:"indoorLevel,omitempty"`
// LatLng: The location of the beacon, expressed as a latitude and
// longitude pair. This location is given when the beacon is registered
// or updated. It does not necessarily indicate the actual current
// location of the beacon. Optional.
LatLng *LatLng `json:"latLng,omitempty"`
// PlaceId: The [Google Places API](/places/place-id) Place ID of the
// place where the beacon is deployed. This is given when the beacon is
// registered or updated, not automatically detected in any way.
// Optional.
PlaceId string `json:"placeId,omitempty"`
// Properties: Properties of the beacon device, for example battery type
// or firmware version. Optional.
Properties map[string]string `json:"properties,omitempty"`
// ProvisioningKey: Some beacons may require a user to provide an
// authorization key before changing any of its configuration (e.g.
// broadcast frames, transmit power). This field provides a place to
// store and control access to that key. This field is populated in
// responses to `GET /v1beta1/beacons/3!beaconId` from users with write
// access to the given beacon. That is to say: If the user is authorized
// to write the beacon's confidential data in the service, the service
// considers them authorized to configure the beacon. Note that this key
// grants nothing on the service, only on the beacon itself.
ProvisioningKey string `json:"provisioningKey,omitempty"`
// Status: Current status of the beacon. Required.
//
// Possible values:
// "STATUS_UNSPECIFIED"
// "ACTIVE"
// "DECOMMISSIONED"
// "INACTIVE"
Status string `json:"status,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *Beacon) MarshalJSON() ([]byte, error) {
type noMethod Beacon
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// BeaconAttachment: Project-specific data associated with a beacon.
type BeaconAttachment struct {
// AttachmentName: Resource name of this attachment. Attachment names
// have the format: beacons/beacon_id/attachments/attachment_id. Leave
// this empty on creation.
AttachmentName string `json:"attachmentName,omitempty"`
// Data: An opaque data container for client-provided data. Must be
// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
// HTTP requests, and will be so encoded (with padding) in responses.
// Required.
Data string `json:"data,omitempty"`
// NamespacedType: Specifies what kind of attachment this is. Tells a
// client how to interpret the `data` field. Format is namespace/type.
// Namespace provides type separation between clients. Type describes
// the type of `data`, for use by the client when parsing the `data`
// field. Required.
NamespacedType string `json:"namespacedType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AttachmentName") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *BeaconAttachment) MarshalJSON() ([]byte, error) {
type noMethod BeaconAttachment
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// BeaconInfo: A subset of beacon information served via the
// `beaconinfo.getforobserved` method, which you call when users of your
// app encounter your beacons.
type BeaconInfo struct {
// AdvertisedId: The ID advertised by the beacon.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
// Attachments: Attachments matching the type(s) requested. May be empty
// if no attachment types were requested, or if none matched.
Attachments []*AttachmentInfo `json:"attachments,omitempty"`
// BeaconName: The name under which the beacon is registered.
BeaconName string `json:"beaconName,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *BeaconInfo) MarshalJSON() ([]byte, error) {
type noMethod BeaconInfo
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Date: Represents a whole calendar date, e.g. date of birth. The time
// of day and time zone are either specified elsewhere or are not
// significant. The date is relative to the Proleptic Gregorian
// Calendar. The day may be 0 to represent a year and month where the
// day is not significant, e.g. credit card expiration date. The year
// may be 0 to represent a month and day independent of year, e.g.
// anniversary date. Related types are google.type.TimeOfDay and
// `google.protobuf.Timestamp`.
type Date struct {
// Day: Day of month. Must be from 1 to 31 and valid for the year and
// month, or 0 if specifying a year/month where the day is not
// significant.
Day int64 `json:"day,omitempty"`
// Month: Month of year. Must be from 1 to 12.
Month int64 `json:"month,omitempty"`
// Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
// without a year.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *Date) MarshalJSON() ([]byte, error) {
type noMethod Date
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// DeleteAttachmentsResponse: Response for a request to delete
// attachments.
type DeleteAttachmentsResponse struct {
// NumDeleted: The number of attachments that were deleted.
NumDeleted int64 `json:"numDeleted,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NumDeleted") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *DeleteAttachmentsResponse) MarshalJSON() ([]byte, error) {
type noMethod DeleteAttachmentsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Diagnostics: Diagnostics for a single beacon.
type Diagnostics struct {
// Alerts: An unordered list of Alerts that the beacon has.
//
// Possible values:
// "ALERT_UNSPECIFIED" - Invalid value. Should never appear.
// "WRONG_LOCATION" - The beacon has been reported in a location
// different than its registered location. This may indicate that the
// beacon has been moved. This signal is not 100% accurate, but
// indicates that further investigation is worth while.
// "LOW_BATTERY" - The battery level for the beacon is low enough
// that, given the beacon's current use, its battery will run out with
// in the next 60 days. This indicates that the battery should be
// replaced soon.
Alerts []string `json:"alerts,omitempty"`
// BeaconName: Resource name of the beacon. For Eddystone-EID beacons,
// this may be the beacon's current EID, or the beacon's "stable"
// Eddystone-UID.
BeaconName string `json:"beaconName,omitempty"`
// EstimatedLowBatteryDate: The date when the battery is expected to be
// low. If the value is missing then there is no estimate for when the
// battery will be low. This value is only an estimate, not an exact
// date.
EstimatedLowBatteryDate *Date `json:"estimatedLowBatteryDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "Alerts") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *Diagnostics) MarshalJSON() ([]byte, error) {
type noMethod Diagnostics
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Empty: A generic empty message that you can re-use to avoid defining
// duplicated empty messages in your APIs. A typical example is to use
// it as the request or the response type of an API method. For
// instance: service Foo { rpc Bar(google.protobuf.Empty) returns
// (google.protobuf.Empty); } The JSON representation for `Empty` is
// empty JSON object `{}`.
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// EphemeralIdRegistration: Write-only registration parameters for
// beacons using Eddystone-EID format. Two ways of securely registering
// an Eddystone-EID beacon with the service are supported: 1. Perform an
// ECDH key exchange via this API, including a previous call to `GET
// /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key`
// and `service_ecdh_public_key` should be populated and
// `beacon_identity_key` should not be populated. This method ensures
// that only the two parties in the ECDH key exchange can compute the
// identity key, which becomes a secret between them. 2. Derive or
// obtain the beacon's identity key via other secure means (perhaps an
// ECDH key exchange between the beacon and a mobile device or any other
// secure method), and then submit the resulting identity key to the
// service. In this case `beacon_identity_key` field should be
// populated, and neither of `beacon_ecdh_public_key` nor
// `service_ecdh_public_key` fields should be. The security of this
// method depends on how securely the parties involved (in particular
// the bluetooth client) handle the identity key, and obviously on how
// securely the identity key was generated. See [the Eddystone
// specification](https://github.com/google/eddystone/tree/master/eddysto
// ne-eid) at GitHub.
type EphemeralIdRegistration struct {
// BeaconEcdhPublicKey: The beacon's public key used for the Elliptic
// curve Diffie-Hellman key exchange. When this field is populated,
// `service_ecdh_public_key` must also be populated, and
// `beacon_identity_key` must not be.
BeaconEcdhPublicKey string `json:"beaconEcdhPublicKey,omitempty"`
// BeaconIdentityKey: The private key of the beacon. If this field is
// populated, `beacon_ecdh_public_key` and `service_ecdh_public_key`
// must not be populated.
BeaconIdentityKey string `json:"beaconIdentityKey,omitempty"`
// InitialClockValue: The initial clock value of the beacon. The
// beacon's clock must have begun counting at this value immediately
// prior to transmitting this value to the resolving service.
// Significant delay in transmitting this value to the service risks
// registration or resolution failures. If a value is not provided, the
// default is zero.
InitialClockValue uint64 `json:"initialClockValue,omitempty,string"`
// InitialEid: An initial ephemeral ID calculated using the clock value
// submitted as `initial_clock_value`, and the secret key generated by
// the Diffie-Hellman key exchange using `service_ecdh_public_key` and
// `service_ecdh_public_key`. This initial EID value will be used by the
// service to confirm that the key exchange process was successful.
InitialEid string `json:"initialEid,omitempty"`
// RotationPeriodExponent: Indicates the nominal period between each
// rotation of the beacon's ephemeral ID. "Nominal" because the beacon
// should randomize the actual interval. See [the spec at
// github](https://github.com/google/eddystone/tree/master/eddystone-eid)
// for details. This value corresponds to a power-of-two scaler on the
// beacon's clock: when the scaler value is K, the beacon will begin
// broadcasting a new ephemeral ID on average every 2^K seconds.
RotationPeriodExponent int64 `json:"rotationPeriodExponent,omitempty"`
// ServiceEcdhPublicKey: The service's public key used for the Elliptic
// curve Diffie-Hellman key exchange. When this field is populated,
// `beacon_ecdh_public_key` must also be populated, and
// `beacon_identity_key` must not be.
ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`
// ForceSendFields is a list of field names (e.g. "BeaconEcdhPublicKey")
// to unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *EphemeralIdRegistration) MarshalJSON() ([]byte, error) {
type noMethod EphemeralIdRegistration
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// EphemeralIdRegistrationParams: Information a client needs to
// provision and register beacons that broadcast Eddystone-EID format
// beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See
// [the Eddystone
// specification](https://github.com/google/eddystone/tree/master/eddysto
// ne-eid) at GitHub.
type EphemeralIdRegistrationParams struct {
// MaxRotationPeriodExponent: Indicates the maximum rotation period
// supported by the service. See
// EddystoneEidRegistration.rotation_period_exponent
MaxRotationPeriodExponent int64 `json:"maxRotationPeriodExponent,omitempty"`
// MinRotationPeriodExponent: Indicates the minimum rotation period
// supported by the service. See
// EddystoneEidRegistration.rotation_period_exponent
MinRotationPeriodExponent int64 `json:"minRotationPeriodExponent,omitempty"`
// ServiceEcdhPublicKey: The beacon service's public key for use by a
// beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman
// key exchange.
ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "MaxRotationPeriodExponent") to unconditionally include in API
// requests. By default, fields with empty 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:"-"`
}
func (s *EphemeralIdRegistrationParams) MarshalJSON() ([]byte, error) {
type noMethod EphemeralIdRegistrationParams
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// GetInfoForObservedBeaconsRequest: Request for beacon and attachment
// information about beacons that a mobile client has encountered "in
// the wild".
type GetInfoForObservedBeaconsRequest struct {
// NamespacedTypes: Specifies what kind of attachments to include in the
// response. When given, the response will include only attachments of
// the given types. When empty, no attachments will be returned. Must be
// in the format namespace/type. Accepts `*` to specify all types in all
// namespaces. Optional.
NamespacedTypes []string `json:"namespacedTypes,omitempty"`
// Observations: The beacons that the client has encountered. At least
// one must be given.
Observations []*Observation `json:"observations,omitempty"`
// ForceSendFields is a list of field names (e.g. "NamespacedTypes") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *GetInfoForObservedBeaconsRequest) MarshalJSON() ([]byte, error) {
type noMethod GetInfoForObservedBeaconsRequest
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// GetInfoForObservedBeaconsResponse: Information about the requested
// beacons, optionally including attachment data.
type GetInfoForObservedBeaconsResponse struct {
// Beacons: Public information about beacons. May be empty if the
// request matched no beacons.
Beacons []*BeaconInfo `json:"beacons,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Beacons") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *GetInfoForObservedBeaconsResponse) MarshalJSON() ([]byte, error) {
type noMethod GetInfoForObservedBeaconsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// IndoorLevel: Indoor level, a human-readable string as returned by
// Google Maps APIs, useful to indicate which floor of a building a
// beacon is located on.
type IndoorLevel struct {
// Name: The name of this level.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *IndoorLevel) MarshalJSON() ([]byte, error) {
type noMethod IndoorLevel
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// LatLng: An object representing a latitude/longitude pair. This is
// expressed as a pair of doubles representing degrees latitude and
// degrees longitude. Unless specified otherwise, this must conform to
// the WGS84 standard. Values must be within normalized ranges. Example
// of normalization code in Python: def NormalizeLongitude(longitude):
// """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r =
// divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0):
// return r - 360.0 return r def NormalizeLatLng(latitude, longitude):
// """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and
// [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0:
// return r - 360, NormalizeLongitude(longitude) else: return 180 - r,
// NormalizeLongitude(longitude + 180.0) assert 180.0 ==
// NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0)
// assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) ==
// NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) ==
// NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) ==
// NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) ==
// NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) ==
// NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) ==
// NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) ==
// NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
// NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) ==
// NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) ==
// NormalizeLatLng(-270.0, 10.0)
type LatLng struct {
// Latitude: The latitude in degrees. It must be in the range [-90.0,
// +90.0].
Latitude float64 `json:"latitude,omitempty"`
// Longitude: The longitude in degrees. It must be in the range [-180.0,
// +180.0].
Longitude float64 `json:"longitude,omitempty"`
// ForceSendFields is a list of field names (e.g. "Latitude") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *LatLng) MarshalJSON() ([]byte, error) {
type noMethod LatLng
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListBeaconAttachmentsResponse: Response to ListBeaconAttachments that
// contains the requested attachments.
type ListBeaconAttachmentsResponse struct {
// Attachments: The attachments that corresponded to the request params.
Attachments []*BeaconAttachment `json:"attachments,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Attachments") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *ListBeaconAttachmentsResponse) MarshalJSON() ([]byte, error) {
type noMethod ListBeaconAttachmentsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListBeaconsResponse: Response that contains list beacon results and
// pagination help.
type ListBeaconsResponse struct {
// Beacons: The beacons that matched the search criteria.
Beacons []*Beacon `json:"beacons,omitempty"`
// NextPageToken: An opaque pagination token that the client may provide
// in their next request to retrieve the next page of results.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalCount: Estimate of the total number of beacons matched by the
// query. Higher values may be less accurate.
TotalCount int64 `json:"totalCount,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Beacons") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *ListBeaconsResponse) MarshalJSON() ([]byte, error) {
type noMethod ListBeaconsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListDiagnosticsResponse: Response that contains the requested
// diagnostics.
type ListDiagnosticsResponse struct {
// Diagnostics: The diagnostics matching the given request.
Diagnostics []*Diagnostics `json:"diagnostics,omitempty"`
// NextPageToken: Token that can be used for pagination. Returned only
// if the request matches more beacons than can be returned in this
// response.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Diagnostics") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *ListDiagnosticsResponse) MarshalJSON() ([]byte, error) {
type noMethod ListDiagnosticsResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// ListNamespacesResponse: Response to ListNamespacesRequest that
// contains all the project's namespaces.
type ListNamespacesResponse struct {
// Namespaces: The attachments that corresponded to the request params.
Namespaces []*Namespace `json:"namespaces,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Namespaces") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *ListNamespacesResponse) MarshalJSON() ([]byte, error) {
type noMethod ListNamespacesResponse
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Namespace: An attachment namespace defines read and write access for
// all the attachments created under it. Each namespace is globally
// unique, and owned by one project which is the only project that can
// create attachments under it.
type Namespace struct {
// NamespaceName: Resource name of this namespace. Namespaces names have
// the format: namespaces/namespace.
NamespaceName string `json:"namespaceName,omitempty"`
// ServingVisibility: Specifies what clients may receive attachments
// under this namespace via `beaconinfo.getforobserved`.
//
// Possible values:
// "VISIBILITY_UNSPECIFIED"
// "UNLISTED"
// "PUBLIC"
ServingVisibility string `json:"servingVisibility,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NamespaceName") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *Namespace) MarshalJSON() ([]byte, error) {
type noMethod Namespace
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// Observation: Represents one beacon observed once.
type Observation struct {
// AdvertisedId: The ID advertised by the beacon the client has
// encountered. Clients may submit an Eddystone-EID `advertised_id`. If
// the client is not authorized to resolve the given Eddystone-EID, no
// data will be returned for that beacon. Required.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
// Telemetry: The array of telemetry bytes received from the beacon. The
// server is responsible for parsing it. This field may frequently be
// empty, as with a beacon that transmits telemetry only occasionally.
Telemetry string `json:"telemetry,omitempty"`
// TimestampMs: Time when the beacon was observed.
TimestampMs string `json:"timestampMs,omitempty"`
// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
// unconditionally include in API requests. By default, fields with
// empty 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:"-"`
}
func (s *Observation) MarshalJSON() ([]byte, error) {
type noMethod Observation
raw := noMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields)
}
// method id "proximitybeacon.beaconinfo.getforobserved":
type BeaconinfoGetforobservedCall struct {
s *Service
getinfoforobservedbeaconsrequest *GetInfoForObservedBeaconsRequest
urlParams_ gensupport.URLParams
ctx_ context.Context
}
// Getforobserved: Given one or more beacon observations, returns any
// beacon information and attachments accessible to your application.
// Authorize by using the [API
// key](https://developers.google.com/beacons/proximity/how-tos/authorizi
// ng#APIKey) for the application.
func (r *BeaconinfoService) Getforobserved(getinfoforobservedbeaconsrequest *GetInfoForObservedBeaconsRequest) *BeaconinfoGetforobservedCall {
c := &BeaconinfoGetforobservedCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.getinfoforobservedbeaconsrequest = getinfoforobservedbeaconsrequest
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *BeaconinfoGetforobservedCall) Fields(s ...googleapi.Field) *BeaconinfoGetforobservedCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *BeaconinfoGetforobservedCall) Context(ctx context.Context) *BeaconinfoGetforobservedCall {
c.ctx_ = ctx
return c
}
func (c *BeaconinfoGetforobservedCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.getinfoforobservedbeaconsrequest)
if err != nil {
return nil, err
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/beaconinfo:getforobserved")
urls += "?" + c.urlParams_.Encode()
req, _ := http.NewRequest("POST", urls, body)
req.Header = reqHeaders
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "proximitybeacon.beaconinfo.getforobserved" call.
// Exactly one of *GetInfoForObservedBeaconsResponse or error will be
// non-nil. Any non-2xx status code is an error. Response headers are in
// either *GetInfoForObservedBeaconsResponse.ServerResponse.Header or
// (if a response was returned at all) in
// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check
// whether the returned error was because http.StatusNotModified was
// returned.
func (c *BeaconinfoGetforobservedCall) Do(opts ...googleapi.CallOption) (*GetInfoForObservedBeaconsResponse, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, &googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
}
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
ret := &GetInfoForObservedBeaconsResponse{