forked from googleapis/google-api-go-client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
proximitybeacon-api.json
823 lines (823 loc) · 34.2 KB
/
proximitybeacon-api.json
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
{
"kind": "discovery#restDescription",
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/yXdK3yTv0tZKHHrFGHjFzQPnyUw\"",
"discoveryVersion": "v1",
"id": "proximitybeacon:v1beta1",
"name": "proximitybeacon",
"version": "v1beta1",
"revision": "20150729",
"title": "Google Proximity Beacon API",
"description": "This API provides services to register, manage, index, and search beacons.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"documentationLink": "https://developers.google.com/beacons/proximity/",
"protocol": "rest",
"baseUrl": "https://proximitybeacon.googleapis.com/",
"basePath": "",
"rootUrl": "https://proximitybeacon.googleapis.com/",
"servicePath": "",
"batchPath": "batch",
"version_module": true,
"parameters": {
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"alt": {
"type": "string",
"description": "Data format for response.",
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
},
"bearer_token": {
"type": "string",
"description": "OAuth bearer token.",
"location": "query"
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"pp": {
"type": "boolean",
"description": "Pretty-print response.",
"default": "true",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"uploadType": {
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query"
},
"$.xgafv": {
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}
},
"schemas": {
"Beacon": {
"id": "Beacon",
"type": "object",
"description": "Details of a beacon device.",
"properties": {
"beaconName": {
"type": "string",
"description": "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."
},
"advertisedId": {
"$ref": "AdvertisedId",
"description": "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."
},
"status": {
"type": "string",
"description": "Current status of the beacon. Required.",
"enum": [
"STATUS_UNSPECIFIED",
"ACTIVE",
"DECOMMISSIONED",
"INACTIVE"
]
},
"placeId": {
"type": "string",
"description": "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."
},
"latLng": {
"$ref": "LatLng",
"description": "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."
},
"indoorLevel": {
"$ref": "IndoorLevel",
"description": "The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional."
},
"expectedStability": {
"type": "string",
"description": "Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.",
"enum": [
"STABILITY_UNSPECIFIED",
"STABLE",
"PORTABLE",
"MOBILE",
"ROVING"
]
},
"description": {
"type": "string",
"description": "Free text used to identify and describe the beacon. Maximum length 140 characters. Optional."
},
"properties": {
"type": "object",
"description": "Properties of the beacon device, for example battery type or firmware version. Optional.",
"additionalProperties": {
"type": "string"
}
}
}
},
"AdvertisedId": {
"id": "AdvertisedId",
"type": "object",
"description": "Defines a unique identifier of a beacon as broadcast by the device.",
"properties": {
"type": {
"type": "string",
"description": "Specifies the identifier type. Required.",
"enum": [
"TYPE_UNSPECIFIED",
"EDDYSTONE",
"IBEACON",
"ALTBEACON"
]
},
"id": {
"type": "string",
"description": "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.",
"format": "byte"
}
}
},
"LatLng": {
"id": "LatLng",
"type": "object",
"description": "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): \"\"\"Wrapsdecimal degrees longitude to [-180.0, 180.0].\"\"\" q, r = divmod(longitude, 360.0) if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): \"\"\"Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.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)",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double"
},
"longitude": {
"type": "number",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double"
}
}
},
"IndoorLevel": {
"id": "IndoorLevel",
"type": "object",
"description": "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.",
"properties": {
"name": {
"type": "string",
"description": "The name of this level."
}
}
},
"Empty": {
"id": "Empty",
"type": "object",
"description": "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 `{}`."
},
"ListBeaconsResponse": {
"id": "ListBeaconsResponse",
"type": "object",
"description": "Response that contains list beacon results and pagination help.",
"properties": {
"beacons": {
"type": "array",
"description": "The beacons that matched the search criteria.",
"items": {
"$ref": "Beacon"
}
},
"nextPageToken": {
"type": "string",
"description": "An opaque pagination token that the client may provide in their next request to retrieve the next page of results."
},
"totalCount": {
"type": "string",
"description": "Estimate of the total number of beacons matched by the query. Higher values may be less accurate.",
"format": "int64"
}
}
},
"BeaconAttachment": {
"id": "BeaconAttachment",
"type": "object",
"description": "Project-specific data associated with a beacon.",
"properties": {
"attachmentName": {
"type": "string",
"description": "Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation."
},
"namespacedType": {
"type": "string",
"description": "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."
},
"data": {
"type": "string",
"description": "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.",
"format": "byte"
}
}
},
"ListBeaconAttachmentsResponse": {
"id": "ListBeaconAttachmentsResponse",
"type": "object",
"description": "Response to ListBeaconAttachments that contains the requested attachments.",
"properties": {
"attachments": {
"type": "array",
"description": "The attachments that corresponded to the request params.",
"items": {
"$ref": "BeaconAttachment"
}
}
}
},
"DeleteAttachmentsResponse": {
"id": "DeleteAttachmentsResponse",
"type": "object",
"description": "Response for a request to delete attachments.",
"properties": {
"numDeleted": {
"type": "integer",
"description": "The number of attachments that were deleted.",
"format": "int32"
}
}
},
"ListNamespacesResponse": {
"id": "ListNamespacesResponse",
"type": "object",
"description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
"properties": {
"namespaces": {
"type": "array",
"description": "The attachments that corresponded to the request params.",
"items": {
"$ref": "Namespace"
}
}
}
},
"Namespace": {
"id": "Namespace",
"type": "object",
"description": "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.",
"properties": {
"namespaceName": {
"type": "string",
"description": "Resource name of this namespace. Namespaces names have the format: namespaces/namespace."
},
"servingVisibility": {
"type": "string",
"description": "Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.",
"enum": [
"VISIBILITY_UNSPECIFIED",
"UNLISTED",
"PUBLIC"
]
}
}
},
"ListDiagnosticsResponse": {
"id": "ListDiagnosticsResponse",
"type": "object",
"description": "Response that contains the requested diagnostics.",
"properties": {
"diagnostics": {
"type": "array",
"description": "The diagnostics matching the given request.",
"items": {
"$ref": "Diagnostics"
}
},
"nextPageToken": {
"type": "string",
"description": "Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response."
}
}
},
"Diagnostics": {
"id": "Diagnostics",
"type": "object",
"description": "Diagnostics for a single beacon.",
"properties": {
"beaconName": {
"type": "string",
"description": "Resource name of the beacon."
},
"estimatedLowBatteryDate": {
"$ref": "Date",
"description": "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."
},
"alerts": {
"type": "array",
"description": "An unordered list of Alerts that the beacon has.",
"enumDescriptions": [
"Invalid value. Should never appear.",
"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.",
"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."
],
"items": {
"type": "string",
"enum": [
"ALERT_UNSPECIFIED",
"WRONG_LOCATION",
"LOW_BATTERY"
]
}
}
}
},
"Date": {
"id": "Date",
"type": "object",
"description": "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`.",
"properties": {
"year": {
"type": "integer",
"description": "Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a year.",
"format": "int32"
},
"month": {
"type": "integer",
"description": "Month of year of date. Must be from 1 to 12.",
"format": "int32"
},
"day": {
"type": "integer",
"description": "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 sigificant.",
"format": "int32"
}
}
},
"GetInfoForObservedBeaconsRequest": {
"id": "GetInfoForObservedBeaconsRequest",
"type": "object",
"description": "Request for beacon and attachment information about beacons that a mobile client has encountered \"in the wild\".",
"properties": {
"observations": {
"type": "array",
"description": "The beacons that the client has encountered. At least one must be given.",
"items": {
"$ref": "Observation"
}
},
"namespacedTypes": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
}
}
},
"Observation": {
"id": "Observation",
"type": "object",
"description": "Represents one beacon observed once.",
"properties": {
"advertisedId": {
"$ref": "AdvertisedId",
"description": "The ID advertised by the beacon the client has encountered. Required."
},
"telemetry": {
"type": "string",
"description": "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.",
"format": "byte"
},
"timestampMs": {
"type": "string",
"description": "Time when the beacon was observed. Being sourced from a mobile device, this time may be suspect."
}
}
},
"GetInfoForObservedBeaconsResponse": {
"id": "GetInfoForObservedBeaconsResponse",
"type": "object",
"description": "Information about the requested beacons, optionally including attachment data.",
"properties": {
"beacons": {
"type": "array",
"description": "Public information about beacons. May be empty if the request matched no beacons.",
"items": {
"$ref": "BeaconInfo"
}
}
}
},
"BeaconInfo": {
"id": "BeaconInfo",
"type": "object",
"description": "A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.",
"properties": {
"advertisedId": {
"$ref": "AdvertisedId",
"description": "The ID advertised by the beacon."
},
"beaconName": {
"type": "string",
"description": "The name under which the beacon is registered."
},
"description": {
"type": "string",
"description": "Free text used to identify or describe the beacon in a registered establishment. For example: \"entrance\", \"room 101\", etc. May be empty."
},
"attachments": {
"type": "array",
"description": "Attachments matching the type(s) requested. May be empty if no attachment types were requested, or if none matched.",
"items": {
"$ref": "AttachmentInfo"
}
}
}
},
"AttachmentInfo": {
"id": "AttachmentInfo",
"type": "object",
"description": "A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.",
"properties": {
"namespacedType": {
"type": "string",
"description": "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"
},
"data": {
"type": "string",
"description": "An opaque data container for client-provided data.",
"format": "byte"
}
}
}
},
"resources": {
"beacons": {
"methods": {
"register": {
"id": "proximitybeacon.beacons.register",
"path": "v1beta1/beacons:register",
"httpMethod": "POST",
"description": "Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once.",
"request": {
"$ref": "Beacon"
},
"response": {
"$ref": "Beacon"
}
},
"decommission": {
"id": "proximitybeacon.beacons.decommission",
"path": "v1beta1/{+beaconName}:decommission",
"httpMethod": "POST",
"description": "Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again.",
"parameters": {
"beaconName": {
"type": "string",
"description": "Beacon that should be decommissioned. Required.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "Empty"
}
},
"get": {
"id": "proximitybeacon.beacons.get",
"path": "v1beta1/{+beaconName}",
"httpMethod": "GET",
"description": "Returns detailed information about the specified beacon.",
"parameters": {
"beaconName": {
"type": "string",
"description": "Beacon that is requested.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "Beacon"
}
},
"list": {
"id": "proximitybeacon.beacons.list",
"path": "v1beta1/beacons",
"httpMethod": "GET",
"description": "Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.",
"parameters": {
"q": {
"type": "string",
"description": "Filter query string that supports the following field filters: * `description:\"\"` For example: `description:\"Room 3\"` Returns beacons whose description matches tokens in the string \"Room 3\" (not necessarily that exact string). The string must be double-quoted. * `status:` For example: `status:active` Returns beacons whose status matches the given value. Values must be one of the Beacon.Status enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `stability:` For example: `stability:mobile` Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `place_id:\"\"` For example: `place_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"` Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from [Google Places API](/places/place-id). Does not match places inside the given place. Does not consider the beacon's actual location (which may be different from its registered place). Accepts multiple filters that will be combined with OR logic. The place ID must be double-quoted. * `registration_time[|=]` For example: `registration_time\u003e=1433116800` Returns beacons whose registration time matches the given filter. Supports the operators: , =. Timestamp must be expressed as an integer number of seconds since midnight January 1, 1970 UTC. Accepts at most two filters that will be combined with AND logic, to support \"between\" semantics. If more than two are supplied, the latter ones are ignored. * `lat: lng: radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000` Returns beacons whose registered location is within the given circle. When any of these fields are given, all are required. Latitude and longitude must be decimal degrees between -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an integer number of meters less than 1,000,000 (1000 km). * `property:\"=\"` For example: `property:\"battery-type=CR2032\"` Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string. * `attachment_type:\"\"` For example: `attachment_type:\"my-namespace/my-type\"` Returns beacons having at least one attachment of the given namespaced type. Supports \"any within this namespace\" via the partial wildcard syntax: \"my-namespace/*\". Supports multiple filters which will be combined with OR logic. The string must be double-quoted. Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "A pagination token obtained from a previous request to list beacons.",
"location": "query"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of records to return for this request, up to a server-defined upper limit.",
"format": "int32",
"location": "query"
}
},
"response": {
"$ref": "ListBeaconsResponse"
}
},
"update": {
"id": "proximitybeacon.beacons.update",
"path": "v1beta1/{+beaconName}",
"httpMethod": "PUT",
"description": "Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the \"read, modify, write\" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for (de)activation and decommissioning.",
"parameters": {
"beaconName": {
"type": "string",
"description": "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.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"request": {
"$ref": "Beacon"
},
"response": {
"$ref": "Beacon"
}
},
"activate": {
"id": "proximitybeacon.beacons.activate",
"path": "v1beta1/{+beaconName}:activate",
"httpMethod": "POST",
"description": "(Re)activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code).",
"parameters": {
"beaconName": {
"type": "string",
"description": "The beacon to activate. Required.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "Empty"
}
},
"deactivate": {
"id": "proximitybeacon.beacons.deactivate",
"path": "v1beta1/{+beaconName}:deactivate",
"httpMethod": "POST",
"description": "Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).",
"parameters": {
"beaconName": {
"type": "string",
"description": "The beacon name of this beacon.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "Empty"
}
}
},
"resources": {
"attachments": {
"methods": {
"create": {
"id": "proximitybeacon.beacons.attachments.create",
"path": "v1beta1/{+beaconName}/attachments",
"httpMethod": "POST",
"description": "Associates the given data with the specified beacon. Attachment data must contain two parts: \n- A namespaced type. \n- The actual attachment data itself. The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long.",
"parameters": {
"beaconName": {
"type": "string",
"description": "The beacon on which the attachment should be created. Required.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"beaconName"
],
"request": {
"$ref": "BeaconAttachment"
},
"response": {
"$ref": "BeaconAttachment"
}
},
"list": {
"id": "proximitybeacon.beacons.attachments.list",
"path": "v1beta1/{+beaconName}/attachments",
"httpMethod": "GET",
"description": "Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint.",
"parameters": {
"beaconName": {
"type": "string",
"description": "The beacon whose attachments are to be fetched. Required.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
},
"namespacedType": {
"type": "string",
"description": "Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify \"all types in all namespaces\".",
"location": "query"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "ListBeaconAttachmentsResponse"
}
},
"delete": {
"id": "proximitybeacon.beacons.attachments.delete",
"path": "v1beta1/{+attachmentName}",
"httpMethod": "DELETE",
"description": "Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone.",
"parameters": {
"attachmentName": {
"type": "string",
"description": "The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738` Required.",
"required": true,
"pattern": "^beacons/[^/]*/attachments/[^/]*$",
"location": "path"
}
},
"parameterOrder": [
"attachmentName"
],
"response": {
"$ref": "Empty"
}
},
"batchDelete": {
"id": "proximitybeacon.beacons.attachments.batchDelete",
"path": "v1beta1/{+beaconName}/attachments:batchDelete",
"httpMethod": "POST",
"description": "Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all.",
"parameters": {
"beaconName": {
"type": "string",
"description": "The beacon whose attachments are to be deleted. Required.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
},
"namespacedType": {
"type": "string",
"description": "Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify \"all types in all namespaces\". Optional.",
"location": "query"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "DeleteAttachmentsResponse"
}
}
}
},
"diagnostics": {
"methods": {
"list": {
"id": "proximitybeacon.beacons.diagnostics.list",
"path": "v1beta1/{+beaconName}/diagnostics",
"httpMethod": "GET",
"description": "List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`.",
"parameters": {
"beaconName": {
"type": "string",
"description": "Beacon that the diagnostics are for.",
"required": true,
"pattern": "^beacons/[^/]*$",
"location": "path"
},
"pageSize": {
"type": "integer",
"description": "Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.",
"format": "int32",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.",
"location": "query"
},
"alertFilter": {
"type": "string",
"description": "Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.",
"enum": [
"ALERT_UNSPECIFIED",
"WRONG_LOCATION",
"LOW_BATTERY"
],
"location": "query"
}
},
"parameterOrder": [
"beaconName"
],
"response": {
"$ref": "ListDiagnosticsResponse"
}
}
}
}
}
},
"namespaces": {
"methods": {
"list": {
"id": "proximitybeacon.namespaces.list",
"path": "v1beta1/namespaces",
"httpMethod": "GET",
"description": "Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project.",
"response": {
"$ref": "ListNamespacesResponse"
}
}
}
},
"beaconinfo": {
"methods": {
"getforobserved": {
"id": "proximitybeacon.beaconinfo.getforobserved",
"path": "v1beta1/beaconinfo:getforobserved",
"httpMethod": "POST",
"description": "Given one or more beacon observations, returns any beacon information and attachments accessible to your application.",
"request": {
"$ref": "GetInfoForObservedBeaconsRequest"
},
"response": {
"$ref": "GetInfoForObservedBeaconsResponse"
}
}
}
}
}
}